API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classSpritesheet

@codexo/exojs / rendering / stable

Slices a single Texture into named frames and optional named animation sequences. Each frame is stored as both a Rectangle (the pixel region) and a pre-configured Sprite ready for direct rendering. Animations are ordered lists of frame names that AnimatedSprite.fromSpritesheet consumes to create playback clips.

4
props
9
methods
0
events
Import
import { Spritesheet } from '@codexo/exojs'

Slices a single Texture into named frames and optional named animation sequences.

Each frame is stored as both a Rectangle (the pixel region) and a pre-configured Sprite ready for direct rendering. Animations are ordered lists of frame names that AnimatedSprite.fromSpritesheet consumes to create playback clips.

Constructors1
new(texture: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (…, data: SpritesheetDataJSON-compatible descriptor that drives Spritesheet.parse. Matches the Aseprite / TexturePacker output format (subset).): Spritesheet
Methods9
addFrame(name: string, data: SpritesheetFrameA single frame entry in a SpritesheetData descriptor.): this
Register a single frame by name, creating its Rectangle and pre-configured Sprite.
clear(): this
Destroy all registered frames, sprites, and animations, resetting the spritesheet to an empty state.
defineAnimation(name: string, frameNames: readonly string[]): this
Register an animation sequence as an ordered list of frame names. All referenced frames must already exist.
destroy(): void
getAnimationFrameNames(name: string): readonly string[]
Return the ordered frame-name list for the named animation. Throws if the animation does not exist.
getFrame(name: string): RectangleMutable axis-aligned rectangle defined by a top-left origin `(x, y)` and dimensions `(width, height)`. Implements Collidable with full SAT collision response f…
Return the Rectangle for the named frame. Throws if the frame does not exist.
getFrameSprite(name: string): SpriteThe primary 2D drawable for textured quads and the foundation of the rendering hierarchy. A Sprite wraps a Texture (or RenderTexture) and exposes full transfor…
Return the pre-configured Sprite for the named frame. Throws if the frame does not exist.
parse(data: SpritesheetDataJSON-compatible descriptor that drives Spritesheet.parse. Matches the Aseprite / TexturePacker output format (subset)., keepFrames: boolean): void
Parse a SpritesheetData descriptor, populating frames, sprites, and animations. When keepFrames is false (default), all existing frames and sprites are destroyed before parsing.
removeFrame(name: string): this
Destroy and remove a single frame's Rectangle and Sprite by name. No-op if the frame does not exist.
Properties4
animations: Map<string, readonly string[]>
frames: Map<string, RectangleMutable axis-aligned rectangle defined by a top-left origin `(x, y)` and dimensions `(width, height)`. Implements Collidable with full SAT collision response f…>
sprites: Map<string, SpriteThe primary 2D drawable for textured quads and the foundation of the rendering hierarchy. A Sprite wraps a Texture (or RenderTexture) and exposes full transfor…>
texture: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (…
Source
src/rendering/sprite/Spritesheet.ts