Class SpriteFrame

One rectangular texture-atlas frame.

Pixel coordinates use the conventional top-left image origin. UV conversion accounts for the texture's flipY policy so the same frame data works through WebGL2 and WebGPU.

Index

Constructors

Properties

duration height texture width x y

Methods

writeUVRect fromTexture

Constructors

constructor

new SpriteFrame(params: SpriteFrameParameters): SpriteFrame
Parameters
- params: SpriteFrameParameters
Returns SpriteFrame
- Defined in 2d/SpriteFrame.ts:44

Properties

`Readonly`duration

duration: number | null

`Readonly`height

height: number

`Readonly`texture

texture: Texture

`Readonly`width

width: number

`Readonly`x

x: number

`Readonly`y

y: number

Methods

writeUVRect

writeUVRect(target: Float32Array): Float32Array
Write the normalized [u, v, width, height] transform consumed by SpriteMaterial.
Parameters
- target: Float32Array
  Reusable four-component output.
Returns Float32Array
- Defined in 2d/SpriteFrame.ts:82

`Static`fromTexture

fromTexture(texture: Texture): SpriteFrame
Create a frame covering the complete texture.
Parameters
- texture: Texture
Returns SpriteFrame
- Defined in 2d/SpriteFrame.ts:74