Name | Type | Description |
---|---|---|
renderer |
PIXI.Renderer |
A reference to the current renderer |
Example
// Create a new application
const app = new PIXI.Application();
document.body.appendChild(app.view);
// Don't start rendering right away
app.stop();
// create a display object
const rect = new PIXI.Graphics()
.beginFill(0x00ff00)
.drawRect(40, 40, 200, 200);
// Add to the stage
app.stage.addChild(rect);
// Don't start rendering until the graphic is uploaded to the GPU
app.renderer.plugins.prepare.upload(app.stage, () => {
app.start();
});
Extends
Members
-
limiter PIXI.CountLimiter | PIXI.TimeLimiter inherited
-
The limiter to be used to control how quickly items are prepared.
-
renderer PIXI.AbstractRenderer protected inherited
-
Reference to the renderer.
-
The only real difference between CanvasPrepare and Prepare is what they pass to upload hooks. That different parameter is stored here.
Methods
-
add (item)this inherited
-
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 this Instance of plugin for chaining. -
destroy () inherited
-
Destroys the plugin, don't use after this.
-
registerFindHook (addHook)this inherited
-
Adds hooks for finding items.
Name Type Description addHook
function Function call that takes two parameters:
item:*, queue:Array
function must returntrue
if it was able to add item to the queue.Returns:
Type Description this Instance of plugin for chaining. -
registerUploadHook (uploadHook)this inherited
-
Adds hooks for uploading items.
Name Type Description uploadHook
function 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 this Instance of plugin for chaining. -
upload (item, done) inherited
-
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