@orillusion/core

---

Class: Sprite

Defined in: src/assets/Sprite.ts:35

Sprite — 2D image asset. Describes what to render: a region of a texture and a default anchor pivot.

A Sprite is data, not a component. One Sprite can be shared by many SpriteRenderer components — renderers subscribe to change notifications via onChange so updating the shared sprite propagates to every instance that binds it. Pair with TextureAtlas.get(name) to get sprites directly from a packed atlas.

Per-instance tweaks (size, pivot override, color, flips) live on the SpriteRenderer component; the Sprite asset only describes the underlying image data.

Constructors

Constructor

new Sprite(opts?): Sprite

Defined in: src/assets/Sprite.ts:47

Parameters

opts?

texture?

Texture

region?

Vector4

pivot?

Vector2

name?

string

Returns

Sprite

Properties

name

name: string = ''

Defined in: src/assets/Sprite.ts:37

Optional name, typically the atlas region id this sprite came from.

Accessors

texture

Get Signature

get texture(): Texture

Defined in: src/assets/Sprite.ts:62

Source texture for this sprite.

Returns

Texture

Set Signature

set texture(value): void

Defined in: src/assets/Sprite.ts:64

Set the source texture, notifying listeners on change.

Parameters

value

Texture

Returns

void

---

region

Get Signature

get region(): Vector4

Defined in: src/assets/Sprite.ts:72

Normalized sub-rect of the texture in UV space — (offsetX, offsetY, scaleX, scaleY).

Returns

Vector4

Set Signature

set region(v): void

Defined in: src/assets/Sprite.ts:74

Set the UV region (copied), notifying listeners.

Parameters

v

Vector4

Returns

void

---

pivot

Get Signature

get pivot(): Vector2

Defined in: src/assets/Sprite.ts:80

Default anchor point in [0,1]² — (0.5, 0.5) = centered.

Returns

Vector2

Set Signature

set pivot(v): void

Defined in: src/assets/Sprite.ts:82

Set the pivot (copied), notifying listeners.

Parameters

v

Vector2

Returns

void

Methods

onChange()

onChange(fn): void

Defined in: src/assets/Sprite.ts:88

Subscribe to sprite field changes. Renderers use this to invalidate their cached UV data.

Parameters

fn

SpriteChangeListener

Returns

void

---

offChange()

offChange(fn): void

Defined in: src/assets/Sprite.ts:93

Unsubscribe a previously registered change listener.

Parameters

fn

SpriteChangeListener

Returns

void

---

clone()

clone(): Sprite

Defined in: src/assets/Sprite.ts:104

Shallow clone — texture is shared (not duplicated), all vector fields are copied.

Returns

Sprite

---

fromTexture()

static fromTexture(texture, name?): Sprite

Defined in: src/assets/Sprite.ts:114

Convenience: build a Sprite from a bare texture, full region, centered pivot.

Parameters

texture

Texture

name?

string

Returns

Sprite