frame-msg
    Preparing search index...

    Interface TxSpriteOptions

    Options for creating a TxSprite instance.

    interface TxSpriteOptions {
        compress?: boolean;
        height: number;
        numColors: number;
        paletteData: Uint8Array;
        pixelData: Uint8Array;
        width: number;
    }
    Index

    Properties

    compress? height numColors paletteData pixelData width

    Properties

    compress?: boolean

    Optional flag whether to compress the pixel data using LZ4. Defaults to false.

    height: number

    The height of the sprite in pixels.

    numColors: number

    The number of colors in the sprite's palette.

    paletteData: Uint8Array

    The palette data as a flat Uint8Array of RGB values.

    pixelData: Uint8Array

    The pixel data as a Uint8Array of palette indices.

    width: number

    The width of the sprite in pixels.

    Settings

    Member Visibility

    On This Page

    Properties