SilkPipe

import { SilkPipe } from 'pixi-silk';

Render pipe that draws runs of consecutive SilkGraphics in one instanced draw call, under WebGL2 and WebGPU. enableSilkBatching installs it.

Implements#

new SilkPipe(renderer: Renderer): SilkPipe;

Created once per renderer, by the pipe that enableSilkBatching() installs or by Pixi’s extensions.

Parameter	Type
`renderer`	`Renderer`

SilkPipe

Property	Modifier	Type	Description	Defined in
`extension`	`static`	{ `name`: `string`; `type`: `ExtensionType`[]; }	Pixi extension metadata, for `extensions.add(SilkPipe)` if you register it yourself.	batch.ts:217
`extension.name`	`public`	`string`	Key in `renderer.renderPipes`, and the `renderPipeId` of batched objects.	batch.ts:221
`extension.type`	`public`	`ExtensionType`[]	Renderer pipe lists the pipe joins.	batch.ts:219

addRenderable(g: SilkGraphics, set: InstructionSet): void;

Adds g to the current run when it can share its draw, or starts a new run.

Parameter	Type
`g`	`SilkGraphics`
`set`	`InstructionSet`

void

RenderPipe.addRenderable

destroyInstructionSet(set: InstructionSet): void;

Frees the batches of an instruction set that Pixi no longer uses.

Parameter	Type
`set`	`InstructionSet`

void

execute(instruction: Instruction): void;

Draws a batch, or hands a single object to the mesh pipe.

Parameter	Type
`instruction`	`Instruction`

void

updateRenderable(g: SilkGraphics): void;

Nothing to do: a batch reads every object again when it draws.

Parameter	Type
`g`	`SilkGraphics`

void

RenderPipe.updateRenderable

validateRenderable(g: SilkGraphics): boolean;

A batch never needs a rebuild for changes inside its objects.

Parameter	Type
`g`	`SilkGraphics`

boolean

RenderPipe.validateRenderable