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

    Type Alias CelKind

    CelKind:
        | { pixels: Pixels; type: "raw"; x: number; y: number }
        | {
            originalCompressed?: Uint8Array;
            pixels: Pixels;
            type: "compressed";
            x: number;
            y: number;
        }
        | { sourceFrame: number; type: "linked"; x: number; y: number }
        | {
            bitsPerTile: number;
            dFlipBitmask: number;
            height: number;
            originalCompressed?: Uint8Array;
            tileIdBitmask: number;
            tiles: Uint32Array;
            type: "tilemap";
            width: number;
            x: number;
            xFlipBitmask: number;
            y: number;
            yFlipBitmask: number;
        }

    The type and data of a cel.

    Type Declaration

    • { pixels: Pixels; type: "raw"; x: number; y: number }

      Uncompressed pixel data.

    • {
          originalCompressed?: Uint8Array;
          pixels: Pixels;
          type: "compressed";
          x: number;
          y: number;
      }

      Zlib-compressed pixel data. originalCompressed keeps the bytes read from the file so that unmodified cels are written back byte-for-byte; it is ignored automatically once pixels.data no longer matches it.

    • { sourceFrame: number; type: "linked"; x: number; y: number }

      References another frame's cel on the same layer. Use AsepriteFile.resolveCel to follow the link.

    • {
          bitsPerTile: number;
          dFlipBitmask: number;
          height: number;
          originalCompressed?: Uint8Array;
          tileIdBitmask: number;
          tiles: Uint32Array;
          type: "tilemap";
          width: number;
          x: number;
          xFlipBitmask: number;
          y: number;
          yFlipBitmask: number;
      }

      Tilemap data referencing tiles by ID (plus flip flags, per the bitmasks).