Bug 830 - Refine Heuristics for to query whether GLDrawableUtil.swapGLContextAndAllGLEventListener is safe: Add Accumulator Buffer bits

5 files changed, 35 insertions, 18 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
index 8473a6e27..956693c4a 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
@@ -28,7 +28,6 @@
 package com.jogamp.opengl.util;
 
 import javax.media.nativewindow.AbstractGraphicsDevice;
-
 import javax.media.nativewindow.NativeSurface;
 import javax.media.opengl.GLAnimatorControl;
 import javax.media.opengl.GLAutoDrawable;
@@ -158,23 +157,41 @@ public class GLDrawableUtil {
      * <ul>
      *   <li>Switching between on- and offscreen and one of the following is <code>true</code>:
      *     <ul>
-     *       <li>{@link GLCapabilitiesImmutable#getSampleBuffers() MSAA is used}[1], or
-     *       <li>{@link GLCapabilitiesImmutable#getStereo() Stereo is used}
+     *       <li>{@link GLCapabilitiesImmutable#getSampleBuffers() MSAA is <i>used</i>} [1] in <code>chosenCapsA</code> or <code>chosenCapsB</code></li>
+     *       <li>{@link GLCapabilitiesImmutable#getStereo() Stereo is <i>used</i>} in <code>chosenCapsA</code> or <code>chosenCapsB</code></li>
+     *       <li>{@link GLCapabilitiesImmutable#getAccumAlphaBits() Accumulator Buffer is <i>requested</i>} [2] in <code>requestedCaps</code></li>
      *     </ul></li>
      * </ul>
      * Otherwise method returns <code>true</code>
      * </p>
-     * <p>
+     * <pre>
      * [1] See Bug 830: swapGLContextAndAllGLEventListener and onscreen MSAA w/ NV/GLX
-     * </p>
+     *     On NVidia GPUs w/ it's proprietary driver context swapping does not work if MSAA is involved
+     *     and when swapping on- to offscreen.
+     * </pre>
+     * <pre>
+     * [2] On AMD GPUs w/ it's proprietary driver, requesting an accumulator buffer leads to receive an accumulator buffer configuration,
+     *     for which context swapping does not work when swapping on- to offscreen and vice-versa, i.e. cannot make context current.
+     *     With AMD and Mesa drivers we only receive an accumulator buffer if requested,
+     *     where on NVidia drivers all configurations contain the accumulator buffer.
+     *     On both drivers, NVidia and Mesa, context swapping with accumulator buffer works.
+     * </pre>
+     * @param requestedCaps requested {@link GLCapabilitiesImmutable} which are intended for usage by both {@link GLAutoDrawable}s A and B
+     * @param chosenCapsA chosen {@link GLCapabilitiesImmutable} of {@link GLAutoDrawable} A, which {@link GLContext} is intended to be swapped
+     * @param chosenCapsB chosen {@link GLCapabilitiesImmutable} of {@link GLAutoDrawable} B, which {@link GLContext} is intended to be swapped
      * @see #swapGLContext(GLAutoDrawable, GLAutoDrawable)
      * @see #swapGLContextAndAllGLEventListener(GLAutoDrawable, GLAutoDrawable)
      */
-    public static boolean isSwapGLContextSafe(final GLCapabilitiesImmutable a, final GLCapabilitiesImmutable b) {
-        if( ( a.isOnscreen() && !b.isOnscreen() || !a.isOnscreen() && b.isOnscreen() ) && // switching between on- and offscreen
+    public static boolean isSwapGLContextSafe(final GLCapabilitiesImmutable requestedCaps, final GLCapabilitiesImmutable chosenCapsA, final GLCapabilitiesImmutable chosenCapsB) {
+        final boolean usingAccumulatorBuffer = requestedCaps.getAccumAlphaBits() > 0 ||
+                                               requestedCaps.getAccumRedBits()   > 0 ||
+                                               requestedCaps.getAccumGreenBits() > 0 ||
+                                               requestedCaps.getAccumBlueBits()  > 0;
+        if( ( chosenCapsA.isOnscreen() && !chosenCapsB.isOnscreen() || !chosenCapsA.isOnscreen() && chosenCapsB.isOnscreen() ) && // switching between on- and offscreen
             (
-              ( a.getSampleBuffers() || b.getSampleBuffers() ) ||  // MSAA involved
-              ( a.getStereo() || b.getStereo() )                   // Stereo involved
+              ( chosenCapsA.getSampleBuffers() || chosenCapsB.getSampleBuffers() ) ||  // MSAA involved
+              ( chosenCapsA.getStereo() || chosenCapsB.getStereo() )               ||  // Stereo involved
+              usingAccumulatorBuffer                                                   // Using accumulator buffer
             )
           )
         {
@@ -207,7 +224,7 @@ public class GLDrawableUtil {
      * e.g. via {@link Threading#invokeOnOpenGLThread(boolean, Runnable)}.
      * </p>
      * @throws GLException if the {@link AbstractGraphicsDevice} are incompatible w/ each other.
-     * @see #isSwapGLContextSafe(GLCapabilitiesImmutable, GLCapabilitiesImmutable)
+     * @see #isSwapGLContextSafe(GLCapabilitiesImmutable, GLCapabilitiesImmutable, GLCapabilitiesImmutable)
      */
     public static final void swapGLContextAndAllGLEventListener(final GLAutoDrawable a, final GLAutoDrawable b) {
         final GLEventListenerState gllsA = GLEventListenerState.moveFrom(a, true);
@@ -249,7 +266,7 @@ public class GLDrawableUtil {
      * </p>
      * @param a
      * @param b
-     * @see #isSwapGLContextSafe(GLCapabilitiesImmutable, GLCapabilitiesImmutable)
+     * @see #isSwapGLContextSafe(GLCapabilitiesImmutable, GLCapabilitiesImmutable, GLCapabilitiesImmutable)
      */
     public static final void swapGLContext(final GLAutoDrawable a, final GLAutoDrawable b) {
         final GLAnimatorControl aAnim = a.getAnimator();
diff --git a/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java b/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
index 4bd4b2c35..0599c1086 100644
--- a/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
+++ b/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
@@ -875,7 +875,7 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
               newGLADCaps.setSampleBuffers(0 < printNumSamples);
               newGLADCaps.setNumSamples(printNumSamples);
           }
-          final boolean reqNewGLADSafe = GLDrawableUtil.isSwapGLContextSafe(gladCaps, newGLADCaps);
+          final boolean reqNewGLADSafe = GLDrawableUtil.isSwapGLContextSafe(getRequestedGLCapabilities(), gladCaps, newGLADCaps);
 
           final boolean reqNewGLAD = ( reqNewGLADOnscrn || reqNewGLADSamples || reqNewGLADSize ) && reqNewGLADSafe;
 
diff --git a/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java b/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java
index 0c30945cc..6e6bb1cad 100644
--- a/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java
+++ b/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java
@@ -726,7 +726,7 @@ public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosing
               newGLADCaps.setSampleBuffers(0 < printNumSamples);
               newGLADCaps.setNumSamples(printNumSamples);
           }
-          final boolean reqNewGLADSafe = GLDrawableUtil.isSwapGLContextSafe(gladCaps, newGLADCaps);
+          final boolean reqNewGLADSafe = GLDrawableUtil.isSwapGLContextSafe(getRequestedGLCapabilities(), gladCaps, newGLADCaps);
 
           final boolean reqNewGLAD = ( reqNewGLADSamples || reqNewGLADSize ) && reqNewGLADSafe;
 
diff --git a/src/newt/classes/com/jogamp/newt/awt/NewtCanvasAWT.java b/src/newt/classes/com/jogamp/newt/awt/NewtCanvasAWT.java
index c0c28d515..397c8109b 100644
--- a/src/newt/classes/com/jogamp/newt/awt/NewtCanvasAWT.java
+++ b/src/newt/classes/com/jogamp/newt/awt/NewtCanvasAWT.java
@@ -657,7 +657,7 @@ public class NewtCanvasAWT extends java.awt.Canvas implements WindowClosingProto
                     newGLADCaps.setSampleBuffers(0 < printNumSamples);
                     newGLADCaps.setNumSamples(printNumSamples);
                 }
-                final boolean reqNewGLADSafe = GLDrawableUtil.isSwapGLContextSafe(gladCaps, newGLADCaps);
+                final boolean reqNewGLADSafe = GLDrawableUtil.isSwapGLContextSafe(glad.getRequestedGLCapabilities(), gladCaps, newGLADCaps);
 
                 final boolean reqNewGLAD = ( reqNewGLADOnscrn || reqNewGLADSamples || reqNewGLADSize ) && reqNewGLADSafe;
 
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/acore/glels/GLContextDrawableSwitchBase0.java b/src/test/com/jogamp/opengl/test/junit/jogl/acore/glels/GLContextDrawableSwitchBase0.java
index 239cab26d..08614f9fb 100644
--- a/src/test/com/jogamp/opengl/test/junit/jogl/acore/glels/GLContextDrawableSwitchBase0.java
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/acore/glels/GLContextDrawableSwitchBase0.java
@@ -183,17 +183,17 @@ public abstract class GLContextDrawableSwitchBase0 extends UITestCase {
         testImpl(reqGLCaps, true);
     }
 
-    private void testImpl(final GLCapabilitiesImmutable srcCaps, final boolean dstOnscreen) throws InterruptedException, InvocationTargetException {
+    private void testImpl(final GLCapabilitiesImmutable srcCapsRequested, final boolean dstOnscreen) throws InterruptedException, InvocationTargetException {
         final QuitAdapter quitAdapter = new QuitAdapter();
-        final GLAutoDrawable gladSource = createGLAutoDrawable(quitAdapter, srcCaps, width, height);
+        final GLAutoDrawable gladSource = createGLAutoDrawable(quitAdapter, srcCapsRequested, width, height);
 
         final GLCapabilitiesImmutable srcCapsChosen = gladSource.getChosenGLCapabilities();
 
         final GLCapabilities dstCaps = (GLCapabilities) srcCapsChosen.cloneMutable();
         dstCaps.setOnscreen(dstOnscreen);
 
-        final boolean isSwapGLContextSafe = GLDrawableUtil.isSwapGLContextSafe(srcCapsChosen, dstCaps);
-        System.err.println("Source Caps Requested: "+srcCaps);
+        final boolean isSwapGLContextSafe = GLDrawableUtil.isSwapGLContextSafe(srcCapsRequested, srcCapsChosen, dstCaps);
+        System.err.println("Source Caps Requested: "+srcCapsRequested);
         System.err.println("Source Caps Chosen   : "+srcCapsChosen);
         System.err.println("Dest   Caps Requested: "+dstCaps);
         System.err.println("Is SwapGLContext safe: "+isSwapGLContextSafe);