PIXI

Class: BasePrepare

PIXI.prepare. BasePrepare

The prepare manager provides functionality to upload content to the GPU. BasePrepare handles
basic queuing functionality and is extended by PIXI.prepare.WebGLPrepare and PIXI.prepare.CanvasPrepare
to provide preparation capabilities specific to their respective renderers.

abstractnew PIXI.prepare.BasePrepare(renderer)

prepare/BasePrepare.js, line 27
Name Type Description
renderer PIXI.SystemRenderer

A reference to the current renderer

Methods

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.

destroy()

prepare/BasePrepare.js, line 273

Destroys the plugin, don't use after this.

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.

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