Class GLArrayDataClient
- java.lang.Object
-
- com.jogamp.opengl.util.GLArrayDataWrapper
-
- com.jogamp.opengl.util.GLArrayDataClient
-
- All Implemented Interfaces:
GLArrayData
,GLArrayDataEditable
- Direct Known Subclasses:
GLArrayDataServer
public class GLArrayDataClient extends GLArrayDataWrapper implements GLArrayDataEditable
-
-
Field Summary
Fields Modifier and Type Field Description static float
DEFAULT_GROWTH_FACTOR
Default growth factor using the golden ratio 1.618-
Fields inherited from class com.jogamp.opengl.util.GLArrayDataWrapper
DEBUG
-
-
Constructor Summary
Constructors Constructor Description GLArrayDataClient(GLArrayDataClient src)
Copy Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
associate(Object obj, boolean enable)
Implementation and type dependent object association.boolean
bindBuffer(GL gl, boolean bind)
ifbind
is true and the data usesVBO
, the latter will be bound and data written to the GPU if required.void
clear()
Clears this buffer and resets states accordingly.void
clear(GL gl)
Clears this buffer and resets states accordingly.int
compsToElemCount(int componentCount)
Returning element-count from given componentCount, rounding up to componentsPerElement.static GLArrayDataClient
createFixed(int index, int comps, int dataType, boolean normalized, int initialElementCount)
Create a client side buffer object, using a predefined fixed function array index and starting with a new created Buffer object with initialElementCount size On profiles GL2 and ES1 the fixed function pipeline behavior is as expected.static GLArrayDataClient
createFixed(int index, int comps, int dataType, boolean normalized, int stride, Buffer buffer)
Create a client side buffer object, using a predefined fixed function array index and starting with a given Buffer object incl it's stride On profiles GL2 and ES1 the fixed function pipeline behavior is as expected.static GLArrayDataClient
createGLSL(String name, int comps, int dataType, boolean normalized, int initialElementCount)
Create a client side buffer object, using a custom GLSL array attribute name and starting with a new created Buffer object with initialElementCount sizestatic GLArrayDataClient
createGLSL(String name, int comps, int dataType, boolean normalized, int stride, Buffer buffer)
Create a client side buffer object, using a custom GLSL array attribute name and starting with a given Buffer object incl it's stridevoid
destroy(GL gl)
void
enableBuffer(GL gl, boolean enable)
Enables the buffer ifenable
istrue
, and transfers the data if required.boolean
enabled()
float
getGrowthFactor()
Returns this buffer's growth factor.boolean
growIfNeeded(int spareComponents)
Increase the capacity of the buffer if necessary to add given spareComponents components.boolean
isVBOWritten()
Is the buffer written to the VBO ?void
padding(int doneInByteSize)
void
put(Buffer v)
Generic buffer relative put method.void
put3b(byte v1, byte v2, byte v3)
void
put3f(float v1, float v2, float v3)
void
put3i(int v1, int v2, int v3)
void
put3s(short v1, short v2, short v3)
void
put4b(byte v1, byte v2, byte v3, byte v4)
void
put4f(float v1, float v2, float v3, float v4)
void
put4i(int v1, int v2, int v3, int v4)
void
put4s(short v1, short v2, short v3, short v4)
void
putb(byte v)
void
putb(byte[] src, int offset, int length)
void
putf(float v)
void
putf(float[] src, int offset, int length)
void
puti(int v)
void
puti(int[] src, int offset, int length)
void
puts(short v)
void
puts(short[] src, int offset, int length)
void
putx(int v)
boolean
reserve(int elementCount)
Increase the capacity of the buffer to given elementCount element size, i.e.void
rewind()
Rewinds this buffer.void
seal(boolean seal)
If seal is true, it disables write operations to the buffer.void
seal(GL gl, boolean seal)
Convenience method callingGLArrayDataEditable.seal(boolean)
andGLArrayDataEditable.enableBuffer(GL, boolean)
.void
setEnableAlways(boolean always)
Affects the behavior of 'enableBuffer'.void
setGrowthFactor(float v)
Sets a new growth factor for this buffer.void
setVBOWritten(boolean written)
Marks the buffer written to the VBOString
toString()
-
Methods inherited from class com.jogamp.opengl.util.GLArrayDataWrapper
bytePosition, createFixed, createFixed, createGLSL, createGLSL, elemPosition, elemStatsToString, fillStatsToString, getBuffer, getBufferClass, getBufferClass, getByteCapacity, getByteCount, getBytesPerComp, getCompsPerElem, getCompType, getElemCapacity, getElemCount, getIndex, getLocation, getName, getNormalized, getStride, getVBOName, getVBOOffset, getVBOTarget, getVBOUsage, isVBO, isVertexAttribute, remainingBytes, remainingElems, sealed, setLocation, setLocation, setLocation, setName, setVBOEnabled, setVBOName, setVBOTarget, setVBOUsage, validate
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.jogamp.opengl.GLArrayData
bytePosition, elemPosition, elemStatsToString, fillStatsToString, getBuffer, getByteCapacity, getByteCount, getBytesPerComp, getCompsPerElem, getCompType, getElemCapacity, getElemCount, getIndex, getLocation, getName, getNormalized, getStride, getVBOName, getVBOOffset, getVBOTarget, getVBOUsage, isVBO, isVertexAttribute, remainingBytes, remainingElems, sealed, setLocation, setLocation, setLocation, setName
-
-
-
-
Field Detail
-
DEFAULT_GROWTH_FACTOR
public static final float DEFAULT_GROWTH_FACTOR
Default growth factor using the golden ratio 1.618- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GLArrayDataClient
public GLArrayDataClient(GLArrayDataClient src)
Copy ConstructorBuffer is
sliced
, i.e. sharing content but using own state.All other values are simply copied.
-
-
Method Detail
-
createFixed
public static GLArrayDataClient createFixed(int index, int comps, int dataType, boolean normalized, int initialElementCount) throws GLException
Create a client side buffer object, using a predefined fixed function array index and starting with a new created Buffer object with initialElementCount size On profiles GL2 and ES1 the fixed function pipeline behavior is as expected. On profile ES2 the fixed function emulation will transform these calls to EnableVertexAttribArray and VertexAttribPointer calls, and a predefined vertex attribute variable name will be chosen. The default name mapping will be used, seeGLPointerFuncUtil.getPredefinedArrayIndexName(int)
.- Parameters:
index
- The GL array indexcomps
- The array component numberdataType
- The array index GL data typenormalized
- Whether the data shall be normalizedinitialElementCount
-- Throws:
GLException
- See Also:
com.jogamp.opengl.GLContext#getPredefinedArrayIndexName(int)
-
createFixed
public static GLArrayDataClient createFixed(int index, int comps, int dataType, boolean normalized, int stride, Buffer buffer) throws GLException
Create a client side buffer object, using a predefined fixed function array index and starting with a given Buffer object incl it's stride On profiles GL2 and ES1 the fixed function pipeline behavior is as expected. On profile ES2 the fixed function emulation will transform these calls to EnableVertexAttribArray and VertexAttribPointer calls, and a predefined vertex attribute variable name will be chosen. The default name mapping will be used, seeGLPointerFuncUtil.getPredefinedArrayIndexName(int)
.- Parameters:
index
- The GL array indexcomps
- The array component numberdataType
- The array index GL data typenormalized
- Whether the data shall be normalizedstride
-buffer
- the user define data- Throws:
GLException
- See Also:
com.jogamp.opengl.GLContext#getPredefinedArrayIndexName(int)
-
createGLSL
public static GLArrayDataClient createGLSL(String name, int comps, int dataType, boolean normalized, int initialElementCount) throws GLException
Create a client side buffer object, using a custom GLSL array attribute name and starting with a new created Buffer object with initialElementCount size- Parameters:
name
- The custom name for the GL attribute.comps
- The array component numberdataType
- The array index GL data typenormalized
- Whether the data shall be normalizedinitialElementCount
-- Throws:
GLException
-
createGLSL
public static GLArrayDataClient createGLSL(String name, int comps, int dataType, boolean normalized, int stride, Buffer buffer) throws GLException
Create a client side buffer object, using a custom GLSL array attribute name and starting with a given Buffer object incl it's stride- Parameters:
name
- The custom name for the GL attribute.comps
- The array component numberdataType
- The array index GL data typenormalized
- Whether the data shall be normalizedstride
-buffer
- the user define data- Throws:
GLException
-
associate
public void associate(Object obj, boolean enable)
Description copied from interface:GLArrayData
Implementation and type dependent object association.One currently known use case is to associate a
ShaderState
to an GLSL aware vertex attribute object, allowing to use the ShaderState to handle it's data persistence, location and state change.
This is implicitly done viashaderState.ownAttribute(GLArrayData, boolean)
.- Specified by:
associate
in interfaceGLArrayData
- Overrides:
associate
in classGLArrayDataWrapper
- Parameters:
obj
- implementation and type dependent associationenable
- pass true to enable the association and false to disable it.
-
isVBOWritten
public final boolean isVBOWritten()
Description copied from interface:GLArrayDataEditable
Is the buffer written to the VBO ?- Specified by:
isVBOWritten
in interfaceGLArrayDataEditable
-
enabled
public final boolean enabled()
- Specified by:
enabled
in interfaceGLArrayDataEditable
-
setVBOWritten
public final void setVBOWritten(boolean written)
Description copied from interface:GLArrayDataEditable
Marks the buffer written to the VBO- Specified by:
setVBOWritten
in interfaceGLArrayDataEditable
-
destroy
public void destroy(GL gl)
- Specified by:
destroy
in interfaceGLArrayData
- Specified by:
destroy
in interfaceGLArrayDataEditable
- Overrides:
destroy
in classGLArrayDataWrapper
-
clear
public void clear(GL gl)
Description copied from interface:GLArrayDataEditable
Clears this buffer and resets states accordingly.Implementation calls
seal(gl, false)
andGLArrayDataEditable.clear()
, i.e. turns-off the GL buffer and then clearing it.The position is set to zero, the limit is set to the capacity, and the mark is discarded.
Invoke this method before using a sequence of get or put operations to fill this buffer.
This method does not actually erase the data in the buffer and will most often be used when erasing the underlying memory is suitable.
- Specified by:
clear
in interfaceGLArrayDataEditable
- See Also:
GLArrayDataEditable.seal(GL, boolean)
,GLArrayDataEditable.clear()
-
seal
public void seal(GL gl, boolean seal)
Description copied from interface:GLArrayDataEditable
Convenience method callingGLArrayDataEditable.seal(boolean)
andGLArrayDataEditable.enableBuffer(GL, boolean)
.- Specified by:
seal
in interfaceGLArrayDataEditable
- See Also:
GLArrayDataEditable.seal(boolean)
,GLArrayDataEditable.enableBuffer(GL, boolean)
-
enableBuffer
public void enableBuffer(GL gl, boolean enable)
Description copied from interface:GLArrayDataEditable
Enables the buffer ifenable
istrue
, and transfers the data if required. In caseVBO is used
, it is bound accordingly for the data transfer and association, i.e. it issuedGLArrayDataEditable.bindBuffer(GL, boolean)
. The VBO buffer is unbound when the method returns.Disables the buffer if
enable
isfalse
.The action will only be executed, if the internal enable state differs, or 'setEnableAlways' was called with 'true'.
It is up to the user to enable/disable the array properly, ie in case of multiple data sets for the same vertex attribute (VA). Meaning in such case usage of one set while expecting another one to be used for the same VA implies decorating each usage with enable/disable.
- Specified by:
enableBuffer
in interfaceGLArrayDataEditable
- See Also:
GLArrayDataEditable.setEnableAlways(boolean)
-
bindBuffer
public boolean bindBuffer(GL gl, boolean bind)
Description copied from interface:GLArrayDataEditable
ifbind
is true and the data usesVBO
, the latter will be bound and data written to the GPU if required.If
bind
is false and the data usesVBO
, the latter will be unbound.This method is exposed to allow data VBO arrays, i.e.
GL.GL_ELEMENT_ARRAY_BUFFER
, to be bounded and written while keeping the VBO bound. The latter is in contrast toGLArrayDataEditable.enableBuffer(GL, boolean)
, which leaves the VBO unbound, since it's not required for vertex attributes or pointers.- Specified by:
bindBuffer
in interfaceGLArrayDataEditable
- Parameters:
gl
- current GL objectbind
- true if VBO shall be bound and data written, otherwise clear VBO binding.- Returns:
- true if data uses VBO and action was performed, otherwise false
-
setEnableAlways
public void setEnableAlways(boolean always)
Description copied from interface:GLArrayDataEditable
Affects the behavior of 'enableBuffer'. The default is 'false' This is useful when you mix up GLArrayData usage with conventional GL array calls or in case of a buggy GL VBO implementation.- Specified by:
setEnableAlways
in interfaceGLArrayDataEditable
- See Also:
GLArrayDataEditable.enableBuffer(GL, boolean)
-
clear
public void clear()
Description copied from interface:GLArrayDataEditable
Clears this buffer and resets states accordingly.The position is set to zero, the limit is set to the capacity, and the mark is discarded.
Invoke this method before using a sequence of get or put operations to fill this buffer.
This method does not actually erase the data in the buffer and will most often be used when erasing the underlying memory is suitable.
- Specified by:
clear
in interfaceGLArrayDataEditable
- See Also:
GLArrayDataEditable.clear(GL)
-
seal
public void seal(boolean seal)
Description copied from interface:GLArrayDataEditable
If seal is true, it disables write operations to the buffer. Calls flip, ie limit:=position and position:=0.
If seal is false, it enable write operations continuing at the buffer position, where you left off at seal(true), ie position:=limit and limit:=capacity.
- Specified by:
seal
in interfaceGLArrayDataEditable
- See Also:
GLArrayDataEditable.seal(boolean)
,GLArrayData.sealed()
-
rewind
public void rewind()
Description copied from interface:GLArrayDataEditable
Rewinds this buffer. The position is set to zero and the mark is discarded.Invoke this method before a sequence of put or get operations.
- Specified by:
rewind
in interfaceGLArrayDataEditable
-
padding
public void padding(int doneInByteSize)
- Specified by:
padding
in interfaceGLArrayDataEditable
-
put
public void put(Buffer v)
Generic buffer relative put method. This class buffer Class must match the arguments buffer class. The arguments remaining elements must be a multiple of this arrays element stride.- Specified by:
put
in interfaceGLArrayDataEditable
-
putb
public void putb(byte v)
- Specified by:
putb
in interfaceGLArrayDataEditable
-
put3b
public void put3b(byte v1, byte v2, byte v3)
- Specified by:
put3b
in interfaceGLArrayDataEditable
-
put4b
public void put4b(byte v1, byte v2, byte v3, byte v4)
- Specified by:
put4b
in interfaceGLArrayDataEditable
-
putb
public void putb(byte[] src, int offset, int length)
- Specified by:
putb
in interfaceGLArrayDataEditable
-
puts
public void puts(short v)
- Specified by:
puts
in interfaceGLArrayDataEditable
-
put3s
public void put3s(short v1, short v2, short v3)
- Specified by:
put3s
in interfaceGLArrayDataEditable
-
put4s
public void put4s(short v1, short v2, short v3, short v4)
- Specified by:
put4s
in interfaceGLArrayDataEditable
-
puts
public void puts(short[] src, int offset, int length)
- Specified by:
puts
in interfaceGLArrayDataEditable
-
puti
public void puti(int v)
- Specified by:
puti
in interfaceGLArrayDataEditable
-
put3i
public void put3i(int v1, int v2, int v3)
- Specified by:
put3i
in interfaceGLArrayDataEditable
-
put4i
public void put4i(int v1, int v2, int v3, int v4)
- Specified by:
put4i
in interfaceGLArrayDataEditable
-
puti
public void puti(int[] src, int offset, int length)
- Specified by:
puti
in interfaceGLArrayDataEditable
-
putx
public void putx(int v)
- Specified by:
putx
in interfaceGLArrayDataEditable
-
putf
public void putf(float v)
- Specified by:
putf
in interfaceGLArrayDataEditable
-
put3f
public void put3f(float v1, float v2, float v3)
- Specified by:
put3f
in interfaceGLArrayDataEditable
-
put4f
public void put4f(float v1, float v2, float v3, float v4)
- Specified by:
put4f
in interfaceGLArrayDataEditable
-
putf
public void putf(float[] src, int offset, int length)
- Specified by:
putf
in interfaceGLArrayDataEditable
-
toString
public String toString()
- Specified by:
toString
in interfaceGLArrayData
- Overrides:
toString
in classGLArrayDataWrapper
-
compsToElemCount
public int compsToElemCount(int componentCount)
Returning element-count from given componentCount, rounding up to componentsPerElement.
-
growIfNeeded
public final boolean growIfNeeded(int spareComponents)
Increase the capacity of the buffer if necessary to add given spareComponents components.Buffer will not change if remaining free slots, capacity less position, satisfy spareComponents components.
- Parameters:
spareComponents
- number of components to add if necessary.- Returns:
- true if buffer size has changed, i.e. grown. Otherwise false.
-
reserve
public final boolean reserve(int elementCount)
Increase the capacity of the buffer to given elementCount element size, i.e. elementCount * componentsPerElement components.Buffer will not change if given elementCount is lower or equal current capacity.
- Parameters:
elementCount
- number of elements to hold.- Returns:
- true if buffer size has changed, i.e. grown. Otherwise false.
-
getGrowthFactor
public float getGrowthFactor()
Returns this buffer's growth factor.Default is
DEFAULT_GROWTH_FACTOR
, i.e. the golden ratio 1.618.- See Also:
setGrowthFactor(float)
,DEFAULT_GROWTH_FACTOR
-
setGrowthFactor
public void setGrowthFactor(float v)
Sets a new growth factor for this buffer.Default is
DEFAULT_GROWTH_FACTOR
, i.e. the golden ratio 1.618.- Parameters:
v
- new growth factor, which will be clipped to a minimum of 1, i.e. 0% minimum growth.- See Also:
getGrowthFactor()
,DEFAULT_GROWTH_FACTOR
-
-