Package com.jogamp.opengl.util

Interface GLPixelBuffer.SingletonGLPixelBufferProvider

All Superinterfaces:

GLPixelBuffer.GLPixelBufferProvider

All Known Implementing Classes:

AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider

Enclosing class:

GLPixelBuffer

public static interface GLPixelBuffer.SingletonGLPixelBufferProvider
extends GLPixelBuffer.GLPixelBufferProvider

Single GLPixelBuffer provider.

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.
void	dispose()	Dispose all resources.
GLPixelBuffer	getSingleBuffer(PixelFormat.Composition hostPixelComp, GLPixelBuffer.GLPixelAttributes pixelAttributes, boolean pack)	Return the last allocated GLPixelBuffer matching the given parameter.
GLPixelBuffer	initSingleton(GLProfile glp, int componentCount, boolean pack, int width, int height, int depth)	Initializes the single GLPixelBuffer w/ a given size, if not yet allocated.

Methods inherited from interface com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider

getAllowRowStride, getAttributes, getHostPixelComp

Method Detail

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.

Being called to gather the initial GLPixelBuffer, or a new replacement GLPixelBuffer if GLPixelBuffer.requiresNewBuffer(GL, int, int, int).

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)

getSingleBuffer

GLPixelBuffer getSingleBuffer(PixelFormat.Composition hostPixelComp,
                              GLPixelBuffer.GLPixelAttributes pixelAttributes,
                              boolean pack)

Return the last allocated GLPixelBuffer matching the given parameter.

May return null if none has been allocated yet.

Returned GLPixelBuffer may be invalid.

Parameters:

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.

initSingleton

GLPixelBuffer initSingleton(GLProfile glp,
                            int componentCount,
                            boolean pack,
                            int width,
                            int height,
                            int depth)

Initializes the single GLPixelBuffer w/ a given size, if not yet allocated.

Parameters:

glp -

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.

width -

height -

depth -

Returns:

the newly initialized single GLPixelBuffer, or null if already allocated.

dispose

void dispose()

Dispose all resources.