Class: AbstractBatchRenderer

Extends

• PIXI.ObjectRenderer

Members

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

geometryClass object protected

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

Default Value:

• PIXI.BatchGeometry

MAX_TEXTURES 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:

• PIXI.AbstractBatchRenderer#contextChange

renderer PIXI.Renderer inherited

The renderer this manager works for.

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.

size number

The number of bufferable objects before a flush occurs automatically.

Default Value:

• settings.SPRITE_MAX_TEXTURES

state PIXI.State readonly

The WebGL state in which this renderer will work.

vertexSize number readonly

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

Methods

contextChange ()

AbstractBatchRenderer.js:252

Handles the contextChange signal.

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

destroy () overrides

AbstractBatchRenderer.js:498

Destroys this AbstractBatchRenderer. It cannot be used again.

flush () overrides

AbstractBatchRenderer.js:321

Renders the content now and empties the current batch.

onPrerender ()

AbstractBatchRenderer.js:289

Handles the prerender signal.

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

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

AbstractBatchRenderer.js:599

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.Sprite	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 (sprite) overrides

AbstractBatchRenderer.js:301

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

Name	Type	Description
sprite	PIXI.Sprite	the sprite to render when using this spritebatch

start () overrides

AbstractBatchRenderer.js:474

Starts a new sprite batch.

stop () overrides

AbstractBatchRenderer.js:490

Stops and flushes the current batch.