Package com.jogamp.opengl.util

Class GLPixelBuffer.DefaultGLPixelBufferProvider

java.lang.Object

com.jogamp.opengl.util.GLPixelBuffer.DefaultGLPixelBufferProvider

All Implemented Interfaces:

GLPixelBuffer.GLPixelBufferProvider

Enclosing class:

GLPixelBuffer

public static class GLPixelBuffer.DefaultGLPixelBufferProvider
extends Object
implements GLPixelBuffer.GLPixelBufferProvider

Constructor Summary

Constructors

Constructor	Description
DefaultGLPixelBufferProvider(boolean allowRowStride)

Method Summary

Modifier and Type	Method	Description
GLPixelBuffer	allocate(GL gl, PixelFormat.Composition hostPixComp, GLPixelBuffer.GLPixelAttributes pixelAttributes, boolean pack, int width, int height, int depth, int minByteSize)	Allocates a new GLPixelBuffer object.
boolean	getAllowRowStride()	Allow GL2ES3.GL_PACK_ROW_LENGTH, or GL2ES2.GL_UNPACK_ROW_LENGTH.
GLPixelBuffer.GLPixelAttributes	getAttributes(GL gl, int componentCount, boolean pack)	Returns RGB[A] GLPixelBuffer.GLPixelAttributes matching GL, componentCount and pack.
PixelFormat.Composition	getHostPixelComp(GLProfile glp, int componentCount)	Returns the host PixelFormat.Composition matching GL and componentCount if required by implementation, otherwise null.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGLPixelBufferProvider

public DefaultGLPixelBufferProvider(boolean allowRowStride)

Parameters:

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

Method Detail

getAllowRowStride

public boolean getAllowRowStride()

Description copied from interface: GLPixelBuffer.GLPixelBufferProvider

Allow GL2ES3.GL_PACK_ROW_LENGTH, or GL2ES2.GL_UNPACK_ROW_LENGTH.

Specified by:

getAllowRowStride in interface GLPixelBuffer.GLPixelBufferProvider

getAttributes

public GLPixelBuffer.GLPixelAttributes getAttributes(GL gl,
                                                     int componentCount,
                                                     boolean pack)

Description copied from interface: GLPixelBuffer.GLPixelBufferProvider

Returns RGB[A] GLPixelBuffer.GLPixelAttributes matching GL, componentCount and pack.

Specified by:

getAttributes in interface GLPixelBuffer.GLPixelBufferProvider

Parameters:

gl - the corresponding current GL context object

componentCount - RGBA component count, i.e. 1 (luminance, alpha or red), 3 (RGB) or 4 (RGBA)

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

getHostPixelComp

public PixelFormat.Composition getHostPixelComp(GLProfile glp,
                                                int componentCount)

Returns the host PixelFormat.Composition matching GL and componentCount if required by implementation, otherwise null.

Returns null!

Specified by:

getHostPixelComp in interface GLPixelBuffer.GLPixelBufferProvider

Parameters:

glp - the corresponding current GL context object

componentCount - RGBA component count, i.e. 1 (luminance, alpha or red), 3 (RGB) or 4 (RGBA)

allocate

public GLPixelBuffer allocate(GL gl,
                              PixelFormat.Composition hostPixComp,
                              GLPixelBuffer.GLPixelAttributes pixelAttributes,
                              boolean pack,
                              int width,
                              int height,
                              int depth,
                              int minByteSize)

Allocates a new GLPixelBuffer object.

The minimum required remaining byte size equals to minByteSize, if > 0, otherwise utilize GLBuffers.sizeof(GL, int[], int, int, int, int, int, boolean) to calculate it.

Returns an NIO ByteBuffer.

Specified by:

allocate in interface GLPixelBuffer.GLPixelBufferProvider

Parameters:

gl - the corresponding current GL context object

hostPixComp - host pixel format, i.e. of the source or sink depending on pack, e.g. fetched via GLPixelBuffer.GLPixelBufferProvider.getHostPixelComp(GLProfile, int). If null, pixelAttributes instance maybe used or an exception is thrown, depending on implementation semantics.

pixelAttributes - the desired GLPixelBuffer.GLPixelAttributes, e.g. fetched via GLPixelBuffer.GLPixelBufferProvider.getAttributes(GL, int, boolean)

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

width - in pixels

height - in pixels

depth - in pixels

minByteSize - if > 0, the pre-calculated minimum byte-size for the resulting buffer, otherwise ignore.

See Also:

GLPixelBuffer.GLPixelBufferProvider.getHostPixelComp(GLProfile, int), GLPixelBuffer.GLPixelBufferProvider.getAttributes(GL, int, boolean)