pandemonium_engine_docs/classes/class_meshtexture.rst

83 lines
3.5 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MeshTexture.xml.
.. _class_MeshTexture:
MeshTexture
===========
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Simple texture that uses a mesh to draw itself.
Description
-----------
Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported.
Properties
----------
+-------------------------------+--------------------------------------------------------------+----------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`base_texture<class_MeshTexture_property_base_texture>` | |
+-------------------------------+--------------------------------------------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | flags | ``0`` (overrides :ref:`Texture<class_Texture_property_flags>`) |
+-------------------------------+--------------------------------------------------------------+----------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`image_size<class_MeshTexture_property_image_size>` | ``Vector2( 0, 0 )`` |
+-------------------------------+--------------------------------------------------------------+----------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshTexture_property_mesh>` | |
+-------------------------------+--------------------------------------------------------------+----------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_MeshTexture_property_base_texture:
- :ref:`Texture<class_Texture>` **base_texture**
+----------+-------------------------+
| *Setter* | set_base_texture(value) |
+----------+-------------------------+
| *Getter* | get_base_texture() |
+----------+-------------------------+
Sets the base texture that the Mesh will use to draw.
----
.. _class_MeshTexture_property_image_size:
- :ref:`Vector2<class_Vector2>` **image_size**
+-----------+-----------------------+
| *Default* | ``Vector2( 0, 0 )`` |
+-----------+-----------------------+
| *Setter* | set_image_size(value) |
+-----------+-----------------------+
| *Getter* | get_image_size() |
+-----------+-----------------------+
Sets the size of the image, needed for reference.
----
.. _class_MeshTexture_property_mesh:
- :ref:`Mesh<class_Mesh>` **mesh**
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
Sets the mesh used to draw. It must be a mesh using 2D vertices.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`