Abstract Class: PrepareQueue

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

Part of the prepare system. Responsible for uploading all the items to the GPU. This class extends the base functionality and resolves given resource items ready for the queue.

Advanced

Extends

• PrepareBase

Extended by

• PrepareUpload

Constructors

Constructor

> new PrepareQueue(renderer): PrepareQueue

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

Parameters

renderer

Renderer

A reference to the current renderer

Returns

PrepareQueue

Inherited from

PrepareBase.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

PrepareBase.queue

---

renderer

> protected renderer: Renderer

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

Reference to the renderer

Inherited from

PrepareBase.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

PrepareBase.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

PrepareBase.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

PrepareBase.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

PrepareBase.add

---

dedupeQueue()

> dedupeQueue(): void

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

eliminate duplicates before processing

Returns

void

Inherited from

PrepareBase.dedupeQueue

---

destroy()

> destroy(): void

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

Returns

void

Inherited from

PrepareBase.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

PrepareBase.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

---

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

---

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

Overrides

PrepareBase.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

PrepareBase.upload

---

uploadQueueItem()

> abstract protected uploadQueueItem(item): void

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

Parameters

item

PrepareQueueItem

Returns

void

Inherited from

PrepareBase.uploadQueueItem