Pixi’VNClass: DOMPipe
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:11
Internal
The DOMPipe class is responsible for managing and rendering DOM elements within a PixiJS scene. It maps dom elements to the canvas and ensures they are correctly positioned and visible.
Implements
Constructors
Constructor
> new DOMPipe(renderer): DOMPipe
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:31
Constructor for the DOMPipe class.
Parameters
renderer
The renderer instance that this DOMPipe will be associated with.
Returns
DOMPipe
Properties
_domElement
> readonly _domElement: HTMLDivElement
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:24
The main DOM element that acts as a container for other DOM elements
extension
> static extension: object
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:16
Static property defining the extension type and name for the DOMPipe. This is used to register the DOMPipe with different rendering pipelines.
name
> readonly name: "dom"
type
> readonly type: readonly [WebGLPipes, WebGPUPipes, CanvasPipes]
Methods
addRenderable()
> addRenderable(domContainer, _instructionSet): void
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:39
Adds a renderable DOM container to the list of attached elements.
Parameters
domContainer
The DOM container to be added.
_instructionSet
The instruction set (unused).
Returns
void
Implementation of
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:54
Destroys the DOMPipe, removing all attached DOM elements and cleaning up resources.
Returns
void
init()
> init(): void
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:33
Initializes the DOMPipe, setting up the main DOM element and adding it to the document body.
Returns
void
postrender()
> postrender(): void
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:52
Handles the post-rendering process, ensuring DOM elements are correctly positioned and visible.
Returns
void
updateRenderable()
> updateRenderable(_domContainer): void
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:44
Updates a renderable DOM container.
Parameters
_domContainer
The DOM container to be updated (unused).
Returns
void
Implementation of
validateRenderable()
> validateRenderable(_domContainer): boolean
Defined in: node_modules/pixi.js/lib/dom/DOMPipe.d.ts:50
Validates a renderable DOM container.
Parameters
_domContainer
The DOM container to be validated (unused).
Returns
boolean
Always returns true as validation is not required.