JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider Interface Reference

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

Inheritance diagram for com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider:
Collaboration diagram for com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider:

Public Member Functions

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

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

Definition at line 57 of file GLPixelBuffer.java.

Member Function Documentation

◆ allocate()

GLPixelBuffer com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.allocate ( GL  gl,
PixelFormat.Composition  hostPixComp,
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
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)

Implemented in com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider, com.jogamp.opengl.util.GLPixelBuffer.DefaultGLPixelBufferProvider, com.jogamp.opengl.util.awt.AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider, and com.jogamp.opengl.util.GLPixelBuffer.SingletonGLPixelBufferProvider.

Here is the caller graph for this function:

◆ getAllowRowStride()

boolean com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.getAllowRowStride ( )

◆ getAttributes()

GLPixelAttributes com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.getAttributes ( GL  gl,
int  componentCount,
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.

Implemented in com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider, and com.jogamp.opengl.util.GLPixelBuffer.DefaultGLPixelBufferProvider.

Here is the caller graph for this function:

◆ getHostPixelComp()

PixelFormat.Composition com.jogamp.opengl.util.GLPixelBuffer.GLPixelBufferProvider.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)

Implemented in com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider, and com.jogamp.opengl.util.GLPixelBuffer.DefaultGLPixelBufferProvider.

Here is the caller graph for this function:

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