class_meshtexture.rst 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshTexture.xml.
  6. .. _class_MeshTexture:
  7. MeshTexture
  8. ===========
  9. **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Simple texture that uses a mesh to draw itself.
  11. Description
  12. -----------
  13. Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported.
  14. Properties
  15. ----------
  16. +-----------------------------------+--------------------------------------------------------------+-------------------+
  17. | :ref:`Texture2D<class_Texture2D>` | :ref:`base_texture<class_MeshTexture_property_base_texture>` | |
  18. +-----------------------------------+--------------------------------------------------------------+-------------------+
  19. | :ref:`Vector2<class_Vector2>` | :ref:`image_size<class_MeshTexture_property_image_size>` | ``Vector2(0, 0)`` |
  20. +-----------------------------------+--------------------------------------------------------------+-------------------+
  21. | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshTexture_property_mesh>` | |
  22. +-----------------------------------+--------------------------------------------------------------+-------------------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_MeshTexture_property_base_texture:
  26. - :ref:`Texture2D<class_Texture2D>` **base_texture**
  27. +----------+-------------------------+
  28. | *Setter* | set_base_texture(value) |
  29. +----------+-------------------------+
  30. | *Getter* | get_base_texture() |
  31. +----------+-------------------------+
  32. Sets the base texture that the Mesh will use to draw.
  33. ----
  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. ----
  45. .. _class_MeshTexture_property_mesh:
  46. - :ref:`Mesh<class_Mesh>` **mesh**
  47. +----------+-----------------+
  48. | *Setter* | set_mesh(value) |
  49. +----------+-----------------+
  50. | *Getter* | get_mesh() |
  51. +----------+-----------------+
  52. Sets the mesh used to draw. It must be a mesh using 2D vertices.
  53. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  54. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  55. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  56. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  57. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  58. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`