MultiMeshInstance2D
Entity that instances a MultiMesh in 2D.
Entity that instances a MultiMesh 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.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
MultiMeshInstance2DConstructor
public MultiMeshInstance2D();Properties2
MultimeshProperty
public MultiMesh Multimesh { get; set; }The MultiMesh that will be drawn by the MultiMeshInstance2D.
TextureProperty
public Texture2D Texture { get; set; }The Texture2D that will be used if using the default CanvasItemMaterial. Can be accessed as TEXTURE in CanvasItem shader.
Methods4
GetMultimeshMultiMesh
public MultiMesh GetMultimesh();MultiMeshGetTextureTexture2D
public Texture2D GetTexture();Texture2DSetMultimeshvoid
public void SetMultimesh(MultiMesh multimesh);| Name | Type | Default |
|---|---|---|
multimesh | MultiMesh | — |
SetTexturevoid
public void SetTexture(Texture2D texture);| Name | Type | Default |
|---|---|---|
texture | Texture2D | — |
Signals and events1
TextureChangedEvent
public event Action TextureChanged;Emitted when the MultiMeshInstance2D.Texture is changed.