com.cyphercove.gdx.flexbatch

Class Batchable

java.lang.Object

com.cyphercove.gdx.flexbatch.Batchable

All Implemented Interfaces:

com.badlogic.gdx.utils.Pool.Poolable

Direct Known Subclasses:

Batchable.FixedSizeBatchable, Poly

public abstract class Batchable
extends java.lang.Object
implements com.badlogic.gdx.utils.Pool.Poolable

A Batchable is an object that can be drawn by a FlexBatch. It also serves as a template object for the FlexBatch to set itself up. All subclasses of Batchable must have an empty constructor if they are to be used as a template for FlexBatch.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Batchable.FixedSizeBatchable Parent class for Batchables that all have the same number of vertices and triangles.

Constructor Summary

Constructors

Constructor and Description
Batchable()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addVertexAttributes(com.badlogic.gdx.utils.Array<com.badlogic.gdx.graphics.VertexAttribute> attributes) A Batchable implementation calls this to populate a list of vertex attributes that will be used by the FlexBatch.
protected abstract int	apply(float[] vertices, int startingIndex, AttributeOffsets offsets, int vertexSize) Called by FlexBatch.
protected abstract int	apply(short[] triangles, int startingIndex, short firstVertex) Called by FlexBatch.
protected abstract int	getNumberOfTextures()
protected abstract boolean	prepareContext(RenderContextAccumulator renderContext, int remainingVertices, int remainingIndices) Called before apply(float[], int, AttributeOffsets, int) to set render context states and texture bindings, and to determine if a flush is necessary before this Batchable can be drawn.
protected void	prepareSharedContext(RenderContextAccumulator renderContext) Prepares the rendering context for this type of Batchable to be drawn.
abstract void	refresh() Resets the state and default parameters of the Batchable so it can be reused for an entirely new image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.badlogic.gdx.utils.Pool.Poolable

reset

Constructor Detail

Batchable

public Batchable()

Method Detail

prepareSharedContext

protected void prepareSharedContext(RenderContextAccumulator renderContext)

Prepares the rendering context for this type of Batchable to be drawn. This method should set state changes that will be the same for all instances of this Batchable type. It must not call begin(), executeChanges(), or end() on renderContext, as these are handled by the FlexBatch. It should not change anything in a way that is unique to any particular instance of this Batchable type.

Parameters:

renderContext - The FlexBatch's manager of GL state changes and texture bindings.

prepareContext

protected abstract boolean prepareContext(RenderContextAccumulator renderContext,
                                          int remainingVertices,
                                          int remainingIndices)

Called before apply(float[], int, AttributeOffsets, int) to set render context states and texture bindings, and to determine if a flush is necessary before this Batchable can be drawn. Overriding this method may produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

Parameters:

renderContext - The FlexBatch's manager of GL state changes and texture bindings. Pending state changes and texture bindings can be made on this context, and the context will return whether the context is now changed, which means a flush is required and this method needs to return true.

remainingVertices - The number of vertices that can be drawn before the next flush is required.

remainingIndices - The number of triangle indices that can be drawn before the next flush is required. This value is undefined for Batchable.FixedSizeBatchable and should not be used or checked against.

Returns:

Whether FlexBatch needs to be flushed before this Batchable can be drawn. This may be true because it binds new textures, there isn't enough vertex or triangle capacity left, or because this Batchable uses new render context parameters.

addVertexAttributes

protected abstract void addVertexAttributes(com.badlogic.gdx.utils.Array<com.badlogic.gdx.graphics.VertexAttribute> attributes)

A Batchable implementation calls this to populate a list of vertex attributes that will be used by the FlexBatch. This is called only on one of the FlexBatch's internal Batchable instances. All instances of a class must have an equivalent set of attributes. Any subclass that does not have equivalent attributes to the superclass cannot be drawn by a FlexBatch that was instantiated with the superclass type.

Parameters:

attributes - An array to which attributes can be added.

getNumberOfTextures

protected abstract int getNumberOfTextures()

Returns:

The number of simultaneous textures that are drawn. This is used by the FlexBatch to determine how many texture uniforms to bind to the shader. Must always return the same value.

refresh

public abstract void refresh()

Resets the state and default parameters of the Batchable so it can be reused for an entirely new image.

apply

protected abstract int apply(float[] vertices,
                             int startingIndex,
                             AttributeOffsets offsets,
                             int vertexSize)

Called by FlexBatch. Applies the Batchable data to the vertex array that will be sent to the Mesh. Overriding this method may produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

Parameters:

vertices -

startingIndex -

offsets - The offsets of the vertex attributes.

vertexSize - The size of a vertex in floats.

Returns:

The number of vertices that were added. The value is unused if this is a Batchable.FixedSizeBatchable, as it is assumed to match Batchable.FixedSizeBatchable.getVerticesPerBatchable().

apply

protected abstract int apply(short[] triangles,
                             int startingIndex,
                             short firstVertex)

Called by FlexBatch. Applies the triangle vertex data indices to the array that will be sent to the Mesh. This method is never called on FixedSizeBatchables. Overriding this method may produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

Parameters:

triangles -

startingIndex -

firstVertex - The first vertex value that should be used.

Returns:

The number of triangle indices that were added.