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.
| 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 center 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. |
| 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. |
| OverrideGeometry | Sets up new Sprite geometry. |
| 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 | Returns the instance id of the object. |
| ToString | Returns the name of the game object. |
| Destroy | Removes a gameobject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Makes the object target not be destroyed automatically when loading a new scene. |
| FindObjectOfType | Returns the first active loaded object of Type type. |
| FindObjectsOfType | Returns a list of all active loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares if two objects refer to the same. |