Class TxTextSpriteBlock

A block of text rendered as sprites, for use in a browser environment.

Index

Constructors

Properties

fontFamily fontSize maxDisplayRows sprites text width

Methods

Constructors

constructor

new TxTextSpriteBlock(options: TxTextSpriteBlockOptions): TxTextSpriteBlock
Parameters
- options: TxTextSpriteBlockOptions
  Configuration options for the text sprite block.
Returns TxTextSpriteBlock
- Defined in tx/text-sprite-block.ts:40

Properties

fontFamily

fontFamily: string

The font family used for rendering the text.

fontSize

fontSize: number

The font size used for rendering the text, in pixels.

maxDisplayRows

maxDisplayRows: number

The maximum number of rows of text to be displayed.

sprites

sprites: TxSprite[] = []

An array of TxSprite instances, each representing a line of rendered text.

text

text: string

The raw text content to be rendered.

width

width: number

The width constraint for the text layout, in pixels.

Methods

pack

pack(): Uint8Array
Packs the text block header and sprite offsets into a binary format.

Returns Uint8Array
Uint8Array Binary representation of the text block.

Throws
Error if there are no sprites to pack.
- Defined in tx/text-sprite-block.ts:170