From 224fab1b2c71464826594740022fdcbe278867dc Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Fri, 11 Jan 2013 08:13:24 +0100
Subject: GLAutoDrawable/AnimatorBase: Add ExclusiveContextThread (ECT)
 feature; AnimatorBase: Add setModeBits/MODE_EXPECT_AWT_RENDERING_THREAD;
 FPSAnimator: Make transactions deterministic.

ExclusiveContextThread (ECT) allows user to dedicate a GLContext to a given thread.
Only the ECT will be allowed to claim the GLContext, hence releasing must be done on the ECT itself.

The core feature is accessible via GLAutoDrawable, while it can be conveniently enabled and disabled
via an AnimatorBase implementation. The latter ensures it's being released on the ECT and waits for the result.

Note that ECT cannot be guaranteed to work correctly w/ native (heavyweight) AWT components
due to resource locking and AWT-EDT access. This is disabled in all new tests per default and
noted on the API doc.

Note: 'Animator transaction' == start(), stop(), pause(), resume().

- Add ExclusiveContextThread (ECT) feature
  - GLAutoDrawable NEW:
    - Thread setExclusiveContextThread(Thread t)
    - Thread getExclusiveContextThread()

  - AnimatorBase NEW:
    - Thread setExclusiveContext(Thread t)
    - boolean setExclusiveContext(boolean enable)
    - boolean isExclusiveContextEnabled()
    - Thread getExclusiveContextThread()

- AnimatorBase: Add setModeBits/MODE_EXPECT_AWT_RENDERING_THREAD
  Allows user to pre-determine whether AWT rendering is expected before starting the animator.
  If AWT is excluded, a more simple and transaction correct impl. will be used.

- FPSAnimator: Make transactions deterministic.
  FPSAnimator previously did not ensure whether a transaction was completed.
  A deterministic transaction is required to utilize ECT.
  FPSAnimator now uses same mechanism like Animator to ensure completeness,
  i.e. Condition and 'finishLifecycleAction(..)'. Both are moved to AnimatorBase.

Tested manually on Linux/NV, Linux/AMD, Windows/NV and OSX/NV.
  - All new tests validated correctness.
  - All new tests shows an performance increase of ~3x w/ single GLWindow, where multiple GLWindows don't show a perf. increase.
---
 .../classes/jogamp/opengl/GLAutoDrawableBase.java  | 30 ++++++++--------------
 1 file changed, 10 insertions(+), 20 deletions(-)

(limited to 'src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java')

diff --git a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
index cbb7cd699..eadd59559 100644
--- a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
+++ b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
@@ -50,7 +50,6 @@ import javax.media.opengl.GLRunnable;
 
 import com.jogamp.common.util.locks.RecursiveLock;
 import com.jogamp.opengl.GLAutoDrawableDelegate;
-import com.jogamp.opengl.util.Animator;
 
 
 /**
@@ -406,6 +405,16 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
         return helper.getAnimator();
     }
 
+    @Override
+    public final Thread setExclusiveContextThread(Thread t) throws GLException {
+        return helper.setExclusiveContextThread(t, context);
+    }
+
+    @Override
+    public final Thread getExclusiveContextThread() {
+        return helper.getExclusiveContextThread();
+    }
+    
     @Override
     public final boolean invoke(boolean wait, GLRunnable glRunnable) {
         return helper.invoke(this, wait, glRunnable);        
@@ -532,25 +541,6 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
         return null != _drawable ? _drawable.getHeight() : 0;
     }
 
-    /**
-     * @param t the thread for which context release shall be skipped, usually the animation thread,
-     *          ie. {@link Animator#getThread()}.
-     * @deprecated This is an experimental feature,
-     *             intended for measuring performance in regards to GL context switch.
-     */
-    @Deprecated
-    public void setSkipContextReleaseThread(Thread t) {
-        helper.setSkipContextReleaseThread(t);
-    }
-
-    /**
-     * @deprecated see {@link #setSkipContextReleaseThread(Thread)}
-     */
-    @Deprecated
-    public Thread getSkipContextReleaseThread() {
-        return helper.getSkipContextReleaseThread();
-    }
-
     @Override
     public final GLCapabilitiesImmutable getChosenGLCapabilities() {
         final GLDrawable _drawable = drawable;
-- 
cgit v1.2.3