Bug 599 - FBObject / Offscreen Support - Part 1

- New FBObject implementation handling FBO and it's attachments  *** API CHANGE: Util -> Core ***
  while it's size and sample-count can be reconfigured on the fly.
    - com.jogamp.opengl.util.FBObject -> com.jogamp.opengl.FBObject
    - agnostic to texture unit
    - separate attachments using OO hierarchy reflecting FBO
    - handling MSAA and blitting
    - no FBO destruction for reconfig (attach/detach)

- New GLFBODrawableImpl impl. an FBObject based GLDrawable
   - Instantiated by a dummy native surface (onscreen and invisible)
     hooked up to a dummy GLDrawable, which is the delegation for context creation.

   - Utilizies ProxySurface.UpstreamSurfaceHook for dummy surface
     avoiding specialization for native platforms.

   - TODO: Allow to utilize common surface interface as a
     dummy-surface to supporting API seperation of
     windowing/GL. The latter allows impl. of createGLDrawable(NativeSurface)
     with FBO.

- New OffscreenAutoDrawable (extends GLAutoDrawableDelegate)
  for all offscreen drawables. Shall replace GLPbuffer.

- New GLCapabilities*.isFBO() / setFBO(boolean) to request FBO offscreen,
  similar to isPBuffer(). Rule: if both are requested, FBO shall be favored.

- GLContext adds raw FBO availability query (min. FBO avail),
  FBObject contains fine grained queries (TODO: Move parts to GLContext for efficiency).

- Add framebuffer tracking, allowing fast querying:
  - GLBase/GLContext:
      public int getBoundFramebuffer(int target);
      public int getDefaultDrawFramebuffer();
      public int getDefaultReadFramebuffer();

  - GLContextImpl
      public final void setBoundFramebuffer(int target, int framebufferName)
      .. called by GL impl bind framebuffer

- GL: getDefaultDrawFramebuffer(), getDefaultReadFramebuffer()
  Adding default framebuffer queries being issued by
  GL.glBindFramebuffer(target, 0) w/ a default framebuffer, o.e. zero.
  This allows a transparent use of a custom FBO even in case the applications
  attempts to reset FBO to zero.
    Value flow: GL <- GLContext <- GLDrawable,

- GLCapabilities handle fbo/pbuffer seperate, don't disable the other

- GLContext/GL track read/write framebuffer to be queried by FBObject
  to determine whether to bind/unbind  a framebuffer

- Test cases for multiple FBO w/ and w/o MSAA

Other Features:

- New interface ProxySurface.UpstreamSurfaceHook,
  allowing to hook an upstream surface of unknown type
  providing lifecycle and information (size, ..) callbacks.
  Used for all new dummy NativeSurface impl and SWT GLCanvas.

  - GLContext -> GLDrawable propagation context/drawable lifecycle
    via ProxySurface.UpstreamSurfaceHook allowing dynamic resources
    to react (create, init, ..)
    - contextRealized()
    - contextMadeCurrent()

- SurfaceChangeable -> MutableSurface
  currently only contains setting the surface handle.

  TODO: May need to move ProxySurface.UpstreamSurfaceHook -> MutableSurface.UpstreamSurfaceHook,
        allowing other impl. classes (NEWT OffscreenWindow) to utilize the new
        upstream hookup mechanism - will allow FBO/Dummy window to work.

- SWT GLCanvas using ProxySurface.UpstreamSurfaceHook for proper size
  propagation.

- New GLAutoDrawable::getUpstreamWidget(), allowing GLEventListener
  to fetch the owning Java side UI element (NEWT, SWT, AWT, ..).

- GLDrawableFactory: Removed createOffscreenSurface() - unused and not GL related

- EGLDrawableFactory handles device/profile avail. mapping
  while actually creating context/drawable.
  This allows us to learn whether the ES context is software/hardware as well as FBO avail.

- EGLDrawable: Removed secret buckets of EGL configs :)
  Employ native surface (X11, WGL, ..) to EGL 'mapping' in
  EGLDrawableFactory utilizing new EGLUpstreamSurfaceHook (implements ProxySurface.UpstreamSurfaceHook).

Other Bugs:

- Add CTX_OPTION_DEBUG to ctx/extension cache key since only a debug ctx
  may expose the ARB debug capability.
  This bug caused lack of ARB/AMD debug functionality.

- Fix GLProfile deadlock (debug mode, w/ EGL/ES, no X11),
  dump availability information _after_ lock.

- ImmModeSink draw(): Use GL's glDrawElements(..), don't cast for GL2ES1.
  Fixes use for GL2ES2.

- Fix KeyEvent.getKeyChar() comment (-> only stable for keyTyped(..))

Misc:

- Refined alot of API doc

- New GLExtensions holds commonly used GL extension strings,
  allows better referencing and usage lookup.

- Move GL (interface) decl. to GLBase

- GLBuffers: Cleanup API doc (format, types)

- TextureIO: Add PAM and PPM static suffix identifier

- GLCapabilities getNumSamples() returns 0 if sampleBuffers is disabled, this seems to be more natural.

- finalized a lot

1 files changed, 40 insertions, 13 deletions

diff --git a/make/config/jogl/gl-impl-CustomJavaCode-common.java b/make/config/jogl/gl-impl-CustomJavaCode-common.java
index d552bc6e4..b05ba2643 100644
--- a/make/config/jogl/gl-impl-CustomJavaCode-common.java
+++ b/make/config/jogl/gl-impl-CustomJavaCode-common.java
@@ -1,48 +1,57 @@
+    @Override
     public GLProfile getGLProfile() {
         return this.glProfile;
     }
     private final GLProfile glProfile;
 
-    public int glGetBoundBuffer(int target) {
+    @Override
+    public final int glGetBoundBuffer(int target) {
         return bufferStateTracker.getBoundBufferObject(target, this);
     }
 
-    public long glGetBufferSize(int buffer) {
+    @Override
+    public final long glGetBufferSize(int buffer) {
         return bufferSizeTracker.getDirectStateBufferSize(buffer, this);
     }
 
-    public boolean glIsVBOArrayEnabled() {
+    @Override
+    public final boolean glIsVBOArrayEnabled() {
         return checkArrayVBOEnabled(false);
     }
 
-    public boolean glIsVBOElementArrayEnabled() {
+    @Override
+    public final boolean glIsVBOElementArrayEnabled() {
         return checkElementVBOEnabled(false);
     }
 
+    @Override
     public final boolean isGL() {
         return true;
     }
       
+    @Override
     public final GL getGL() throws GLException {
         return this;
     }
 
-    public boolean isFunctionAvailable(String glFunctionName) {
+    @Override
+    public final boolean isFunctionAvailable(String glFunctionName) {
       return _context.isFunctionAvailable(glFunctionName);
     }
 
-    public boolean isExtensionAvailable(String glExtensionName) {
+    @Override
+    public final boolean isExtensionAvailable(String glExtensionName) {
       return _context.isExtensionAvailable(glExtensionName);
     }
 
-    public Object getExtension(String extensionName) {
+    @Override
+    public final Object getExtension(String extensionName) {
       // At this point we don't expose any extensions using this mechanism
       return null;
     }
 
-    /** Returns the context this GL object is associated with for better
-        error checking by DebugGL. */
-    public GLContext getContext() {
+    @Override
+    public final GLContext getContext() {
       return _context;
     }
 
@@ -51,18 +60,36 @@
     /**
      * @see javax.media.opengl.GLContext#setSwapInterval(int)
      */
-    public void setSwapInterval(int interval) {
+    @Override
+    public final void setSwapInterval(int interval) {
       _context.setSwapInterval(interval);
     }
 
     /**
      * @see javax.media.opengl.GLContext#getSwapInterval()
      */
-    public int getSwapInterval() {
+    @Override
+    public final int getSwapInterval() {
       return _context.getSwapInterval();
     }
 
-    public Object getPlatformGLExtensions() {
+    @Override
+    public final Object getPlatformGLExtensions() {
       return _context.getPlatformGLExtensions();
     }
 
+    @Override
+    public final int getBoundFramebuffer(int target) {
+      return _context.getBoundFramebuffer(target);
+    }
+
+    @Override
+    public final int getDefaultDrawFramebuffer() {
+      return _context.getDefaultDrawFramebuffer();
+    }
+
+    @Override
+    public final int getDefaultReadFramebuffer() {
+      return _context.getDefaultReadFramebuffer();
+    }
+