Version: 2023.2
LanguageEnglish
  • C#

Mesh.SetSubMeshes

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Declaration

public void SetSubMeshes(SubMeshDescriptor[] desc, int start, int count, Rendering.MeshUpdateFlags flags);

Declaration

public void SetSubMeshes(SubMeshDescriptor[] desc, Rendering.MeshUpdateFlags flags);

Declaration

public void SetSubMeshes(List<SubMeshDescriptor> desc, int start, int count, Rendering.MeshUpdateFlags flags);

Declaration

public void SetSubMeshes(List<SubMeshDescriptor> desc, Rendering.MeshUpdateFlags flags);

Declaration

public void SetSubMeshes(NativeArray<T> desc, int start, int count, Rendering.MeshUpdateFlags flags);

Declaration

public void SetSubMeshes(NativeArray<T> desc, Rendering.MeshUpdateFlags flags);

Parameters

desc An array or list of sub-mesh data descriptors.
start Index of the first element to take from the array or list in desc.
count Number of elements to take from the array or list in desc.
flags (Optional) Flags controlling the function behavior, see MeshUpdateFlags.

Description

Sets information defining all sub-meshes in this Mesh, replacing any existing sub-meshes.

Note that SetSubMeshes, SetSubMesh, SubMeshDescriptor, and SetIndexBufferData are designed for maximum performance. These functions operate on the underlying mesh data structures involving raw index buffers, vertex buffers and mesh subset data. When you use these methods, Unity performs very little data validation, so you must ensure your data is valid.

In particular, you must ensure that the SubMeshDescriptor index ranges and SubMeshDescriptor.topology values are set to correct values. SubMesh indices, both indexStart and indexCount, must not overlap with any other SubMesh indices.

For information about the difference between the simpler and more advanced methods of assigning data to a Mesh from script, see Mesh.

The SubMeshDescriptor-bounds, SubMeshDescriptor-firstVertex and SubMeshDescriptor-vertexCount values of SubMeshDescriptor are calculated automatically by SetSubMeshes, unless MeshUpdateFlags.DontRecalculateBounds flag is passed. Note that this only applies to the bounds of the SubMesh. You must call Mesh.RecalculateBounds to recalculate the bounds of the Mesh itself.

General usage pattern is:

var mesh = new Mesh();

// setup vertex buffer data mesh.vertices = ...;

// set index buffer mesh.SetIndexBufferParams(...); mesh.SetIndexBufferData(...);

// setup information about mesh subsets SubMeshDescriptor[] sm = new SubMeshDescriptor[] {...} mesh.SetSubMeshes(sm);

// update bounds of the mesh mesh.RecalculateBounds();

For details on what data to set up for each sub-mesh, see SubMeshDescriptor.

Additional resources: subMeshCount, GetSubMesh, SetSubMesh, SetIndexBufferParams, SetIndexBufferData, MeshUpdateFlags.