JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider Class Reference

Provider for AWTGLPixelBuffer instances. More...

Inheritance diagram for com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider:
Collaboration diagram for com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider:

Public Member Functions

 AWTGLPixelBufferProvider (final boolean allowRowStride)
 
boolean getAllowRowStride ()
 Allow GL2ES3#GL_PACK_ROW_LENGTH, or GL2ES2#GL_UNPACK_ROW_LENGTH. More...
 
GLPixelAttributes getAttributes (final GL gl, final int componentCount, final boolean pack)
 Returns RGB[A] GLPixelAttributes matching GL, componentCount and pack. More...
 
GLPixelAttributes getAttributes (final GLProfile glp, final int componentCount)
 
PixelFormat.Composition getHostPixelComp (final GLProfile glp, final int componentCount)
 Returns the host PixelFormat.Composition matching GL and componentCount if required by implementation, otherwise null.
Parameters
glpthe corresponding current GL context object
componentCountRGBA component count, i.e. 1 (luminance, alpha or red), 3 (RGB) or 4 (RGBA)
More...
 
int getAWTFormat (final GLProfile glp, final int componentCount)
 Returns one of. More...
 
PixelFormat getAWTPixelFormat (final GLProfile glp, final int componentCount)
 
AWTGLPixelBuffer allocate (final GL gl, final PixelFormat.Composition hostPixComp, final GLPixelAttributes pixelAttributes, final boolean pack, final int width, final int height, final int depth, final 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
glthe corresponding current GL context object
hostPixComphost 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.
pixelAttributesthe desired GLPixelAttributes, e.g. fetched via getAttributes(GL, int, boolean)
packtrue for read mode GPU -> CPU, e.g. glReadPixels. false for write mode CPU -> GPU, e.g. glTexImage2D.
widthin pixels
heightin pixels
depthin pixels
minByteSizeif > 0, the pre-calculated minimum byte-size for the resulting buffer, otherwise ignore.
See also
getHostPixelComp(GLProfile, int)
getAttributes(GL, int, boolean)
More...
 
boolean getAllowRowStride ()
 Allow GL2ES3#GL_PACK_ROW_LENGTH, or GL2ES2#GL_UNPACK_ROW_LENGTH. More...
 
GLPixelAttributes getAttributes (GL gl, int componentCount, boolean pack)
 Returns RGB[A] GLPixelAttributes matching GL, componentCount and pack. More...
 
PixelFormat.Composition getHostPixelComp (final GLProfile glp, final int componentCount)
 Returns the host PixelFormat.Composition matching GL and componentCount if required by implementation, otherwise null. More...
 
GLPixelBuffer allocate (GL gl, PixelFormat.Composition hostPixComp, GLPixelAttributes pixelAttributes, boolean pack, int width, int height, int depth, int minByteSize)
 Allocates a new GLPixelBuffer object. More...
 

Detailed Description

Provider for AWTGLPixelBuffer instances.

Definition at line 162 of file AWTGLPixelBuffer.java.

Constructor & Destructor Documentation

◆ AWTGLPixelBufferProvider()

com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.AWTGLPixelBufferProvider ( final boolean  allowRowStride)
Parameters
allowRowStrideIf true, allow row-stride, otherwise not. See getAllowRowStride() and AWTGLPixelBuffer#requiresNewBuffer(GL, int, int, int). If true, user shall decide whether to use a width-aligned image.

Definition at line 170 of file AWTGLPixelBuffer.java.

Member Function Documentation

◆ allocate()

AWTGLPixelBuffer com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.allocate ( final GL  gl,
final PixelFormat.Composition  hostPixComp,
final GLPixelAttributes  pixelAttributes,
final boolean  pack,
final int  width,
final int  height,
final int  depth,
final 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
glthe corresponding current GL context object
hostPixComphost 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.
pixelAttributesthe desired GLPixelAttributes, e.g. fetched via getAttributes(GL, int, boolean)
packtrue for read mode GPU -> CPU, e.g. glReadPixels. false for write mode CPU -> GPU, e.g. glTexImage2D.
widthin pixels
heightin pixels
depthin pixels
minByteSizeif > 0, the pre-calculated minimum byte-size for the resulting buffer, otherwise ignore.
See also
getHostPixelComp(GLProfile, int)
getAttributes(GL, int, boolean)

Returns an array backed IntBuffer of size

width*height* SIZEOF_INT.

Implements com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.

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

Definition at line 233 of file AWTGLPixelBuffer.java.

Here is the call graph for this function:

◆ getAllowRowStride()

boolean com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.getAllowRowStride ( )

◆ getAttributes() [1/2]

GLPixelAttributes com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.getAttributes ( final GL  gl,
final int  componentCount,
final boolean  pack 
)

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

Parameters
glthe corresponding current GL context object
componentCountRGBA component count, i.e. 1 (luminance, alpha or red), 3 (RGB) or 4 (RGBA)
packtrue for read mode GPU -> CPU, e.g. glReadPixels. false for write mode CPU -> GPU, e.g. glTexImage2D.

Implements com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.

Definition at line 178 of file AWTGLPixelBuffer.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAttributes() [2/2]

GLPixelAttributes com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.getAttributes ( final GLProfile  glp,
final int  componentCount 
)

Definition at line 182 of file AWTGLPixelBuffer.java.

Here is the call graph for this function:

◆ getAWTFormat()

int com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.getAWTFormat ( final GLProfile  glp,
final int  componentCount 
)

Returns one of.

Parameters
glp
componentCount
Returns

Definition at line 209 of file AWTGLPixelBuffer.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAWTPixelFormat()

PixelFormat com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.getAWTPixelFormat ( final GLProfile  glp,
final int  componentCount 
)

Definition at line 218 of file AWTGLPixelBuffer.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getHostPixelComp()

PixelFormat.Composition com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider.getHostPixelComp ( final GLProfile  glp,
final int  componentCount 
)

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

Parameters
glpthe corresponding current GL context object
componentCountRGBA component count, i.e. 1 (luminance, alpha or red), 3 (RGB) or 4 (RGBA)

Returns a valid PixelFormat.Composition instance from getAWTPixelFormat(GLProfile, int).

Implements com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.

Definition at line 193 of file AWTGLPixelBuffer.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: