Merge pull request #87 from TomNuydens/bug_1160

Unit test for bug 1160: context sharing between external GL context and offscreen drawable

1 files changed, 180 insertions, 0 deletions

diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/offscreen/ShareWithExternalContextTest.java b/src/test/com/jogamp/opengl/test/junit/jogl/offscreen/ShareWithExternalContextTest.java
new file mode 100644
index 000000000..cd5ce8217
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/offscreen/ShareWithExternalContextTest.java
@@ -0,0 +1,180 @@
+package com.jogamp.opengl.test.junit.jogl.offscreen;
+
+import java.awt.EventQueue;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.lang.reflect.InvocationTargetException;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+import javax.swing.Timer;
+
+import org.junit.Test;
+
+import com.jogamp.opengl.*;
+
+/**
+ * Test for context sharing with an external context. Creates an external GL context, then
+ * sets up an offscreen drawable which shares with it. The test contains two cases: one
+ * which creates and repaints the offscreen drawable on the EDT, and one which does so on
+ * a dedicated thread. On Windows+NVidia, the former fails.
+ */
+public class ShareWithExternalContextTest {
+
+  private static final int LATCH_COUNT = 5;
+
+  private void doTest(boolean aUseEDT) throws Exception {
+    CountDownLatch latch = new CountDownLatch(LATCH_COUNT);
+    final MyGLEventListener listener = new MyGLEventListener(aUseEDT, latch);
+
+    /**
+     * For the purpose of this test, this offscreen drawable will be used to create
+     * an external GL context. In the actual application, the external context
+     * represents a GL context which lives outside the JVM.
+     */
+    Runnable runnable = new Runnable() {
+      public void run() {
+        GLProfile glProfile = GLProfile.getDefault();
+        GLCapabilities caps = new GLCapabilities(glProfile);
+        GLAutoDrawable buffer = GLDrawableFactory.getDesktopFactory().createOffscreenAutoDrawable(
+            GLProfile.getDefaultDevice(), caps, null, 512, 512
+        );
+        // The listener will set up the context sharing in its init() method.
+        buffer.addGLEventListener(listener);
+        buffer.display();
+      }
+    };
+
+    // Wait for test to finish.
+    Thread thread = new Thread(runnable);
+    thread.start();
+    thread.join();
+    latch.await(3, TimeUnit.SECONDS);
+
+    // If exceptions occurred, fail.
+    Exception e = listener.fException;
+    if (e != null) {
+      throw e;
+    }
+  }
+
+  @Test
+  public void testOnEDT() throws Exception {
+    doTest(true);
+  }
+
+  @Test
+  public void testOnExecutorThread() throws Exception {
+    doTest(false);
+  }
+
+  /**
+   * Listener that creates an external drawable and an offscreen drawable, with context
+   * sharing between the two.
+   */
+  private static class MyGLEventListener implements GLEventListener {
+    private GLOffscreenAutoDrawable fOffscreenDrawable;
+    private boolean fUseEDT;
+    private CountDownLatch fLatch;
+
+    private Exception fException = null;
+
+    public MyGLEventListener(boolean aUseEDT, CountDownLatch aLatch) {
+      fUseEDT = aUseEDT;
+      fLatch = aLatch;
+    }
+
+    @Override
+    public void init(GLAutoDrawable drawable) {
+      GL2 gl = drawable.getGL().getGL2();
+      gl.glClearColor(0.5f, 0.5f, 0.5f, 1.0f);
+      gl.glClear(GL.GL_COLOR_BUFFER_BIT);
+
+      // Create the external context on the caller thread.
+      final GLContext ext = GLDrawableFactory.getDesktopFactory().createExternalGLContext();
+
+      // This runnable creates an offscreen drawable which shares with the external context.
+      Runnable initializer = new Runnable() {
+        public void run() {
+          fOffscreenDrawable = GLDrawableFactory.getDesktopFactory().createOffscreenAutoDrawable(
+              GLProfile.getDefaultDevice(),
+              new GLCapabilities(GLProfile.getDefault()),
+              new DefaultGLCapabilitiesChooser(),
+              512, 512
+          );
+          fOffscreenDrawable.setSharedContext(ext);
+          // Causes GLException on NVidia driver if using EDT (see below)
+          try {
+            fOffscreenDrawable.display();
+          } catch (GLException e) {
+            fException = e;
+            throw e;
+          }
+        }
+      };
+
+      /**
+       * Depending on the test case, invoke the initialization on the EDT or on an
+       * executor thread. The test also displays the offscreen drawable a few times
+       * before finishing.
+       */
+      if (fUseEDT) {
+        // Initialize using invokeAndWait().
+        try {
+          EventQueue.invokeAndWait(initializer);
+        } catch (InterruptedException | InvocationTargetException e) {
+          fException = e;
+        }
+
+        // Display using a Swing timer, i.e. also on the EDT.
+        Timer t = new Timer(200, new ActionListener() {
+          int i = 0;
+
+          @Override
+          public void actionPerformed(ActionEvent e) {
+            if (++i > LATCH_COUNT) {
+              return;
+            }
+
+            System.out.println("Update on EDT");
+            fOffscreenDrawable.display();
+            fLatch.countDown();
+          }
+        });
+        t.start();
+      } else {
+        // Initialize and display using a single-threaded executor.
+        ScheduledExecutorService exe = Executors.newSingleThreadScheduledExecutor();
+        exe.submit(initializer);
+        exe.scheduleAtFixedRate(new Runnable() {
+          int i = 0;
+
+          @Override
+          public void run() {
+            if (++i > LATCH_COUNT) {
+              return;
+            }
+
+            System.out.println("Update on Executor thread");
+            fOffscreenDrawable.display();
+            fLatch.countDown();
+          }
+        }, 0, 200, TimeUnit.MILLISECONDS);
+      }
+    }
+
+    @Override
+    public void dispose(GLAutoDrawable drawable) {
+    }
+
+    @Override
+    public void display(GLAutoDrawable drawable) {
+    }
+
+    @Override
+    public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {
+    }
+  }
+}