PixiJS

Class: CanvasPrepare

PIXI.CanvasPrepare

The prepare manager provides functionality to upload content to the GPU.

This cannot be done directly for Canvas like in WebGL, but the effect can be achieved by drawing textures to an offline canvas. This draw call will force the texture to be moved onto the GPU.

An instance of this class is automatically created by default, and can be found at renderer.plugins.prepare

new PIXI.CanvasPrepare (renderer) overrides

CanvasPrepare.ts:65
Name Type Description
renderer PIXI.CanvasRenderer

A reference to the current renderer

Extends

Members

canvas

ctx

Methods

destroy () void overrides

CanvasPrepare.ts:94

Destroys the plugin, don't use after this.

Inherited Properties

From class PIXI.BasePrepare

limiter PIXI.CountLimiter | PIXI.TimeLimiter inherited

The limiter to be used to control how quickly items are prepared.

renderer PIXI.AbstractRenderer protected inherited

Reference to the renderer.

uploadHookHelper object protected inherited

The only real difference between CanvasPrepare and Prepare is what they pass to upload hooks. That different parameter is stored here.

Inherited Methods

From class PIXI.BasePrepare

add (item) this inherited

BasePrepare.ts:477

Manually add an item to the uploading queue.

Name Type Description
item PIXI.DisplayObject | PIXI.Container | PIXI.BaseTexture | PIXI.Texture | PIXI.Graphics | PIXI.Text | unknown

Object to add to the queue
Returns:
Type Description
this Instance of plugin for chaining.

registerFindHook (addHook) this inherited

BasePrepare.ts:443

Adds hooks for finding items.

Name Type Description
addHook Function

Function call that takes two parameters: item:*, queue:Array function must return true if it was able to add item to the queue.
Returns:
Type Description
this Instance of plugin for chaining.

registerUploadHook (uploadHook) this inherited

BasePrepare.ts:460

Adds hooks for uploading items.

Name Type Description
uploadHook Function

Function call that takes two parameters: prepare:CanvasPrepare, item:* and function must return true if it was able to handle upload of item.
Returns:
Type Description
this Instance of plugin for chaining.

upload (item, done) void inherited

BasePrepare.ts:335

Upload all the textures and graphics to the GPU.

Name Type Attributes Description
item Function | PIXI.DisplayObject | PIXI.Container | PIXI.BaseTexture | PIXI.Texture | PIXI.Graphics | PIXI.Text

Either the container or display object to search for items to upload, the items to upload themselves, or the callback function, if items have been added using prepare.add.
done Function <optional>

Optional callback when all queued uploads have completed