Abstract Class: PrepareUpload

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

Advanced

Part of the prepare system. Responsible for uploading all the items to the GPU. This class extends the resolver functionality and uploads the given queue items.

Extends

• PrepareQueue

Extended by

• PrepareSystem

Constructors

Constructor

> new PrepareUpload(renderer): PrepareUpload

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

Parameters

renderer

Renderer

A reference to the current renderer

Returns

PrepareUpload

Inherited from

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

PrepareQueue.queue

---

renderer

> protected renderer: Renderer

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

Reference to the renderer

Inherited from

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

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

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

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

PrepareQueue.add

---

dedupeQueue()

> dedupeQueue(): void

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

eliminate duplicates before processing

Returns

void

Inherited from

PrepareQueue.dedupeQueue

---

destroy()

> destroy(): void

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

Returns

void

Inherited from

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

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

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

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

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

PrepareQueue.upload

---

uploadBitmapText()

> protected uploadBitmapText(_text): void

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

Parameters

_text

BitmapText

Returns

void

---

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

---

uploadHTMLText()

> protected uploadHTMLText(_text): void

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

Parameters

_text

HTMLText

Returns

void

---

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

Overrides

PrepareQueue.uploadQueueItem

---

uploadText()

> protected uploadText(_text): void

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

Parameters

_text

Text

Returns

void

---

uploadTextureSource()

> protected uploadTextureSource(textureSource): void

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

Parameters

textureSource

TextureSource

Returns

void