class in UnityEngine
/
Inherits from:Object
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseRepresents 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.
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. |
AddScriptableObject | Adds a ScriptableObject reference to the sprite. |
GetPhysicsShape | Gets a physics shape from the Sprite by its index. |
GetPhysicsShapeCount | The number of physics shapes for the Sprite. |
GetPhysicsShapePointCount | Retrieves the number of points in the selected physics shape for the sprite. |
GetScriptableObjects | Retrieves an array of ScriptableObject referenced by the sprite. |
GetScriptableObjectsCount | Gets the number of ScriptableObject that the sprite references. |
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. |
RemoveScriptableObjectAt | Removes the ScriptableObject reference from the sprite. |
SetScriptableObjectAt | Replace the ScriptableObject reference from the sprite. |
Create | Create a new Sprite object. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
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. |
FindObjectsByType | Retrieves 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. |
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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.