Kiln API / kiln / SpriteSheetSpec

Interface: SpriteSheetSpec<C>

Type Parameters

Type Parameter	Default type
`C` extends `string`	`string`

Property	Type	Description
`texture`	`string` \| `Texture`<`unknown`, `TextureEventMap`> \| `null`	An image path in public/ (loaded through Assets), a THREE.Texture, or null for an untextured quad.
`columns?`	`number`	Grid sheets: frames are numbered left to right, top to bottom.
`rows?`	`number`	-
`atlas?`	`object`	Atlas sheets: the image size and each frame's rectangle in pixels. Frame numbers index this list.
`atlas.width`	`number`	-
`atlas.height`	`number`	-
`atlas.frames`	readonly `AtlasRect`[]	-
`clips`	`{ readonly [K in string]: SpriteClipSpec }`	-
`size?`	readonly [`number`, `number`]	World units of one frame, [width, height]. Default [1, 1].
`pivot?`	readonly [`number`, `number`]	Where the Transform sits on the quad, 0..1 from the bottom-left: [0.5, 0] puts it at the feet. Default [0.5, 0.5].
`filter?`	`"linear"` \| `"nearest"`	'nearest' keeps pixel art crisp (default); 'linear' smooths.
`color?`	`ColorRepresentation`	Tint multiplied with the texture. Default white.