Provides high-performance mesh instancing.
MultiMesh provides low-level mesh instancing. Drawing thousands of [MeshInstance] 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 of each other, performance may be reduced as every single instance will always rendered (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.
https://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/animating_thousands_of_fish.html https://docs.godotengine.org/en/latest/tutorials/optimization/using_multimesh.html
Returns the visibility axis-aligned bounding box.
Gets a specific instance's color.
Returns the custom data that has been set for a specific instance.
Returns the [Transform] of a specific instance.
Returns the [Transform2D] of a specific instance.
Sets the color of a specific instance. For the color to take effect, ensure that [member use_colors] is [code]true[/code] on the [MultiMesh] and [member BaseMaterial3D.vertex_color_use_as_albedo] is [code]true[/code] on the material.
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 [member use_custom_data] is [code]true[/code].
Sets the [Transform] for a specific instance.
Sets the [Transform2D] for a specific instance.
- 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 [member visible_instance_count].
- Mesh to be drawn.
- Format of transform used to transform mesh, either 2D or 3D.
- Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers.
Use this when using 2D transforms.
Use this when using 3D transforms.