Version: 2020.3
LanguageEnglish
  • C#

MeshUpdateFlags

enumeration

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

Description

Mesh data update flags.

Some advanced Mesh functions like SetVertexBufferData, SetIndexBufferData, SetSubMesh take an optional flags parameter that controls behavior of these functions. In particular, these flags allow you to control what happens when a Mesh's data is updated.

By default, Unity performs checks and validation on the data you supply when using these methods - for example, to check whether the indices array has any out-of-bounds values.

These flags allow you to optionally omit some or all of these checks for the purpose of increasing performance. If you choose to omit these checks, you must ensure that the data you are supplying is valid.

You can combine individual flags using the logical OR operator. For example: MeshUpdateFlags.DontNotifyMeshUsers | MeshUpdateFlags.DontValidateIndices.

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

Properties

DefaultIndicates that Unity should perform the default checks and validation when you update a Mesh's data.
DontValidateIndicesIndicates that Unity should not check index values when you use Mesh.SetIndexBufferData to modify a Mesh's data.
DontResetBoneBoundsIndicates that Unity should not reset skinned mesh bone bounds when you modify Mesh data using Mesh.SetVertexBufferData or Mesh.SetIndexBufferData.
DontNotifyMeshUsersIndicates that Unity should not notify Renderer components about a possible Mesh bounds change, when you modify Mesh data.
DontRecalculateBoundsIndicates that Unity should not recalculate the bounds when you set Mesh data using Mesh.SetSubMesh.