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.


class in UnityEngine


Inherits from:Object


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.




Represents a Sprite object for use in 2D gameplay.

Sprites are 2D graphic objects used for characters, props, projectiles and other elments of 2D gameplay. The graphics are obtained from bitmap images - Texture2D. The Sprite class primarily identifies the section of the image that should be used for a specific sprite. This information can then be used by a SpriteRenderer component on a GameObject to actually display the graphic.

See Also: SpriteRenderer class.


associatedAlphaSplitTextureReturns the texture that contains the alpha channel from the source texture. Unity generates this texture under the hood for sprites that have alpha in the source, and need to be compressed using techniques like ETC1.Returns NULL if there is no associated alpha texture for the source sprite. This is the case if the sprite has not been setup to use ETC1 compression.
borderReturns the border sizes of the sprite.
bounds Bounds of the Sprite, specified by its center and extents in world space units.
packedReturns true if this Sprite is packed in an atlas.
packingModeIf Sprite is packed (see Sprite.packed), returns its SpritePackingMode.
packingRotationIf Sprite is packed (see Sprite.packed), returns its SpritePackingRotation.
pivotLocation of the Sprite's center point in the Rect on the original Texture, specified in pixels.
pixelsPerUnitThe number of pixels in the sprite that correspond to one unit in world space. (Read Only)
rectLocation of the Sprite on the original Texture, specified in pixels.
textureGet the reference to the used texture. If packed this will point to the atlas, if not packed will point to the source sprite.
textureRectGet the rectangle this sprite uses on its texture. Raises an exception if this sprite is tightly packed in an atlas.
textureRectOffsetGets the offset of the rectangle this sprite uses on its texture to the original sprite bounds. If sprite mesh type is FullRect, offset is zero.
trianglesReturns a copy of the array containing sprite mesh triangles.
uvThe base texture coordinates of the sprite mesh.
verticesReturns a copy of the array containing sprite mesh vertex positions.

Public Methods

GetPhysicsShapeGets a physics shape from the Sprite by its index.
GetPhysicsShapeCountThe number of physics shapes for the Sprite.
GetPhysicsShapePointCountThe number of points in the selected physics shape for the Sprite.
OverrideGeometrySets up new Sprite geometry.
OverridePhysicsShapeSets up a new Sprite physics shape.

Static Methods

CreateCreate a new Sprite object.

Inherited Members


hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.


boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

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