Pixi’VNClass: HTMLTextPipe
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:11
Internal
The HTMLTextPipe class is responsible for rendering HTML text.
Implements
Constructors
Constructor
> new HTMLTextPipe(renderer): HTMLTextPipe
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:19
Parameters
renderer
Returns
HTMLTextPipe
Methods
addRenderable()
> addRenderable(htmlText, instructionSet): void
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:22
This is where the renderable is added to the instruction set. This is called once per renderable. For instance, a MeshRenderPipe could be used to enqueue a 'draw mesh' command to the rendering instruction set, catering to the rendering of mesh geometry. In more complex scenarios, such as the SpritePipe, this seamlessly coordinates with a batchPipe to efficiently batch and add batch instructions to the instructions set
Add is called when the instructions set is being built.
Parameters
htmlText
instructionSet
the instruction set currently being built
Returns
void
Implementation of
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:28
Returns
void
initGpuText()
> initGpuText(htmlText): BatchableHTMLText
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:26
Parameters
htmlText
Returns
onTextUnload()
> protected onTextUnload(text): void
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:27
Parameters
text
Returns
void
resolutionChange()
> protected resolutionChange(): void
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:20
Returns
void
updateRenderable()
> updateRenderable(htmlText): void
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:23
Called whenever a renderable has been been updated, eg its position has changed. This is only called in the render loop if the instructions set is being reused from the last frame. Otherwise addRenderable is called.
Parameters
htmlText
Returns
void
Implementation of
validateRenderable()
> validateRenderable(htmlText): boolean
Defined in: node_modules/pixi.js/lib/scene/text-html/HTMLTextPipe.d.ts:21
This function is called when the renderer is determining if it can use the same instruction set again to improve performance. If this function returns true, the renderer will rebuild the whole instruction set for the scene. This is only called if the scene has not its changed its structure .
Parameters
htmlText
Returns
boolean