Package com.jogamp.opengl.util

Class GLPixelBuffer.GLPixelAttributes

java.lang.Object

com.jogamp.opengl.util.GLPixelBuffer.GLPixelAttributes

Enclosing class:

GLPixelBuffer

public static class GLPixelBuffer.GLPixelAttributes
extends Object

Pixel attributes.

Field Summary

Fields

Modifier and Type	Field	Description
int	format	The OpenGL pixel data format
PixelFormat	pfmt	PixelFormat describing the component layout
int	type	The OpenGL pixel data type
static GLPixelBuffer.GLPixelAttributes	UNDEF	Undefined instance of GLPixelBuffer.GLPixelAttributes, having componentCount:=0, format:=0 and type:= 0.

Constructor Summary

Constructors

Constructor	Description
GLPixelAttributes(int dataFormat, int dataType)	Create a new GLPixelBuffer.GLPixelAttributes instance based on GL format and type.
GLPixelAttributes(GLProfile glp, PixelFormat pixFmt, boolean pack)	Create a new GLPixelBuffer.GLPixelAttributes instance based on GLProfile, PixelFormat and pack.

Method Summary

Modifier and Type	Method	Description
static GLPixelBuffer.GLPixelAttributes	convert(GL gl, int componentCount, boolean pack)	Returns the matching GLPixelBuffer.GLPixelAttributes for the given byte sized RGBA componentCount and GL if exists, otherwise returns null.
static GLPixelBuffer.GLPixelAttributes	convert(GLProfile glp, PixelFormat pixFmt, boolean pack)	Returns the matching GLPixelBuffer.GLPixelAttributes for the given GLProfile, PixelFormat and pack if exists, otherwise returns null.
boolean	equals(Object obj)
static PixelFormat	getPixelFormat(int glFormat, int glDataType)	Returns the matching PixelFormat for the given GL format and type if exists, otherwise returns null.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNDEF

public static final GLPixelBuffer.GLPixelAttributes UNDEF

Undefined instance of GLPixelBuffer.GLPixelAttributes, having componentCount:=0, format:=0 and type:= 0.

format

public final int format

The OpenGL pixel data format

type

public final int type

The OpenGL pixel data type

pfmt

public final PixelFormat pfmt

PixelFormat describing the component layout

Constructor Detail

GLPixelAttributes

public GLPixelAttributes(int dataFormat,
                         int dataType)
                  throws GLException

Create a new GLPixelBuffer.GLPixelAttributes instance based on GL format and type.

Parameters:

dataFormat - GL data format

dataType - GL data type

Throws:

GLException - if PixelFormat could not be determined, see getPixelFormat(int, int).

GLPixelAttributes

public GLPixelAttributes(GLProfile glp,
                         PixelFormat pixFmt,
                         boolean pack)
                  throws GLException

Create a new GLPixelBuffer.GLPixelAttributes instance based on GLProfile, PixelFormat and pack.

Parameters:

glp - the corresponding GLProfile

pixFmt - the to be matched pixel format

pack - true for read mode GPU -> CPU, e.g. glReadPixels. false for write mode CPU -> GPU, e.g. glTexImage2D.

Throws:

GLException - if GL format or type could not be determined, see convert(GLProfile, PixelFormat, boolean).

Method Detail

getPixelFormat

public static final PixelFormat getPixelFormat(int glFormat,
                                               int glDataType)

Returns the matching PixelFormat for the given GL format and type if exists, otherwise returns null.

convert

public static GLPixelBuffer.GLPixelAttributes convert(GL gl,
                                                      int componentCount,
                                                      boolean pack)

Returns the matching GLPixelBuffer.GLPixelAttributes for the given byte sized RGBA componentCount and GL if exists, otherwise returns null.

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.

convert

public static final GLPixelBuffer.GLPixelAttributes convert(GLProfile glp,
                                                            PixelFormat pixFmt,
                                                            boolean pack)

Returns the matching GLPixelBuffer.GLPixelAttributes for the given GLProfile, PixelFormat and pack if exists, otherwise returns null.

Parameters:

glp - the corresponding GLProfile

pixFmt - the to be matched pixel format

pack - true for read mode GPU -> CPU, e.g. glReadPixels. false for write mode CPU -> GPU, e.g. glTexImage2D.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object