PIXI

Class: WebGLPrepare

PIXI. WebGLPrepare

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

new PIXI.WebGLPrepare(renderer)

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

A reference to the current renderer

Members

staticPIXI.WebGLPrepare.UPLOADS_PER_FRAMEnumber

The number of graphics or textures to upload to the GPU

Default Value:
  • 4

Methods

add(item){PIXI.WebGLPrepare}

prepare/webgl/WebGLPrepare.js, line 195

Manually add an item to the uploading queue.

Name Type Description
item PIXI.DisplayObject | PIXI.Container | *

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

destroy()

prepare/webgl/WebGLPrepare.js, line 223

Destroys the plugin, don't use after this.

register(addHook, uploadHook){PIXI.WebGLPrepare}

prepare/webgl/WebGLPrepare.js, line 174

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: renderer:WebGLRenderer, item:* and
function must return true if it was able to handle upload of item.
Returns:
Type Description
PIXI.WebGLPrepare Instance of plugin for chaining.

upload(item, done)

prepare/webgl/WebGLPrepare.js, line 76

Upload all the textures and graphics to the GPU.

Name Type Description
item function | PIXI.DisplayObject | PIXI.Container

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

Optional callback when all queued uploads have completed