Legacy Documentation: Version 2018.1 (Go to current version)
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.


class in UnityEngine.Experimental.U2D


Implemented in:UnityEngine.CoreModule

Suggest a change


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.


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.




A list of methods designed for reading and writing to the rich internal data of a Sprite.

It is now possible to read and write to all the channels of the VertexAttribute, BoneWeight, BindPose and the SpriteBones of a Sprite.

Static Methods

GetBindPosesReturns an array of BindPoses.
GetBonesReturns a list of SpriteBone in this Sprite.
GetBoneWeightsReturns a list of BoneWeight that corresponds to each and every vertice in this Sprite.
GetIndicesReturns a list of indices. This is the same as Sprite.triangle.
GetVertexAttributeRetrieves a strided accessor to the internal vertex attributes.
GetVertexCountReturns the number of vertices in this Sprite.
HasVertexAttributeChecks if a specific channel exists for this Sprite.
SetBindPosesSets the bind poses for this Sprite.
SetBonesSets the SpriteBones for this Sprite.
SetBoneWeightsSets the BoneWeight for this Sprite. The length of the input array must match the number of vertices.
SetIndicesSet the indices for this Sprite. This is the same as Sprite.triangle.
SetVertexAttributeSets a specific channel of the VertexAttribute.
SetVertexCountSets the vertex count. This resizes the internal buffer. It also preserves any configurations of VertexAttributes.

Did you find this page useful? Please give it a rating: