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

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	GLPixelBuffer.DefaultGLPixelBufferProvider
public static class	GLPixelBuffer.GLPixelAttributes Pixel attributes.
public static interface	GLPixelBuffer.GLPixelBufferProvider Allows user to interface with another toolkit to define `GLPixelAttributes` and memory buffer to produce `TextureData`.
public static interface	GLPixelBuffer.SingletonGLPixelBufferProvider Single `GLPixelBuffer` provider.

Modifier and Type	Field and Description
public final boolean	allowRowStride Allow `GL2ES3#GL_PACK_ROW_LENGTH`, or `GL2ES2#GL_UNPACK_ROW_LENGTH`.
public final Buffer	buffer Buffer holding the pixel data.
public final int	bufferElemSize Buffer element size in bytes.
public final int	byteSize Byte size of the buffer.
public static final GLPixelBuffer.GLPixelBufferProvider	defaultProviderNoRowStride Default `GLPixelBufferProvider` with `GLPixelBufferProvider#getAllowRowStride()` == `false`, utilizing best match for `GLPixelAttributes` and `allocating` a `ByteBuffer`.
public static final GLPixelBuffer.GLPixelBufferProvider	defaultProviderWithRowStride Default `GLPixelBufferProvider` with `GLPixelBufferProvider#getAllowRowStride()` == `true`, utilizing best match for `GLPixelAttributes` and `allocating` a `ByteBuffer`.
public final int	depth Depth in pixels.
private boolean	disposed
public final int	height Height in pixels, representing `buffer`'s `byteSize`.
public final boolean	pack Data packing direction.
public final GLPixelBuffer.GLPixelAttributes	pixelAttributes The `GLPixelAttributes`.
public final int	width Width in pixels, representing `buffer`'s `byteSize`.

Access Constructor and Description

Access	Constructor and Description
public	GLPixelBuffer(final GLPixelBuffer.GLPixelAttributes the desired `GLPixelAttributes` pixelAttributes, final boolean `true` for read mode GPU -> CPU, e.g. `glReadPixels`. `false` for write mode CPU -> GPU, e.g. `glTexImage2D`. pack, final int in pixels width, final int in pixels height, final int in pixels depth, final Buffer the backing array buffer, final boolean If `true`, allow row-stride, otherwise not. See `requiresNewBuffer(GL, int, int, int)`. allowRowStride)

public

pixelAttributes, final boolean

true for read mode GPU -> CPU, e.g. glReadPixels. false for write mode CPU -> GPU, e.g. glTexImage2D.

pack, final int

in pixels

width, final int

in pixels

height, final int

in pixels

depth, final Buffer

the backing array

buffer, final boolean

If true, allow row-stride, otherwise not. See requiresNewBuffer(GL, int, int, int).

allowRowStride)

Modifier and Type	Method and Description
public int	capacity() Returns the byte capacity of the `buffer`.
public Buffer	clear() See `Buffer#clear()`.
public void	dispose() Dispose resources.
public Buffer	flip() See `Buffer#flip()`.
public final boolean	getAllowRowStride() Allow `GL2ES3#GL_PACK_ROW_LENGTH`, or `GL2ES2#GL_UNPACK_ROW_LENGTH`.
public boolean	isValid() Is not `disposed` and has `byteSize` > 0.
public int	limit() Returns the byte limit of the `buffer`.
public int	position() Returns the byte position of the `buffer`.
public Buffer	position(final int bytePos) Sets the byte position of the `buffer`.
public boolean	requiresNewBuffer(final GL the corresponding current GL context object gl, final int new width in pixels newWidth, final int new height in pixels newHeight, int if > 0, the pre-calculated minimum byte-size for the resulting buffer, otherwise ignore. newByteSize) Returns true, if `invalid` or implementation requires a new buffer based on the new size due to pixel alignment or byte size, otherwise false.
public Buffer	rewind() See `Buffer#rewind()`.
public StringBuilder	toString(StringBuilder sb)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait