| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MultiMeshInstance.xml.
- .. _class_MultiMeshInstance:
- MultiMeshInstance
- =================
- **Inherits:** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`CullInstance<class_CullInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Node that instances a :ref:`MultiMesh<class_MultiMesh>`.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- **MultiMeshInstance** is a specialized node to instance :ref:`GeometryInstance<class_GeometryInstance>`\ s based on a :ref:`MultiMesh<class_MultiMesh>` resource.
- This is useful to optimize the rendering of a high amount of instances of a given mesh (for example trees in a forest or grass strands).
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`../tutorials/performance/vertex_animation/animating_thousands_of_fish`
- - :doc:`../tutorials/3d/using_multi_mesh_instance`
- - :doc:`../tutorials/performance/using_multimesh`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-----------------------------------+--------------------------------------------------------------+
- | :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance_property_multimesh>` |
- +-----------------------------------+--------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_MultiMeshInstance_property_multimesh:
- .. rst-class:: classref-property
- :ref:`MultiMesh<class_MultiMesh>` **multimesh**
- .. rst-class:: classref-property-setget
- - void **set_multimesh** **(** :ref:`MultiMesh<class_MultiMesh>` value **)**
- - :ref:`MultiMesh<class_MultiMesh>` **get_multimesh** **(** **)**
- The :ref:`MultiMesh<class_MultiMesh>` resource that will be used and shared among all instances of the **MultiMeshInstance**.
- .. |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.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
