GLSL DataArray/Handler: Remove ShaderState state and pass it through: ShaderState.getShaderState(gl)

This removes the dependency of a GLSL GLDataArray object to a specific ShaderState
and enables sharing of this VBO data, i.e. via a shared context.

Test: TestSharedContextVBOES2NEWT

8 files changed, 108 insertions, 165 deletions

diff --git a/src/jogl/classes/jogamp/opengl/util/GLArrayHandler.java b/src/jogl/classes/jogamp/opengl/util/GLArrayHandler.java
new file mode 100644
index 000000000..4a570d3a7
--- /dev/null
+++ b/src/jogl/classes/jogamp/opengl/util/GLArrayHandler.java
@@ -0,0 +1,69 @@
+/**
+ * Copyright 2010 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+
+package jogamp.opengl.util;
+
+import javax.media.opengl.*;
+
+/**
+ * Handles consistency of buffer data and array state.
+ * Implementations shall consider buffer types (VBO, ..), interleaved, etc.
+ * They also need to consider array state types, i.e. fixed function or GLSL.
+ */
+public interface GLArrayHandler {
+
+  /**
+   * Implementation shall associate the data with the array
+   * and synchronize the data with the GPU.
+   * 
+   * @param gl current GL object
+   * @param enable true if array data shall be valid, otherwise false.
+   * @param ext extension object allowing passing of an implementation detail 
+   */
+  public void syncData(GL gl, boolean enable, Object ext);
+  
+  /**
+   * Implementation shall enable or disable the array state.
+   * 
+   * @param gl current GL object
+   * @param enable true if array shall be enabled, otherwise false.
+   * @param ext extension object allowing passing of an implementation detail 
+   */
+  public void enableState(GL gl, boolean enable, Object ext);
+  
+  /**
+   * Supporting interleaved arrays, where sub handlers may handle 
+   * the array state and the <i>master</i> handler the buffer consistency.
+   *   
+   * @param handler the sub handler
+   * @throws UnsupportedOperationException if this array handler does not support interleaved arrays
+   */
+  public void addSubHandler(GLArrayHandler handler) throws UnsupportedOperationException;
+
+}
+
diff --git a/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandlerInterleaved.java b/src/jogl/classes/jogamp/opengl/util/GLArrayHandlerInterleaved.java
index 4bac20217..8e813a79b 100644
--- a/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandlerInterleaved.java
+++ b/src/jogl/classes/jogamp/opengl/util/GLArrayHandlerInterleaved.java
@@ -28,25 +28,24 @@
 
 package jogamp.opengl.util;
 
-import javax.media.opengl.*;
-import javax.media.opengl.fixedfunc.*;
 
-import com.jogamp.opengl.util.GLArrayDataEditable;
-import com.jogamp.opengl.util.GLArrayHandler;
-
-import java.nio.*;
+import java.nio.Buffer;
 import java.util.ArrayList;
 import java.util.List;
 
+import javax.media.opengl.GL;
+
+import com.jogamp.opengl.util.GLArrayDataEditable;
+
 /**
  * Interleaved fixed function arrays, i.e. where this buffer data 
  * represents many arrays. 
  */
-public class GLFixedArrayHandlerInterleaved implements GLArrayHandler {
+public class GLArrayHandlerInterleaved implements GLArrayHandler {
   private GLArrayDataEditable ad;
   private List<GLArrayHandler> subArrays = new ArrayList<GLArrayHandler>();
 
-  public GLFixedArrayHandlerInterleaved(GLArrayDataEditable ad) {
+  public GLArrayHandlerInterleaved(GLArrayDataEditable ad) {
     this.ad = ad;
   }
   
@@ -54,13 +53,13 @@ public class GLFixedArrayHandlerInterleaved implements GLArrayHandler {
       subArrays.add(handler);
   }
 
-  private final void syncSubData(GL gl, boolean enable) {
+  private final void syncSubData(GL gl, boolean enable, Object ext) {
       for(int i=0; i<subArrays.size(); i++) {
-          subArrays.get(i).syncData(gl, enable);
+          subArrays.get(i).syncData(gl, enable, ext);
       }      
-  }
+  }  
   
-  public final void syncData(GL gl, boolean enable) {
+  public final void syncData(GL gl, boolean enable, Object ext) {
     if(enable) {
         final Buffer buffer = ad.getBuffer();
 
@@ -75,18 +74,18 @@ public class GLFixedArrayHandlerInterleaved implements GLArrayHandler {
                 ad.setVBOWritten(true);
             }
         }
-        syncSubData(gl, true);
+        syncSubData(gl, true, ext);
     } else {
-        syncSubData(gl, false);
+        syncSubData(gl, false, ext);
         if(ad.isVBO()) {
             gl.glBindBuffer(ad.getVBOTarget(), 0);
         }
     }
   }
   
-  public final void enableState(GL gl, boolean enable) {
+  public final void enableState(GL gl, boolean enable, Object ext) {
     for(int i=0; i<subArrays.size(); i++) {
-        subArrays.get(i).enableState(gl, enable);
+        subArrays.get(i).enableState(gl, enable, ext);
     }      
   }
 }
diff --git a/src/jogl/classes/jogamp/opengl/util/GLDataArrayHandler.java b/src/jogl/classes/jogamp/opengl/util/GLDataArrayHandler.java
index d114abe4d..c91d6c93e 100644
--- a/src/jogl/classes/jogamp/opengl/util/GLDataArrayHandler.java
+++ b/src/jogl/classes/jogamp/opengl/util/GLDataArrayHandler.java
@@ -49,7 +49,7 @@ public class GLDataArrayHandler implements GLArrayHandler {
       throw new UnsupportedOperationException();
   }
   
-  public final void syncData(GL gl, boolean enable) {
+  public final void syncData(GL gl, boolean enable, Object ext) {
     if(!ad.isVBO()) {
         // makes no sense otherwise
         throw new GLException("GLDataArrayHandler can only handle VBOs.");
@@ -71,7 +71,7 @@ public class GLDataArrayHandler implements GLArrayHandler {
     }      
   }
   
-  public final void enableState(GL gl, boolean enable) { 
+  public final void enableState(GL gl, boolean enable, Object ext) { 
       // no array association
   }
 }
diff --git a/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandler.java b/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandler.java
index 2cce72ff4..8963b7985 100644
--- a/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandler.java
+++ b/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandler.java
@@ -32,7 +32,6 @@ import javax.media.opengl.*;
 import javax.media.opengl.fixedfunc.*;
 
 import com.jogamp.opengl.util.GLArrayDataEditable;
-import com.jogamp.opengl.util.GLArrayHandler;
 
 import java.nio.*;
 
@@ -51,7 +50,7 @@ public class GLFixedArrayHandler implements GLArrayHandler {
       throw new UnsupportedOperationException();
   }
   
-  public final void syncData(GL gl, boolean enable) {
+  public final void syncData(GL gl, boolean enable, Object ext) {
     if(enable) {
         final Buffer buffer = ad.getBuffer();
         if(ad.isVBO()) {
@@ -87,7 +86,7 @@ public class GLFixedArrayHandler implements GLArrayHandler {
     }
   }
   
-  public final void enableState(GL gl, boolean enable) {
+  public final void enableState(GL gl, boolean enable, Object ext) {
     final GLPointerFunc glp = gl.getGL2ES1();
     if(enable) {
         glp.glEnableClientState(ad.getIndex());        
diff --git a/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandlerFlat.java b/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandlerFlat.java
index 4dda9c6a1..81c782dab 100644
--- a/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandlerFlat.java
+++ b/src/jogl/classes/jogamp/opengl/util/GLFixedArrayHandlerFlat.java
@@ -33,7 +33,6 @@ import javax.media.opengl.GLArrayData;
 import javax.media.opengl.GLException;
 import javax.media.opengl.fixedfunc.GLPointerFunc;
 
-import com.jogamp.opengl.util.GLArrayHandler;
 
 /**
  * Used for interleaved fixed function arrays, i.e. where the buffer data itself is handled 
@@ -50,7 +49,7 @@ public class GLFixedArrayHandlerFlat implements GLArrayHandler {
       throw new UnsupportedOperationException();
   }
   
-  public final void syncData(GL gl, boolean enable) {
+  public final void syncData(GL gl, boolean enable, Object ext) {
     if(enable) {
         final GLPointerFunc glp = gl.getGL2ES1();
         switch(ad.getIndex()) {
@@ -72,7 +71,7 @@ public class GLFixedArrayHandlerFlat implements GLArrayHandler {
     }
   }
 
-  public final void enableState(GL gl, boolean enable) {
+  public final void enableState(GL gl, boolean enable, Object ext) {
     final GLPointerFunc glp = gl.getGL2ES1();
     if(enable) {
         glp.glEnableClientState(ad.getIndex());        
diff --git a/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandler.java b/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandler.java
index d2fc52d5c..96bb02b19 100644
--- a/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandler.java
+++ b/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandler.java
@@ -33,8 +33,9 @@ import java.nio.Buffer;
 import javax.media.opengl.GL;
 import javax.media.opengl.GL2ES2;
 
+import jogamp.opengl.util.GLArrayHandler;
+
 import com.jogamp.opengl.util.GLArrayDataEditable;
-import com.jogamp.opengl.util.GLArrayHandler;
 import com.jogamp.opengl.util.glsl.ShaderState;
 
 /**
@@ -43,10 +44,8 @@ import com.jogamp.opengl.util.glsl.ShaderState;
  */
 public class GLSLArrayHandler implements GLArrayHandler {
   private GLArrayDataEditable ad;
-  private ShaderState st;
 
-  public GLSLArrayHandler(ShaderState st, GLArrayDataEditable ad) {
-    this.st = st;
+  public GLSLArrayHandler(GLArrayDataEditable ad) {
     this.ad = ad;
   }
 
@@ -54,9 +53,10 @@ public class GLSLArrayHandler implements GLArrayHandler {
       throw new UnsupportedOperationException();
   }
   
-  public final void syncData(GL gl, boolean enable) {
+  public final void syncData(GL gl, boolean enable, Object ext) {
     final GL2ES2 glsl = gl.getGL2ES2();
-
+    final ShaderState st = (ShaderState) ext;
+    
     if(enable) {
         final Buffer buffer = ad.getBuffer();
         /*
@@ -100,9 +100,10 @@ public class GLSLArrayHandler implements GLArrayHandler {
     }      
   }
   
-  public final void enableState(GL gl, boolean enable) {
+  public final void enableState(GL gl, boolean enable, Object ext) {
     final GL2ES2 glsl = gl.getGL2ES2();
-
+    final ShaderState st = (ShaderState) ext;
+    
     if(enable) {
         st.enableVertexAttribArray(glsl, ad);
     } else {
diff --git a/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerFlat.java b/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerFlat.java
index 5c4aa718c..0d6da7ba4 100644
--- a/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerFlat.java
+++ b/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerFlat.java
@@ -31,7 +31,9 @@ package jogamp.opengl.util.glsl;
 import javax.media.opengl.GL;
 import javax.media.opengl.GL2ES2;
 import javax.media.opengl.GLArrayData;
-import com.jogamp.opengl.util.GLArrayHandler;
+
+import jogamp.opengl.util.GLArrayHandler;
+
 import com.jogamp.opengl.util.glsl.ShaderState;
 
 /**
@@ -39,11 +41,9 @@ import com.jogamp.opengl.util.glsl.ShaderState;
  * separately and interleaves many arrays.
  */
 public class GLSLArrayHandlerFlat implements GLArrayHandler {
-  private ShaderState st;
   private GLArrayData ad;
 
-  public GLSLArrayHandlerFlat(ShaderState st, GLArrayData ad) {
-    this.st = st;
+  public GLSLArrayHandlerFlat(GLArrayData ad) {
     this.ad = ad;
   }
 
@@ -51,15 +51,17 @@ public class GLSLArrayHandlerFlat implements GLArrayHandler {
       throw new UnsupportedOperationException();
   }
   
-  public final void syncData(GL gl, boolean enable) {
+  public final void syncData(GL gl, boolean enable, Object ext) {
+    final ShaderState st = (ShaderState) ext;
     if(enable) {
         st.vertexAttribPointer(gl.getGL2ES2(), ad);
     }
   }
 
-  public final void enableState(GL gl, boolean enable) {
+  public final void enableState(GL gl, boolean enable, Object ext) {
     final GL2ES2 glsl = gl.getGL2ES2();
-
+    final ShaderState st = (ShaderState) ext;
+    
     if(enable) {
         st.enableVertexAttribArray(glsl, ad);
     } else {
diff --git a/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerInterleaved.java b/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerInterleaved.java
deleted file mode 100644
index c662c13d2..000000000
--- a/src/jogl/classes/jogamp/opengl/util/glsl/GLSLArrayHandlerInterleaved.java
+++ /dev/null
@@ -1,126 +0,0 @@
-/**
- * Copyright 2010 JogAmp Community. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification, are
- * permitted provided that the following conditions are met:
- *
- *    1. Redistributions of source code must retain the above copyright notice, this list of
- *       conditions and the following disclaimer.
- *
- *    2. Redistributions 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.
- *
- * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * The views and conclusions contained in the software and documentation are those of the
- * authors and should not be interpreted as representing official policies, either expressed
- * or implied, of JogAmp Community.
- */
-
-package jogamp.opengl.util.glsl;
-
-import java.nio.Buffer;
-import java.util.ArrayList;
-import java.util.List;
-
-import javax.media.opengl.GL;
-import javax.media.opengl.GL2ES2;
-import javax.media.opengl.GLException;
-
-import jogamp.opengl.util.GLFixedArrayHandlerFlat;
-
-import com.jogamp.opengl.util.GLArrayDataEditable;
-import com.jogamp.opengl.util.GLArrayHandler;
-import com.jogamp.opengl.util.glsl.ShaderState;
-
-/**
- * Interleaved GLSL arrays, i.e. where this buffer data 
- * represents many arrays. 
- */
-public class GLSLArrayHandlerInterleaved implements GLArrayHandler {
-  private GLArrayDataEditable ad;
-  private ShaderState st;
-  private List<GLArrayHandler> subArrays = new ArrayList<GLArrayHandler>();
-
-  public GLSLArrayHandlerInterleaved(ShaderState st, GLArrayDataEditable ad) {
-    this.st = st;
-    this.ad = ad;
-  }
-
-  public final void addSubHandler(GLArrayHandler handler) {
-      subArrays.add(handler);
-  }
-
-  private final void syncSubData(GL gl, boolean enable) {
-      for(int i=0; i<subArrays.size(); i++) {
-          subArrays.get(i).syncData(gl, enable);
-      }      
-  }
-  
-  public final void syncData(GL gl, boolean enable) {
-    GL2ES2 glsl = gl.getGL2ES2();
-
-    if(enable) {
-        Buffer buffer = ad.getBuffer();
-
-        /*
-         * This would be the non optimized code path:
-         * 
-        if(ad.isVBO()) {
-            glsl.glBindBuffer(ad.getVBOTarget(), ad.getVBOName());
-            if(!ad.isVBOWritten()) {
-                if(null!=buffer) {
-                    glsl.glBufferData(ad.getVBOTarget(), ad.getSizeInBytes(), buffer, ad.getVBOUsage());
-                }
-                ad.setVBOWritten(true);
-            }
-        }
-        syncSubData(gl, true);
-        */
-        if(ad.isVBO()) {
-            // bind and refresh the VBO / vertex-attr only if necessary
-            if(!ad.isVBOWritten()) {
-                glsl.glBindBuffer(ad.getVBOTarget(), ad.getVBOName());
-                if(null!=buffer) {
-                    glsl.glBufferData(ad.getVBOTarget(), ad.getSizeInBytes(), buffer, ad.getVBOUsage());
-                }
-                ad.setVBOWritten(true);
-                syncSubData(gl, true);
-            } else if(st.getAttribLocation(glsl, ad) >= 0) {
-                // didn't experience a performance hit on this query ..
-                // (using ShaderState's location query above to validate the location)
-                final int[] qi = new int[1];
-                glsl.glGetVertexAttribiv(ad.getLocation(), GL2ES2.GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, qi, 0);
-                if(ad.getVBOName() != qi[0]) {
-                    glsl.glBindBuffer(ad.getVBOTarget(), ad.getVBOName());
-                    syncSubData(gl, true);
-                }
-            }
-        } else if(null!=buffer) {
-            syncSubData(gl, true);
-        }
-    } else {
-        syncSubData(gl, false);
-        if(ad.isVBO()) {
-            glsl.glBindBuffer(ad.getVBOTarget(), 0);
-        }
-    }      
-  }
-  
-  public final void enableState(GL gl, boolean enable) {
-    for(int i=0; i<subArrays.size(); i++) {
-        subArrays.get(i).enableState(gl, enable);
-    }      
-  }
-
-}
-