Skip to content

Kiln API / kiln / spriteSheet

Function: spriteSheet() ​

ts
function spriteSheet<C>(spec): SpriteSheet;

Defines a sprite sheet and its clips: spriteSheet({ texture: 'sprites/hero.png', columns: 4, rows: 2, clips: { idle: { range: [0, 3], fps: 6 }, run: { range: [4, 7], fps: 12 } } }). Grid sheets number frames left to right, top to bottom; atlas sheets index atlas.frames.

Type Parameters ​

Type Parameter
C extends string

Parameters ​

ParameterType
specSpriteSheetSpec<C>

Returns ​

SpriteSheet