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 interface	Batch.IBatchAttributes

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)
static byte[]	c(Color4 c)
static byte[]	c(float r, float g, float b)
static byte[]	c(float r, float g, float b, float a)
void	destroy(IGL gl)
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	getNumIndices()
int	getNumIndicesWritten()
int	getNumVertices()
int	getNumVerticesWritten()
Batch.IBatchAttributes	getUserAttributes()
boolean	hasColors()
boolean	hasNormals()
boolean	hasTexCoords()
static float[]	n(Vec3 n)
static Batch	newPersistent() Persistent Batch allocating persistent memory, must be destroyed with destroy(IGL)
static Batch	newVolatile() Volatile Batch allocating volatile memory in BufferPool
static float[]	pos(float x, float y, float z)
static float[]	pos(Vec3 vec)
void	putIndex(int index)
void	putIndices()
void	putIndices(int[] indices)
void	putQuadAsTriangles(int i0, int i1, int i2, int i3) Put two triangles: (0,1,2) (0,2,3)
void	putVertex(float[] p, float[] tc, float[] n, byte[] c)
void	putVertex(int numVertex, float[] p, float[] tc, float[] n, byte[] c)
void	render(IGL gl, boolean diffuseTexture, boolean alphaTest) Render the geometry with the specified texture, if any
void	render(IGL gl, boolean diffuseTexture, boolean alphaTest, boolean sdFont, Lights<?> lights)
void	reserve(int numVertices, int numIndices, int polygonType) Reserve the specified vertices and indices for this Batch.
void	rewind() Rewind memory buffer after data are filled
void	setDynamicHint(boolean dynamicHint)
void	setUserAttributes(Batch.IBatchAttributes userAttributes)
static float[]	uv(float u, float v)

Methods inherited from class java.lang.Object

equals, 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(IGL)

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,
                    int polygonType)

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

alloc

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

Allocate the reserved vertices and indices

See Also:

reserve(int, int, int)

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)

putIndex

public void putIndex(int index)

putIndices

public void putIndices(int[] indices)

putIndices

public void putIndices()

putQuadAsTriangles

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

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

rewind

public void 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

getNumIndices

public int getNumIndices()

Returns:

the indices capacity

getNumIndicesWritten

public int getNumIndicesWritten()

Returns:

the number of indices currently written

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(IGL gl)

Specified by:

destroy in interface IDestroyable

render

public void render(IGL gl,
                   boolean diffuseTexture,
                   boolean alphaTest)

Render the geometry with the specified texture, if any

Parameters:

gl -

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

render

public void render(IGL gl,
                   boolean diffuseTexture,
                   boolean alphaTest,
                   boolean sdFont,
                   Lights<?> lights)

pos

public static final float[] pos(float x,
                                float y,
                                float z)

pos

public static final float[] pos(Vec3 vec)

uv

public static final float[] uv(float u,
                               float v)

n

public static final float[] n(Vec3 n)

c

public static final byte[] c(Color4 c)

c

public static final byte[] c(float r,
                             float g,
                             float b)

c

public static final byte[] c(float r,
                             float g,
                             float b,
                             float a)