class_meshtexture.rst 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the MeshTexture.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_MeshTexture:
  6. MeshTexture
  7. ===========
  8. **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Simple texture that uses a mesh to draw itself.
  10. Description
  11. -----------
  12. Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported.
  13. Properties
  14. ----------
  15. +-----------------------------------+--------------------------------------------------------------+-------------------+
  16. | :ref:`Texture2D<class_Texture2D>` | :ref:`base_texture<class_MeshTexture_property_base_texture>` | |
  17. +-----------------------------------+--------------------------------------------------------------+-------------------+
  18. | :ref:`Vector2<class_Vector2>` | :ref:`image_size<class_MeshTexture_property_image_size>` | ``Vector2(0, 0)`` |
  19. +-----------------------------------+--------------------------------------------------------------+-------------------+
  20. | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshTexture_property_mesh>` | |
  21. +-----------------------------------+--------------------------------------------------------------+-------------------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_MeshTexture_property_base_texture:
  25. - :ref:`Texture2D<class_Texture2D>` **base_texture**
  26. +----------+-------------------------+
  27. | *Setter* | set_base_texture(value) |
  28. +----------+-------------------------+
  29. | *Getter* | get_base_texture() |
  30. +----------+-------------------------+
  31. Sets the base texture that the Mesh will use to draw.
  32. ----
  33. .. _class_MeshTexture_property_image_size:
  34. - :ref:`Vector2<class_Vector2>` **image_size**
  35. +-----------+-----------------------+
  36. | *Default* | ``Vector2(0, 0)`` |
  37. +-----------+-----------------------+
  38. | *Setter* | set_image_size(value) |
  39. +-----------+-----------------------+
  40. | *Getter* | get_image_size() |
  41. +-----------+-----------------------+
  42. Sets the size of the image, needed for reference.
  43. ----
  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.
  52. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  53. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  54. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  55. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  56. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  57. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`