Version: 2019.4
LanguageEnglish
  • C#

Mesh.GetBoneWeights

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 GetBoneWeights(List<BoneWeight> boneWeights);

Parameters

boneWeights A list of BoneWeight structs to populate.

Description

Gets the bone weights for the Mesh.

Use this method instead of Mesh.boneWeights if you want to avoid allocating a new array with every access.

The bone weight at each index corresponds to the vertex with the same index if this mesh has bone weights defined. Otherwise the list will be empty.

This property uses BoneWeight structs, which represent exactly 4 bone weights per vertex. Within each BoneWeight struct in the array, the bone weights are in descending order and add up to 1. If a vertex is affected by fewer than 4 bones, each of the remaining bone weights must be 0.

To work with more or fewer bone weights per vertex, use the newer Mesh.GetAllBoneWeights and Mesh.SetBoneWeights APIs, which use BoneWeight1 structs.

See Also: Mesh.boneWeights, Mesh.GetAllBoneWeights, Mesh.SetBoneWeights, Mesh.GetBonesPerVertex, ModelImporter.maxBonesPerVertex, QualitySettings.skinWeights, SkinnedMeshRenderer.quality.