Class: PrepareSystem

Defined in: node_modules/pixi.js/lib/prepare/PrepareSystem.d.ts:36

The prepare system provides renderer-specific plugins for pre-rendering DisplayObjects. This is 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.

Example

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

// Create a new application (prepare will be auto-added to renderer)
const app = new Application();
await app.init();
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();
});

Advanced

Extends

• PrepareUpload

Implements

• System

Constructors

Constructor

> new PrepareSystem(renderer): PrepareSystem

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:40

Parameters

renderer

Renderer

A reference to the current renderer

Returns

PrepareSystem

Inherited from

PrepareUpload.constructor

Properties

queue

> protected queue: PrepareQueueItem[]

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:31

The queue to process over a async timer

Inherited from

PrepareUpload.queue

renderer

> protected renderer: Renderer

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:29

Reference to the renderer

Inherited from

PrepareUpload.renderer

resolves

> protected resolves: (value) => void[]

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:33

Collection of callbacks to call when the uploads are finished

Parameters

value

void | PromiseLike<void>

Returns

void

Inherited from

PrepareUpload.resolves

timeout?

> protected optional timeout?: number

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:35

Timeout id for next processing call

Inherited from

PrepareUpload.timeout

uploadsPerFrame

> static uploadsPerFrame: number

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:27

The number of uploads to process per frame

Inherited from

PrepareUpload.uploadsPerFrame

Methods

add()

> add(resource): this

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:53

Add a textures or graphics resource to the queue

Parameters

resource

PrepareSourceItem | PrepareSourceItem[]

Returns

this

Inherited from

PrepareUpload.add

dedupeQueue()

> dedupeQueue(): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:65

eliminate duplicates before processing

Returns

void

Inherited from

PrepareUpload.dedupeQueue

destroy()

> destroy(): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareSystem.d.ts:43

Destroys the plugin, don't use after this.

Returns

void

Implementation of

System.destroy

Overrides

PrepareUpload.destroy

getQueue()

> getQueue(): PrepareQueueItem[]

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:48

Return a copy of the queue

Returns

PrepareQueueItem[]

The queue

Inherited from

PrepareUpload.getQueue

resolveContainerQueueItem()

> protected resolveContainerQueueItem(container, queue): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareQueue.d.ts:23

Resolve the given container and return an item for the queue

Parameters

container

Container

queue

PrepareQueueItem[]

Returns

void

Inherited from

PrepareUpload.resolveContainerQueueItem

resolveGraphicsContextQueueItem()

> protected resolveGraphicsContextQueueItem(graphicsContext): PrepareQueueItem | null

Defined in: node_modules/pixi.js/lib/prepare/PrepareQueue.d.ts:28

Resolve the given graphics context and return an item for the queue

Parameters

graphicsContext

GraphicsContext

Returns

PrepareQueueItem | null

Inherited from

PrepareUpload.resolveGraphicsContextQueueItem

resolveQueueItem()

> protected resolveQueueItem(source, queue): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareQueue.d.ts:17

Resolve the given resource type and return an item for the queue

Parameters

source

PrepareSourceItem

queue

PrepareQueueItem[]

Returns

void

Inherited from

PrepareUpload.resolveQueueItem

upload()

> upload(resource?): Promise<void>

Defined in: node_modules/pixi.js/lib/prepare/PrepareBase.d.ts:63

Upload all the textures and graphics to the GPU (optionally add more resources to the queue first)

Parameters

resource?

PrepareSourceItem | PrepareSourceItem[]

Returns

Promise<void>

Inherited from

PrepareUpload.upload

uploadBitmapText()

> protected uploadBitmapText(_text): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareUpload.d.ts:22

Parameters

_text

BitmapText

Returns

void

Inherited from

PrepareUpload.uploadBitmapText

uploadGraphicsContext()

> protected uploadGraphicsContext(graphicsContext): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareUpload.d.ts:28

Resolve the given graphics context and return an item for the queue

Parameters

graphicsContext

GraphicsContext

Returns

void

Inherited from

PrepareUpload.uploadGraphicsContext

uploadHTMLText()

> protected uploadHTMLText(_text): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareUpload.d.ts:23

Parameters

_text

HTMLText

Returns

void

Inherited from

PrepareUpload.uploadHTMLText

uploadQueueItem()

> protected uploadQueueItem(item): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareUpload.d.ts:19

Upload the given queue item

Parameters

item

PrepareQueueItem

Returns

void

Inherited from

PrepareUpload.uploadQueueItem

uploadText()

> protected uploadText(_text): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareUpload.d.ts:21

Parameters

_text

Text

Returns

void

Inherited from

PrepareUpload.uploadText

uploadTextureSource()

> protected uploadTextureSource(textureSource): void

Defined in: node_modules/pixi.js/lib/prepare/PrepareUpload.d.ts:20

Parameters

textureSource

TextureSource

Returns

void

Inherited from

PrepareUpload.uploadTextureSource