class_meshtexture.rst 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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>` |
  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. Set 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. | *Setter* | set_image_size(value) |
  38. +----------+-----------------------+
  39. | *Getter* | get_image_size() |
  40. +----------+-----------------------+
  41. Set the size of the image, needed for reference.
  42. .. _class_MeshTexture_property_mesh:
  43. - :ref:`Mesh<class_Mesh>` **mesh**
  44. +----------+-----------------+
  45. | *Setter* | set_mesh(value) |
  46. +----------+-----------------+
  47. | *Getter* | get_mesh() |
  48. +----------+-----------------+
  49. Set the mesh used to draw. It must be a mesh using 2D vertices.