Unity - Scripting API: Sprite (2024)

class in UnityEngine

Inherits from:Object

Implemented in:UnityEngine.CoreModule

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.

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.

Your name Your email Suggestion*

Cancel

Description

Represents a Sprite object for use in 2D gameplay.

Sprites are 2D graphic objects used for characters, props, projectiles and other elements 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.

Additional resources: SpriteRenderer class.

Properties

associatedAlphaSplitTexture	Returns 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.
border	Returns the border sizes of the Sprite.
bounds	Bounds of the Sprite, specified by its center and extents in world space units.
packed	Returns true if this Sprite is packed in an atlas.
packingMode	If Sprite is packed (see Sprite.packed), returns its SpritePackingMode.
packingRotation	If Sprite is packed (see Sprite.packed), returns its SpritePackingRotation.
pivot	Location of the Sprite's pivot point in the Rect on the original Texture, specified in pixels.
pixelsPerUnit	The number of pixels in the Sprite that correspond to one unit in world space. (Read Only)
rect	Location of the Sprite on the original Texture, specified in pixels.
spriteAtlasTextureScale	The Variant scale of Texture used by the Sprite. This is useful to check when a Variant SpriteAtlas is being used by Sprites.
texture	Get the reference to the used Texture. If packed this will point to the atlas, if not packed will point to the source Sprite.
textureRect	Get the rectangle this Sprite uses on its Texture. Raises an exception if this Sprite is tightly packed in an atlas.
textureRectOffset	Gets 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.
triangles	Returns a copy of the array containing Sprite mesh triangles.
uv	The base Texture coordinates of the Sprite mesh.
vertices	Returns a copy of the array containing Sprite mesh vertex positions.

Public Methods

GetPhysicsShape	Gets a physics shape from the Sprite by its index.
GetPhysicsShapeCount	The number of physics shapes for the Sprite.
GetPhysicsShapePointCount	The number of points in the selected physics shape for the Sprite.
GetSecondaryTextureCount	Gets the number of Secondary Textures that the Sprite is using.
GetSecondaryTextures	Retrieves an array of SecondarySpriteTexture used by the Sprite.
OverrideGeometry	Sets up new Sprite geometry.
OverridePhysicsShape	Sets up a new Sprite physics shape.

Static Methods

Create

Create a new Sprite object.

Inherited Members

Properties

hideFlags	Should the object be hidden, saved with the Scene or modifiable by the user?
name	The name of the object.

Public Methods

GetInstanceID	Gets the instance ID of the object.
ToString	Returns the name of the object.

Static Methods

Destroy	Removes a GameObject, component or asset.
DestroyImmediate	Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad	Do not destroy the target Object when loading a new Scene.
FindAnyObjectByType	Retrieves any active loaded object of Type type.
FindFirstObjectByType	Retrieves the first active loaded object of Type type.
FindObjectOfType	Returns the first active loaded object of Type type.
FindObjectsByType	Retrieves a list of all loaded objects of Type type.
FindObjectsOfType	Gets a list of all loaded objects of Type type.
Instantiate	Clones the object original and returns the clone.
InstantiateAsync	Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

Operators

bool	Does 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.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information

Your Privacy Choices (Cookie Settings)