com.jme3.shader

Class BufferObject

java.lang.Object

com.jme3.util.NativeObject

com.jme3.shader.BufferObject

All Implemented Interfaces:

java.lang.Cloneable

public class BufferObject
extends NativeObject

The base implementation of BO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BufferObject.BufferType
static class	BufferObject.Layout

Field Summary

Fields inherited from class com.jme3.util.NativeObject

handleRef, id, INVALID_ID, objectManager, OBJTYPE_AUDIOBUFFER, OBJTYPE_AUDIOSTREAM, OBJTYPE_BO, OBJTYPE_FILTER, OBJTYPE_FRAMEBUFFER, OBJTYPE_SHADER, OBJTYPE_SHADERSOURCE, OBJTYPE_TEXTURE, OBJTYPE_VERTEXBUFFER, updateNeeded

Constructor Summary

Constructors

Constructor and Description
BufferObject()
BufferObject(BufferObject.BufferType bufferType)
BufferObject(BufferObject.Layout layout)
BufferObject(int binding)
BufferObject(int binding, BufferObject.BufferType bufferType)
BufferObject(int binding, BufferObject.Layout layout)
BufferObject(int binding, BufferObject.Layout layout, BufferObject.BufferType bufferType)

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	computeData(int maxSize) Computes the current binary data of this BO.
NativeObject	createDestructableClone() Creates a shallow clone of this GL Object.
void	declareField(java.lang.String name, VarType varType) Declares a filed in this BO.
protected void	deleteNativeBuffers() Deletes any associated native buffers.
void	deleteObject(java.lang.Object rendererObject) Deletes the GL object from the GPU when it is no longer used.
protected int	estimate(float[] values) Estimates byte count to present the values on the GPU.
protected int	estimate(int[] values) Estimates byte count to present the values on the GPU.
protected int	estimateArray(java.lang.Object value, int multiplier) Estimates byte count to present the value on the GPU.
protected int	estimateSize(BufferObjectField field) Estimates size of the field.
int	getBinding() Get the binding number.
BufferObject.BufferType	getBufferType() Gets the buffer's type.
<T> T	getFieldValue(java.lang.String name) Gets the current value of the field by the name.
long	getUniqueId() Returns a unique ID for this NativeObject.
protected static VarType	getVarTypeByValue(java.lang.Object value)
void	resetObject() Called when the GL context is restarted to reset all IDs.
void	setBufferType(BufferObject.BufferType bufferType) Sets the buffer's type.
void	setFieldValue(java.lang.String name, java.lang.Object value) Sets the value to the filed by the field's name.
protected void	write(java.nio.ByteBuffer data, float[] value) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, float x, float y, float z) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, float x, float y, float z, float w) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, int[] value) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, Matrix3f value) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, Matrix4f value) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, Vector2f value) Writes the value to the data buffer.
protected void	write(java.nio.ByteBuffer data, Vector3f value) Writes the value to the data buffer.
protected void	writeField(BufferObjectField field, java.nio.ByteBuffer data) Writes the field to the data buffer.
protected void	writeMat3Array(java.nio.ByteBuffer data, java.lang.Object value) Writes the value to the data buffer.
protected void	writeMat4Array(java.nio.ByteBuffer data, java.lang.Object value) Writes the value to the data buffer.
protected void	writeVec2Array(java.nio.ByteBuffer data, java.lang.Object value) Writes the value to the data buffer.
protected void	writeVec3Array(java.nio.ByteBuffer data, java.lang.Object value) Writes the value to the data buffer.
protected void	writeVec4(java.nio.ByteBuffer data, java.lang.Object value) Writes the value to the data buffer.
protected void	writeVec4Array(java.nio.ByteBuffer data, java.lang.Object value) Writes the value to the data buffer.

Methods inherited from class com.jme3.util.NativeObject

clearUpdateNeeded, clone, dispose, getId, getWeakRef, isUpdateNeeded, setId, setUpdateNeeded, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferObject

public BufferObject(int binding,
                    BufferObject.Layout layout,
                    BufferObject.BufferType bufferType)

BufferObject

public BufferObject(int binding,
                    BufferObject.Layout layout)

BufferObject

public BufferObject(int binding,
                    BufferObject.BufferType bufferType)

BufferObject

public BufferObject(BufferObject.BufferType bufferType)

BufferObject

public BufferObject(BufferObject.Layout layout)

BufferObject

public BufferObject(int binding)

BufferObject

public BufferObject()

Method Detail

getVarTypeByValue

protected static VarType getVarTypeByValue(java.lang.Object value)

declareField

public void declareField(java.lang.String name,
                         VarType varType)

Declares a filed in this BO.

Parameters:

name - the field's name.

varType - the field's type.

getBufferType

public BufferObject.BufferType getBufferType()

Gets the buffer's type.

Returns:

the buffer's type.

setBufferType

public void setBufferType(BufferObject.BufferType bufferType)

Sets the buffer's type.

Parameters:

bufferType - the buffer's type.

setFieldValue

public void setFieldValue(java.lang.String name,
                          java.lang.Object value)

Sets the value to the filed by the field's name.

Parameters:

name - the field's name.

value - the value.

getFieldValue

public <T> T getFieldValue(java.lang.String name)

Gets the current value of the field by the name.

Type Parameters:

T - the value's type.

Parameters:

name - the field name.

Returns:

the current value.

getBinding

public int getBinding()

Get the binding number.

Returns:

the binding number.

resetObject

public void resetObject()

Description copied from class: NativeObject

Called when the GL context is restarted to reset all IDs. Prevents "white textures" on display restart.

Specified by:

resetObject in class NativeObject

computeData

public java.nio.ByteBuffer computeData(int maxSize)

Computes the current binary data of this BO.

Parameters:

maxSize - the max data size.

Returns:

the current binary data of this BO.

estimateSize

protected int estimateSize(BufferObjectField field)

Estimates size of the field.

Parameters:

field - the field.

Returns:

the estimated size.

estimateArray

protected int estimateArray(java.lang.Object value,
                            int multiplier)

Estimates byte count to present the value on the GPU.

Parameters:

value - the value.

multiplier - the multiplier.

Returns:

the estimated byte count.

estimate

protected int estimate(float[] values)

Estimates byte count to present the values on the GPU.

Parameters:

values - the values.

Returns:

the estimated byte count.

estimate

protected int estimate(int[] values)

Estimates byte count to present the values on the GPU.

Parameters:

values - the values.

Returns:

the estimated byte count.

writeField

protected void writeField(BufferObjectField field,
                          java.nio.ByteBuffer data)

Writes the field to the data buffer.

Parameters:

field - the field.

data - the data buffer.

writeMat3Array

protected void writeMat3Array(java.nio.ByteBuffer data,
                              java.lang.Object value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

writeMat4Array

protected void writeMat4Array(java.nio.ByteBuffer data,
                              java.lang.Object value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

writeVec4Array

protected void writeVec4Array(java.nio.ByteBuffer data,
                              java.lang.Object value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

writeVec3Array

protected void writeVec3Array(java.nio.ByteBuffer data,
                              java.lang.Object value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

writeVec2Array

protected void writeVec2Array(java.nio.ByteBuffer data,
                              java.lang.Object value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

write

protected void write(java.nio.ByteBuffer data,
                     float[] value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

write

protected void write(java.nio.ByteBuffer data,
                     int[] value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

writeVec4

protected void writeVec4(java.nio.ByteBuffer data,
                         java.lang.Object value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

write

protected void write(java.nio.ByteBuffer data,
                     Vector3f value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

write

protected void write(java.nio.ByteBuffer data,
                     float x,
                     float y,
                     float z)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

x - the x value.

y - the y value.

z - the z value.

write

protected void write(java.nio.ByteBuffer data,
                     float x,
                     float y,
                     float z,
                     float w)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

x - the x value.

y - the y value.

z - the z value.

w - the w value.

write

protected void write(java.nio.ByteBuffer data,
                     Vector2f value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

write

protected void write(java.nio.ByteBuffer data,
                     Matrix3f value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

write

protected void write(java.nio.ByteBuffer data,
                     Matrix4f value)

Writes the value to the data buffer.

Parameters:

data - the data buffer.

value - the value.

deleteObject

public void deleteObject(java.lang.Object rendererObject)

Description copied from class: NativeObject

Deletes the GL object from the GPU when it is no longer used. Called automatically by the GL object manager.

Specified by:

deleteObject in class NativeObject

Parameters:

rendererObject - The renderer to be used to delete the object

createDestructableClone

public NativeObject createDestructableClone()

Description copied from class: NativeObject

Creates a shallow clone of this GL Object. The deleteObject method should be functional for this object.

Specified by:

createDestructableClone in class NativeObject

Returns:

a new instance

deleteNativeBuffers

protected void deleteNativeBuffers()

Description copied from class: NativeObject

Deletes any associated native buffers. This is necessary because it is unlikely that native buffers will be garbage collected naturally (due to how GC works), therefore the collection must be handled manually. Only implementations that manage native buffers need to override this method. Note that the behavior that occurs when a deleted native buffer is used is not defined, therefore this method is protected

Overrides:

deleteNativeBuffers in class NativeObject

getUniqueId

public long getUniqueId()

Description copied from class: NativeObject

Returns a unique ID for this NativeObject. No other NativeObject shall have the same ID.

Specified by:

getUniqueId in class NativeObject

Returns:

unique ID for this NativeObject.