com.bonzaiengine.renderer

Class Batch

java.lang.Object

com.bonzaiengine.renderer.Batch

All Implemented Interfaces:

IDestroyable

public final class Batch
extends java.lang.Object
implements IDestroyable

Utility to create temporary or persistent geometry.
Temporary geometry will be create from BufferPool memory, meaning no allocation (BufferPool is pre-allocated).
Batch is rendered efficiently and can be rendered with hardware instancing (requires GLApiExt.instancing).
Batch class offers low level rendering methods for rendering with simple shading or with a specified Shader.
For advanced material rendering, Batch is also integrated in the rendering pipeline Renderer.render(Batch, com.bonzaiengine.math.Transform, com.bonzaiengine.material.IMaterial, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Batch.CreateType
static interface	Batch.IBatchAttributes
static class	Batch.PolygonType

Method Summary

Modifier and Type	Method and Description
void	alloc(boolean hasUv, boolean hasNrm, boolean hasClr) Allocate the reserved vertices and indices
void	alloc(int numUv, boolean hasNrm, boolean hasClr)
void	destroy(IGLApi glApi)
void	disableColors() Disable colors
void	disableNormals() Disable normals
void	disableTexCoords() Disable texture coordinates
void	enableColors() Enable colors
void	enableNormals() Enable normals
void	enableTexCoords() Enable texture coordinates
void	free() Free memory buffers
int	getNumIndicesToRender()
int	getNumVertices()
int	getNumVerticesToRender()
int	getNumVerticesWritten()
Batch.IBatchAttributes	getUserAttributes()
boolean	hasColors()
boolean	hasNormals()
boolean	hasTexCoords()
boolean	isAllocated()
static Batch	newPersistent() Persistent Batch allocating persistent memory, must be destroyed with destroy(IGLApi)
static Batch	newVolatile() Volatile Batch allocating volatile memory in BufferPool
void	putLine(int i0, int i1)
void	putLineLoop()
void	putLines()
void	putLineStrip()
void	putPatch(int... indices)
void	putPoint(int index)
void	putPoints()
void	putQuadAsTriangle(int i0, int i1, int i2, int i3) Put two triangles: (0,1,2) (0,2,3)
void	putTriangle(int i0, int i1, int i2)
void	putTriangleFan()
void	putTriangles()
void	putTriangleStrip()
void	putVertex(float[] p, float[] tc, float[] n, byte[] c)
void	putVertex(int numVertex, float[] p, float[] tc, float[] n, byte[] c)
void	render(IGLApi glApi, boolean diffuseTexture, boolean alphaTest) Render the geometry with the specified texture, if any
void	render(IGLApi glApi, boolean diffuseTexture, boolean alphaTest, boolean sdFont, Lights<?> lights)
void	reserve(int numVertices, int numIndices, Batch.PolygonType polygonType) Reserve the specified vertices and indices for this Batch.
boolean	rewind() Rewind memory buffer after data are filled
void	setDynamicHint(boolean dynamicHint)
void	setUserAttributes(Batch.IBatchAttributes userAttributes)

Methods inherited from class java.lang.Object

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

Method Detail

newPersistent

public static final Batch newPersistent()

Persistent Batch allocating persistent memory, must be destroyed with destroy(IGLApi)

Returns:

a new persistent Batch

newVolatile

public static final Batch newVolatile()

Volatile Batch allocating volatile memory in BufferPool

Returns:

a new volatile Batch

setDynamicHint

public void setDynamicHint(boolean dynamicHint)

Parameters:

dynamicHint - true to specified this Batch may be dynamically updated
Hint used for internal performance enhancements

setUserAttributes

public void setUserAttributes(Batch.IBatchAttributes userAttributes)

getUserAttributes

public Batch.IBatchAttributes getUserAttributes()

reserve

public void reserve(int numVertices,
                    int numIndices,
                    Batch.PolygonType polygonType)

Reserve the specified vertices and indices for this Batch.
Multiple call will appends, and check the polygonType is the same

isAllocated

public boolean isAllocated()

alloc

public void alloc(boolean hasUv,
                  boolean hasNrm,
                  boolean hasClr)

Allocate the reserved vertices and indices

See Also:

reserve(int, int, PolygonType)

alloc

public void alloc(int numUv,
                  boolean hasNrm,
                  boolean hasClr)

putVertex

public void putVertex(float[] p,
                      float[] tc,
                      float[] n,
                      byte[] c)

putVertex

public void putVertex(int numVertex,
                      float[] p,
                      float[] tc,
                      float[] n,
                      byte[] c)

putPoint

public void putPoint(int index)

putPoints

public void putPoints()

putLine

public void putLine(int i0,
                    int i1)

putLines

public void putLines()

putLineLoop

public void putLineLoop()

putLineStrip

public void putLineStrip()

putTriangle

public void putTriangle(int i0,
                        int i1,
                        int i2)

putTriangles

public void putTriangles()

putTriangleFan

public void putTriangleFan()

putTriangleStrip

public void putTriangleStrip()

putQuadAsTriangle

public void putQuadAsTriangle(int i0,
                              int i1,
                              int i2,
                              int i3)

Put two triangles: (0,1,2) (0,2,3)

putPatch

public void putPatch(int... indices)

rewind

public boolean rewind()

Rewind memory buffer after data are filled

free

public void free()

Free memory buffers

getNumVertices

public int getNumVertices()

Returns:

the vertices capacity

getNumVerticesWritten

public int getNumVerticesWritten()

Returns:

the number of vertices currently written

getNumVerticesToRender

public int getNumVerticesToRender()

getNumIndicesToRender

public int getNumIndicesToRender()

hasTexCoords

public boolean hasTexCoords()

Returns:

true if texture coordinates are available for the current batch

hasNormals

public boolean hasNormals()

Returns:

true if normals are available for the current batch

hasColors

public boolean hasColors()

Returns:

true if colors is available for the current batch

disableTexCoords

public void disableTexCoords()

Disable texture coordinates

enableTexCoords

public void enableTexCoords()

Enable texture coordinates

Throws:

java.lang.IllegalStateException - if hasTexCoords() return false

disableNormals

public void disableNormals()

Disable normals

enableNormals

public void enableNormals()

Enable normals

Throws:

java.lang.IllegalStateException - if hasNormals() return false

disableColors

public void disableColors()

Disable colors

enableColors

public void enableColors()

Enable colors

Throws:

java.lang.IllegalStateException - if hasColors() return false

destroy

public void destroy(IGLApi glApi)

Specified by:

destroy in interface IDestroyable

render

public void render(IGLApi glApi,
                   boolean diffuseTexture,
                   boolean alphaTest)

Render the geometry with the specified texture, if any

Parameters:

diffuseTexture - reference of the texture already binded, or null if not textures

render

public void render(IGLApi glApi,
                   boolean diffuseTexture,
                   boolean alphaTest,
                   boolean sdFont,
                   Lights<?> lights)