Class: BatcherPipe

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:24

A pipe that batches elements into batches and sends them to the renderer.

You can install new Batchers using ExtensionType.Batcher. Each render group will have a default batcher and any required ones will be created on demand.

Advanced

Implements

• InstructionPipe<Batch>
• BatchPipe

Constructors

Constructor

> new BatcherPipe(renderer, adaptor): BatcherPipe

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:40

Parameters

renderer

Renderer

adaptor

BatcherAdaptor

Returns

BatcherPipe

Properties

renderer

> renderer: Renderer

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:31

---

state

> state: State

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:30

---

_availableBatchers

> static _availableBatchers: Record<string, () => Batcher>

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:38

Methods

addToBatch()

> addToBatch(batchableObject, instructionSet): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:42

Add a add a batchable object to the batch.

Parameters

batchableObject

BatchableElement

instructionSet

InstructionSet

the instruction set currently being built

Returns

void

Implementation of

BatchPipe.addToBatch

---

break()

> break(instructionSet): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:43

Forces the batch to break. This can happen if for example you need to render everything and then change the render target.

Parameters

instructionSet

InstructionSet

the instruction set currently being built

Returns

void

Implementation of

BatchPipe.break

---

buildEnd()

> buildEnd(instructionSet): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:44

Parameters

instructionSet

InstructionSet

Returns

void

Implementation of

InstructionPipe.buildEnd

---

buildStart()

> buildStart(instructionSet): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:41

Parameters

instructionSet

InstructionSet

Returns

void

Implementation of

InstructionPipe.buildStart

---

destroy()

> destroy(): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:47

Returns

void

---

execute()

> execute(batch): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:46

this is where the actual instruction is executed - eg make the draw call activate a filter. Any instructions that have the same renderPipeId have their execute method called

Parameters

batch

Batch

Returns

void

Implementation of

InstructionPipe.execute

---

upload()

> upload(instructionSet): void

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:45

called just before we execute the draw calls , this is where the pipes have an opportunity to upload data to the GPU. This is only called if data changes.

Parameters

instructionSet

InstructionSet

the instruction set currently being built

Returns

void

Implementation of

InstructionPipe.upload

---

getBatcher()

> static getBatcher(name): Batcher

Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatcherPipe.d.ts:39

Parameters

name

string

Returns

Batcher