Class: SpriteFrame

Typed wrapper for a loaded texture. texture is unknown to stay backend-agnostic — cast to your backend's type when you need its API (e.g. as Pixi.Texture). getSize() returns the cropped frame size for atlas frames, not the source image.

Extends

• AssetHandle

Constructors

Constructor

new SpriteFrame(assetId, loader?): SpriteFrame;

Parameters

Parameter	Type
assetId	string
loader?	IAssetLoader

Returns

SpriteFrame

Inherited from

AssetHandle.constructor

Properties

Property	Modifier	Type	Inherited from
assetId	readonly	string	AssetHandle.assetId

Accessors

texture

Get Signature

get texture(): unknown;

Returns

unknown

Methods

GetDefaultAssetLoader()

static GetDefaultAssetLoader(): IAssetLoader | null;

Returns

IAssetLoader | null

Inherited from

AssetHandle.GetDefaultAssetLoader

---

getSize()

getSize(): 
  | {
  height: number;
  width: number;
}
  | null;

Returns

| { height: number; width: number; } | null

---

isLoaded()

isLoaded(): boolean;

Returns

boolean

Inherited from

AssetHandle.isLoaded

---

SetDefaultAssetLoader()

static SetDefaultAssetLoader(loader): void;

Parameters

Parameter	Type
loader	IAssetLoader | null

Returns

void

Inherited from

AssetHandle.SetDefaultAssetLoader