Fixed Issue 44: Add pbuffer-based GLJPanel implementation

Fixed Issue 61: Make debug variables load from system properties

Added a hardware acceleration path for GLJPanel implemented using the
GLPbuffer interfaces. If instantiation of the pbuffer fails, the
GLJPanel implementation attempts to catch the resulting exception and
fall back on the existing software rendering path.

The new code has been successfully tested on Windows. This checkin
attempts to make the needed changes to the pbuffer implementation on
other platforms, but the GLJPanel continues to use software rendering
until all platforms can be tested.

Additionally, references to static final DEBUG flags have been made
settable via system properties. "jogl.verbose" enables certain
printing statements. "jogl.debug" enables all debugging printing.
"jogl.debug.GLContext" enables the debug printing inside the GLContext
class. The system property names are chosen by convention and are not
enforced.


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@209 232f8b59-042b-4e1e-8c03-345bb8c30851

10 files changed, 150 insertions, 21 deletions

diff --git a/src/net/java/games/jogl/impl/Debug.java b/src/net/java/games/jogl/impl/Debug.java
new file mode 100755
index 000000000..ad0092a6f
--- /dev/null
+++ b/src/net/java/games/jogl/impl/Debug.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package net.java.games.jogl.impl;
+
+import java.security.*;
+
+/** Helper routines for logging and debugging. */
+
+public class Debug {
+  // Some common properties
+  private static boolean verbose;
+  private static boolean debugAll;
+  
+  static {
+    verbose = isPropertyDefined("jogl.verbose");
+    debugAll = isPropertyDefined("jogl.debug");
+  }
+
+  public static boolean getBooleanProperty(final String property) {
+    Boolean b = (Boolean) AccessController.doPrivileged(new PrivilegedAction() {
+        public Object run() {
+          boolean val = Boolean.getBoolean(property);
+          return (val ? Boolean.TRUE : Boolean.FALSE);
+        }
+      });
+    return b.booleanValue();
+  }
+
+  public static boolean isPropertyDefined(final String property) {
+    Boolean b = (Boolean) AccessController.doPrivileged(new PrivilegedAction() {
+        public Object run() {
+          String val = System.getProperty(property);
+          return (val != null ? Boolean.TRUE : Boolean.FALSE);
+        }
+      });
+    return b.booleanValue();
+  }
+
+  public static boolean verbose() {
+    return verbose;
+  }
+
+  public static boolean debugAll() {
+    return debugAll;
+  }
+
+  public static boolean debug(String subcomponent) {
+    return debugAll() || isPropertyDefined("jogl.debug." + subcomponent);
+  }
+}
diff --git a/src/net/java/games/jogl/impl/FunctionAvailabilityCache.java b/src/net/java/games/jogl/impl/FunctionAvailabilityCache.java
index bceb66f9b..01a70e4b7 100644
--- a/src/net/java/games/jogl/impl/FunctionAvailabilityCache.java
+++ b/src/net/java/games/jogl/impl/FunctionAvailabilityCache.java
@@ -52,7 +52,7 @@ import java.lang.reflect.*;
  * and display.
  */
 public final class FunctionAvailabilityCache {
-  private static final boolean DEBUG = false;
+  private static final boolean DEBUG = Debug.debug("FunctionAvailabilityCache");
 
   FunctionAvailabilityCache(GLContext context)
   {
diff --git a/src/net/java/games/jogl/impl/GLContext.java b/src/net/java/games/jogl/impl/GLContext.java
index cc5d465d6..aab3f9dd0 100644
--- a/src/net/java/games/jogl/impl/GLContext.java
+++ b/src/net/java/games/jogl/impl/GLContext.java
@@ -44,7 +44,7 @@ import net.java.games.jogl.*;
 import net.java.games.gluegen.runtime.*;
 
 public abstract class GLContext {
-  protected static final boolean DEBUG = false;
+  protected static final boolean DEBUG = Debug.debug("GLContext");
 
   static {
     NativeLibLoader.load();
diff --git a/src/net/java/games/jogl/impl/GLPbufferImpl.java b/src/net/java/games/jogl/impl/GLPbufferImpl.java
index 2fb927c92..03d161fdd 100644
--- a/src/net/java/games/jogl/impl/GLPbufferImpl.java
+++ b/src/net/java/games/jogl/impl/GLPbufferImpl.java
@@ -196,6 +196,10 @@ public class GLPbufferImpl implements GLPbuffer {
     return isInitialized;
   }
 
+  public void destroy() {
+    context.destroy();
+  }
+
   //----------------------------------------------------------------------
   // Internals only below this point
   //
diff --git a/src/net/java/games/jogl/impl/SingleThreadedWorkaround.java b/src/net/java/games/jogl/impl/SingleThreadedWorkaround.java
index 2ffd09e6a..eb7d8f09d 100755
--- a/src/net/java/games/jogl/impl/SingleThreadedWorkaround.java
+++ b/src/net/java/games/jogl/impl/SingleThreadedWorkaround.java
@@ -52,7 +52,6 @@ public class SingleThreadedWorkaround {
   // If the user specified the workaround's system property (either
   // true or false), don't let the automatic detection have any effect
   private static boolean systemPropertySpecified = false;
-  private static boolean verbose = false;
   
   static {
     AccessController.doPrivileged(new PrivilegedAction() {
@@ -66,7 +65,6 @@ public class SingleThreadedWorkaround {
             systemPropertySpecified = true;
             singleThreadedWorkaround = Boolean.valueOf(workaround).booleanValue();
           }
-          verbose = (System.getProperty("jogl.verbose") != null);
           printWorkaroundNotice();
           return null;
         }
@@ -85,7 +83,7 @@ public class SingleThreadedWorkaround {
   }
 
   private static void printWorkaroundNotice() {
-    if (singleThreadedWorkaround && verbose) {
+    if (singleThreadedWorkaround && Debug.verbose()) {
       System.err.println("Using single-threaded workaround of dispatching display() on event thread");
     }
   }
diff --git a/src/net/java/games/jogl/impl/macosx/MacOSXPbufferGLContext.java b/src/net/java/games/jogl/impl/macosx/MacOSXPbufferGLContext.java
index 6ac854090..8e65ce1f3 100644
--- a/src/net/java/games/jogl/impl/macosx/MacOSXPbufferGLContext.java
+++ b/src/net/java/games/jogl/impl/macosx/MacOSXPbufferGLContext.java
@@ -4,8 +4,7 @@ import net.java.games.jogl.*;
 import net.java.games.jogl.impl.*;
 
 public class MacOSXPbufferGLContext extends MacOSXGLContext {
-
-  private static final boolean DEBUG = false;
+  private static final boolean DEBUG = Debug.debug("MacOSXPbufferGLContext");
   
   protected int  initWidth;
   protected int  initHeight;
@@ -131,6 +130,10 @@ public class MacOSXPbufferGLContext extends MacOSXGLContext {
     return false;
   }
   
+  protected void destroyImpl() throws GLException {
+    destroyPBuffer();
+  }
+
   public void swapBuffers() throws GLException {
     // FIXME: do we need to do anything if the pbuffer is double-buffered?
   }
diff --git a/src/net/java/games/jogl/impl/windows/WindowsOffscreenGLContext.java b/src/net/java/games/jogl/impl/windows/WindowsOffscreenGLContext.java
index 9e871caba..5743253a0 100644
--- a/src/net/java/games/jogl/impl/windows/WindowsOffscreenGLContext.java
+++ b/src/net/java/games/jogl/impl/windows/WindowsOffscreenGLContext.java
@@ -172,7 +172,8 @@ public class WindowsOffscreenGLContext extends WindowsGLContext {
     }
     hbitmap = WGL.CreateDIBSection(hdc, info, WGL.DIB_RGB_COLORS, 0, 0, 0);
     if (hbitmap == 0) {
-      throw new GLException("Error creating offscreen bitmap");
+      throw new GLException("Error creating offscreen bitmap of width " + width +
+                            ", height " + height);
     }
     if ((origbitmap = WGL.SelectObject(hdc, hbitmap)) == 0) {
       throw new GLException("Error selecting bitmap into new device context");
diff --git a/src/net/java/games/jogl/impl/windows/WindowsPbufferGLContext.java b/src/net/java/games/jogl/impl/windows/WindowsPbufferGLContext.java
index d3795905f..9d803d58a 100644
--- a/src/net/java/games/jogl/impl/windows/WindowsPbufferGLContext.java
+++ b/src/net/java/games/jogl/impl/windows/WindowsPbufferGLContext.java
@@ -43,7 +43,7 @@ import net.java.games.jogl.*;
 import net.java.games.jogl.impl.*;
 
 public class WindowsPbufferGLContext extends WindowsGLContext {
-  private static final boolean DEBUG = false;
+  private static final boolean DEBUG = Debug.debug("WindowsPbufferGLContext");
 
   private int  initWidth;
   private int  initHeight;
@@ -308,10 +308,16 @@ public class WindowsPbufferGLContext extends WindowsGLContext {
 
     if (buffer == 0) {
       // pbuffer not instantiated yet
+      if (DEBUG) {
+        System.err.println("pbuffer not instantiated yet");
+      }
       return false;
     }
 
     boolean res = super.makeCurrent(initAction);
+    if (DEBUG) {
+      System.err.println("super.makeCurrent() = " + res + ", created = " + created);
+    }
     if (created) {
       // Initialize render-to-texture support if requested
       rtt  = capabilities.getOffscreenRenderToTexture();
@@ -396,6 +402,22 @@ public class WindowsPbufferGLContext extends WindowsGLContext {
     }
   }
 
+  protected void destroyImpl() throws GLException {
+    if (hglrc != 0) {
+      super.destroyImpl();
+      // Must release DC and pbuffer
+      GL gl = getGL();
+      if (gl.wglReleasePbufferDCARB(buffer, hdc) == 0) {
+        throw new GLException("Error releasing pbuffer device context: error code " + WGL.GetLastError());
+      }
+      hdc = 0;
+      if (!gl.wglDestroyPbufferARB(buffer)) {
+        throw new GLException("Error destroying pbuffer: error code " + WGL.GetLastError());
+      }
+      buffer = 0;
+    }
+  }
+
   public void swapBuffers() throws GLException {
     // FIXME: do we need to do anything if the pbuffer is double-buffered?
     // For now, just grab the pixels for the render-to-texture support.
diff --git a/src/net/java/games/jogl/impl/x11/X11GLContext.java b/src/net/java/games/jogl/impl/x11/X11GLContext.java
index efcd9a101..1f8023e66 100644
--- a/src/net/java/games/jogl/impl/x11/X11GLContext.java
+++ b/src/net/java/games/jogl/impl/x11/X11GLContext.java
@@ -187,6 +187,7 @@ public abstract class X11GLContext extends GLContext {
   }
 
   protected void destroyImpl() throws GLException {
+    lockAWT();
     if (context != 0) {
       GLX.glXDestroyContext(mostRecentDisplay, context);
       if (DEBUG) {
@@ -194,6 +195,7 @@ public abstract class X11GLContext extends GLContext {
       }
       context = 0;
     }
+    unlockAWT();
   }
 
   public abstract void swapBuffers() throws GLException;
@@ -381,4 +383,14 @@ public abstract class X11GLContext extends GLContext {
   protected long getContext() {
     return context;
   }
+
+  // These synchronization primitives prevent the AWT from making
+  // requests from the X server asynchronously to this code.
+  protected void lockAWT() {
+    getJAWT().Lock();
+  }
+
+  protected void unlockAWT() {
+    getJAWT().Unlock();
+  }
 }
diff --git a/src/net/java/games/jogl/impl/x11/X11PbufferGLContext.java b/src/net/java/games/jogl/impl/x11/X11PbufferGLContext.java
index a253b9615..5b6df1843 100644
--- a/src/net/java/games/jogl/impl/x11/X11PbufferGLContext.java
+++ b/src/net/java/games/jogl/impl/x11/X11PbufferGLContext.java
@@ -43,7 +43,7 @@ import net.java.games.jogl.*;
 import net.java.games.jogl.impl.*;
 
 public class X11PbufferGLContext extends X11GLContext {
-  private static final boolean DEBUG = false;
+  private static final boolean DEBUG = Debug.debug("X11PbufferGLContext");
 
   private int  initWidth;
   private int  initHeight;
@@ -315,6 +315,19 @@ public class X11PbufferGLContext extends X11GLContext {
     }
   }
 
+  protected void destroyImpl() throws GLException {
+    lockAWT();
+    try {
+      if (context != 0) {
+        super.destroyImpl();
+        GLX.glXDestroyPbuffer(display, buffer);
+        buffer = 0;
+      }
+    } finally {
+      unlockAWT();
+    }
+  }
+
   public void swapBuffers() throws GLException {
     // FIXME: do we need to do anything if the pbuffer is double-buffered?
   }
@@ -326,15 +339,4 @@ public class X11PbufferGLContext extends X11GLContext {
     }
     return tmp[0];
   }
-
-  // These synchronization primitives, which prevent the AWT from
-  // making requests from the X server asynchronously to this code,
-  // are required for pbuffers to work properly on X11.
-  private void lockAWT() {
-    getJAWT().Lock();
-  }
-
-  private void unlockAWT() {
-    getJAWT().Unlock();
-  }
 }