PIXI

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

new PIXI.prepare.WebGLPrepare(renderer)

prepare/webgl/WebGLPrepare.js, line 15
Name Type Description
renderer PIXI.WebGLRenderer

A reference to the current renderer

Extends

Methods

inherited add(item){PIXI.CanvasPrepare}

prepare/BasePrepare.js, line 245

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
Returns:
Type Description
PIXI.CanvasPrepare Instance of plugin for chaining.

inherited destroy()

prepare/BasePrepare.js, line 273

Destroys the plugin, don't use after this.

inherited register(addHook, uploadHook){PIXI.CanvasPrepare}

prepare/BasePrepare.js, line 223

Adds hooks for finding and uploading items.

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.
Returns:
Type Description
PIXI.CanvasPrepare Instance of plugin for chaining.

inherited upload(item, done)

prepare/BasePrepare.js, line 117

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