mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
e903776b06
Sync the class reference with the 3.4 branch (4330c0b8e909bd095345f2a979a23aad08493bb8), minus some 3.4.3 specific API changes that are not released yet. Importantly, this fixes some invalid links and thus makes CI happy. Happy CI, happy devs!
94 lines
3.4 KiB
ReStructuredText
94 lines
3.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the MeshInstance2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_MeshInstance2D:
|
|
|
|
MeshInstance2D
|
|
==============
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Node used for displaying a :ref:`Mesh<class_Mesh>` in 2D.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Node used for displaying a :ref:`Mesh<class_Mesh>` in 2D. Can be constructed from an existing :ref:`Sprite<class_Sprite>` via a tool in the editor toolbar. Select "Sprite" then "Convert to Mesh2D", select settings in popup and press "Create Mesh2D".
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/2d/2d_meshes`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+-------------------------------------------------------------+
|
|
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshInstance2D_property_mesh>` |
|
|
+-------------------------------+-------------------------------------------------------------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_MeshInstance2D_property_normal_map>` |
|
|
+-------------------------------+-------------------------------------------------------------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`texture<class_MeshInstance2D_property_texture>` |
|
|
+-------------------------------+-------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_MeshInstance2D_signal_texture_changed:
|
|
|
|
- **texture_changed** **(** **)**
|
|
|
|
Emitted when the :ref:`texture<class_MeshInstance2D_property_texture>` is changed.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_MeshInstance2D_property_mesh:
|
|
|
|
- :ref:`Mesh<class_Mesh>` **mesh**
|
|
|
|
+----------+-----------------+
|
|
| *Setter* | set_mesh(value) |
|
|
+----------+-----------------+
|
|
| *Getter* | get_mesh() |
|
|
+----------+-----------------+
|
|
|
|
The :ref:`Mesh<class_Mesh>` that will be drawn by the ``MeshInstance2D``.
|
|
|
|
----
|
|
|
|
.. _class_MeshInstance2D_property_normal_map:
|
|
|
|
- :ref:`Texture<class_Texture>` **normal_map**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_normal_map(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_normal_map() |
|
|
+----------+-----------------------+
|
|
|
|
The normal map that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`.
|
|
|
|
**Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.
|
|
|
|
----
|
|
|
|
.. _class_MeshInstance2D_property_texture:
|
|
|
|
- :ref:`Texture<class_Texture>` **texture**
|
|
|
|
+----------+--------------------+
|
|
| *Setter* | set_texture(value) |
|
|
+----------+--------------------+
|
|
| *Getter* | get_texture() |
|
|
+----------+--------------------+
|
|
|
|
The :ref:`Texture<class_Texture>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.
|
|
|
|
.. |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.)`
|