PixiJS

Class: Prepare

PIXI.Prepare

The prepare plugin provides renderer-specific plugins for pre-rendering DisplayObjects. These plugins are useful for asynchronously preparing and uploading to the GPU assets, textures, graphics waiting to be displayed.

Do not instantiate this plugin directly. It is available from the renderer.prepare property.

new PIXI.Prepare (renderer) overrides

Prepare.ts:131
Name Type Description
renderer PIXI.Renderer

A reference to the current renderer

Example

 import { Application, Graphics } from 'pixi.js';

 // Create a new application (prepare will be auto-added to renderer)
 const app = new Application();
 document.body.appendChild(app.view);

 // Don't start rendering right away
 app.stop();

 // Create a display object
 const rect = new 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.prepare.upload(app.stage, () => {
     app.start();
 });

Extends

Implements

Inherited Properties

From class PIXI.BasePrepare

addHooks Array<Function> inherited

Collection of additional hooks for finding assets.

completes Array<Function> inherited

Callback to call after completed.

ticking boolean inherited

If prepare is ticking (running).

uploadHooks Array<Function> inherited

Collection of additional hooks for processing assets.

queue Array<any> protected inherited

Collection of items to uploads at once.

renderer PIXI.IRenderer protected inherited

Reference to the renderer.

uploadHookHelper any protected inherited

The only real difference between CanvasPrepare and Prepare is what they pass to upload hooks. That different parameter is stored here.

Inherited Methods

From class PIXI.BasePrepare

add (item) this inherited

BasePrepare.ts:448

Manually add an item to the uploading queue.

Name Type Description
item PIXI.DisplayObject | PIXI.Container | PIXI.BaseTexture | PIXI.Texture | PIXI.Graphics | PIXI.Text | unknown

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

destroy () void inherited

BasePrepare.ts:478

Destroys the plugin, don't use after this.

registerFindHook (addHook) this inherited

BasePrepare.ts:416

Adds hooks for finding items.

Name Type Description
addHook Function

Function call that takes two parameters: item:*, queue:Array function must return true if it was able to add item to the queue.
Returns:
Type Description
this Instance of plugin for chaining.

registerUploadHook (uploadHook) this inherited

BasePrepare.ts:432

Adds hooks for uploading items.

Name Type Description
uploadHook Function

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
this Instance of plugin for chaining.

upload (item) Promise<void> inherited

BasePrepare.ts:317

Upload all the textures and graphics to the GPU.

Name Type Attributes Description
item PIXI.DisplayObject | PIXI.Container | PIXI.BaseTexture | PIXI.Texture | PIXI.Graphics | PIXI.Text <optional>

Container or display object to search for items to upload or the items to upload themselves, or optionally ommitted, if items have been added using prepare.add.
Returns:
Type Description
Promise<void>