MultiMesh

Category: Core

Provides high performance mesh instancing.

Properties

Enumerations

enum TransformFormat:

• TRANSFORM_2D = 0 — Use this when using 2D transforms.
• TRANSFORM_3D = 1 — Use this when using 3D transforms.

enum ColorFormat:

• COLOR_8BIT = 1 — Compress data into 8 bits when passing to shader. This uses less memory and can be faster, but the Color loses precision.
• COLOR_FLOAT = 2 — The passed into set_instance_color will use 4 floats. Use this for highest precision .

enum CustomDataFormat:

• CUSTOM_DATA_NONE = 0 — Use when you are not using per-instance custom data.
• CUSTOM_DATA_8BIT = 1 — Compress custom_data into 8 bits when passing to shader. This uses less memory and can be faster, but loses precision.
• CUSTOM_DATA_FLOAT = 2 — The Color passed into will use 4 floats. Use this for highest precision.

MultiMesh provides low level mesh instancing. Drawing thousands of MeshInstance nodes can be slow because each object is submitted to the GPU to be drawn individually.

MultiMesh is much faster because it can draw thousands of instances with a single draw call, resulting in less API overhead.

Since instances may have any behavior, the AABB used for visibility must be provided by the user.

Tutorials

• ColorFormat color_format

Format of colors in color array that gets passed to shader.

• custom_data_format

Format of custom data in custom data array that gets passed to shader.

• int instance_count

Number of instances that will get drawn.

• mesh

Mesh to be drawn.

Format of transform used to transform mesh, either 2D or 3D.

• int visible_instance_count

Method Descriptions

• get_aabb ( ) const

Returns the visibility AABB.

• Color get_instance_color ( instance ) const

• Color get_instance_custom_data ( instance ) const

Returns the custom data that has been set for a specific instance.

• Transform get_instance_transform ( instance ) const

Returns the Transform of a specific instance.

• get_instance_transform_2d ( int instance ) const

Returns the of a specific instance.

• void set_instance_color ( int instance, color )

Set the color of a specific instance.

For the color to take effect, ensure that color_format is non- on the and is on the material.

• void set_instance_custom_data ( int instance, custom_data )

Set custom data for a specific instance. Although Color is used, it is just a container for 4 numbers.

• void set_instance_transform ( instance, Transform transform )

Set the transform for a specific instance.

• void set_instance_transform_2d ( instance, Transform2D transform )