Abstract Class: PrepareBase

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

Part of the prepare system. Responsible for uploading all the items to the GPU. This class provides the base functionality and handles processing the queue asynchronously.

Advanced

Extended by

• PrepareQueue

Constructors

Constructor

> new PrepareBase(renderer): PrepareBase

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

Parameters

renderer

Renderer

A reference to the current renderer

Returns

PrepareBase

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

---

renderer

> protected renderer: Renderer

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

Reference to the 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

---

timeout?

> protected optional timeout?: number

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

Timeout id for next processing call

---

uploadsPerFrame

> static uploadsPerFrame: number

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

The number of uploads to process per frame

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

---

dedupeQueue()

> dedupeQueue(): void

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

eliminate duplicates before processing

Returns

void

---

destroy()

> destroy(): void

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

Returns

void

---

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

---

resolveQueueItem()

> abstract protected resolveQueueItem(source, queue): void

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

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

Parameters

source

PrepareSourceItem

queue

PrepareQueueItem[]

Returns

void

---

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>

---

uploadQueueItem()

> abstract protected uploadQueueItem(item): void

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

Parameters

item

PrepareQueueItem

Returns

void