new PIXI.CanvasPrepare(renderer)
Name | Type | Description |
---|---|---|
renderer |
PIXI.CanvasRenderer |
A reference to the current renderer |
Members
-
staticPIXI.CanvasPrepare.UPLOADS_PER_FRAMEnumber
-
The number of graphics or textures to upload to the GPU.
- Default Value:
- 4
Methods
-
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.CanvasPrepare Instance of plugin for chaining. -
destroy()
-
Destroys the plugin, don't use after this.
-
register(addHook, uploadHook){PIXI.CanvasPrepare}
-
Adds hooks for finding and uploading items.
Name Type Description addHook
function optional Function call that takes two parameters:
item:*, queue:Array
function must returntrue
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 returntrue
if it was able to handle upload of item.Returns:
Type Description PIXI.CanvasPrepare Instance of plugin for chaining. -
upload(item, done)
-
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 usingprepare.add
.done
function optional Optional callback when all queued uploads have completed