Struct MultiMesh
Provides high-performance mesh instancing.
struct MultiMesh
;
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.
Properties
| Name | Type | Description |
|---|---|---|
colorArray[get, set]
|
PoolArray!(godot.core.color.Color) | |
colorFormat[get, set]
|
MultiMesh | Format of colors in color array that gets passed to shader. |
customDataArray[get, set]
|
PoolArray!(godot.core.color.Color) | |
customDataFormat[get, set]
|
MultiMesh | Format of custom data in custom data array that gets passed to shader. |
instanceCount[get, set]
|
long | 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 visibleInstanceCount.
|
mesh[get, set]
|
Mesh | Mesh to be drawn. |
transform2dArray[get, set]
|
PoolArray!(godot.core.vector2.Vector2) | |
transformArray[get, set]
|
PoolArray!(godot.core.vector3.Vector3) | |
transformFormat[get, set]
|
MultiMesh | Format of transform used to transform mesh, either 2D or 3D. |
visibleInstanceCount[get, set]
|
long | Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers. |
Methods
| Name | Description |
|---|---|
_getColorArray
|
|
_getCustomDataArray
|
|
_getTransform2dArray
|
|
_getTransformArray
|
|
_setColorArray
|
|
_setCustomDataArray
|
|
_setTransform2dArray
|
|
_setTransformArray
|
|
getAabb
|
Returns the visibility axis-aligned bounding box. |
getColorFormat
|
|
getCustomDataFormat
|
|
getInstanceColor
|
Gets a specific instance's color. |
getInstanceCount
|
|
getInstanceCustomData
|
Returns the custom data that has been set for a specific instance. |
getInstanceTransform
|
Returns the Transform of a specific instance.
|
getInstanceTransform2d
|
Returns the Transform2D of a specific instance.
|
getMesh
|
|
getTransformFormat
|
|
getVisibleInstanceCount
|
|
setAsBulkArray
|
Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.
All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc...
Transform is stored as 12 floats, Transform2D is stored as 8 floats, COLOR_8BIT / CUSTOM_DATA_8BIT is stored as 1 float (4 bytes as is) and COLOR_FLOAT / CUSTOM_DATA_FLOAT is stored as 4 floats.
|
setColorFormat
|
|
setCustomDataFormat
|
|
setInstanceColor
|
Sets the color of a specific instance.
For the color to take effect, ensure that colorFormat is non-null on the MultiMesh and SpatialMaterial is true on the material.
|
setInstanceCount
|
|
setInstanceCustomData
|
Sets custom data for a specific instance. Although Color is used, it is just a container for 4 floating point numbers. The format of the number can change depending on the customdataformat used.
|
setInstanceTransform
|
Sets the Transform for a specific instance.
|
setInstanceTransform2d
|
Sets the Transform2D for a specific instance.
|
setMesh
|
|
setTransformFormat
|
|
setVisibleInstanceCount
|
Enums
| Name | Description |
|---|---|
ColorFormat
|
|
Constants
|
|
CustomDataFormat
|
|
TransformFormat
|