org.andengine.opengl.vbo

Class VertexBufferObject

java.lang.Object

org.andengine.opengl.vbo.VertexBufferObject

All Implemented Interfaces:

IVertexBufferObject, IDisposable

Direct Known Subclasses:

HighPerformanceVertexBufferObject, LowMemoryVertexBufferObject, TextureWarmUpVertexBufferObject

public abstract class VertexBufferObject
extends java.lang.Object
implements IVertexBufferObject

TODO Extract a common base class from VertexBufferObject and ZeroMemoryVertexBufferObject (due to significant code duplication). For naming, maybe be inspired by the java ByteBuffer naming (i.e. HeapBackedFloatArrayVertexBufferObject, StreamBufferVertexBufferObject, SharedBufferStreamVertexBufferObject). (c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

14:22:56 - 07.04.2010

Nested Class Summary

Nested classes/interfaces inherited from interface org.andengine.util.IDisposable

IDisposable.AlreadyDisposedException

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mAutoDispose
protected java.nio.ByteBuffer	mByteBuffer
protected int	mCapacity
protected boolean	mDirtyOnHardware
protected boolean	mDisposed
protected int	mHardwareBufferID
protected int	mUsage
protected VertexBufferObjectAttributes	mVertexBufferObjectAttributes
protected VertexBufferObjectManager	mVertexBufferObjectManager

Fields inherited from interface org.andengine.opengl.vbo.IVertexBufferObject

HARDWARE_BUFFER_ID_INVALID

Constructor Summary

Constructors

Constructor and Description
VertexBufferObject(VertexBufferObjectManager pVertexBufferObjectManager, int pCapacity, DrawType pDrawType, boolean pAutoDispose, VertexBufferObjectAttributes pVertexBufferObjectAttributes)

Method Summary

Modifier and Type	Method and Description
void	bind(GLState pGLState)
void	bind(GLState pGLState, ShaderProgram pShaderProgram)
void	dispose()
void	draw(int pPrimitiveType, int pCount)
void	draw(int pPrimitiveType, int pOffset, int pCount)
protected void	finalize()
int	getByteCapacity()
int	getCapacity()
int	getGPUMemoryByteSize()
int	getHardwareBufferID()
VertexBufferObjectManager	getVertexBufferObjectManager()
boolean	isAutoDispose()
boolean	isDirtyOnHardware()
boolean	isDisposed()
boolean	isLoadedToHardware()
protected abstract void	onBufferData()
void	setDirtyOnHardware() Mark this VertexBufferObject dirty so it gets updated on the hardware.
void	setNotLoadedToHardware() Mark this VertexBufferObject as not not loaded to hardware.
void	unbind(GLState pGLState, ShaderProgram pShaderProgram)
void	unloadFromHardware(GLState pGLState)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.andengine.opengl.vbo.IVertexBufferObject

getHeapMemoryByteSize, getNativeHeapMemoryByteSize

Field Detail

mCapacity

protected final int mCapacity

mAutoDispose

protected final boolean mAutoDispose

mUsage

protected final int mUsage

mByteBuffer

protected final java.nio.ByteBuffer mByteBuffer

mHardwareBufferID

protected int mHardwareBufferID

mDirtyOnHardware

protected boolean mDirtyOnHardware

mDisposed

protected boolean mDisposed

mVertexBufferObjectManager

protected final VertexBufferObjectManager mVertexBufferObjectManager

mVertexBufferObjectAttributes

protected final VertexBufferObjectAttributes mVertexBufferObjectAttributes

Constructor Detail

VertexBufferObject

public VertexBufferObject(VertexBufferObjectManager pVertexBufferObjectManager,
                          int pCapacity,
                          DrawType pDrawType,
                          boolean pAutoDispose,
                          VertexBufferObjectAttributes pVertexBufferObjectAttributes)

Parameters:

pVertexBufferObjectManager - (Optional, if you manage reloading on your own.)

pCapacity -

pDrawType -

pAutoDispose - when passing true this VertexBufferObject loads itself to the active VertexBufferObjectManager. WARNING: When passing false one needs to take care of that by oneself!

pVertexBufferObjectAttributes - to be automatically enabled on the ShaderProgram used in VertexBufferObject#bind(ShaderProgram).

Method Detail

getVertexBufferObjectManager

public VertexBufferObjectManager getVertexBufferObjectManager()

Specified by:

getVertexBufferObjectManager in interface IVertexBufferObject

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface IDisposable

isAutoDispose

public boolean isAutoDispose()

Specified by:

isAutoDispose in interface IVertexBufferObject

getHardwareBufferID

public int getHardwareBufferID()

Specified by:

getHardwareBufferID in interface IVertexBufferObject

isLoadedToHardware

public boolean isLoadedToHardware()

Specified by:

isLoadedToHardware in interface IVertexBufferObject

setNotLoadedToHardware

public void setNotLoadedToHardware()

Description copied from interface: IVertexBufferObject

Mark this VertexBufferObject as not not loaded to hardware. It will reload itself to hardware when it gets used again.

Specified by:

setNotLoadedToHardware in interface IVertexBufferObject

isDirtyOnHardware

public boolean isDirtyOnHardware()

Specified by:

isDirtyOnHardware in interface IVertexBufferObject

setDirtyOnHardware

public void setDirtyOnHardware()

Description copied from interface: IVertexBufferObject

Mark this VertexBufferObject dirty so it gets updated on the hardware.

Specified by:

setDirtyOnHardware in interface IVertexBufferObject

getCapacity

public int getCapacity()

Specified by:

getCapacity in interface IVertexBufferObject

Returns:

the number of floats that fit into this IVertexBufferObject.

getByteCapacity

public int getByteCapacity()

Specified by:

getByteCapacity in interface IVertexBufferObject

Returns:

the number of bytes that fit into this IVertexBufferObject.

getGPUMemoryByteSize

public int getGPUMemoryByteSize()

Specified by:

getGPUMemoryByteSize in interface IVertexBufferObject

Returns:

the number of bytes that are allocated on the GPU.

onBufferData

protected abstract void onBufferData()

bind

public void bind(GLState pGLState)

Specified by:

bind in interface IVertexBufferObject

bind

public void bind(GLState pGLState,
                 ShaderProgram pShaderProgram)

Specified by:

bind in interface IVertexBufferObject

unbind

public void unbind(GLState pGLState,
                   ShaderProgram pShaderProgram)

Specified by:

unbind in interface IVertexBufferObject

unloadFromHardware

public void unloadFromHardware(GLState pGLState)

Specified by:

unloadFromHardware in interface IVertexBufferObject

draw

public void draw(int pPrimitiveType,
                 int pCount)

Specified by:

draw in interface IVertexBufferObject

draw

public void draw(int pPrimitiveType,
                 int pOffset,
                 int pCount)

Specified by:

draw in interface IVertexBufferObject

dispose

public void dispose()

Specified by:

dispose in interface IDisposable

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable