The GLJPanel can be made transparent by creating it with a GLCapabilities object with alpha bits specified and calling {@link #setOpaque}(false). Pixels with resulting OpenGL alpha values less than 1.0 will be overlaid on any underlying Swing rendering.
Notes specific to the Reference Implementation: This component attempts to use hardware-accelerated rendering via pbuffers and falls back on to software rendering if problems occur. Note that because this component attempts to use pbuffers for rendering, and because pbuffers can not be resized, somewhat surprising behavior may occur during resize operations; the {@link GLEventListener#init} method may be called multiple times as the pbuffer is resized to be able to cover the size of the GLJPanel. This behavior is correct, as the textures and display lists for the GLJPanel will have been lost during the resize operation. The application should attempt to make its GLEventListener.init() methods as side-effect-free as possible.
* Please read Java2D OpenGL Remarks. *
*/ @SuppressWarnings({ "serial", "deprecation" }) public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosingProtocol { private static final boolean DEBUG = Debug.debug("GLJPanel"); private GLDrawableHelper helper = new GLDrawableHelper(); private volatile boolean isInitialized; // Data used for either pbuffers or pixmap-based offscreen surfaces private GLCapabilitiesImmutable offscreenCaps; private GLProfile glProfile; private GLDrawableFactoryImpl factory; private GLCapabilitiesChooser chooser; private GLContext shareWith; private int additionalCtxCreationFlags = 0; // Width of the actual GLJPanel private int panelWidth = 0; private int panelHeight = 0; // Lazy reshape notification private boolean handleReshape = false; private boolean sendReshape = true; // The backend in use private Backend backend; // Used by all backends either directly or indirectly to hook up callbacks private Updater updater = new Updater(); // Turns off the pbuffer-based backend (used by default, unless the // Java 2D / OpenGL pipeline is in use) private static boolean hardwareAccelerationDisabled = Debug.isPropertyDefined("jogl.gljpanel.nohw", true); // Turns off the fallback to software-based rendering from // pbuffer-based rendering private static boolean softwareRenderingDisabled = Debug.isPropertyDefined("jogl.gljpanel.nosw", true); // Indicates whether the Java 2D OpenGL pipeline is enabled private boolean oglPipelineEnabled = Java2D.isOGLPipelineActive() && !Debug.isPropertyDefined("jogl.gljpanel.noogl", true); // For handling reshape events lazily // private int reshapeX; // private int reshapeY; private int reshapeWidth; private int reshapeHeight; // These are always set to (0, 0) except when the Java2D / OpenGL // pipeline is active private int viewportX; private int viewportY; private AWTWindowClosingProtocol awtWindowClosingProtocol = new AWTWindowClosingProtocol(this, new Runnable() { @Override public void run() { GLJPanel.this.destroy(); } }); static { // Force eager initialization of part of the Java2D class since // otherwise it's likely it will try to be initialized while on // the Queue Flusher Thread, which is not allowed if (Java2D.isOGLPipelineActive() && Java2D.isFBOEnabled()) { Java2D.getShareContext(GraphicsEnvironment. getLocalGraphicsEnvironment(). getDefaultScreenDevice()); } } /** Creates a new GLJPanel component with a default set of OpenGL capabilities and using the default OpenGL capabilities selection mechanism. * @throws GLException if no default profile is available for the default desktop device. */ public GLJPanel() throws GLException { this(null); } /** Creates a new GLJPanel component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism. * @throws GLException if no GLCapabilities are given and no default profile is available for the default desktop device. */ public GLJPanel(GLCapabilitiesImmutable userCapsRequest) throws GLException { this(userCapsRequest, null, null); } /** Creates a new GLJPanel component. The passed GLCapabilities specifies the OpenGL capabilities for the component; if null, a default set of capabilities is used. The GLCapabilitiesChooser specifies the algorithm for selecting one of the available GLCapabilities for the component; a DefaultGLCapabilitesChooser is used if null is passed for this argument. The passed GLContext specifies an OpenGL context with which to share textures, display lists and other OpenGL state, and may be null if sharing is not desired. See the note in the overview documentation on context sharing.Note: Sharing cannot be enabled using J2D OpenGL FBO sharing, since J2D GL Context must be shared and we can only share one context. * @throws GLException if no GLCapabilities are given and no default profile is available for the default desktop device. */ public GLJPanel(GLCapabilitiesImmutable userCapsRequest, GLCapabilitiesChooser chooser, GLContext shareWith) throws GLException { super(); // Works around problems on many vendors' cards; we don't need a // back buffer for the offscreen surface anyway { GLCapabilities caps; if (userCapsRequest != null) { caps = (GLCapabilities) userCapsRequest.cloneMutable(); } else { caps = new GLCapabilities(GLProfile.getDefault(GLProfile.getDefaultDevice())); } caps.setDoubleBuffered(false); offscreenCaps = caps; } this.glProfile = offscreenCaps.getGLProfile(); this.factory = GLDrawableFactoryImpl.getFactoryImpl(glProfile); this.chooser = ((chooser != null) ? chooser : new DefaultGLCapabilitiesChooser()); this.shareWith = shareWith; } @Override public final Object getUpstreamWidget() { return this; } @Override public void display() { if (EventQueue.isDispatchThread()) { // Want display() to be synchronous, so call paintImmediately() paintImmediately(0, 0, getWidth(), getHeight()); } else { // Multithreaded redrawing of Swing components is not allowed, // so do everything on the event dispatch thread try { EventQueue.invokeAndWait(paintImmediatelyAction); } catch (Exception e) { throw new GLException(e); } } } protected void dispose() { if(DEBUG) { System.err.println(getThreadName()+": GLJPanel.dispose() - start"); // Thread.dumpStack(); } if (backend != null && backend.getContext() != null) { boolean animatorPaused = false; GLAnimatorControl animator = getAnimator(); if(null!=animator) { animatorPaused = animator.pause(); } if(backend.getContext().isCreated()) { Threading.invoke(true, disposeAction, getTreeLock()); } if(null != backend) { // not yet destroyed due to backend.isUsingOwnThreadManagment() == true backend.destroy(); isInitialized = false; } if(animatorPaused) { animator.resume(); } } if(DEBUG) { System.err.println(getThreadName()+": GLJPanel.dispose() - stop"); } } /** * Just an alias for removeNotify */ @Override public void destroy() { removeNotify(); } /** Overridden to cause OpenGL rendering to be performed during repaint cycles. Subclasses which override this method must call super.paintComponent() in their paintComponent() method in order to function properly.
paintComponent in class javax.swing.JComponent
addNotify in class java.awt.Component
removeNotify in class java.awt.Component
reshape in class java.awt.ComponentglClear(GL_COLOR_BUFFER_BIT |
GL_DEPTH_BUFFER_BIT)), but for certain optimized Swing
implementations which use OpenGL internally, it may be possible
to perform OpenGL rendering using the GLJPanel into the same
OpenGL drawable as the Swing implementation uses. */
public boolean shouldPreserveColorBufferIfTranslucent() {
return oglPipelineEnabled;
}
@Override
public GLCapabilitiesImmutable getChosenGLCapabilities() {
return backend.getChosenGLCapabilities();
}
@Override
public final GLProfile getGLProfile() {
return glProfile;
}
@Override
public NativeSurface getNativeSurface() {
throw new GLException("FIXME");
}
@Override
public long getHandle() {
throw new GLException("FIXME");
}
@Override
public final GLDrawableFactory getFactory() {
return factory;
}
//----------------------------------------------------------------------
// Internals only below this point
//
private void createAndInitializeBackend() {
if (panelWidth == 0 ||
panelHeight == 0) {
// See whether we have a non-zero size yet and can go ahead with
// initialization
if (reshapeWidth == 0 ||
reshapeHeight == 0) {
return;
}
// Pull down reshapeWidth and reshapeHeight into panelWidth and
// panelHeight eagerly in order to complete initialization, and
// force a reshape later
panelWidth = reshapeWidth;
panelHeight = reshapeHeight;
}
do {
if (backend == null) {
if (oglPipelineEnabled) {
backend = new J2DOGLBackend();
} else {
if (!hardwareAccelerationDisabled &&
factory.canCreateGLPbuffer(null)) {
backend = new PbufferBackend();
} else {
if (softwareRenderingDisabled) {
throw new GLException("Fallback to software rendering disabled by user");
}
backend = new SoftwareBackend();
}
}
}
if (!isInitialized) {
backend.initialize();
}
// The backend might set itself to null, indicating it punted to
// a different implementation -- try again
} while (backend == null);
awtWindowClosingProtocol.addClosingListenerOneShot();
}
@Override
public WindowClosingMode getDefaultCloseOperation() {
return awtWindowClosingProtocol.getDefaultCloseOperation();
}
@Override
public WindowClosingMode setDefaultCloseOperation(WindowClosingMode op) {
return awtWindowClosingProtocol.setDefaultCloseOperation(op);
}
private void handleReshape() {
panelWidth = reshapeWidth;
panelHeight = reshapeHeight;
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel.handleReshape: (w,h) = (" +
panelWidth + "," + panelHeight + ")");
}
sendReshape = true;
backend.handleReshape();
handleReshape = false;
}
// This is used as the GLEventListener for the pbuffer-based backend
// as well as the callback mechanism for the other backends
class Updater implements GLEventListener {
private Graphics g;
public void setGraphics(Graphics g) {
this.g = g;
}
@Override
public void init(GLAutoDrawable drawable) {
if (!backend.preGL(g)) {
return;
}
helper.init(GLJPanel.this, !sendReshape);
backend.postGL(g, false);
}
@Override
public void dispose(GLAutoDrawable drawable) {
helper.dispose(GLJPanel.this);
}
@Override
public void display(GLAutoDrawable drawable) {
if (!backend.preGL(g)) {
return;
}
if (sendReshape) {
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel.display: reshape(" + viewportX + "," + viewportY + " " + panelWidth + "x" + panelHeight + ")");
}
helper.reshape(GLJPanel.this, viewportX, viewportY, panelWidth, panelHeight);
sendReshape = false;
}
helper.display(GLJPanel.this);
backend.postGL(g, true);
}
@Override
public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {
// This is handled above and dispatched directly to the appropriate context
}
public void displayChanged(GLAutoDrawable drawable, boolean modeChanged, boolean deviceChanged) {
}
}
@Override
public String toString() {
return "AWT-GLJPanel[ "+((null!=backend)?backend.getDrawable().getClass().getName():"null-drawable")+"]";
}
private final Runnable postDisposeAction = new Runnable() {
@Override
public void run() {
if (backend != null && !backend.isUsingOwnThreadManagment()) {
backend.destroy();
backend = null;
isInitialized = false;
}
}
};
private final Runnable disposeAction = new Runnable() {
@Override
public void run() {
helper.disposeGL(GLJPanel.this, backend.getDrawable(), backend.getContext(), postDisposeAction);
}
};
private final Runnable updaterInitAction = new Runnable() {
@Override
public void run() {
updater.init(GLJPanel.this);
}
};
private final Runnable updaterDisplayAction = new Runnable() {
@Override
public void run() {
updater.display(GLJPanel.this);
}
};
private final Runnable paintImmediatelyAction = new Runnable() {
@Override
public void run() {
paintImmediately(0, 0, getWidth(), getHeight());
}
};
private int getNextPowerOf2(int number) {
// Workaround for problems where 0 width or height are transiently
// seen during layout
if (number == 0) {
return 2;
}
return GLBuffers.getNextPowerOf2(number);
}
private int getGLInteger(GL gl, int which) {
int[] tmp = new int[1];
gl.glGetIntegerv(which, tmp, 0);
return tmp[0];
}
protected static String getThreadName() {
return Thread.currentThread().getName();
}
//----------------------------------------------------------------------
// Implementations of the various backends
//
// Abstraction of the different rendering backends: i.e., pure
// software / pixmap rendering, pbuffer-based acceleration, Java 2D
// / JOGL bridge
static interface Backend {
// Create, Destroy, ..
public boolean isUsingOwnThreadManagment();
// Called each time the backend needs to initialize itself
public void initialize();
// Called when the backend should clean up its resources
public void destroy();
// Called when the opacity of the GLJPanel is changed
public void setOpaque(boolean opaque);
// Called to manually create an additional OpenGL context against
// this GLJPanel
public GLContext createContext(GLContext shareWith);
// Called to set the current backend's GLContext
public void setContext(GLContext ctx);
// Called to get the current backend's GLContext
public GLContext getContext();
// Called to get the current backend's GLDrawable
public GLDrawable getDrawable();
// Called to fetch the "real" GLCapabilities for the backend
public GLCapabilitiesImmutable getChosenGLCapabilities();
// Called to fetch the "real" GLProfile for the backend
public GLProfile getGLProfile();
// Called to handle a reshape event. When this is called, the
// OpenGL context associated with the backend is not current, to
// make it easier to destroy and re-create pbuffers if necessary.
public void handleReshape();
// Called before the OpenGL work is done in init() and display().
// If false is returned, this render is aborted.
public boolean preGL(Graphics g);
// Called after the OpenGL work is done in init() and display().
// The isDisplay argument indicates whether this was called on
// behalf of a call to display() rather than init().
public void postGL(Graphics g, boolean isDisplay);
// Called from within paintComponent() to initiate the render
public void doPaintComponent(Graphics g);
}
// Base class used by both the software (pixmap) and pbuffer
// backends, both of which rely on reading back the OpenGL frame
// buffer and drawing it with a BufferedImage
abstract class AbstractReadbackBackend implements Backend {
// This image is exactly the correct size to render into the panel
protected BufferedImage offscreenImage;
// One of these is used to store the read back pixels before storing
// in the BufferedImage
protected ByteBuffer readBackBytes;
protected IntBuffer readBackInts;
protected int readBackWidthInPixels;
protected int readBackHeightInPixels;
private int glFormat;
private int glType;
// For saving/restoring of OpenGL state during ReadPixels
private int[] swapbytes = new int[1];
private int[] rowlength = new int[1];
private int[] skiprows = new int[1];
private int[] skippixels = new int[1];
private int[] alignment = new int[1];
@Override
public void setOpaque(boolean opaque) {
if (opaque != isOpaque()) {
if (offscreenImage != null) {
offscreenImage.flush();
offscreenImage = null;
}
}
}
@Override
public boolean preGL(Graphics g) {
// Empty in this implementation
return true;
}
@Override
public void postGL(Graphics g, boolean isDisplay) {
if (isDisplay) {
// Must now copy pixels from offscreen context into surface
if (offscreenImage == null) {
if (panelWidth > 0 && panelHeight > 0) {
// It looks like NVidia's drivers (at least the ones on my
// notebook) are buggy and don't allow a sub-rectangle to be
// read from a pbuffer...this doesn't really matter because
// it's the Graphics.drawImage() calls that are the
// bottleneck
int awtFormat = 0;
// Should be more flexible in these BufferedImage formats;
// perhaps see what the preferred image types are on the
// given platform
if (isOpaque()) {
awtFormat = BufferedImage.TYPE_INT_RGB;
} else {
awtFormat = BufferedImage.TYPE_INT_ARGB;
}
offscreenImage = new BufferedImage(panelWidth,
panelHeight,
awtFormat);
switch (awtFormat) {
case BufferedImage.TYPE_3BYTE_BGR:
glFormat = GL2.GL_BGR;
glType = GL.GL_UNSIGNED_BYTE;
readBackBytes = ByteBuffer.allocate(readBackWidthInPixels * readBackHeightInPixels * 3);
break;
case BufferedImage.TYPE_INT_RGB:
case BufferedImage.TYPE_INT_ARGB:
glFormat = GL.GL_BGRA;
glType = getGLPixelType();
readBackInts = IntBuffer.allocate(readBackWidthInPixels * readBackHeightInPixels);
break;
default:
// FIXME: Support more off-screen image types (current
// offscreen context implementations don't use others, and
// some of the OpenGL formats aren't supported in the 1.1
// headers, which we're currently using)
throw new GLException("Unsupported offscreen image type " + awtFormat);
}
}
}
if (offscreenImage != null) {
GL2 gl = getGL().getGL2();
// Save current modes
gl.glGetIntegerv(GL2.GL_PACK_SWAP_BYTES, swapbytes, 0);
gl.glGetIntegerv(GL2.GL_PACK_ROW_LENGTH, rowlength, 0);
gl.glGetIntegerv(GL2.GL_PACK_SKIP_ROWS, skiprows, 0);
gl.glGetIntegerv(GL2.GL_PACK_SKIP_PIXELS, skippixels, 0);
gl.glGetIntegerv(GL2.GL_PACK_ALIGNMENT, alignment, 0);
gl.glPixelStorei(GL2.GL_PACK_SWAP_BYTES, GL.GL_FALSE);
gl.glPixelStorei(GL2.GL_PACK_ROW_LENGTH, readBackWidthInPixels);
gl.glPixelStorei(GL2.GL_PACK_SKIP_ROWS, 0);
gl.glPixelStorei(GL2.GL_PACK_SKIP_PIXELS, 0);
gl.glPixelStorei(GL2.GL_PACK_ALIGNMENT, 1);
// Actually read the pixels.
gl.glReadBuffer(GL2.GL_FRONT);
if (readBackBytes != null) {
gl.glReadPixels(0, 0, readBackWidthInPixels, readBackHeightInPixels, glFormat, glType, readBackBytes);
} else if (readBackInts != null) {
gl.glReadPixels(0, 0, readBackWidthInPixels, readBackHeightInPixels, glFormat, glType, readBackInts);
}
// Restore saved modes.
gl.glPixelStorei(GL2.GL_PACK_SWAP_BYTES, swapbytes[0]);
gl.glPixelStorei(GL2.GL_PACK_ROW_LENGTH, rowlength[0]);
gl.glPixelStorei(GL2.GL_PACK_SKIP_ROWS, skiprows[0]);
gl.glPixelStorei(GL2.GL_PACK_SKIP_PIXELS, skippixels[0]);
gl.glPixelStorei(GL2.GL_PACK_ALIGNMENT, alignment[0]);
if (readBackBytes != null || readBackInts != null) {
// Copy temporary data into raster of BufferedImage for faster
// blitting Note that we could avoid this copy in the cases
// where !offscreenContext.offscreenImageNeedsVerticalFlip(),
// but that's the software rendering path which is very slow
// anyway
Object src = null;
Object dest = null;
int srcIncr = 0;
int destIncr = 0;
if (readBackBytes != null) {
src = readBackBytes.array();
dest = ((DataBufferByte) offscreenImage.getRaster().getDataBuffer()).getData();
srcIncr = readBackWidthInPixels * 3;
destIncr = offscreenImage.getWidth() * 3;
} else {
src = readBackInts.array();
dest = ((DataBufferInt) offscreenImage.getRaster().getDataBuffer()).getData();
srcIncr = readBackWidthInPixels;
destIncr = offscreenImage.getWidth();
}
if (flipVertically()) {
int srcPos = 0;
int destPos = (offscreenImage.getHeight() - 1) * destIncr;
for (; destPos >= 0; srcPos += srcIncr, destPos -= destIncr) {
System.arraycopy(src, srcPos, dest, destPos, destIncr);
}
} else {
int srcPos = 0;
int destEnd = destIncr * offscreenImage.getHeight();
for (int destPos = 0; destPos < destEnd; srcPos += srcIncr, destPos += destIncr) {
System.arraycopy(src, srcPos, dest, destPos, destIncr);
}
}
// Note: image will be drawn back in paintComponent() for
// correctness on all platforms
}
}
}
}
@Override
public void doPaintComponent(Graphics g) {
doPaintComponentImpl();
if (offscreenImage != null) {
// Draw resulting image in one shot
g.drawImage(offscreenImage, 0, 0,
offscreenImage.getWidth(),
offscreenImage.getHeight(),
GLJPanel.this);
}
}
protected abstract void doPaintComponentImpl();
protected abstract int getGLPixelType();
protected abstract boolean flipVertically();
}
class SoftwareBackend extends AbstractReadbackBackend {
// Implementation using software rendering
private GLDrawableImpl offscreenDrawable;
private GLContextImpl offscreenContext;
@Override
public boolean isUsingOwnThreadManagment() { return false; }
@Override
public void initialize() {
if(DEBUG) {
System.err.println(getThreadName()+": SoftwareBackend: initialize()");
}
// Fall-through path: create an offscreen context instead
offscreenDrawable = (GLDrawableImpl) factory.createOffscreenDrawable(
null /* default platform device */,
offscreenCaps,
chooser,
Math.max(1, panelWidth),
Math.max(1, panelHeight));
offscreenDrawable.setRealized(true);
offscreenContext = (GLContextImpl) offscreenDrawable.createContext(shareWith);
offscreenContext.setContextCreationFlags(additionalCtxCreationFlags);
isInitialized = true;
}
@Override
public void destroy() {
if(DEBUG) {
System.err.println(getThreadName()+": SoftwareBackend: destroy() - offscreenContext: "+(null!=offscreenContext)+" - offscreenDrawable: "+(null!=offscreenDrawable));
}
if (offscreenContext != null) {
offscreenContext.destroy();
offscreenContext = null;
}
if (offscreenDrawable != null) {
final AbstractGraphicsDevice adevice = offscreenDrawable.getNativeSurface().getGraphicsConfiguration().getScreen().getDevice();
offscreenDrawable.setRealized(false);
offscreenDrawable = null;
if(null != adevice) {
adevice.close();
}
}
}
@Override
public GLContext createContext(GLContext shareWith) {
return (null != offscreenDrawable) ? offscreenDrawable.createContext(shareWith) : null;
}
@Override
public void setContext(GLContext ctx) {
offscreenContext=(GLContextImpl)ctx;
}
@Override
public GLContext getContext() {
return offscreenContext;
}
@Override
public GLDrawable getDrawable() {
return offscreenDrawable;
}
@Override
public GLCapabilitiesImmutable getChosenGLCapabilities() {
if (offscreenDrawable == null) {
return null;
}
return offscreenDrawable.getChosenGLCapabilities();
}
@Override
public GLProfile getGLProfile() {
if (offscreenDrawable == null) {
return null;
}
return offscreenDrawable.getGLProfile();
}
@Override
public void handleReshape() {
destroy();
initialize();
readBackWidthInPixels = Math.max(1, panelWidth);
readBackHeightInPixels = Math.max(1, panelHeight);
if (offscreenImage != null) {
offscreenImage.flush();
offscreenImage = null;
}
}
@Override
protected void doPaintComponentImpl() {
helper.invokeGL(offscreenDrawable, offscreenContext, updaterDisplayAction, updaterInitAction);
}
@Override
protected int getGLPixelType() {
return offscreenContext.getOffscreenContextPixelDataType();
}
@Override
protected boolean flipVertically() {
return offscreenContext.offscreenImageNeedsVerticalFlip();
}
}
class PbufferBackend extends AbstractReadbackBackend {
private GLPbuffer pbuffer;
private int pbufferWidth = 256;
private int pbufferHeight = 256;
@Override
public boolean isUsingOwnThreadManagment() { return false; }
@Override
public void initialize() {
if (pbuffer != null) {
throw new InternalError("Creating pbuffer twice without destroying it (memory leak / correctness bug)");
}
if(DEBUG) {
System.err.println(getThreadName()+": PbufferBackend: initialize()");
}
try {
pbuffer = factory.createGLPbuffer(null /* default platform device */,
offscreenCaps,
null,
pbufferWidth,
pbufferHeight,
shareWith);
pbuffer.setContextCreationFlags(additionalCtxCreationFlags);
pbuffer.addGLEventListener(updater);
isInitialized = true;
} catch (GLException e) {
if (DEBUG) {
e.printStackTrace();
System.err.println(getThreadName()+": GLJPanel: Falling back on software rendering because of problems creating pbuffer");
}
hardwareAccelerationDisabled = true;
backend = null;
isInitialized = false;
createAndInitializeBackend();
}
}
@Override
public void destroy() {
if(DEBUG) {
System.err.println(getThreadName()+": PbufferBackend: destroy() - pbuffer: "+(null!=pbuffer));
}
if (pbuffer != null) {
pbuffer.destroy();
pbuffer = null;
}
}
@Override
public GLContext createContext(GLContext shareWith) {
return (null != pbuffer) ? pbuffer.createContext(shareWith) : null;
}
@Override
public void setContext(GLContext ctx) {
if (pbuffer == null || Beans.isDesignTime()) {
return;
}
pbuffer.setContext(ctx);
}
@Override
public GLContext getContext() {
// Workaround for crashes in NetBeans GUI builder
if (null == pbuffer || Beans.isDesignTime()) {
return null;
}
return pbuffer.getContext();
}
@Override
public GLDrawable getDrawable() {
return pbuffer;
}
@Override
public GLCapabilitiesImmutable getChosenGLCapabilities() {
if (pbuffer == null) {
return null;
}
return pbuffer.getChosenGLCapabilities();
}
@Override
public GLProfile getGLProfile() {
if (pbuffer == null) {
return null;
}
return pbuffer.getGLProfile();
}
@Override
public void handleReshape() {
// Use factor larger than 2 during shrinks for some hysteresis
float shrinkFactor = 2.5f;
if ((panelWidth > pbufferWidth) || (panelHeight > pbufferHeight) ||
(panelWidth < (pbufferWidth / shrinkFactor)) || (panelHeight < (pbufferHeight / shrinkFactor))) {
if (DEBUG) {
System.err.println(getThreadName()+": Resizing pbuffer from (" + pbufferWidth + ", " + pbufferHeight + ") " +
" to fit (" + panelWidth + ", " + panelHeight + ")");
}
// Must destroy and recreate pbuffer to fit
if (pbuffer != null) {
// Watch for errors during pbuffer destruction (due to
// buggy / bad OpenGL drivers, in particular SiS) and fall
// back to software rendering
try {
pbuffer.destroy();
} catch (GLException e) {
hardwareAccelerationDisabled = true;
backend = null;
isInitialized = false;
// Just disabled hardware acceleration during this resize operation; do a fixup
readBackWidthInPixels = Math.max(1, panelWidth);
readBackHeightInPixels = Math.max(1, panelHeight);
if (DEBUG) {
System.err.println(getThreadName()+": Warning: falling back to software rendering due to bugs in OpenGL drivers");
e.printStackTrace();
}
createAndInitializeBackend();
return;
}
}
pbuffer = null;
isInitialized = false;
pbufferWidth = getNextPowerOf2(panelWidth);
pbufferHeight = getNextPowerOf2(panelHeight);
if (DEBUG && !hardwareAccelerationDisabled) {
System.err.println(getThreadName()+": New pbuffer size is (" + pbufferWidth + ", " + pbufferHeight + ")");
}
initialize();
}
// It looks like NVidia's drivers (at least the ones on my
// notebook) are buggy and don't allow a rectangle of less than
// the pbuffer's width to be read...this doesn't really matter
// because it's the Graphics.drawImage() calls that are the
// bottleneck. Should probably make the size of the offscreen
// image be the exact size of the pbuffer to save some work on
// resize operations...
readBackWidthInPixels = pbufferWidth;
readBackHeightInPixels = panelHeight;
if (offscreenImage != null) {
offscreenImage.flush();
offscreenImage = null;
}
}
@Override
protected void doPaintComponentImpl() {
pbuffer.display();
}
@Override
protected int getGLPixelType() {
// This seems to be a good choice on all platforms
return GL2.GL_UNSIGNED_INT_8_8_8_8_REV;
}
@Override
protected boolean flipVertically() {
return true;
}
}
class J2DOGLBackend implements Backend {
// Opaque Object identifier representing the Java2D surface we are
// drawing to; used to determine when to destroy and recreate JOGL
// context
private Object j2dSurface;
// Graphics object being used during Java2D update action
// (absolutely essential to cache this)
// No-op context representing the Java2D OpenGL context
private GLContext j2dContext;
// Context associated with no-op drawable representing the JOGL
// OpenGL context
private GLDrawable joglDrawable;
// The real OpenGL context JOGL uses to render
private GLContext joglContext;
// State captured from Java2D OpenGL context necessary in order to
// properly render into Java2D back buffer
private int[] drawBuffer = new int[1];
private int[] readBuffer = new int[1];
// This is required when the FBO option of the Java2D / OpenGL
// pipeline is active
private int[] frameBuffer = new int[1];
// Current (as of this writing) NVidia drivers have a couple of bugs
// relating to the sharing of framebuffer and renderbuffer objects
// between contexts. It appears we have to (a) reattach the color
// attachment and (b) actually create new depth buffer storage and
// attach it in order for the FBO to behave properly in our context.
private boolean checkedForFBObjectWorkarounds;
private boolean fbObjectWorkarounds;
private int[] frameBufferDepthBuffer;
private int[] frameBufferTexture;
private boolean createNewDepthBuffer;
// Current (as of this writing) ATI drivers have problems when the
// same FBO is bound in two different contexts. Here we check for
// this case and explicitly release the FBO from Java2D's context
// before switching to ours. Java2D will re-bind the FBO when it
// makes its context current the next time. Interestingly, if we run
// this code path on NVidia hardware, it breaks the rendering
// results -- no output is generated. This doesn't appear to be an
// interaction with the abovementioned NVidia-specific workarounds,
// as even if we disable that code the FBO is still reported as
// incomplete in our context.
private boolean checkedGLVendor;
private boolean vendorIsATI;
// Holding on to this GraphicsConfiguration is a workaround for a
// problem in the Java 2D / JOGL bridge when FBOs are enabled; see
// comment related to Issue 274 below
private GraphicsConfiguration workaroundConfig;
@Override
public boolean isUsingOwnThreadManagment() { return true; }
@Override
public void initialize() {
if(DEBUG) {
System.err.println(getThreadName()+": J2DOGL: initialize()");
}
// No-op in this implementation; everything is done lazily
isInitialized = true;
}
@Override
public void destroy() {
Java2D.invokeWithOGLContextCurrent(null, new Runnable() {
@Override
public void run() {
if(DEBUG) {
System.err.println(getThreadName()+": J2DOGL: destroy() - joglContext: "+(null!=joglContext)+" - joglDrawable: "+(null!=joglDrawable));
}
if (joglContext != null) {
joglContext.destroy();
joglContext = null;
}
joglDrawable = null;
if (j2dContext != null) {
j2dContext.destroy();
j2dContext = null;
}
}
});
}
@Override
public void setOpaque(boolean opaque) {
// Empty in this implementation
}
@Override
public GLContext createContext(GLContext shareWith) {
if(null != shareWith) {
throw new GLException("J2DOGLBackend cannot create context w/ additional shared context, since it already needs to share the context w/ J2D.");
}
return (null != joglDrawable && null != j2dContext) ? joglDrawable.createContext(j2dContext) : null;
}
@Override
public void setContext(GLContext ctx) {
joglContext=ctx;
}
@Override
public GLContext getContext() {
return joglContext;
}
@Override
public GLDrawable getDrawable() {
return joglDrawable;
}
@Override
public GLCapabilitiesImmutable getChosenGLCapabilities() {
// FIXME: should do better than this; is it possible to using only platform-independent code?
return new GLCapabilities(null);
}
@Override
public GLProfile getGLProfile() {
// FIXME: should do better than this; is it possible to using only platform-independent code?
return GLProfile.getDefault(GLProfile.getDefaultDevice());
}
@Override
public void handleReshape() {
// Empty in this implementation
}
@Override
public boolean preGL(Graphics g) {
GL2 gl = joglContext.getGL().getGL2();
// Set up needed state in JOGL context from Java2D context
gl.glEnable(GL2.GL_SCISSOR_TEST);
Rectangle r = Java2D.getOGLScissorBox(g);
if (r == null) {
if (DEBUG) {
System.err.println(getThreadName()+": Java2D.getOGLScissorBox() returned null");
}
return false;
}
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: gl.glScissor(" + r.x + ", " + r.y + ", " + r.width + ", " + r.height + ")");
}
gl.glScissor(r.x, r.y, r.width, r.height);
Rectangle oglViewport = Java2D.getOGLViewport(g, panelWidth, panelHeight);
// If the viewport X or Y changes, in addition to the panel's
// width or height, we need to send a reshape operation to the
// client
if ((viewportX != oglViewport.x) ||
(viewportY != oglViewport.y)) {
sendReshape = true;
if (DEBUG) {
System.err.println(getThreadName()+": Sending reshape because viewport changed");
System.err.println(" viewportX (" + viewportX + ") ?= oglViewport.x (" + oglViewport.x + ")");
System.err.println(" viewportY (" + viewportY + ") ?= oglViewport.y (" + oglViewport.y + ")");
}
}
viewportX = oglViewport.x;
viewportY = oglViewport.y;
// If the FBO option is active, bind to the FBO from the Java2D
// context.
// Note that all of the plumbing in the context sharing stuff will
// allow us to bind to this object since it's in our namespace.
if (Java2D.isFBOEnabled() &&
Java2D.getOGLSurfaceType(g) == Java2D.FBOBJECT) {
// The texture target for Java2D's OpenGL pipeline when using FBOs
// -- either GL_TEXTURE_2D or GL_TEXTURE_RECTANGLE_ARB
int fboTextureTarget = Java2D.getOGLTextureType(g);
if (!checkedForFBObjectWorkarounds) {
checkedForFBObjectWorkarounds = true;
gl.glBindTexture(fboTextureTarget, 0);
gl.glBindFramebuffer(GL2.GL_FRAMEBUFFER, frameBuffer[0]);
int status = gl.glCheckFramebufferStatus(GL.GL_FRAMEBUFFER);
if (status != GL.GL_FRAMEBUFFER_COMPLETE) {
// Need to do workarounds
fbObjectWorkarounds = true;
createNewDepthBuffer = true;
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: ERR GL_FRAMEBUFFER_BINDING: Discovered Invalid J2D FBO("+frameBuffer[0]+"): "+FBObject.getStatusString(status) +
", frame_buffer_object workarounds to be necessary");
}
} else {
// Don't need the frameBufferTexture temporary any more
frameBufferTexture = null;
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: OK GL_FRAMEBUFFER_BINDING: "+frameBuffer[0]);
}
}
}
if (fbObjectWorkarounds && createNewDepthBuffer) {
if (frameBufferDepthBuffer == null)
frameBufferDepthBuffer = new int[1];
// Create our own depth renderbuffer and associated storage
// If we have an old one, delete it
if (frameBufferDepthBuffer[0] != 0) {
gl.glDeleteRenderbuffers(1, frameBufferDepthBuffer, 0);
frameBufferDepthBuffer[0] = 0;
}
gl.glBindTexture(fboTextureTarget, frameBufferTexture[0]);
int[] width = new int[1];
int[] height = new int[1];
gl.glGetTexLevelParameteriv(fboTextureTarget, 0, GL2.GL_TEXTURE_WIDTH, width, 0);
gl.glGetTexLevelParameteriv(fboTextureTarget, 0, GL2.GL_TEXTURE_HEIGHT, height, 0);
gl.glGenRenderbuffers(1, frameBufferDepthBuffer, 0);
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: Generated frameBufferDepthBuffer " + frameBufferDepthBuffer[0] +
" with width " + width[0] + ", height " + height[0]);
}
gl.glBindRenderbuffer(GL.GL_RENDERBUFFER, frameBufferDepthBuffer[0]);
// FIXME: may need a loop here like in Java2D
gl.glRenderbufferStorage(GL.GL_RENDERBUFFER, GL2GL3.GL_DEPTH_COMPONENT24, width[0], height[0]);
gl.glBindRenderbuffer(GL2.GL_RENDERBUFFER, 0);
createNewDepthBuffer = false;
}
gl.glBindTexture(fboTextureTarget, 0);
gl.glBindFramebuffer(GL.GL_FRAMEBUFFER, frameBuffer[0]);
if (fbObjectWorkarounds) {
// Hook up the color and depth buffer attachment points for this framebuffer
gl.glFramebufferTexture2D(GL.GL_FRAMEBUFFER,
GL.GL_COLOR_ATTACHMENT0,
fboTextureTarget,
frameBufferTexture[0],
0);
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: frameBufferDepthBuffer: " + frameBufferDepthBuffer[0]);
}
gl.glFramebufferRenderbuffer(GL.GL_FRAMEBUFFER,
GL.GL_DEPTH_ATTACHMENT,
GL.GL_RENDERBUFFER,
frameBufferDepthBuffer[0]);
}
if (DEBUG) {
int status = gl.glCheckFramebufferStatus(GL.GL_FRAMEBUFFER);
if (status != GL.GL_FRAMEBUFFER_COMPLETE) {
throw new GLException("Error: framebuffer was incomplete: status = 0x" +
Integer.toHexString(status));
}
}
} else {
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: Setting up drawBuffer " + drawBuffer[0] +
" and readBuffer " + readBuffer[0]);
}
gl.glDrawBuffer(drawBuffer[0]);
gl.glReadBuffer(readBuffer[0]);
}
return true;
}
@Override
public void postGL(Graphics g, boolean isDisplay) {
// Cause OpenGL pipeline to flush its results because
// otherwise it's possible we will buffer up multiple frames'
// rendering results, resulting in apparent mouse lag
GL gl = getGL();
gl.glFinish();
if (Java2D.isFBOEnabled() &&
Java2D.getOGLSurfaceType(g) == Java2D.FBOBJECT) {
// Unbind the framebuffer from our context to work around
// apparent driver bugs or at least unspecified behavior causing
// OpenGL to run out of memory with certain cards and drivers
gl.glBindFramebuffer(GL.GL_FRAMEBUFFER, 0);
}
}
@Override
public void doPaintComponent(final Graphics g) {
// This is a workaround for an issue in the Java 2D / JOGL
// bridge (reported by an end user as JOGL Issue 274) where Java
// 2D can occasionally leave its internal OpenGL context current
// to the on-screen window rather than its internal "scratch"
// pbuffer surface to which the FBO is attached. JOGL expects to
// find a stable OpenGL drawable (on Windows, an HDC) upon which
// it can create another OpenGL context. It turns out that, on
// Windows, when Java 2D makes its internal OpenGL context
// current against the window in order to put pixels on the
// screen, it gets the device context for the window, makes its
// context current, and releases the device context. This means
// that when JOGL's Runnable gets to run below, the HDC is
// already invalid. The workaround for this is to force Java 2D
// to make its context current to the scratch surface, which we
// can do by executing an empty Runnable with the "shared"
// context current. This will be fixed in a Java SE 6 update
// release, hopefully 6u2.
if (Java2D.isFBOEnabled()) {
if (workaroundConfig == null) {
workaroundConfig = GraphicsEnvironment.
getLocalGraphicsEnvironment().
getDefaultScreenDevice().
getDefaultConfiguration();
}
Java2D.invokeWithOGLSharedContextCurrent(workaroundConfig, new Runnable() { @Override
public void run() {}});
}
Java2D.invokeWithOGLContextCurrent(g, new Runnable() {
@Override
public void run() {
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel.invokeWithOGLContextCurrent");
}
// Create no-op context representing Java2D context
if (j2dContext == null) {
j2dContext = factory.createExternalGLContext();
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel.Created External Context: "+j2dContext);
}
if (DEBUG) {
// j2dContext.setGL(new DebugGL2(j2dContext.getGL().getGL2()));
}
// Check to see whether we can support the requested
// capabilities or need to fall back to a pbuffer
// FIXME: add more checks?
j2dContext.makeCurrent();
GL gl = j2dContext.getGL();
if ((getGLInteger(gl, GL.GL_RED_BITS) < offscreenCaps.getRedBits()) ||
(getGLInteger(gl, GL.GL_GREEN_BITS) < offscreenCaps.getGreenBits()) ||
(getGLInteger(gl, GL.GL_BLUE_BITS) < offscreenCaps.getBlueBits()) ||
// (getGLInteger(gl, GL.GL_ALPHA_BITS) < offscreenCaps.getAlphaBits()) ||
(getGLInteger(gl, GL2.GL_ACCUM_RED_BITS) < offscreenCaps.getAccumRedBits()) ||
(getGLInteger(gl, GL2.GL_ACCUM_GREEN_BITS) < offscreenCaps.getAccumGreenBits()) ||
(getGLInteger(gl, GL2.GL_ACCUM_BLUE_BITS) < offscreenCaps.getAccumBlueBits()) ||
(getGLInteger(gl, GL2.GL_ACCUM_ALPHA_BITS) < offscreenCaps.getAccumAlphaBits()) ||
// (getGLInteger(gl, GL2.GL_DEPTH_BITS) < offscreenCaps.getDepthBits()) ||
(getGLInteger(gl, GL.GL_STENCIL_BITS) < offscreenCaps.getStencilBits())) {
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: Falling back to pbuffer-based support because Java2D context insufficient");
System.err.println(" Available Required");
System.err.println("GL_RED_BITS " + getGLInteger(gl, GL.GL_RED_BITS) + " " + offscreenCaps.getRedBits());
System.err.println("GL_GREEN_BITS " + getGLInteger(gl, GL.GL_GREEN_BITS) + " " + offscreenCaps.getGreenBits());
System.err.println("GL_BLUE_BITS " + getGLInteger(gl, GL.GL_BLUE_BITS) + " " + offscreenCaps.getBlueBits());
System.err.println("GL_ALPHA_BITS " + getGLInteger(gl, GL.GL_ALPHA_BITS) + " " + offscreenCaps.getAlphaBits());
System.err.println("GL_ACCUM_RED_BITS " + getGLInteger(gl, GL2.GL_ACCUM_RED_BITS) + " " + offscreenCaps.getAccumRedBits());
System.err.println("GL_ACCUM_GREEN_BITS " + getGLInteger(gl, GL2.GL_ACCUM_GREEN_BITS) + " " + offscreenCaps.getAccumGreenBits());
System.err.println("GL_ACCUM_BLUE_BITS " + getGLInteger(gl, GL2.GL_ACCUM_BLUE_BITS) + " " + offscreenCaps.getAccumBlueBits());
System.err.println("GL_ACCUM_ALPHA_BITS " + getGLInteger(gl, GL2.GL_ACCUM_ALPHA_BITS) + " " + offscreenCaps.getAccumAlphaBits());
System.err.println("GL_DEPTH_BITS " + getGLInteger(gl, GL.GL_DEPTH_BITS) + " " + offscreenCaps.getDepthBits());
System.err.println("GL_STENCIL_BITS " + getGLInteger(gl, GL.GL_STENCIL_BITS) + " " + offscreenCaps.getStencilBits());
}
isInitialized = false;
backend = null;
oglPipelineEnabled = false;
handleReshape = true;
j2dContext.destroy();
j2dContext = null;
return;
}
} else {
j2dContext.makeCurrent();
}
try {
captureJ2DState(j2dContext.getGL(), g);
Object curSurface = Java2D.getOGLSurfaceIdentifier(g);
if (curSurface != null) {
if (j2dSurface != curSurface) {
if (joglContext != null) {
joglContext.destroy();
joglContext = null;
joglDrawable = null;
sendReshape = true;
if (DEBUG) {
System.err.println(getThreadName()+": Sending reshape because surface changed");
System.err.println("New surface = " + curSurface);
}
}
j2dSurface = curSurface;
if (DEBUG) {
System.err.print(getThreadName()+": Surface type: ");
int surfaceType = Java2D.getOGLSurfaceType(g);
if (surfaceType == Java2D.UNDEFINED) {
System.err.println("UNDEFINED");
} else if (surfaceType == Java2D.WINDOW) {
System.err.println("WINDOW");
} else if (surfaceType == Java2D.PBUFFER) {
System.err.println("PBUFFER");
} else if (surfaceType == Java2D.TEXTURE) {
System.err.println("TEXTURE");
} else if (surfaceType == Java2D.FLIP_BACKBUFFER) {
System.err.println("FLIP_BACKBUFFER");
} else if (surfaceType == Java2D.FBOBJECT) {
System.err.println("FBOBJECT");
} else {
System.err.println("(Unknown surface type " + surfaceType + ")");
}
}
}
if (joglContext == null) {
AbstractGraphicsDevice device = j2dContext.getGLDrawable().getNativeSurface().getGraphicsConfiguration().getScreen().getDevice();
if (factory.canCreateExternalGLDrawable(device)) {
joglDrawable = factory.createExternalGLDrawable();
joglContext = joglDrawable.createContext(j2dContext);
if (DEBUG) {
System.err.println("-- Created External Drawable: "+joglDrawable);
System.err.println("-- Created Context: "+joglContext);
}
} else if (factory.canCreateContextOnJava2DSurface(device)) {
// Mac OS X code path
joglContext = factory.createContextOnJava2DSurface(g, j2dContext);
if (DEBUG) {
System.err.println("-- Created Context: "+joglContext);
}
}
/*if (DEBUG) {
joglContext.setGL(new DebugGL2(joglContext.getGL().getGL2()));
}*/
if (Java2D.isFBOEnabled() &&
Java2D.getOGLSurfaceType(g) == Java2D.FBOBJECT &&
fbObjectWorkarounds) {
createNewDepthBuffer = true;
}
}
if (joglContext instanceof Java2DGLContext) {
// Mac OS X code path
((Java2DGLContext) joglContext).setGraphics(g);
}
helper.invokeGL(joglDrawable, joglContext, updaterDisplayAction, updaterInitAction);
}
} finally {
j2dContext.release();
}
}
});
}
private void captureJ2DState(GL gl, Graphics g) {
gl.glGetIntegerv(GL2.GL_DRAW_BUFFER, drawBuffer, 0);
gl.glGetIntegerv(GL2.GL_READ_BUFFER, readBuffer, 0);
if (Java2D.isFBOEnabled() &&
Java2D.getOGLSurfaceType(g) == Java2D.FBOBJECT) {
gl.glGetIntegerv(GL.GL_FRAMEBUFFER_BINDING, frameBuffer, 0);
if(!gl.glIsFramebuffer(frameBuffer[0])) {
checkedForFBObjectWorkarounds=true;
fbObjectWorkarounds = true;
createNewDepthBuffer = true;
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: Fetched ERR GL_FRAMEBUFFER_BINDING: "+frameBuffer[0]+" - NOT A FBO"+
", frame_buffer_object workarounds to be necessary");
}
} else if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: Fetched OK GL_FRAMEBUFFER_BINDING: "+frameBuffer[0]);
}
if(fbObjectWorkarounds || !checkedForFBObjectWorkarounds) {
// See above for description of what we are doing here
if (frameBufferTexture == null)
frameBufferTexture = new int[1];
// Query the framebuffer for its color buffer so we can hook
// it back up in our context (should not be necessary)
gl.glGetFramebufferAttachmentParameteriv(GL.GL_FRAMEBUFFER,
GL.GL_COLOR_ATTACHMENT0,
GL.GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME,
frameBufferTexture, 0);
if (DEBUG) {
System.err.println(getThreadName()+": GLJPanel: FBO COLOR_ATTACHMENT0: " + frameBufferTexture[0]);
}
}
if (!checkedGLVendor) {
checkedGLVendor = true;
String vendor = gl.glGetString(GL.GL_VENDOR);
if ((vendor != null) &&
vendor.startsWith("ATI")) {
vendorIsATI = true;
}
}
if (vendorIsATI) {
// Unbind the FBO from Java2D's context as it appears that
// driver bugs on ATI's side are causing problems if the FBO is
// simultaneously bound to more than one context. Java2D will
// re-bind the FBO during the next validation of its context.
// Note: this breaks rendering at least on NVidia hardware
gl.glBindFramebuffer(GL.GL_FRAMEBUFFER, 0);
}
}
}
}
}