Bug 802: Graph TextRenderer Performance Part-1 (incomplete, rendering artifacts)

Strategy Change:
  - Font.Glyph itself holds it's OutlineShape
    with it's default scaling.
    Triangulation is done only once per glyph!

  - A CharSequence produces a Region
    by translating and scaling each Glyphs's OutlineShape.
    This removes the need for re-triangulate - see above.
    See: TextRendererUtil

  - The indices of re-added Triangles are
    offset to the new vertices (FIXME, seems not be be accurate yet).

  - OutlineShape's vertices and triangles are reused if 'clean'.

  - Simplified code

  - Reduced copies

API Changes:
  - OutlineShape, Region, ...: See above

  - Removed TextRenderer, GlyphShape and GlyphString: Redundant

  - Added TextRendererUtil to produce the Region from CharSequence

Result:
  - Over 600 fps while changing text for each frame.
    Previously only ~60fps max.

TODO:
  - Region shall not hold the triangles itself,
    but the indices instead.
    This will remove the need to swizzle w/ vertices in the Region Renderer impl
    and easies reusage of OutlineShapes.

2 files changed, 30 insertions, 127 deletions

diff --git a/src/jogl/classes/jogamp/graph/curve/opengl/TextRendererImpl01.java b/src/jogl/classes/jogamp/graph/curve/opengl/TextRendererImpl01.java
deleted file mode 100644
index c3c7e0cac..000000000
--- a/src/jogl/classes/jogamp/graph/curve/opengl/TextRendererImpl01.java
+++ /dev/null
@@ -1,108 +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.graph.curve.opengl;
-
-import javax.media.opengl.GL2ES2;
-import javax.media.opengl.GLException;
-
-import jogamp.graph.curve.opengl.shader.AttributeNames;
-import jogamp.graph.curve.text.GlyphString;
-
-import com.jogamp.graph.curve.opengl.RenderState;
-import com.jogamp.graph.curve.opengl.TextRenderer;
-import com.jogamp.graph.font.Font;
-import com.jogamp.opengl.GLExtensions;
-import com.jogamp.opengl.util.glsl.ShaderCode;
-import com.jogamp.opengl.util.glsl.ShaderProgram;
-import com.jogamp.opengl.util.glsl.ShaderState;
-
-public class TextRendererImpl01 extends TextRenderer {
-    public TextRendererImpl01(RenderState rs, int type) {
-        super(rs, type);
-    }
-
-    @Override
-    protected boolean initShaderProgram(GL2ES2 gl){
-        final ShaderState st = rs.getShaderState();
-
-        final ShaderCode rsVp = ShaderCode.create(gl, GL2ES2.GL_VERTEX_SHADER, TextRendererImpl01.class, "shader",
-                                                  "shader/bin", getVertexShaderName(), true);
-        final ShaderCode rsFp = ShaderCode.create(gl, GL2ES2.GL_FRAGMENT_SHADER, TextRendererImpl01.class, "shader",
-                                                  "shader/bin", getFragmentShaderName(), true);
-        rsVp.defaultShaderCustomization(gl, true, true);
-        // rsFp.defaultShaderCustomization(gl, true, true);
-        int pos = rsFp.addGLSLVersion(gl);
-        if( gl.isGLES() ) {
-            pos = rsFp.insertShaderSource(0, pos, ShaderCode.createExtensionDirective(GLExtensions.OES_standard_derivatives, ShaderCode.ENABLE));
-        }
-        final String rsFpDefPrecision =  getFragmentShaderPrecision(gl);
-        if( null != rsFpDefPrecision ) {
-            rsFp.insertShaderSource(0, pos, rsFpDefPrecision);
-        }
-
-        final ShaderProgram sp = new ShaderProgram();
-        sp.add(rsVp);
-        sp.add(rsFp);
-
-        if( !sp.init(gl) ) {
-            throw new GLException("RegionRenderer: Couldn't init program: "+sp);
-        }
-        st.attachShaderProgram(gl, sp, false);
-        st.bindAttribLocation(gl, AttributeNames.VERTEX_ATTR_IDX, AttributeNames.VERTEX_ATTR_NAME);
-        st.bindAttribLocation(gl, AttributeNames.TEXCOORD_ATTR_IDX, AttributeNames.TEXCOORD_ATTR_NAME);
-
-        if(!sp.link(gl, System.err)) {
-            throw new GLException("TextRendererImpl01: Couldn't link program: "+sp);
-        }
-        st.useProgram(gl, true);
-
-        if(DEBUG) {
-            System.err.println("TextRendererImpl01 initialized: " + Thread.currentThread()+" "+st);
-        }
-        return true;
-    }
-
-    @Override
-    protected void destroyImpl(GL2ES2 gl) {
-        super.destroyImpl(gl);
-    }
-
-    @Override
-    public void drawString3D(GL2ES2 gl, Font font, String str, int fontSize, int[/*1*/] texSize) {
-        if(!isInitialized()){
-            throw new GLException("TextRendererImpl01: not initialized!");
-        }
-        GlyphString glyphString = getCachedGlyphString(font, str, fontSize);
-        if(null == glyphString) {
-            glyphString = createString(gl, font, fontSize, str);
-            addCachedGlyphString(gl, font, str, fontSize, glyphString);
-        }
-
-        glyphString.renderString3D(gl, rs, vp_width, vp_height, texSize);
-    }
-}
diff --git a/src/jogl/classes/jogamp/graph/curve/opengl/VBORegionSPES2.java b/src/jogl/classes/jogamp/graph/curve/opengl/VBORegionSPES2.java
index 9feb18a12..3cc6152b2 100644
--- a/src/jogl/classes/jogamp/graph/curve/opengl/VBORegionSPES2.java
+++ b/src/jogl/classes/jogamp/graph/curve/opengl/VBORegionSPES2.java
@@ -42,7 +42,7 @@ import com.jogamp.opengl.util.glsl.ShaderState;
 public class VBORegionSPES2 extends GLRegion {
     private GLArrayDataServer verticeAttr = null;
     private GLArrayDataServer texCoordAttr = null;
-    private GLArrayDataServer indices = null;
+    private GLArrayDataServer indicesBuffer = null;
 
     protected VBORegionSPES2(int renderModes) {
         super(renderModes);
@@ -54,11 +54,11 @@ public class VBORegionSPES2 extends GLRegion {
             return;
         }
 
-        if(null == indices) {
+        if(null == indicesBuffer) {
             final int initialElementCount = 256;
             final ShaderState st = rs.getShaderState();
 
-            indices = GLArrayDataServer.createData(3, GL2ES2.GL_SHORT, initialElementCount, GL.GL_STATIC_DRAW, GL.GL_ELEMENT_ARRAY_BUFFER);
+            indicesBuffer = GLArrayDataServer.createData(3, GL2ES2.GL_SHORT, initialElementCount, GL.GL_STATIC_DRAW, GL.GL_ELEMENT_ARRAY_BUFFER);
 
             verticeAttr = GLArrayDataServer.createGLSL(AttributeNames.VERTEX_ATTR_NAME, 3, GL2ES2.GL_FLOAT,
                     false, initialElementCount, GL.GL_STATIC_DRAW);
@@ -73,9 +73,12 @@ public class VBORegionSPES2 extends GLRegion {
             }
         }
 
+        if(DEBUG_INSTANCE) {
+            System.err.println("VBORegionSPES2 Indices of "+triangles.size()+", triangles");
+        }
         // process triangles
-        indices.seal(gl, false);
-        indices.rewind();
+        indicesBuffer.seal(gl, false);
+        indicesBuffer.rewind();
         for(int i=0; i<triangles.size(); i++) {
             final Triangle t = triangles.get(i);
             final Vertex[] t_vertices = t.getVertices();
@@ -89,17 +92,25 @@ public class VBORegionSPES2 extends GLRegion {
                 vertices.add(t_vertices[1]);
                 vertices.add(t_vertices[2]);
 
-                indices.puts((short) t_vertices[0].getId());
-                indices.puts((short) t_vertices[1].getId());
-                indices.puts((short) t_vertices[2].getId());
+                indicesBuffer.puts((short) t_vertices[0].getId());
+                indicesBuffer.puts((short) t_vertices[1].getId());
+                indicesBuffer.puts((short) t_vertices[2].getId());
+                if(DEBUG_INSTANCE) {
+                    System.err.println("VBORegionSPES2.Indices.1: "+
+                            t_vertices[0].getId()+", "+t_vertices[1].getId()+", "+t_vertices[2].getId());
+                }
             } else {
-                indices.puts((short) t_vertices[0].getId());
-                indices.puts((short) t_vertices[1].getId());
-                indices.puts((short) t_vertices[2].getId());
+                indicesBuffer.puts((short) t_vertices[0].getId());
+                indicesBuffer.puts((short) t_vertices[1].getId());
+                indicesBuffer.puts((short) t_vertices[2].getId());
+                if(DEBUG_INSTANCE) {
+                    System.err.println("VBORegionSPES2.Indices.2: "+
+                            t_vertices[0].getId()+", "+t_vertices[1].getId()+", "+t_vertices[2].getId());
+                }
             }
         }
-        indices.seal(gl, true);
-        indices.enableBuffer(gl, false);
+        indicesBuffer.seal(gl, true);
+        indicesBuffer.enableBuffer(gl, false);
 
         // process vertices and update bbox
         box.reset();
@@ -130,11 +141,11 @@ public class VBORegionSPES2 extends GLRegion {
     protected void drawImpl(GL2ES2 gl, RenderState rs, int vp_width, int vp_height, int[/*1*/] texWidth) {
         verticeAttr.enableBuffer(gl, true);
         texCoordAttr.enableBuffer(gl, true);
-        indices.bindBuffer(gl, true); // keeps VBO binding
+        indicesBuffer.bindBuffer(gl, true); // keeps VBO binding
 
-        gl.glDrawElements(GL2ES2.GL_TRIANGLES, indices.getElementCount() * indices.getComponentCount(), GL2ES2.GL_UNSIGNED_SHORT, 0);
+        gl.glDrawElements(GL2ES2.GL_TRIANGLES, indicesBuffer.getElementCount() * indicesBuffer.getComponentCount(), GL2ES2.GL_UNSIGNED_SHORT, 0);
 
-        indices.bindBuffer(gl, false);
+        indicesBuffer.bindBuffer(gl, false);
         texCoordAttr.enableBuffer(gl, false);
         verticeAttr.enableBuffer(gl, false);
     }
@@ -155,9 +166,9 @@ public class VBORegionSPES2 extends GLRegion {
             texCoordAttr.destroy(gl);
             texCoordAttr = null;
         }
-        if(null != indices) {
-            indices.destroy(gl);
-            indices = null;
+        if(null != indicesBuffer) {
+            indicesBuffer.destroy(gl);
+            indicesBuffer = null;
         }
     }
 }