ArrayMesh

addBlendShape void addBlendShape(String name): Adds name for a blend shape that will be added with addSurfaceFromArrays. Must be called before surface is added.
addSurfaceFromArrays void addSurfaceFromArrays(long primitive, Array arrays, Array blend_shapes, long compress_flags): Creates a new surface. Surfaces are created to be rendered using a primitive, which may be any of the types defined in Mesh.primitivetype. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) Mesh.getSurfaceCount will become the surf_idx for this new surface. The arrays argument is an array of arrays. See arraytype for the values used in this array. For example, arrays$(D 0) is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for constant ARRAY_INDEX if it is used.
clearBlendShapes void clearBlendShapes(): Removes all blend shapes from this ArrayMesh.
getBlendShapeCount long getBlendShapeCount(): Returns the number of blend shapes that the ArrayMesh holds.
getBlendShapeMode Mesh.BlendShapeMode getBlendShapeMode()
getBlendShapeName String getBlendShapeName(long index): Returns the name of the blend shape at this index.
getCustomAabb AABB getCustomAabb()
lightmapUnwrap GodotError lightmapUnwrap(Transform transform, double texel_size): Will perform a UV unwrap on the ArrayMesh to prepare the mesh for lightmapping.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(ArrayMesh other)
opEquals bool opEquals(typeof(null) n)
regenNormalmaps void regenNormalmaps(): Will regenerate normal maps for the ArrayMesh.
setBlendShapeMode void setBlendShapeMode(long mode)
setCustomAabb void setCustomAabb(AABB aabb)
surfaceFindByName long surfaceFindByName(String name): Returns the index of the first surface with this name held within this ArrayMesh. If none are found, -1 is returned.
surfaceGetArrayIndexLen long surfaceGetArrayIndexLen(long surf_idx): Returns the length in indices of the index array in the requested surface (see addSurfaceFromArrays).
surfaceGetArrayLen long surfaceGetArrayLen(long surf_idx): Returns the length in vertices of the vertex array in the requested surface (see addSurfaceFromArrays).
surfaceGetFormat long surfaceGetFormat(long surf_idx): Returns the format mask of the requested surface (see addSurfaceFromArrays).
surfaceGetName String surfaceGetName(long surf_idx): Gets the name assigned to this surface.
surfaceGetPrimitiveType Mesh.PrimitiveType surfaceGetPrimitiveType(long surf_idx): Returns the primitive type of the requested surface (see addSurfaceFromArrays).
surfaceRemove void surfaceRemove(long surf_idx): Removes a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
surfaceSetName void surfaceSetName(long surf_idx, String name): Sets a name for a given surface.
surfaceUpdateRegion void surfaceUpdateRegion(long surf_idx, long offset, PoolByteArray data): Updates a specified region of mesh arrays on the GPU. Warning: Only use if you know what you are doing. You can easily cause crashes by calling this function with improper arguments.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

blendShapeMode Mesh.BlendShapeMode blendShapeMode [@property getter]
long blendShapeMode [@property setter]: Sets the blend shape mode to one of Mesh.blendshapemode.
customAabb AABB customAabb [@property getter]
AABB customAabb [@property setter]: Overrides the AABB with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices.

Static functions

_new ArrayMesh _new(): Construct a new instance of ArrayMesh. Note: use memnew!ArrayMesh instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: 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 inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(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.

var vertices = PoolVector3Array() vertices.push_back(Vector3(0, 1, 0)) vertices.push_back(Vector3(1, 0, 0)) vertices.push_back(Vector3(0, 0, 1)) # Initialize the ArrayMesh. var arr_mesh = ArrayMesh.new() var arrays = [] arrays.resize(ArrayMesh.ARRAY_MAX) arraysArrayMesh.ARRAY_VERTEX = vertices # Create the Mesh. arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays) var m = MeshInstance.new() m.mesh = arr_mesh

The MeshInstance is ready to be added to the SceneTree to be shown. See also ImmediateGeometry, MeshDataTool and SurfaceTool for procedural geometry generation. Note: Godot uses clockwise url=https://learnopengl.com/Advanced-OpenGL/Face-cullingwinding order/url for front faces of triangle primitive modes.

ArrayMesh

Members

Aliases

Enums

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Detailed Description

Meta

Source

ArrayMesh

From mixin baseCasts

From `mixin baseCasts`