Class: HTMLTextSystem

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:11

System plugin to the renderer to manage HTMLText

Advanced

Implements

• System

Constructors

Constructor

> new HTMLTextSystem(renderer): HTMLTextSystem

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:25

Parameters

renderer

Renderer

Returns

HTMLTextSystem

Methods

decreaseReferenceCount()

> decreaseReferenceCount(textKey): void

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:48

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

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:58

Generic destroy methods to be overridden by the subclass

Returns

void

Implementation of

System.destroy

---

getManagedTexture()

> getManagedTexture(text): Promise<Texture<TextureSource<any>>>

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:35

Increases the reference count for a texture.

Parameters

text

HTMLText

The HTMLText instance associated with the texture.

Returns

Promise<Texture<TextureSource<any>>>

---

getReferenceCount()

> getReferenceCount(textKey): number

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:41

Gets the current reference count for a texture associated with a text key.

Parameters

textKey

string

The unique key identifying the text style configuration

Returns

number

The number of Text instances currently using this texture

---

~~getTexture()~~

> getTexture(options): Promise<Texture<TextureSource<any>>>

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:30

Parameters

options

HTMLTextOptions

Returns

Promise<Texture<TextureSource<any>>>

Deprecated

Use getTexturePromise instead

---

getTexturePromise()

> getTexturePromise(options): Promise<Texture<TextureSource<any>>>

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:54

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): void

Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextSystem.d.ts:56

Parameters

texturePromise

Promise<Texture<TextureSource<any>>>

Returns

void