class_meshtexture.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the MeshTexture.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_MeshTexture:
  5. MeshTexture
  6. ===========
  7. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Simple texture that uses a mesh to draw itself.
  12. Properties
  13. ----------
  14. +-------------------------------+--------------------------------------------------------------+-----------------+
  15. | :ref:`Texture<class_Texture>` | :ref:`base_texture<class_MeshTexture_property_base_texture>` | |
  16. +-------------------------------+--------------------------------------------------------------+-----------------+
  17. | :ref:`Vector2<class_Vector2>` | :ref:`image_size<class_MeshTexture_property_image_size>` | Vector2( 0, 0 ) |
  18. +-------------------------------+--------------------------------------------------------------+-----------------+
  19. | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshTexture_property_mesh>` | |
  20. +-------------------------------+--------------------------------------------------------------+-----------------+
  21. Description
  22. -----------
  23. Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported.
  24. Property Descriptions
  25. ---------------------
  26. .. _class_MeshTexture_property_base_texture:
  27. - :ref:`Texture<class_Texture>` **base_texture**
  28. +----------+-------------------------+
  29. | *Setter* | set_base_texture(value) |
  30. +----------+-------------------------+
  31. | *Getter* | get_base_texture() |
  32. +----------+-------------------------+
  33. Sets the base texture that the Mesh will use to draw.
  34. .. _class_MeshTexture_property_image_size:
  35. - :ref:`Vector2<class_Vector2>` **image_size**
  36. +-----------+-----------------------+
  37. | *Default* | Vector2( 0, 0 ) |
  38. +-----------+-----------------------+
  39. | *Setter* | set_image_size(value) |
  40. +-----------+-----------------------+
  41. | *Getter* | get_image_size() |
  42. +-----------+-----------------------+
  43. Sets the size of the image, needed for reference.
  44. .. _class_MeshTexture_property_mesh:
  45. - :ref:`Mesh<class_Mesh>` **mesh**
  46. +----------+-----------------+
  47. | *Setter* | set_mesh(value) |
  48. +----------+-----------------+
  49. | *Getter* | get_mesh() |
  50. +----------+-----------------+
  51. Sets the mesh used to draw. It must be a mesh using 2D vertices.