class_multimeshinstance.rst 1.2 KB

12345678910111213141516171819202122232425262728293031323334
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the MultiMeshInstance.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_MultiMeshInstance:
  5. MultiMeshInstance
  6. =================
  7. **Inherits:** :ref:`GeometryInstance<class_geometryinstance>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Node that instances a :ref:`MultiMesh<class_multimesh>`.
  12. Member Variables
  13. ----------------
  14. .. _class_MultiMeshInstance_multimesh:
  15. - :ref:`MultiMesh<class_multimesh>` **multimesh** - The :ref:`MultiMesh<class_multimesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance``.
  16. Description
  17. -----------
  18. ``MultiMeshInstance`` is a specialized node to instance :ref:`GeometryInstance<class_geometryinstance>`\ s based on a :ref:`MultiMesh<class_multimesh>` resource.
  19. This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands).