Package com.jogamp.opengl.util

Interface GLPixelBuffer.GLPixelBufferProvider

All Known Subinterfaces:

GLPixelBuffer.SingletonGLPixelBufferProvider

All Known Implementing Classes:

AWTGLPixelBuffer.AWTGLPixelBufferProvider, AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider, GLPixelBuffer.DefaultGLPixelBufferProvider

Enclosing class:

GLPixelBuffer

public static interface GLPixelBuffer.GLPixelBufferProvider

Allows user to interface with another toolkit to define GLPixelBuffer.GLPixelAttributes and memory buffer to produce TextureData.

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.

Method Detail

getAllowRowStride

boolean getAllowRowStride()

Allow GL2ES3.GL_PACK_ROW_LENGTH, or GL2ES2.GL_UNPACK_ROW_LENGTH.

getAttributes

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

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

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

PixelFormat.Composition getHostPixelComp(GLProfile glp,
                                         int componentCount)

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

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

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.

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 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 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:

getHostPixelComp(GLProfile, int), getAttributes(GL, int, boolean)