A Resource that contains vertex array-based geometry.
Mesh is a type of Resource that contains vertex array-based geometry, divided in surfaces. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. The maximum number of surfaces per mesh is RenderingServer.MAX_MESH_SURFACES.
Virtual method to override the number of blend shapes for a custom class extending Mesh.
Virtual method to override the retrieval of blend shape names for a custom class extending Mesh.
Virtual method to override the surface count for a custom class extending Mesh.
Virtual method to override the names of blend shapes for a custom class extending Mesh.
Virtual method to override the surface array index length for a custom class extending Mesh.
Virtual method to override the surface array length for a custom class extending Mesh.
Virtual method to override the surface arrays for a custom class extending Mesh.
Virtual method to override the blend shape arrays for a custom class extending Mesh.
Virtual method to override the surface format for a custom class extending Mesh.
Virtual method to override the surface LODs for a custom class extending Mesh.
Virtual method to override the surface material for a custom class extending Mesh.
Virtual method to override the surface primitive type for a custom class extending Mesh.
Virtual method to override the setting of a material at the given index for a custom class extending Mesh.
Calculate a ConvexPolygonShape3D from the mesh.
If clean is true (default), duplicate and interior vertices are removed automatically. You can set it to false to make the process faster if not needed.
If simplify is true, the geometry can be further simplified to reduce the number of vertices. Disabled by default.
Calculate an outline mesh at a defined offset (margin) from the original mesh.
Note: This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise).
Creates a placeholder version of this resource (PlaceholderMesh).
Calculate a ConcavePolygonShape3D from the mesh.
Generate a TriangleMesh from the mesh. Considers only surfaces using one of these primitive types: PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP.
Returns the smallest AABB enclosing this mesh in local space. Not affected by custom_aabb.
Note: This is only implemented for ArrayMesh and PrimitiveMesh.
Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle.
Returns the number of surfaces that the Mesh holds. This is equivalent to MeshInstance3D.get_surface_override_material_count().
Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface (see ArrayMesh.add_surface_from_arrays()).
Returns a Material in a given surface. Surface is rendered using this material.
Note: This returns the material within the Mesh resource, not the Material associated to the MeshInstance3D's Surface Material Override properties. To get the Material associated to the MeshInstance3D's Surface Material Override properties, use MeshInstance3D.get_surface_override_material() instead.
Sets a Material for a given surface. Surface will be rendered using this material.
Note: This assigns the material within the Mesh resource, not the Material associated to the MeshInstance3D's Surface Material Override properties. To set the Material associated to the MeshInstance3D's Surface Material Override properties, use MeshInstance3D.set_surface_override_material() instead.
PRIMITIVE_POINTS = 0Render array as points (one vertex equals one point).
PRIMITIVE_LINES = 1Render array as lines (every two vertices a line is created).
PRIMITIVE_LINE_STRIP = 2Render array as line strip.
PRIMITIVE_TRIANGLES = 3Render array as triangles (every three vertices a triangle is created).
PRIMITIVE_TRIANGLE_STRIP = 4Render array as triangle strips.
ARRAY_VERTEX = 0PackedVector3Array, PackedVector2Array, or Array of vertex positions.
ARRAY_NORMAL = 1PackedVector3Array of vertex normals.
Note: The array has to consist of normal vectors, otherwise they will be normalized by the engine, potentially causing visual discrepancies.
ARRAY_TANGENT = 2PackedFloat32Array of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
ARRAY_COLOR = 3PackedColorArray of vertex colors.
ARRAY_TEX_UV = 4PackedVector2Array for UV coordinates.
ARRAY_TEX_UV2 = 5PackedVector2Array for second UV coordinates.
ARRAY_CUSTOM0 = 6Contains custom color channel 0. PackedByteArray if (format >> Mesh.ARRAY_FORMAT_CUSTOM0_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK is ARRAY_CUSTOM_RGBA8_UNORM, ARRAY_CUSTOM_RGBA8_SNORM, ARRAY_CUSTOM_RG_HALF, or ARRAY_CUSTOM_RGBA_HALF. PackedFloat32Array otherwise.
ARRAY_CUSTOM1 = 7Contains custom color channel 1. PackedByteArray if (format >> Mesh.ARRAY_FORMAT_CUSTOM1_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK is ARRAY_CUSTOM_RGBA8_UNORM, ARRAY_CUSTOM_RGBA8_SNORM, ARRAY_CUSTOM_RG_HALF, or ARRAY_CUSTOM_RGBA_HALF. PackedFloat32Array otherwise.
ARRAY_CUSTOM2 = 8Contains custom color channel 2. PackedByteArray if (format >> Mesh.ARRAY_FORMAT_CUSTOM2_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK is ARRAY_CUSTOM_RGBA8_UNORM, ARRAY_CUSTOM_RGBA8_SNORM, ARRAY_CUSTOM_RG_HALF, or ARRAY_CUSTOM_RGBA_HALF. PackedFloat32Array otherwise.
ARRAY_CUSTOM3 = 9Contains custom color channel 3. PackedByteArray if (format >> Mesh.ARRAY_FORMAT_CUSTOM3_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK is ARRAY_CUSTOM_RGBA8_UNORM, ARRAY_CUSTOM_RGBA8_SNORM, ARRAY_CUSTOM_RG_HALF, or ARRAY_CUSTOM_RGBA_HALF. PackedFloat32Array otherwise.
ARRAY_BONES = 10PackedFloat32Array or PackedInt32Array of bone indices. Contains either 4 or 8 numbers per vertex depending on the presence of the ARRAY_FLAG_USE_8_BONE_WEIGHTS flag.
ARRAY_WEIGHTS = 11PackedFloat32Array or PackedFloat64Array of bone weights in the range 0.0 to 1.0 (inclusive). Contains either 4 or 8 numbers per vertex depending on the presence of the ARRAY_FLAG_USE_8_BONE_WEIGHTS flag.
ARRAY_INDEX = 12PackedInt32Array of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the i'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.
ARRAY_MAX = 13Represents the size of the ArrayType enum.
ARRAY_CUSTOM_RGBA8_UNORM = 0Indicates this custom channel contains unsigned normalized byte colors from 0 to 1, encoded as PackedByteArray.
ARRAY_CUSTOM_RGBA8_SNORM = 1Indicates this custom channel contains signed normalized byte colors from -1 to 1, encoded as PackedByteArray.
ARRAY_CUSTOM_RG_HALF = 2Indicates this custom channel contains half precision float colors, encoded as PackedByteArray. Only red and green channels are used.
ARRAY_CUSTOM_RGBA_HALF = 3Indicates this custom channel contains half precision float colors, encoded as PackedByteArray.
ARRAY_CUSTOM_R_FLOAT = 4Indicates this custom channel contains full float colors, in a PackedFloat32Array. Only the red channel is used.
ARRAY_CUSTOM_RG_FLOAT = 5Indicates this custom channel contains full float colors, in a PackedFloat32Array. Only red and green channels are used.
ARRAY_CUSTOM_RGB_FLOAT = 6Indicates this custom channel contains full float colors, in a PackedFloat32Array. Only red, green and blue channels are used.
ARRAY_CUSTOM_RGBA_FLOAT = 7Indicates this custom channel contains full float colors, in a PackedFloat32Array.
ARRAY_CUSTOM_MAX = 8Represents the size of the ArrayCustomFormat enum.
ARRAY_FORMAT_VERTEX = 1Mesh array contains vertices. All meshes require a vertex array so this should always be present.
ARRAY_FORMAT_NORMAL = 2Mesh array contains normals.
ARRAY_FORMAT_TANGENT = 4Mesh array contains tangents.
ARRAY_FORMAT_COLOR = 8Mesh array contains colors.
ARRAY_FORMAT_TEX_UV = 16Mesh array contains UVs.
ARRAY_FORMAT_TEX_UV2 = 32Mesh array contains second UV.
ARRAY_FORMAT_CUSTOM0 = 64Mesh array contains custom channel index 0.
ARRAY_FORMAT_CUSTOM1 = 128Mesh array contains custom channel index 1.
ARRAY_FORMAT_CUSTOM2 = 256Mesh array contains custom channel index 2.
ARRAY_FORMAT_CUSTOM3 = 512Mesh array contains custom channel index 3.
ARRAY_FORMAT_BONES = 1024Mesh array contains bones.
ARRAY_FORMAT_WEIGHTS = 2048Mesh array contains bone weights.
ARRAY_FORMAT_INDEX = 4096Mesh array uses indices.
ARRAY_FORMAT_BLEND_SHAPE_MASK = 7Mask of mesh channels permitted in blend shapes.
ARRAY_FORMAT_CUSTOM_BASE = 13Shift of first custom channel.
ARRAY_FORMAT_CUSTOM_BITS = 3Number of format bits per custom channel. See ArrayCustomFormat.
ARRAY_FORMAT_CUSTOM0_SHIFT = 13Amount to shift ArrayCustomFormat for custom channel index 0.
ARRAY_FORMAT_CUSTOM1_SHIFT = 16Amount to shift ArrayCustomFormat for custom channel index 1.
ARRAY_FORMAT_CUSTOM2_SHIFT = 19Amount to shift ArrayCustomFormat for custom channel index 2.
ARRAY_FORMAT_CUSTOM3_SHIFT = 22Amount to shift ArrayCustomFormat for custom channel index 3.
ARRAY_FORMAT_CUSTOM_MASK = 7Mask of custom format bits per custom channel. Must be shifted by one of the SHIFT constants. See ArrayCustomFormat.
ARRAY_COMPRESS_FLAGS_BASE = 25Shift of first compress flag. Compress flags should be passed to ArrayMesh.add_surface_from_arrays() and SurfaceTool.commit().
ARRAY_FLAG_USE_2D_VERTICES = 33554432Flag used to mark that the array contains 2D vertices.
ARRAY_FLAG_USE_DYNAMIC_UPDATE = 67108864Flag used to mark that the mesh data will use GL_DYNAMIC_DRAW on GLES. Unused on Vulkan.
ARRAY_FLAG_USE_8_BONE_WEIGHTS = 134217728Flag used to mark that the mesh contains up to 8 bone influences per vertex. This flag indicates that ARRAY_BONES and ARRAY_WEIGHTS elements will have double length.
ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 268435456Flag used to mark that the mesh intentionally contains no vertex array.
ARRAY_FLAG_COMPRESS_ATTRIBUTES = 536870912Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can.