MultiMesh

Inherits: Resource < RefCounted < Object

Provides high-performance mesh instancing.

Description

MultiMesh provides low-level mesh instancing. Drawing thousands of MeshInstance3D nodes can be slow, since each object is submitted to the GPU then drawn individually.

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

As a drawback, if the instances are too far away from each other, performance may be reduced as every single instance will always render (they are spatially indexed as one, for the whole object).

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

Methods

AABB

get_aabb ( ) const

Color

get_instance_color ( int instance ) const

Color

get_instance_custom_data ( int instance ) const

Transform3D

get_instance_transform ( int instance ) const

Transform2D

get_instance_transform_2d ( int instance ) const

void

set_instance_color ( int instance, Color color )

void

set_instance_custom_data ( int instance, Color custom_data )

void

set_instance_transform ( int instance, Transform3D transform )

void

set_instance_transform_2d ( int instance, Transform2D transform )

Enumerations

enum TransformFormat:

  • TRANSFORM_2D = 0 --- Use this when using 2D transforms.

  • TRANSFORM_3D = 1 --- Use this when using 3D transforms.

Property Descriptions

Default

PackedFloat32Array()

Setter

set_buffer(value)

Getter

get_buffer()

  • int instance_count

Default

0

Setter

set_instance_count(value)

Getter

get_instance_count()

Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with visible_instance_count.

Setter

set_mesh(value)

Getter

get_mesh()

Mesh to be drawn.

Default

0

Setter

set_transform_format(value)

Getter

get_transform_format()

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

Default

false

Setter

set_use_colors(value)

Getter

is_using_colors()

If true, the MultiMesh will use color data (see color_array).

  • bool use_custom_data

Default

false

Setter

set_use_custom_data(value)

Getter

is_using_custom_data()

If true, the MultiMesh will use custom data (see custom_data_array).

  • int visible_instance_count

Default

-1

Setter

set_visible_instance_count(value)

Getter

get_visible_instance_count()

Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers.

Method Descriptions

  • AABB get_aabb ( ) const

Returns the visibility axis-aligned bounding box in local space. See also VisualInstance3D.get_transformed_aabb.

  • Color get_instance_color ( int instance ) const

Gets a specific instance's color.

  • Color get_instance_custom_data ( int instance ) const

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

Returns the Transform3D of a specific instance.

Returns the Transform2D of a specific instance.

  • void set_instance_color ( int instance, Color color )

Sets the color of a specific instance by multiplying the mesh's existing vertex colors.

For the color to take effect, ensure that use_colors is true on the MultiMesh and BaseMaterial3D.vertex_color_use_as_albedo is true on the material.

  • void set_instance_custom_data ( int instance, Color custom_data )

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

For the custom data to be used, ensure that use_custom_data is true.

Sets the Transform3D for a specific instance.

  • void set_instance_transform_2d ( int instance, Transform2D transform )

Sets the Transform2D for a specific instance.