PixiJS

Class: DOMPipe

DOMPipe

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.

new DOMPipe (renderer)

ts:36

Constructor for the DOMPipe class.

Name Type Description
renderer Renderer

The renderer instance that this DOMPipe will be associated with.

Implements

Members

extension static

Static property defining the extension type and name for the DOMPipe. This is used to register the DOMPipe with different rendering pipelines.

Methods

addRenderable (domContainer, _instructionSet) void

ts:57

Adds a renderable DOM container to the list of attached elements.

Name Type Description
domContainer DOMContainer

The DOM container to be added.
_instructionSet InstructionSet

The instruction set (unused).

destroy () void

ts:159

Destroys the DOMPipe, removing all attached DOM elements and cleaning up resources.

destroyRenderable (domContainer) void

ts:90

Destroys a renderable DOM container, removing it from the list of attached elements.

Name Type Description
domContainer DOMContainer

The DOM container to be destroyed.

postrender () void

ts:106

Handles the post-rendering process, ensuring DOM elements are correctly positioned and visible.

updateRenderable (_domContainer) void

ts:71

Updates a renderable DOM container.

Name Type Description
_domContainer DOMContainer

The DOM container to be updated (unused).

validateRenderable (_domContainer) boolean

ts:80

Validates a renderable DOM container.

Name Type Description
_domContainer DOMContainer

The DOM container to be validated (unused).
Returns:
Type Description
boolean Always returns true as validation is not required.