Package com.jogamp.opengl.util.awt

Class AWTGLPixelBuffer

java.lang.Object

com.jogamp.opengl.util.GLPixelBuffer

com.jogamp.opengl.util.awt.AWTGLPixelBuffer

public class AWTGLPixelBuffer
extends GLPixelBuffer

AWT GLPixelBuffer backed by an BufferedImage of type BufferedImage.TYPE_INT_ARGB or BufferedImage.TYPE_INT_RGB.

Implementation uses an array backed IntBuffer.

AWTGLPixelBuffer can be produced via AWTGLPixelBuffer.AWTGLPixelBufferProvider's allocate(..).

See GLPixelBuffer.requiresNewBuffer(GL, int, int, int) for GLPixelBuffer.allowRowStride details.

If using allowRowStride == true, user may needs to get the aligned image since GLPixelBuffer.requiresNewBuffer(GL, int, int, int) will allow different width in this case.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AWTGLPixelBuffer.AWTGLPixelBufferProvider	Provider for AWTGLPixelBuffer instances.
static class	AWTGLPixelBuffer.SingleAWTGLPixelBufferProvider	Provider for singleton AWTGLPixelBuffer instances.

Nested classes/interfaces inherited from class com.jogamp.opengl.util.GLPixelBuffer

GLPixelBuffer.DefaultGLPixelBufferProvider, GLPixelBuffer.GLPixelAttributes, GLPixelBuffer.GLPixelBufferProvider, GLPixelBuffer.SingletonGLPixelBufferProvider

Field Summary

Fields

Modifier and Type	Field	Description
BufferedImage	image	The underlying BufferedImage.

Fields inherited from class com.jogamp.opengl.util.GLPixelBuffer

allowRowStride, buffer, bufferElemSize, byteSize, defaultProviderNoRowStride, defaultProviderWithRowStride, depth, height, pack, pixelAttributes, width

Constructor Summary

Constructors

Constructor	Description
AWTGLPixelBuffer(PixelFormat.Composition hostPixelComp, GLPixelBuffer.GLPixelAttributes pixelAttributes, boolean pack, int awtFormat, int width, int height, int depth, BufferedImage image, Buffer buffer, boolean allowRowStride)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Dispose resources.
BufferedImage	getAlignedImage(int width, int height)	Returns a width- and height-aligned image representation sharing data w/ image.
int	getAWTFormat()
PixelFormat.Composition	getHostPixelComp()
boolean	isDataBufferSource(BufferedImage imageU)
String	toString()
StringBuilder	toString(StringBuilder sb)

Methods inherited from class com.jogamp.opengl.util.GLPixelBuffer

capacity, clear, flip, getAllowRowStride, isValid, limit, position, position, requiresNewBuffer, rewind

Methods inherited from class java.lang.Object

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

Field Detail

image

public final BufferedImage image

The underlying BufferedImage.

Constructor Detail

AWTGLPixelBuffer

public AWTGLPixelBuffer(PixelFormat.Composition hostPixelComp,
                        GLPixelBuffer.GLPixelAttributes pixelAttributes,
                        boolean pack,
                        int awtFormat,
                        int width,
                        int height,
                        int depth,
                        BufferedImage image,
                        Buffer buffer,
                        boolean allowRowStride)

Parameters:

hostPixelComp - the host PixelFormat.Composition

pixelAttributes - the desired GLPixelBuffer.GLPixelAttributes

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

awtFormat - the used AWT format, i.e. AWTGLPixelBuffer.AWTGLPixelBufferProvider.getAWTFormat(GLProfile, int)

width - in pixels

height - in pixels

depth - in pixels

image - the AWT image

buffer - the backing array

allowRowStride - If true, allow row-stride, otherwise not. See GLPixelBuffer.requiresNewBuffer(GL, int, int, int). If true, user shall decide whether to use a width-aligned image.

Method Detail

getHostPixelComp

public final PixelFormat.Composition getHostPixelComp()

getAWTFormat

public final int getAWTFormat()

dispose

public void dispose()

Description copied from class: GLPixelBuffer

Dispose resources. See GLPixelBuffer.isValid().

Overrides:

dispose in class GLPixelBuffer

getAlignedImage

public BufferedImage getAlignedImage(int width,
                                     int height)
                              throws IllegalArgumentException

Returns a width- and height-aligned image representation sharing data w/ image.

Parameters:

width -

height -

Returns:

Throws:

IllegalArgumentException - if requested size exceeds image size

isDataBufferSource

public final boolean isDataBufferSource(BufferedImage imageU)

toString

public StringBuilder toString(StringBuilder sb)

Overrides:

toString in class GLPixelBuffer

toString

public String toString()

Overrides:

toString in class GLPixelBuffer