Class HTMLTextSystem`Advanced`

System plugin to the renderer to manage HTMLText

Implements

System

Index

Constructors

Methods

decreaseReferenceCount destroy getManagedTexture getTexture getTexturePromise returnTexturePromise

Constructors

constructor

new HTMLTextSystem(renderer: Renderer): HTMLTextSystem
Parameters
- renderer: Renderer
Returns HTMLTextSystem

Methods

decreaseReferenceCount

decreaseReferenceCount(textKey: string): void
Decreases the reference count for a texture. If the count reaches zero, the texture is cleaned up.
Parameters
- textKey: string
  The key associated with the HTMLText instance.
Returns void

destroy

destroy(): void
Generic destroy methods to be overridden by the subclass

Returns void
Implementation of System.destroy

getManagedTexture

getManagedTexture(text: HTMLText): Promise<Texture<TextureSource<any>>>
Increases the reference count for a texture.
Parameters
- text: HTMLText
  The HTMLText instance associated with the texture.
Returns Promise<Texture<TextureSource<any>>>

getTexture

getTexture(options: HTMLTextOptions): Promise<Texture<TextureSource<any>>>
Parameters
- options: HTMLTextOptions
Returns Promise<Texture<TextureSource<any>>>
Deprecated
Use getTexturePromise instead

getTexturePromise

getTexturePromise(
options: HTMLTextOptions,
): Promise<Texture<TextureSource<any>>>
Returns a promise that resolves to a texture for the given HTMLText options.
Parameters
- options: HTMLTextOptions
  The options for the HTMLText.
Returns Promise<Texture<TextureSource<any>>>
A promise that resolves to a Texture.

returnTexturePromise

returnTexturePromise(texturePromise: Promise<Texture<TextureSource<any>>>): void
Parameters
- texturePromise: Promise<Texture<TextureSource<any>>>
Returns void