MultiMesh

Provides high performance mesh instancing.

MultiMesh provides low level mesh instancing. If the amount of Mesh instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of MeshInstance nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little 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.

@GodotBaseClass

struct MultiMesh {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(MultiMesh other);

MultiMesh opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static MultiMesh _new();

enum TransformFormat;

enum CustomDataFormat;

enum ColorFormat;

enum Constants;

void setMesh(Mesh mesh);

Ref!Mesh getMesh();

void setColorFormat(long format);

MultiMesh.ColorFormat getColorFormat();

void setCustomDataFormat(long format);

MultiMesh.CustomDataFormat getCustomDataFormat();

void setTransformFormat(long format);

MultiMesh.TransformFormat getTransformFormat();

void setInstanceCount(long count);

long getInstanceCount();

void setInstanceTransform(long instance, Transform transform);

Transform getInstanceTransform(long instance);

void setInstanceColor(long instance, Color color);

Color getInstanceColor(long instance);

void setInstanceCustomData(long instance, Color custom_data);

Color getInstanceCustomData(long instance);

AABB getAabb();

void _setTransformArray(PoolVector3Array arg0);

PoolVector3Array _getTransformArray();

void _setColorArray(PoolColorArray arg0);

PoolColorArray _getColorArray();

void _setCustomDataArray(PoolColorArray arg0);

PoolColorArray _getCustomDataArray();

MultiMesh.ColorFormat colorFormat [@property getter];

long colorFormat [@property setter];

MultiMesh.TransformFormat transformFormat [@property getter];

long transformFormat [@property setter];

MultiMesh.CustomDataFormat customDataFormat [@property getter];

long customDataFormat [@property setter];

long instanceCount [@property getter];

long instanceCount [@property setter];

Mesh mesh [@property getter];

Mesh mesh [@property setter];

PoolVector3Array transformArray [@property getter];

PoolVector3Array transformArray [@property setter];

PoolColorArray colorArray [@property getter];

PoolColorArray colorArray [@property setter];

PoolColorArray customDataArray [@property getter];

PoolColorArray customDataArray [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

ColorFormat enum ColorFormat
Constants enum Constants
CustomDataFormat enum CustomDataFormat
TransformFormat enum TransformFormat

Functions

_getColorArray PoolColorArray _getColorArray()
_getCustomDataArray PoolColorArray _getCustomDataArray()
_getTransformArray PoolVector3Array _getTransformArray()
_setColorArray void _setColorArray(PoolColorArray arg0)
_setCustomDataArray void _setCustomDataArray(PoolColorArray arg0)
_setTransformArray void _setTransformArray(PoolVector3Array arg0)
getAabb AABB getAabb(): Return the visibility AABB.
getColorFormat MultiMesh.ColorFormat getColorFormat()
getCustomDataFormat MultiMesh.CustomDataFormat getCustomDataFormat()
getInstanceColor Color getInstanceColor(long instance): Get the color of a specific instance.
getInstanceCount long getInstanceCount()
getInstanceCustomData Color getInstanceCustomData(long instance)
getInstanceTransform Transform getInstanceTransform(long instance): Return the transform of a specific instance.
getMesh Ref!Mesh getMesh()
getTransformFormat MultiMesh.TransformFormat getTransformFormat()
opAssign MultiMesh opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(MultiMesh other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setColorFormat void setColorFormat(long format)
setCustomDataFormat void setCustomDataFormat(long format)
setInstanceColor void setInstanceColor(long instance, Color color): Set the color of a specific instance.
setInstanceCount void setInstanceCount(long count)
setInstanceCustomData void setInstanceCustomData(long instance, Color custom_data)
setInstanceTransform void setInstanceTransform(long instance, Transform transform): Set the transform for a specific instance.
setMesh void setMesh(Mesh mesh)
setTransformFormat void setTransformFormat(long format)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

colorArray PoolColorArray colorArray [@property setter]
colorArray PoolColorArray colorArray [@property getter]
colorFormat MultiMesh.ColorFormat colorFormat [@property getter]
long colorFormat [@property setter]
customDataArray PoolColorArray customDataArray [@property getter]
PoolColorArray customDataArray [@property setter]
customDataFormat MultiMesh.CustomDataFormat customDataFormat [@property getter]
long customDataFormat [@property setter]
instanceCount long instanceCount [@property getter]
long instanceCount [@property setter]
mesh Mesh mesh [@property getter]
Mesh mesh [@property setter]
transformArray PoolVector3Array transformArray [@property getter]
PoolVector3Array transformArray [@property setter]
transformFormat MultiMesh.TransformFormat transformFormat [@property getter]
long transformFormat [@property setter]

Static functions

_new MultiMesh _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot multimesh structs

MultiMesh