| Name | Type | Description |
|---|---|---|
renderer |
PIXI.SystemRenderer |
A reference to the current renderer |
Example
// Create a sprite
const sprite = new PIXI.Sprite.fromImage('something.png');
// Load object into GPU
app.renderer.plugins.prepare.upload(sprite, () => {
//Texture(s) has been uploaded to GPU
app.stage.addChild(sprite);
})Methods
-
Manually add an item to the uploading queue.
Name Type Description itemPIXI.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. -
Destroys the plugin, don't use after this.
-
Name Type Description addHookfunction optional Function call that takes two parameters:
item:*, queue:Arrayfunction must returntrueif it was able to add item to the queue.uploadHookfunction optional Function call that takes two parameters:
prepare:CanvasPrepare, item:*and function must returntrueif it was able to handle upload of item.Returns:
Type Description PIXI.BasePrepare Instance of plugin for chaining. -
Adds hooks for finding items.
Name Type Description addHookfunction Function call that takes two parameters:
item:*, queue:Arrayfunction must returntrueif it was able to add item to the queue.Returns:
Type Description PIXI.BasePrepare Instance of plugin for chaining. -
Adds hooks for uploading items.
Name Type Description uploadHookfunction Function call that takes two parameters:
prepare:CanvasPrepare, item:*and function must returntrueif it was able to handle upload of item.Returns:
Type Description PIXI.BasePrepare Instance of plugin for chaining. -
Upload all the textures and graphics to the GPU.
Name Type Description itemfunction | 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.donefunction optional Optional callback when all queued uploads have completed