Class Sprite

Inheritance

Object

Object

Sprite

Inherited Members

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.name

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.hideFlags

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine

Assembly: UnityEngine.dll

Syntax

public sealed class Sprite : Object

Properties

associatedAlphaSplitTexture

Declaration

public Texture2D associatedAlphaSplitTexture { get; }

Property Value

Type	Description
Texture2D

border

Declaration

public Vector4 border { get; }

Property Value

Type	Description
Vector4

bounds

Declaration

public Bounds bounds { get; }

Property Value

Type	Description
Bounds

packed

Declaration

public bool packed { get; }

Property Value

Type	Description
Boolean

packingMode

Declaration

public SpritePackingMode packingMode { get; }

Property Value

Type	Description
SpritePackingMode

packingRotation

Declaration

public SpritePackingRotation packingRotation { get; }

Property Value

Type	Description
SpritePackingRotation

pivot

Declaration

public Vector2 pivot { get; }

Property Value

Type	Description
Vector2

pixelsPerUnit

Declaration

public float pixelsPerUnit { get; }

Property Value

Type	Description
Single

rect

Declaration

public Rect rect { get; }

Property Value

Type	Description
Rect

texture

Declaration

public Texture2D texture { get; }

Property Value

Type	Description
Texture2D

textureRect

Declaration

public Rect textureRect { get; }

Property Value

Type	Description
Rect

textureRectOffset

Declaration

public Vector2 textureRectOffset { get; }

Property Value

Type	Description
Vector2

triangles

Declaration

public ushort[] triangles { get; }

Property Value

Type	Description
UInt16[]

uv

Declaration

public Vector2[] uv { get; }

Property Value

Type	Description
Vector2[]

vertices

Declaration

public Vector2[] vertices { get; }

Property Value

Type	Description
Vector2[]

Methods

Create(Texture2D, Rect, Vector2)

Declaration

public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot)

Parameters

Type	Name	Description
Texture2D	texture
Rect	rect
Vector2	pivot

Returns

Type	Description
Sprite

Create(Texture2D, Rect, Vector2, Single)

Declaration

public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit)

Parameters

Type	Name	Description
Texture2D	texture
Rect	rect
Vector2	pivot
Single	pixelsPerUnit

Returns

Type	Description
Sprite

Create(Texture2D, Rect, Vector2, Single, UInt32)

Declaration

public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude)

Parameters

Type	Name	Description
Texture2D	texture
Rect	rect
Vector2	pivot
Single	pixelsPerUnit
UInt32	extrude

Returns

Type	Description
Sprite

Create(Texture2D, Rect, Vector2, Single, UInt32, SpriteMeshType)

Declaration

public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude, SpriteMeshType meshType)

Parameters

Type	Name	Description
Texture2D	texture
Rect	rect
Vector2	pivot
Single	pixelsPerUnit
UInt32	extrude
SpriteMeshType	meshType

Returns

Type	Description
Sprite

Create(Texture2D, Rect, Vector2, Single, UInt32, SpriteMeshType, Vector4)

Declaration

public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude, SpriteMeshType meshType, Vector4 border)

Parameters

Type	Name	Description
Texture2D	texture
Rect	rect
Vector2	pivot
Single	pixelsPerUnit
UInt32	extrude
SpriteMeshType	meshType
Vector4	border

Returns

Type	Description
Sprite

Create(Texture2D, Rect, Vector2, Single, UInt32, SpriteMeshType, Vector4, Boolean)

Declaration

public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude, SpriteMeshType meshType, Vector4 border, bool generateFallbackPhysicsShape)

Parameters

Type	Name	Description
Texture2D	texture
Rect	rect
Vector2	pivot
Single	pixelsPerUnit
UInt32	extrude
SpriteMeshType	meshType
Vector4	border
Boolean	generateFallbackPhysicsShape

Returns

Type	Description
Sprite

GetPhysicsShape(Int32, List<Vector2>)

Declaration

public int GetPhysicsShape(int shapeIdx, List<Vector2> physicsShape)

Parameters

Type	Name	Description
Int32	shapeIdx
List<Vector2>	physicsShape

Returns

Type	Description
Int32

GetPhysicsShapeCount()

Declaration

public int GetPhysicsShapeCount()

Returns

Type	Description
Int32

GetPhysicsShapePointCount(Int32)

Declaration

public int GetPhysicsShapePointCount(int shapeIdx)

Parameters

Type	Name	Description
Int32	shapeIdx

Returns

Type	Description
Int32

OverrideGeometry(Vector2[], UInt16[])

Declaration

public void OverrideGeometry(Vector2[] vertices, ushort[] triangles)

Parameters

Type	Name	Description
Vector2[]	vertices
UInt16[]	triangles

OverridePhysicsShape(IList<Vector2[]>)

Declaration

public void OverridePhysicsShape(IList<Vector2[]> physicsShapes)

Parameters

Type	Name	Description
IList<Vector2[]>	physicsShapes

Extension Methods

SpriteDataAccessExtensions.GetVertexAttribute<T>(Sprite, VertexAttribute)

SpriteDataAccessExtensions.SetVertexAttribute<T>(Sprite, VertexAttribute, NativeArray<T>)

SpriteDataAccessExtensions.GetBindPoses(Sprite)

SpriteDataAccessExtensions.SetBindPoses(Sprite, NativeArray<Matrix4x4>)

SpriteDataAccessExtensions.GetIndices(Sprite)

SpriteDataAccessExtensions.SetIndices(Sprite, NativeArray<UInt16>)

SpriteDataAccessExtensions.GetBoneWeights(Sprite)

SpriteDataAccessExtensions.SetBoneWeights(Sprite, NativeArray<BoneWeight>)

SpriteDataAccessExtensions.GetBones(Sprite)

SpriteDataAccessExtensions.SetBones(Sprite, SpriteBone[])

SpriteDataAccessExtensions.HasVertexAttribute(Sprite, VertexAttribute)

SpriteDataAccessExtensions.SetVertexCount(Sprite, Int32)

SpriteDataAccessExtensions.GetVertexCount(Sprite)

MustExtensions.MustBeEqual<T>(T, T)

MustExtensions.MustBeEqual<T>(T, T, String)

MustExtensions.MustNotBeEqual<T>(T, T)

MustExtensions.MustNotBeEqual<T>(T, T, String)

MustExtensions.MustBeNull<T>(T)

MustExtensions.MustBeNull<T>(T, String)

MustExtensions.MustNotBeNull<T>(T)

MustExtensions.MustNotBeNull<T>(T, String)

SpriteEditorExtension.GetSpriteID(Sprite)

SpriteEditorExtension.SetSpriteID(Sprite, GUID)