PixiJS

Class: BatchSystem

PIXI.BatchSystem

System plugin to the renderer to manage batching.

new PIXI.BatchSystem (renderer)

BatchSystem.ts:29
Name Type Description
renderer PIXI.Renderer

The renderer this System works for.

Implements

Members

currentRenderer PIXI.ObjectRenderer

The currently active ObjectRenderer.

emptyRenderer PIXI.ObjectRenderer readonly

An empty renderer.

Methods

boundArray (texArray, boundTextures, batchId, maxTextures) void

BatchSystem.ts:91

Assigns batch locations to textures in array based on boundTextures state. All textures in texArray should have _batchEnabled = _batchId, and their count should be less than maxTextures.

Name Type Description
texArray PIXI.BatchTextureArray

textures to bound
boundTextures Array<PIXI.BaseTexture>

current state of bound textures
batchId number

marker for _batchEnabled param of textures in texArray
maxTextures number

number of texture locations to manipulate

copyBoundTextures (arr, maxTextures) void

BatchSystem.ts:71

Handy function for batch renderers: copies bound textures in first maxTextures locations to array sets actual _batchLocation for them

Name Type Description
arr PIXI.BaseTexture[]

arr copy destination
maxTextures number

number of copied elements

flush () void

BatchSystem.ts:56

This should be called if you wish to do some custom rendering It will basically render anything that may be batched up such as sprites

reset () void

BatchSystem.ts:65

Reset the system to an empty renderer

setObjectRenderer (objectRenderer) void

BatchSystem.ts:39

Changes the current renderer to the one given in parameter

Name Type Description
objectRenderer PIXI.ObjectRenderer

The object renderer to use.