PixiJS API Documentation

Class: WebGLPrepare

PIXI .prepare.WebGLPrepare

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

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

Name	Type	Description
`renderer`	PIXI.WebGLRenderer	A reference to the current renderer

add (item)PIXI.CanvasPrepare inherited BasePrepare.js:278

Manually add an item to the uploading queue.

Name	Type	Description
`item`	PIXI.DisplayObject \| PIXI.Container \| PIXI.BaseTexture \| PIXI.Texture \| PIXI.Graphics \| PIXI.Text \| *	Object to add to the queue

Type	Description
PIXI.CanvasPrepare	Instance of plugin for chaining.

Destroys the plugin, don't use after this.

register (addHook, uploadHook)PIXI.BasePrepare Deprecated : since version 4.4.2 inherited deprecation.js:1071

Name	Type	Description
`addHook`	function	optional Function call that takes two parameters: `item:*, queue:Array` function must return `true` if it was able to add item to the queue.
`uploadHook`	function	optional Function call that takes two parameters: `prepare:CanvasPrepare, item:*` and function must return `true` if it was able to handle upload of item.

See:

Type	Description
PIXI.BasePrepare	Instance of plugin for chaining.

registerFindHook (addHook)PIXI.BasePrepare inherited BasePrepare.js:244

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.

Type	Description
PIXI.BasePrepare	Instance of plugin for chaining.

registerUploadHook (uploadHook)PIXI.BasePrepare inherited BasePrepare.js:261

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.

Type	Description
PIXI.BasePrepare	Instance of plugin for chaining.

Upload all the textures and graphics to the GPU.

Name	Type	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