godotengine
/
godot
mirror of https://github.com/godotengine/godot
1
0
Fork 0
Code

Clarify the purpose of MeshInstance2D and MultiMeshInstance2D

This commit is contained in:
Hugo Locurcio 2025-11-24 19:40:19 +01:00 committed by Rémi Verschelde
parent 7692a3d53b
commit 9ae02dbab0
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/MeshInstance2D.xml
View File

@ -4,7 +4,9 @@
Node used for displaying a [Mesh] in 2D.
</brief_description>
<description>
Node used for displaying a [Mesh] in 2D. A [MeshInstance2D] can be automatically created from an existing [Sprite2D] via a tool in the editor toolbar. Select the [Sprite2D] node, then choose [b]Sprite2D &gt; Convert to MeshInstance2D[/b] at the top of the 2D editor viewport.
Node used for displaying a [Mesh] in 2D. This can be faster to render compared to displaying a [Sprite2D] node with large transparent areas, especially if the node takes up a lot of space on screen at high viewport resolutions. This is because using a mesh designed to fit the sprite's opaque areas will reduce GPU fill rate utilization (at the cost of increased vertex processing utilization).
When a [Mesh] has to be instantiated more than thousands of times close to each other, consider using a [MultiMesh] in a [MultiMeshInstance2D] instead.
A [MeshInstance2D] can be created from an existing [Sprite2D] via a tool in the editor toolbar. Select the [Sprite2D] node, then choose [b]Sprite2D &gt; Convert to MeshInstance2D[/b] at the top of the 2D editor viewport.
</description>
<tutorials>
<link title="2D meshes">$DOCS_URL/tutorials/2d/2d_meshes.html</link>

2
doc/classes/MultiMeshInstance2D.xml
View File

@ -4,7 +4,7 @@
Node that instances a [MultiMesh] in 2D.
</brief_description>
<description>
[MultiMeshInstance2D] is a specialized node to instance a [MultiMesh] resource in 2D.
[MultiMeshInstance2D] is a specialized node to instance a [MultiMesh] resource in 2D. This can be faster to render compared to displaying many [Sprite2D] nodes with large transparent areas, especially if the nodes take up a lot of space on screen at high viewport resolutions. This is because using a mesh designed to fit the sprites' opaque areas will reduce GPU fill rate utilization (at the cost of increased vertex processing utilization).
Usage is the same as [MultiMeshInstance3D].
</description>
<tutorials>