JOGL 2.3.2 · com.jogamp.opengl.util.GLArrayDataEditable

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if data uses VBO and action was performed, otherwise false bindBuffer(GL current GL object gl, boolean true if VBO shall be bound and data written, otherwise clear VBO binding. bind) if `bind` is true and the data uses `VBO`, the latter will be bound and data written to the GPU if required.
public void	destroy(GL gl) Redeclares com.jogamp.opengl.GLArrayData.destroy.
public void	enableBuffer(GL gl, boolean enable) Enables the buffer if `enable` is `true`, and transfers the data if required.
public boolean	enabled()
public boolean	isVBOWritten() Is the buffer written to the VBO ?
public void	padding(int doneInByteSize)
public void	put(Buffer v)
public void	putb(byte v)
public void	putf(float v)
public void	puti(int v)
public void	puts(short v)
public void	putx(int v)
public void	reset(GL gl)
public void	reset()
public void	rewind()
public void	seal(GL gl, boolean seal) Convenience method calling `seal(boolean)` and `enableBuffer(GL, boolean)`.
public void	seal(boolean seal) If seal is true, it disables write operations to the buffer.
public boolean	sealed()
public void	setEnableAlways(boolean always) Affects the behavior of 'enableBuffer'.
public void	setVBOWritten(boolean written) Marks the buffer written to the VBO

Method Detail

bindBuffer back to summary

bindBuffer	back to summary
public boolean bindBuffer(GL gl, boolean bind) if `bind` is true and the data uses `VBO`, the latter will be bound and data written to the GPU if required. If `bind` is false and the data uses `VBO`, 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 to `enableBuffer(GL, boolean)`, which leaves the VBO unbound, since it's not required for vertex attributes or pointers. Parameters gl:GL current GL object bind:boolean true if VBO shall be bound and data written, otherwise clear VBO binding. Returns:boolean true if data uses VBO and action was performed, otherwise false

public boolean bindBuffer(GL gl, boolean bind)

if bind is true and the data uses VBO, the latter will be bound and data written to the GPU if required.

If bind is false and the data uses VBO, 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 to enableBuffer(GL, boolean), which leaves the VBO unbound, since it's not required for vertex attributes or pointers.

Parameters

gl:GL: current GL object
bind:boolean: true if VBO shall be bound and data written, otherwise clear VBO binding.

Returns:boolean

true if data uses VBO and action was performed, otherwise false

destroy	back to summary
public void destroy(GL gl) Redeclares com.jogamp.opengl.GLArrayData.destroy. Annotations @Override

destroy

back to summary

public void destroy(GL gl)

Redeclares com.jogamp.opengl.GLArrayData.destroy.

Annotations

@Override

enableBuffer back to summary

enableBuffer	back to summary
public void enableBuffer(GL gl, boolean enable) Enables the buffer if `enable` is `true`, and transfers the data if required. In case `VBO is used`, it is bound accordingly for the data transfer and association, i.e. it issued `bindBuffer(GL, boolean)`. The VBO buffer is unbound when the method returns. Disables the buffer if `enable` is `false`. 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. See Also `setEnableAlways(boolean)`

public void enableBuffer(GL gl, boolean enable)

Enables the buffer if enable is true, and transfers the data if required. In case VBO is used, it is bound accordingly for the data transfer and association, i.e. it issued bindBuffer(GL, boolean). The VBO buffer is unbound when the method returns.

Disables the buffer if enable is false.

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.

See Also: setEnableAlways(boolean)

enabled	back to summary
public boolean enabled()

isVBOWritten	back to summary
public boolean isVBOWritten() Is the buffer written to the VBO ?

padding	back to summary
public void padding(int doneInByteSize)

put	back to summary
public void put(Buffer v)

putb	back to summary
public void putb(byte v)

putf	back to summary
public void putf(float v)

puti	back to summary
public void puti(int v)

puts	back to summary
public void puts(short v)

putx	back to summary
public void putx(int v)

reset	back to summary
public void reset(GL gl)

reset	back to summary
public void reset()

rewind	back to summary
public void rewind()

seal back to summary

seal	back to summary
public void seal(GL gl, boolean seal) Convenience method calling `seal(boolean)` and `enableBuffer(GL, boolean)`. See Also `seal(boolean)`, `enableBuffer(GL, boolean)`

public void seal(GL gl, boolean seal)

Convenience method calling seal(boolean) and enableBuffer(GL, boolean).

See Also: seal(boolean), enableBuffer(GL, boolean)

seal back to summary

seal	back to summary
public void seal(boolean seal) 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. See Also `seal(boolean)`

public void seal(boolean seal)

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.

See Also: seal(boolean)

sealed	back to summary
public boolean sealed()

setEnableAlways back to summary

setEnableAlways	back to summary
public void setEnableAlways(boolean always) 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. See Also `enableBuffer(GL, boolean)`

public void setEnableAlways(boolean always)

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.

See Also: enableBuffer(GL, boolean)

setVBOWritten	back to summary
public void setVBOWritten(boolean written) Marks the buffer written to the VBO

public Interface GLArrayDataEditable

Method Summary

Method Detail