Further context-related changes for the JSR-231 API. The GLContext

implementations on all platforms have been split into orthogonal
GLDrawable and GLContext concepts. It is now possible to create more
than one GLContet per GLDrawable (though this has not been tested
yet). GLCanvas has been reimplemented in terms of
GLDrawableFactory.getGLDrawable(). More functionality has been moved
from GLDrawable to GLAutoDrawable. Reimplemented lazy sending of
reshape GLEventListener events in GLCanvas and GLJPanel and deleted
notion of deferred reshapes from GLDrawableHelper and elsewhere.
Sharing of textures and display lists is now expressed in terms of
GLContexts instead of GLDrawables. Still need to move pbuffer creation
into GLDrawableFactory from the onscreen GLContext implementations.
Added option to gleem ExaminerViewer to disable automatic redraws upon
mouse events and respecified more of gleem to work on GLAutoDrawables
rather than GLDrawables. Updated all JOGL demos to work with new APIs
and slightly different initialization sequences (in particular, for
pbuffers -- this will change with the addition of
GLDrawableFactory.createGLPbuffer()).


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

1 files changed, 393 insertions, 0 deletions

diff --git a/src/net/java/games/jogl/impl/windows/WindowsPbufferGLDrawable.java b/src/net/java/games/jogl/impl/windows/WindowsPbufferGLDrawable.java
new file mode 100644
index 000000000..6917b281d
--- /dev/null
+++ b/src/net/java/games/jogl/impl/windows/WindowsPbufferGLDrawable.java
@@ -0,0 +1,393 @@
+/*
+ * Copyright (c) 2003 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
+ * MICROSYSTEMS, 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.windows;
+
+import net.java.games.jogl.*;
+import net.java.games.jogl.impl.*;
+
+public class WindowsPbufferGLDrawable extends WindowsGLDrawable {
+  private int  initWidth;
+  private int  initHeight;
+
+  private GL   cachedGL; // cached GL instance from parent GLCanvas,
+                         // needed to destroy pbuffer
+  private long buffer; // pbuffer handle
+  private int  width;
+  private int  height;
+
+  private int floatMode;
+
+  public WindowsPbufferGLDrawable(GLCapabilities capabilities, int initialWidth, int initialHeight) {
+    super(null, capabilities, null);
+    this.initWidth  = initialWidth;
+    this.initHeight = initialHeight;
+    if (initWidth <= 0 || initHeight <= 0) {
+      throw new GLException("Initial width and height of pbuffer must be positive (were (" +
+			    initWidth + ", " + initHeight + "))");
+    }
+
+    if (DEBUG) {
+      System.out.println("Pbuffer caps on init: " + capabilities +
+                         (capabilities.getOffscreenRenderToTexture() ? " [rtt]" : "") +
+                         (capabilities.getOffscreenRenderToTextureRectangle() ? " [rect]" : "") +
+                         (capabilities.getOffscreenFloatingPointBuffers() ? " [float]" : ""));
+    }
+  }
+
+  public GLContext createContext(GLContext shareWith) {
+    return new WindowsPbufferGLContext(this, shareWith);
+  }
+
+  public void destroy() {
+    if (hdc != 0) {
+      // Must release DC and pbuffer
+      // NOTE that since the context is not current, glGetError() can
+      // not be called here, so we skip the use of any composable
+      // pipelines (see WindowsOnscreenGLContext.makeCurrentImpl)
+      GL gl = cachedGL;
+      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 setSize(int width, int height) {
+    // FIXME
+    throw new GLException("Not yet implemented");
+  }
+
+  public int getWidth() {
+    return width;
+  }
+
+  public int getHeight() {
+    return height;
+  }
+
+  public void createPbuffer(GL gl, long parentHdc) {
+    int[]   iattributes = new int  [2*MAX_ATTRIBS];
+    float[] fattributes = new float[2*MAX_ATTRIBS];
+    int nfattribs = 0;
+    int niattribs = 0;
+
+    if (DEBUG) {
+      System.out.println("Pbuffer parentHdc = " + toHexString(parentHdc));
+      System.out.println("Pbuffer caps: " + capabilities +
+                         (capabilities.getOffscreenRenderToTexture() ? " [rtt]" : "") +
+                         (capabilities.getOffscreenRenderToTextureRectangle() ? " [rect]" : "") +
+                         (capabilities.getOffscreenFloatingPointBuffers() ? " [float]" : ""));
+    }
+
+    boolean rtt      = capabilities.getOffscreenRenderToTexture();
+    boolean rect     = capabilities.getOffscreenRenderToTextureRectangle();
+    boolean useFloat = capabilities.getOffscreenFloatingPointBuffers();
+    boolean ati      = false;
+    
+    // Since we are trying to create a pbuffer, the pixel format we
+    // request (and subsequently use) must be "p-buffer capable".
+    iattributes[niattribs++] = GL.WGL_DRAW_TO_PBUFFER_ARB;
+    iattributes[niattribs++] = GL.GL_TRUE;
+
+    if (rtt && !rect) {
+      throw new GLException("Render-to-texture-rectangle requires render-to-texture to be specified");
+    }
+
+    if (rect) {
+      if (!gl.isExtensionAvailable("GL_NV_texture_rectangle")) {
+        throw new GLException("Render-to-texture-rectangle requires GL_NV_texture_rectangle extension");
+      }
+    }
+
+    if (useFloat) {
+      if (!gl.isExtensionAvailable("WGL_ATI_pixel_format_float") &&
+          !gl.isExtensionAvailable("WGL_NV_float_buffer")) {
+        throw new GLException("Floating-point pbuffers not supported by this hardware");
+      }
+
+      // Prefer NVidia extension over ATI
+      if (gl.isExtensionAvailable("WGL_NV_float_buffer")) {
+        ati = false;
+        floatMode = GLPbuffer.NV_FLOAT;
+      } else {
+        ati = true;
+        floatMode = GLPbuffer.ATI_FLOAT;
+      }
+      if (DEBUG) {
+        System.err.println("Using " + (ati ? "ATI" : "NVidia") + " floating-point extension");
+      }
+    }
+
+    if (useFloat && ati) {
+      if (rtt) {
+        throw new GLException("Render-to-floating-point-texture not supported on ATI hardware");
+      } else {
+        iattributes[niattribs++] = GL.WGL_PIXEL_TYPE_ARB;
+        iattributes[niattribs++] = GL.WGL_TYPE_RGBA_FLOAT_ATI;
+      }
+    } else {
+      if (!rtt) {
+        // Currently we don't support non-truecolor visuals in the
+        // GLCapabilities, so we don't offer the option of making
+        // color-index pbuffers.
+        iattributes[niattribs++] = GL.WGL_PIXEL_TYPE_ARB;
+        iattributes[niattribs++] = GL.WGL_TYPE_RGBA_ARB;
+      }
+    }
+
+    iattributes[niattribs++] = GL.WGL_DOUBLE_BUFFER_ARB;
+    if (capabilities.getDoubleBuffered()) {
+      iattributes[niattribs++] = GL.GL_TRUE;
+    } else {
+      iattributes[niattribs++] = GL.GL_FALSE;
+    }
+
+    iattributes[niattribs++] = GL.WGL_DEPTH_BITS_ARB;
+    iattributes[niattribs++] = capabilities.getDepthBits();
+
+    iattributes[niattribs++] = GL.WGL_RED_BITS_ARB;
+    iattributes[niattribs++] = capabilities.getRedBits();
+
+    iattributes[niattribs++] = GL.WGL_GREEN_BITS_ARB;
+    iattributes[niattribs++] = capabilities.getGreenBits();
+
+    iattributes[niattribs++] = GL.WGL_BLUE_BITS_ARB;
+    iattributes[niattribs++] = capabilities.getBlueBits();
+
+    iattributes[niattribs++] = GL.WGL_ALPHA_BITS_ARB;
+    iattributes[niattribs++] = capabilities.getAlphaBits();
+
+    iattributes[niattribs++] = GL.WGL_STENCIL_BITS_ARB;
+    if (capabilities.getStencilBits() > 0) {
+      iattributes[niattribs++] = GL.GL_TRUE;
+    } else {
+      iattributes[niattribs++] = GL.GL_FALSE;
+    }
+
+    if (capabilities.getAccumRedBits()   > 0 ||
+        capabilities.getAccumGreenBits() > 0 ||
+        capabilities.getAccumBlueBits()  > 0) {
+      iattributes[niattribs++] = GL.WGL_ACCUM_BITS_ARB;
+      iattributes[niattribs++] = GL.GL_TRUE;
+    }
+
+    if (useFloat && !ati) {
+      iattributes[niattribs++] = GL.WGL_FLOAT_COMPONENTS_NV;
+      iattributes[niattribs++] = GL.GL_TRUE;
+    }
+
+    if (rtt) {
+      if (useFloat) {
+        assert(!ati);
+        if (!rect) {
+          throw new GLException("Render-to-floating-point-texture only supported on NVidia hardware with render-to-texture-rectangle");
+        }
+        iattributes[niattribs++] = GL.WGL_BIND_TO_TEXTURE_RECTANGLE_FLOAT_RGB_NV;
+        iattributes[niattribs++] = GL.GL_TRUE;
+      } else {
+        iattributes[niattribs++] = rect ? GL.WGL_BIND_TO_TEXTURE_RECTANGLE_RGB_NV : GL.WGL_BIND_TO_TEXTURE_RGB_ARB;
+        iattributes[niattribs++] = GL.GL_TRUE;
+      }
+    }
+
+    iattributes[niattribs++] = GL.WGL_SUPPORT_OPENGL_ARB;
+    iattributes[niattribs++] = GL.GL_TRUE;
+    
+    int[] pformats = new int[MAX_PFORMATS];
+    int   nformats;
+    int[] nformatsTmp = new int[1];
+    if (!gl.wglChoosePixelFormatARB(parentHdc,
+                                    iattributes, 0,
+                                    fattributes, 0,
+                                    MAX_PFORMATS,
+                                    pformats, 0,
+                                    nformatsTmp, 0)) {
+      throw new GLException("pbuffer creation error: wglChoosePixelFormatARB() failed");
+    }
+    nformats = nformatsTmp[0];
+    if (nformats <= 0) {
+      throw new GLException("pbuffer creation error: Couldn't find a suitable pixel format");
+    }
+
+    if (DEBUG) {
+      System.err.println("" + nformats + " suitable pixel formats found");
+      // query pixel format
+      iattributes[0] = GL.WGL_RED_BITS_ARB;
+      iattributes[1] = GL.WGL_GREEN_BITS_ARB;
+      iattributes[2] = GL.WGL_BLUE_BITS_ARB;
+      iattributes[3] = GL.WGL_ALPHA_BITS_ARB;
+      iattributes[4] = GL.WGL_DEPTH_BITS_ARB;
+      iattributes[5] = (useFloat ? (ati ? GL.WGL_PIXEL_TYPE_ARB : GL.WGL_FLOAT_COMPONENTS_NV) : GL.WGL_RED_BITS_ARB);
+      iattributes[6] = GL.WGL_SAMPLE_BUFFERS_EXT;
+      iattributes[7] = GL.WGL_SAMPLES_EXT;
+      iattributes[8] = GL.WGL_DRAW_TO_PBUFFER_ARB;
+      int[] ivalues = new int[9];
+      for (int i = 0; i < nformats; i++) {
+        if (!gl.wglGetPixelFormatAttribivARB(parentHdc, pformats[i], 0, 9, iattributes, 0, ivalues, 0)) {
+          throw new GLException("Error while querying pixel format " + pformats[i] +
+                                "'s (index " + i + "'s) capabilities for debugging");
+        }
+        System.err.print("pixel format " + pformats[i] + " (index " + i + "): ");
+        System.err.print( "r: " + ivalues[0]);
+        System.err.print(" g: " + ivalues[1]);
+        System.err.print(" b: " + ivalues[2]);
+        System.err.print(" a: " + ivalues[3]);
+        System.err.print(" depth: " + ivalues[4]);
+        System.err.print(" multisample: " + ivalues[6]);
+        System.err.print(" samples: " + ivalues[7]);
+        if (useFloat) {
+          if (ati) {
+            if (ivalues[5] == GL.WGL_TYPE_RGBA_FLOAT_ATI) {
+              System.err.print(" [ati float]");
+            } else if (ivalues[5] != GL.WGL_TYPE_RGBA_ARB) {
+              System.err.print(" [unknown pixel type " + ivalues[5] + "]");
+            }
+          } else {
+            if (ivalues[5] != 0) {
+              System.err.print(" [float]");
+            }
+          }
+        }
+
+        if (ivalues[8] != 0) {
+          System.err.print(" [pbuffer]");
+        }
+        System.err.println();
+      }
+    }
+
+    long tmpBuffer = 0;
+    int whichFormat = 0;
+    // Loop is a workaround for bugs in NVidia's recent drivers
+    do {
+      int format = pformats[whichFormat];
+
+      // Create the p-buffer.
+      niattribs = 0;
+
+      if (rtt) {
+        iattributes[niattribs++]   = GL.WGL_TEXTURE_FORMAT_ARB;
+        if (useFloat) {
+          iattributes[niattribs++] = GL.WGL_TEXTURE_FLOAT_RGB_NV;
+        } else {
+          iattributes[niattribs++] = GL.WGL_TEXTURE_RGBA_ARB;
+        }
+
+        iattributes[niattribs++] = GL.WGL_TEXTURE_TARGET_ARB;
+        iattributes[niattribs++] = rect ? GL.WGL_TEXTURE_RECTANGLE_NV : GL.WGL_TEXTURE_2D_ARB;
+
+        iattributes[niattribs++] = GL.WGL_MIPMAP_TEXTURE_ARB;
+        iattributes[niattribs++] = GL.GL_FALSE;
+
+        iattributes[niattribs++] = GL.WGL_PBUFFER_LARGEST_ARB;
+        iattributes[niattribs++] = GL.GL_FALSE;
+      }
+
+      iattributes[niattribs++] = 0;
+
+      tmpBuffer = gl.wglCreatePbufferARB(parentHdc, format, initWidth, initHeight, iattributes, 0);
+      ++whichFormat;
+    } while ((tmpBuffer == 0) && (whichFormat < nformats));
+
+    if (tmpBuffer == 0) {
+      throw new GLException("pbuffer creation error: wglCreatePbufferARB() failed: tried " + nformats +
+                            " pixel formats, last error was: " + wglGetLastError());
+    }
+
+    // Get the device context.
+    long tmpHdc = gl.wglGetPbufferDCARB(tmpBuffer);
+    if (tmpHdc == 0) {
+      throw new GLException("pbuffer creation error: wglGetPbufferDCARB() failed");
+    }
+
+    // Set up instance variables
+    buffer = tmpBuffer;
+    hdc    = tmpHdc;
+    cachedGL = gl;
+
+    // Determine the actual width and height we were able to create.
+    int[] tmp = new int[1];
+    gl.wglQueryPbufferARB( buffer, GL.WGL_PBUFFER_WIDTH_ARB,  tmp, 0 );
+    width = tmp[0];
+    gl.wglQueryPbufferARB( buffer, GL.WGL_PBUFFER_HEIGHT_ARB, tmp, 0 );
+    height = tmp[0];
+
+    if (DEBUG) {
+      System.err.println("Created pbuffer " + width + " x " + height);
+    }
+  }
+
+  public GLCapabilities getCapabilities() {
+    return capabilities;
+  }
+
+  public long getPbuffer() {
+    return buffer;
+  }
+
+  public int getFloatingPointMode() {
+    return floatMode;
+  }
+
+  public void swapBuffers() throws GLException {
+    // FIXME: this doesn't make sense any more because we don't have
+    // access to our OpenGL context here
+    /*
+    // 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.
+    if (rtt && !hasRTT) {
+      if (DEBUG) {
+        System.err.println("Copying pbuffer data to GL_TEXTURE_2D state");
+      }
+
+      GL gl = getGL();
+      gl.glCopyTexSubImage2D(textureTarget, 0, 0, 0, 0, 0, width, height);
+    }
+    */
+  }
+
+  private static String wglGetLastError() {
+    return WindowsGLContextFactory.wglGetLastError();
+  }
+}