Class TxImageSpriteBlock

An image split into horizontal sprite strips.

Index

Constructors

Properties

image progressiveRender spriteLineHeight spriteLines updatable

Methods

Constructors

constructor

new TxImageSpriteBlock(options: TxImageSpriteBlockOptions): TxImageSpriteBlock
Constructs an instance of TxImageSpriteBlock.
Parameters
- options: TxImageSpriteBlockOptions
  Configuration options for the image sprite block.
Returns TxImageSpriteBlock
- Defined in tx/image-sprite-block.ts:51

Properties

image

image: TxSprite

Source sprite to split.

progressiveRender

progressiveRender: boolean

Whether to render lines as they arrive.

spriteLineHeight

spriteLineHeight: number

Height of each sprite strip. If the TxSprite is compressed, the strip has a packed size limit of 4kB and this value is dynamically calculated.

spriteLines

spriteLines: TxSprite[] = []

List of sprite strips.

updatable

updatable: boolean

Whether lines can be updated after initial render.

Methods

pack

pack(): Uint8Array
Packs the image block header into a binary format.

Returns Uint8Array
Uint8Array Binary representation of the header

Throws
Error if there are no sprite lines to pack (though _splitIntoLines should always create at least one if height > 0 and spriteLineHeight > 0)
- Defined in tx/image-sprite-block.ts:147