Class TextTexture

constructor

• new TextTexture(options: TextTextureOptions): TextTexture

  Creates a new TextTexture and draws it immediately using already-available fonts (system fonts, or fonts already registered via CSS @font-face/document.fonts). Use TextTexture.create instead if options.fontUrl needs to be loaded first.

  Parameters

  • options: TextTextureOptions

    Configuration options.

  Returns TextTexture

Readonlytexture

aspectRatio

• get aspectRatio(): number

  The width-to-height ratio of the rendered text texture.

  Returns number

height

• get height(): number

  The unscaled (CSS pixel) height of the rendered text texture, useful for sizing a Plane.

  Returns number

width

• get width(): number

  The unscaled (CSS pixel) width of the rendered text texture, useful for sizing a Plane.

  Returns number

setOptions

• setOptions(options: Partial<TextTextureOptions>): void

  Merges new options in, redraws, and marks the texture for GPU re-upload.

  Parameters

  • options: Partial<TextTextureOptions>

    Partial options to merge over the current configuration.

  Returns void

setText

• setText(text: string): void

  Replaces the displayed text and redraws, marking the texture for GPU re-upload.

  Parameters

  • text: string

    The new text to display.

  Returns void

Staticcreate

• create(options: TextTextureOptions): Promise<TextTexture>

  Creates a TextTexture, first loading options.fontUrl (if given) via the CSS Font Loading API.

  Parameters

  • options: TextTextureOptions

    Configuration options.

  Returns Promise<TextTexture>

  A promise that resolves to a new TextTexture instance.

StaticloadFont

• loadFont(family: string, url: string): Promise<FontFace>

  Loads a font file and registers it with document.fonts under the given family name.

  Parameters

  • family: string

    The font family name to register the loaded font under.

  • url: string

    The URL of the font file (e.g. a variable-font .woff2).

  Returns Promise<FontFace>

  A promise that resolves to the loaded FontFace.