frame-msg
    Preparing search index...

    Interface TxImageSpriteBlockOptions

    Options for configuring an image sprite block.

    interface TxImageSpriteBlockOptions {
        image: TxSprite;
        progressiveRender?: boolean;
        spriteLineHeight?: number;
        updatable?: boolean;
    }
    Index

    Properties

    image progressiveRender? spriteLineHeight? updatable?

    Properties

    image: TxSprite

    The source TxSprite to be split into strips.

    progressiveRender?: boolean

    Optional flag whether to render lines as they arrive. Defaults to true.

    spriteLineHeight?: number

    Optional height of each sprite strip. Defaults to 16. If the source image is compressed (image.compress is true), this value is dynamically calculated to respect a 4kB packed size limit per strip and any provided value here is ignored.

    updatable?: boolean

    Optional flag whether lines can be updated after initial render. Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties