aseprite-io - v0.1.0
    Preparing search index...

    Class AsepriteFile

    An Aseprite .ase/.aseprite file.

    const file = AsepriteFile.read(bytes);
    console.log(file.width, file.height, file.frames.length);
    const file = new AsepriteFile(16, 16, 'rgba');
    const layer = file.addLayer('Background');
    const frame = file.addFrame(100);
    file.setCel(layer, frame, createPixels(new Uint8Array(16 * 16 * 4), 16, 16, 'rgba'));
    const bytes = file.write();
    Index
    • get flags(): number

      Raw header flags (bit 1: layer opacity is valid; bit 2: group opacity/blend valid; bit 4: layers have a UUID).

      Returns number

    • get height(): number

      Canvas height in pixels.

      Returns number

    • get layers(): readonly Layer[]

      All layers, in document order (bottom to top).

      Returns readonly Layer[]

    • get palette(): readonly Color[]

      Color palette (empty if the file had no palette chunk).

      Returns readonly Color[]

    • get pixelRatio(): Readonly<{ height: number; width: number }>

      Pixel aspect ratio.

      Returns Readonly<{ height: number; width: number }>

    • get transparentIndex(): number

      Transparent palette index (only meaningful in indexed color mode).

      Returns number

    • get width(): number

      Canvas width in pixels.

      Returns number

    • Adds a frame with the given duration in milliseconds. Returns the frame index.

      Parameters

      • durationMs: number = 100

      Returns number

    • Adds a slice. Returns its index.

      Parameters

      Returns number

    • Adds an animation tag over the inclusive frame range [from, to]. Returns the tag index.

      Parameters

      • name: string
      • from: number
      • to: number
      • direction: "forward" | "reverse" | "ping-pong" | "ping-pong-reverse" = 'forward'
      • repeat: number = 0

      Returns number

    • Adds a tileset definition. Returns its index.

      Parameters

      Returns number

    • Returns the raw cel at a layer/frame, or undefined. May be a 'linked' cel; see resolveCel.

      Parameters

      Returns Cel | undefined

    • Iterates over all cels, ordered by layer index and then frame index.

      Returns IterableIterator<CelEntry>

    • Returns a GroupRef for a layer index, or undefined if out of bounds or not a group.

      Parameters

      • index: number

      Returns GroupRef | undefined

    • Returns a LayerRef for a layer index, or undefined if out of bounds or a group.

      Parameters

      • index: number

      Returns LayerRef | undefined

    • Removes the cel at a layer/frame. Returns whether a cel was removed.

      Parameters

      Returns boolean

    • Returns the cel at a layer/frame, following linked cels. Never returns a 'linked' cel; returns undefined if the cel or its link target is missing.

      Parameters

      Returns Cel | undefined

    • Makes the cel at frame a link to the cel at sourceFrame on the same layer.

      Parameters

      Returns void

    • Sets the color palette (at most 256 entries).

      Parameters

      • colors: readonly Color[]

      Returns void

    • Sets the pixel aspect ratio.

      Parameters

      • width: number
      • height: number

      Returns void

    • Sets user data on a tag.

      Parameters

      Returns void

    • Sets tilemap content for a tilemap layer/frame. tiles holds width * height 32-bit tile entries (tile ID in the low 29 bits, then X/Y/diagonal flip bits).

      Parameters

      • layer: LayerRef
      • frame: number
      • tiles: ArrayLike<number> | Uint32Array<ArrayBufferLike>
      • width: number
      • height: number
      • opts: TilemapCelOptions = {}

      Returns void

    • Sets the transparent palette index.

      Parameters

      • index: number

      Returns void