Package com.jogamp.opengl.util.awt

Class AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider

java.lang.Object

com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider

com.jogamp.opengl.util.awt.AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider

All Implemented Interfaces:

GLPixelBuffer.GLPixelBufferProvider, GLPixelBuffer.SingletonGLPixelBufferProvider

Enclosing class:

AWTGLPixelBuffer

public static class AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider
extends AWTGLPixelBuffer.AWTGLPixelBufferProvider
implements GLPixelBuffer.SingletonGLPixelBufferProvider

Provider for singleton AWTGLPixelBuffer instances.

Provider instance holds the last AWTGLPixelBuffer instance allocated. A new allocation will return same instance, if a new buffer is not required. The latter is true if size are compatible, hence allowRowStride should be enabled, if possible.

Constructor Summary

Constructors

Constructor	Description
SingleAWTGLPixelBufferProvider(boolean allowRowStride)

Method Summary

Modifier and Type	Method	Description
AWTGLPixelBuffer	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.
AWTGLPixelBuffer	getSingleBuffer(PixelFormat.Composition hostPixelComp, GLPixelBuffer.GLPixelAttributes pixelAttributes, boolean pack)	Return the last allocated AWTGLPixelBuffer, if compatible w/ the given PixelFormat.Composition and GLPixelBuffer.GLPixelAttributes.
AWTGLPixelBuffer	initSingleton(GLProfile glp, int componentCount, boolean pack, int width, int height, int depth)	Initializes the single AWTGLPixelBuffer w/ a given size, if not yet allocated.

Methods inherited from class com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider

getAllowRowStride, getAttributes, getAttributes, getAWTFormat, getAWTPixelFormat, getHostPixelComp

Methods inherited from class java.lang.Object

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

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

getAllowRowStride, getAttributes, getHostPixelComp

Constructor Detail

SingleAWTGLPixelBufferProvider

public SingleAWTGLPixelBufferProvider(boolean allowRowStride)

Parameters:

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

Method Detail

allocate

public AWTGLPixelBuffer 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 array backed IntBuffer of size

width*height*SIZEOF_INT.
 

 

 Returns an array backed IntBuffer of size 
width*height*SIZEOF_INT.
 

Specified by:

allocate in interface GLPixelBuffer.GLPixelBufferProvider

Specified by:

allocate in interface GLPixelBuffer.SingletonGLPixelBufferProvider

Overrides:

allocate in class AWTGLPixelBuffer.AWTGLPixelBufferProvider

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

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

Return the last allocated AWTGLPixelBuffer, if compatible w/ the given PixelFormat.Composition and GLPixelBuffer.GLPixelAttributes.

Specified by:

getSingleBuffer in interface GLPixelBuffer.SingletonGLPixelBufferProvider

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

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

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

Specified by:

initSingleton in interface GLPixelBuffer.SingletonGLPixelBufferProvider

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.

Returns:

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

dispose

public void dispose()

Description copied from interface: GLPixelBuffer.SingletonGLPixelBufferProvider

Dispose all resources.

Specified by:

dispose in interface GLPixelBuffer.SingletonGLPixelBufferProvider