new PIXI.AbstractBatchRenderer (renderer) overrides
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.AbstractBatchRenderer._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.AbstractBatchRenderer._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.
Maximum number of textures that can be uploaded to
the GPU under the current context. It is initialized
properly in this.contextChange.
The number of bufferable objects before a flush occurs automatically.
- Default Value:
- settings.SPRITE_BATCH_SIZE * 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.
_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.
Number of elements that are buffered and are waiting to be flushed.
A flush may occur multiple times in a single
frame. On iOS devices or when
settings.CAN_UPLOAD_SAME_BUFFER 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.
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.
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.
Total count of all vertices used by the currently buffered objects.
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.
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
Bind textures for current rendering
| Name | Type | Description |
|---|---|---|
texArray |
PIXI.BatchTextureArray |
Populating drawcalls for rendering
| Name | Type | Description |
|---|---|---|
texArray |
PIXI.BatchTextureArray | |
start |
number | |
finish |
number |
Handles the contextChange signal.
It calculates this.MAX_TEXTURES and allocating the packed-geometry object pool.
destroy () void overrides
Destroys this AbstractBatchRenderer. It cannot be used again.
flush () void overrides
Renders the content now and empties the current batch.
getAttributeBuffer (size) PIXI.ViewableBuffer
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 |
|
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 |
|
Makes sure that static and dynamic flush pooled objects have correct dimensions.
Handles the prerender signal. It ensures that flushes start from the first geometry object again.
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 |
render (element) void overrides
Buffers the "batchable" object. It need not be rendered immediately.
| Name | Type | Description |
|---|---|---|
element |
PIXI.DisplayObject |
the element to render when using this renderer |
start () void overrides
Starts a new sprite batch.
stop () void overrides
Stops and flushes the current batch.
Inherited Properties
From class PIXI.ObjectRenderer
renderer PIXI.Renderer protected inherited
The renderer this manager works for.