Class TxSprite

constructor

• new TxSprite(options: TxSpriteOptions): TxSprite

  Creates an instance of TxSprite.

  Parameters

  • options: TxSpriteOptions

    Configuration options for the sprite.

  Returns TxSprite

compress

height

numColors

paletteData

pixelData

width

bpp

• get bpp(): number

  The number of bits per pixel, derived from the number of colors.

  Returns number

pack

• pack(): Uint8Array

  Packs the sprite data into a compact binary format. The format includes a header, palette data, and packed pixel data. Pixel data can be optionally compressed using LZ4.

  Returns Uint8Array

  A Uint8Array containing the packed sprite data.

toPngBytes

• toPngBytes(): ArrayBuffer

  Converts the TxSprite to a PNG image as an ArrayBuffer. Intended for debugging and visualization purposes.

  Returns ArrayBuffer

  The PNG image data as an ArrayBuffer.

StaticfromImageBytes

• fromImageBytes(
      imageBytes: ArrayBuffer,
      maxPixels?: number,
      compress?: boolean,
  ): Promise<TxSprite>

  Creates a TxSprite from an image file, resizing and quantizing it to a maximum of 16 colors.

  Parameters

  • imageBytes: ArrayBuffer

    The ArrayBuffer containing the image data.
  • maxPixels: number = 48000

    The maximum number of pixels allowed in the sprite.
  • compress: boolean = false

    Whether to compress the pixel data using LZ4.

  Returns Promise<TxSprite>

  A TxSprite instance.

StaticfromIndexedPngBytes

• fromIndexedPngBytes(
      imageBytes: ArrayBuffer,
      compress?: boolean,
  ): Promise<TxSprite>

  Creates a TxSprite from an indexed PNG image.

  Parameters

  • imageBytes: ArrayBuffer

    The ArrayBuffer containing the PNG image data.
  • compress: boolean = false

    Whether to compress the pixel data using LZ4.

  Returns Promise<TxSprite>

  A TxSprite instance.