PixiJS

Class: BatchRenderer

PIXI.BatchRenderer

Renderer dedicated to drawing and batching sprites.

This is the default batch renderer. It buffers objects with texture-based geometries and renders them in batches. It uploads multiple textures to the GPU to reduce to the number of draw calls.

new PIXI.BatchRenderer (renderer) overrides

BatchRenderer.ts:250

This will hook onto the renderer's contextChange and prerender signals.

Name Type Description
renderer PIXI.Renderer

The renderer this works for.

Extends

Members

PIXI.BatchRenderer._drawCallPool Array<PIXI.BatchDrawCall> static

Pool of BatchDrawCall objects that flush used to create "batches" of the objects being rendered.

These are never re-allocated again. Shared between all batch renderers because it can be only one "flush" working at the moment.

PIXI.BatchRenderer._textureArrayPool Array<PIXI.BatchTextureArray> static

Pool of BatchDrawCall objects that flush used to create "batches" of the objects being rendered.

These are never re-allocated again. Shared between all batch renderers because it can be only one "flush" working at the moment.

PIXI.BatchRenderer.canUploadSameBuffer boolean static

Can we upload the same buffer in a single frame?

PIXI.BatchRenderer.defaultBatchSize number static

The default sprite batch size.

The default aims to balance desktop and mobile devices.

Default Value:
  • 4096

PIXI.BatchRenderer.defaultFragmentTemplate string staticreadonly

The default fragment shader source

PIXI.BatchRenderer.defaultMaxTextures number static

The maximum textures that this device supports.

Default Value:
  • 32

PIXI.BatchRenderer.defaultVertexSrc string staticreadonly

The default vertex shader source

MAX_TEXTURES number Deprecated : since 7.1.0 readonly

See:

maxTextures number readonly

Maximum number of textures that can be uploaded to the GPU under the current context. It is initialized properly in this.contextChange.

See:

size number

The number of bufferable objects before a flush occurs automatically.

Default Value:
  • PIXI.BatchRenderer.defaultBatchSize * 4

state PIXI.State readonly

The WebGL state in which this renderer will work.

_aBuffers Array<PIXI.ViewableBuffer> protected

Pool of ViewableBuffer objects that are sorted in order of increasing size. The flush method uses the buffer with the least size above the amount it requires. These are used for passing attributes.

The first buffer has a size of 8; each subsequent buffer has double capacity of its previous.

See:

_bufferedElements Array<PIXI.DisplayObject> protected

Buffer of objects that are yet to be rendered.

_bufferedTextures Array<PIXI.BaseTexture> protected

Data for texture batch builder, helps to save a bit of CPU on a pass.

_bufferSize number protected

Number of elements that are buffered and are waiting to be flushed.

_flushId number protected

A flush may occur multiple times in a single frame. On iOS devices or when BatchRenderer.canUploadSameBuffer is false, the batch renderer does not upload data to the same WebGLBuffer for performance reasons.

This is the index into packedGeometries that points to geometry holding the most recent buffers.

_iBuffers Array<Uint16Array> protected

Pool of Uint16Array objects that are sorted in order of increasing size. The flush method uses the buffer with the least size above the amount it requires. These are used for passing indices.

The first buffer has a size of 12; each subsequent buffer has double capacity of its previous.

See:

_indexCount number protected

Total count of all indices used by the currently buffered objects.

_shader PIXI.Shader protected

This shader is generated by this.shaderGenerator.

It is generated specifically to handle the required number of textures being batched together.

_vertexCount number protected

Total count of all vertices used by the currently buffered objects.

geometryClass object protected

The class that represents the geometry of objects that are going to be batched with this.

Default Value:
  • PIXI.BatchGeometry

shaderGenerator PIXI.BatchShaderGenerator protected

This is used to generate a shader that can color each vertex based on a aTextureId attribute that points to an texture in uSampler.

This enables the objects with different textures to be drawn in the same draw call.

You can customize your shader by creating your custom shader generator.

vertexSize number protected

Size of data being buffered per vertex in the attribute buffers (in floats). By default, the batch-renderer plugin uses 6:

aVertexPosition 2
aTextureCoords 2
aColor 1
aTextureId 1
Default Value:
  • 6

Methods

bindAndClearTexArray (texArray) void

BatchRenderer.ts:549

Bind textures for current rendering

Name Type Description
texArray PIXI.BatchTextureArray

buildDrawCalls (texArray, start, finish) void

BatchRenderer.ts:488

Populating drawcalls for rendering

Name Type Description
texArray PIXI.BatchTextureArray
start number
finish number

contextChange () void

BatchRenderer.ts:336

Handles the contextChange signal.

It calculates this.maxTextures and allocating the packed-geometry object pool.

destroy () void overrides

BatchRenderer.ts:670

Destroys this BatchRenderer. It cannot be used again.

flush () void overrides

BatchRenderer.ts:624

Renders the content now and empties the current batch.

getAttributeBuffer (size) PIXI.ViewableBuffer

BatchRenderer.ts:698

Fetches an attribute buffer from this._aBuffers that can hold atleast size floats.

Name Type Description
size number

minimum capacity required
Returns:
Type Description
PIXI.ViewableBuffer
  • buffer than can hold atleast size floats

getIndexBuffer (size) Uint16Array

BatchRenderer.ts:725

Fetches an index buffer from this._iBuffers that can have at least size capacity.

Name Type Description
size number

minimum required capacity
Returns:
Type Description
Uint16Array
  • buffer that can fit size indices.

initFlushBuffers () void

BatchRenderer.ts:374

Makes sure that static and dynamic flush pooled objects have correct dimensions.

onPrerender () void

BatchRenderer.ts:400

Handles the prerender signal. It ensures that flushes start from the first geometry object again.

packInterleavedGeometry (element, attributeBuffer, indexBuffer, aIndex, iIndex) void

BatchRenderer.ts:753

Takes the four batching parameters of element, interleaves and pushes them into the batching attribute/index buffers given.

It uses these properties: vertexData uvs, textureId and indicies. It also uses the "tint" of the base-texture, if present.

Name Type Description
element PIXI.DisplayObject

element being rendered
attributeBuffer PIXI.ViewableBuffer

attribute buffer.
indexBuffer Uint16Array

index buffer
aIndex number

number of floats already in the attribute buffer
iIndex number

number of indices already in indexBuffer

render (element) void overrides

BatchRenderer.ts:406

Buffers the "batchable" object. It need not be rendered immediately.

Name Type Description
element PIXI.DisplayObject

the element to render when using this renderer

setShaderGenerator (options) void

BatchRenderer.ts:322

Set the shader generator.

Name Type Attributes Default Description
options object <optional>
options.vertex string <optional>
 PIXI.BatchRenderer.defaultVertexSrc

Vertex shader source
options.fragment string <optional>
 PIXI.BatchRenderer.defaultFragmentTemplate

Fragment shader template

start () void overrides

BatchRenderer.ts:648

Starts a new sprite batch.

stop () void overrides

BatchRenderer.ts:664

Stops and flushes the current batch.

Inherited Properties

From class PIXI.ObjectRenderer

renderer PIXI.Renderer protected inherited

The renderer this manager works for.