Bug 801: VBAA Render-Mode Based on SampleCount (not a user-based texWidth) ; Proper FontSize -> PixelSize

VBAA Render-Mode Based on SampleCount (not a user-based texWidth)
  - All Region based APIs now use 'sampleCount' instead of 'texWidth'

  - VBORegion2PES2 calculates perspective FBO width/height considering the sampleCount

Proper FontSize -> PixelSize
  - Font: Add getPixelSize(fontSize, dpi)

  - Text* Demos/Classes: Use proper fontSize -> PixelSize

5 files changed, 123 insertions, 47 deletions

diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
index 6d0e5e538..014b1641a 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
@@ -95,16 +95,16 @@ public abstract class GLRegion extends Region {
      * of the region.

      * @param matrix current {@link PMVMatrix}.

      * @param renderer the {@link RegionRenderer} to be used

-     * @param texWidth desired texture width for multipass-rendering.

-     *        The actual used texture-width is written back when mp rendering is enabled, otherwise the store is untouched.

+     * @param sampleCount desired multisampling sample count for msaa-rendering.

+     *        The actual used scample-count is written back when msaa-rendering is enabled, otherwise the store is untouched.

      */

-    public final void draw(GL2ES2 gl, RegionRenderer renderer, int[/*1*/] texWidth) {

+    public final void draw(GL2ES2 gl, RegionRenderer renderer, int[/*1*/] sampleCount) {

         if(isDirty()) {

             update(gl, renderer);

             setDirty(false);

         }

-        drawImpl(gl, renderer, texWidth);

+        drawImpl(gl, renderer, sampleCount);

     }

 

-    protected abstract void drawImpl(GL2ES2 gl, RegionRenderer renderer, int[/*1*/] texWidth);

+    protected abstract void drawImpl(GL2ES2 gl, RegionRenderer renderer, int[/*1*/] sampleCount);

 }

diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
index a9e258f36..92fa084cd 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
@@ -36,7 +36,6 @@ import javax.media.opengl.fixedfunc.GLMatrixFunc;
 import com.jogamp.opengl.util.glsl.ShaderCode;
 import com.jogamp.opengl.util.glsl.ShaderState;
 import com.jogamp.opengl.util.PMVMatrix;
-import com.jogamp.graph.curve.OutlineShape;
 import com.jogamp.graph.curve.Region;
 
 /**
diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java
index 0d1e87ad1..dd668c927 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java
@@ -55,22 +55,22 @@ public class TextRegionUtil {
     }
 
     /**
-     * Add the string in 3D space w.r.t. the font and fontSize at the end of the {@link GLRegion}.
+     * Add the string in 3D space w.r.t. the font and pixelSize at the end of the {@link GLRegion}.
      * @param region the {@link GLRegion} sink
      * @param vertexFactory vertex impl factory {@link Factory}
      * @param font the target {@link Font}
-     * @param fontSize
+     * @param pixelSize Use {@link Font#getPixelSize(float, float)} for resolution correct pixel-size.
      * @param str string text
      */
     public static void addStringToRegion(final GLRegion region, final Factory<? extends Vertex> vertexFactory,
-                                         final Font font, final float fontSize, final CharSequence str) {
+                                         final Font font, final float pixelSize, final CharSequence str) {
         final int charCount = str.length();
 
         // region.setFlipped(true);
         final Font.Metrics metrics = font.getMetrics();
-        final float lineHeight = font.getLineHeight(fontSize);
+        final float lineHeight = font.getLineHeight(pixelSize);
 
-        final float scale = metrics.getScale(fontSize);
+        final float scale = metrics.getScale(pixelSize);
         final AffineTransform transform = new AffineTransform(vertexFactory);
         final AffineTransform t = new AffineTransform(vertexFactory);
 
@@ -83,7 +83,7 @@ public class TextRegionUtil {
                 y -= lineHeight;
                 advanceTotal = 0;
             } else if (character == ' ') {
-                advanceTotal += font.getAdvanceWidth(Glyph.ID_SPACE, fontSize);
+                advanceTotal += font.getAdvanceWidth(Glyph.ID_SPACE, pixelSize);
             } else {
                 if(Region.DEBUG_INSTANCE) {
                     System.err.println("XXXXXXXXXXXXXXx char: "+character+", scale: "+scale+"; translate: "+advanceTotal+", "+y);
@@ -99,66 +99,92 @@ public class TextRegionUtil {
                 }
                 region.addOutlineShape(glyphShape, t);
 
-                advanceTotal += glyph.getAdvance(fontSize, true);
+                advanceTotal += glyph.getAdvance(pixelSize, true);
             }
         }
     }
 
     /**
-     * Render the string in 3D space w.r.t. the font and fontSize
+     * Render the string in 3D space w.r.t. the font and pixelSize
      * using a cached {@link GLRegion} for reuse.
      * <p>
      * Cached {@link GLRegion}s will be destroyed w/ {@link #clear(GL2ES2)} or to free memory.
      * </p>
      * @param gl the current GL state
      * @param font {@link Font} to be used
-     * @param fontSize font size
+     * @param pixelSize Use {@link Font#getPixelSize(float, float)} for resolution correct pixel-size.
      * @param str text to be rendered
-     * @param texSize desired texture width for multipass-rendering.
-     *        The actual used texture-width is written back when mp rendering is enabled, otherwise the store is untouched.
+     * @param sampleCount desired multisampling sample count for msaa-rendering.
+     *        The actual used scample-count is written back when msaa-rendering is enabled, otherwise the store is untouched.
      * @throws Exception if TextRenderer not initialized
      */
     public void drawString3D(final GL2ES2 gl,
-                             final Font font, final float fontSize, final CharSequence str,
-                             final int[/*1*/] texSize) {
+                             final Font font, final float pixelSize, final CharSequence str,
+                             final int[/*1*/] sampleCount) {
         if( !renderer.isInitialized() ) {
             throw new GLException("TextRendererImpl01: not initialized!");
         }
-        final RenderState rs = renderer.getRenderState();
         final int special = 0;
-        GLRegion region = getCachedRegion(font, str, fontSize, special);
+        GLRegion region = getCachedRegion(font, str, pixelSize, special);
         if(null == region) {
             region = GLRegion.create(renderer.getRenderModes());
-            addStringToRegion(region, rs.getVertexFactory(), font, fontSize, str);
-            addCachedRegion(gl, font, str, fontSize, special, region);
+            addStringToRegion(region, renderer.getRenderState().getVertexFactory(), font, pixelSize, str);
+            addCachedRegion(gl, font, str, pixelSize, special, region);
         }
-        region.draw(gl, renderer, texSize);
+        region.draw(gl, renderer, sampleCount);
     }
 
     /**
-     * Render the string in 3D space w.r.t. the font and fontSize
+     * Render the string in 3D space w.r.t. the font and pixelSize
      * using a temporary {@link GLRegion}, which will be destroyed afterwards.
+     * <p>
+     * In case of a multisampling region renderer, i.e. {@link Region#VBAA_RENDERING_BIT}, recreating the {@link GLRegion}
+     * is a huge performance impact.
+     * In such case better use {@link #drawString3D(GLRegion, RegionRenderer, GL2ES2, Font, float, CharSequence, int[])}
+     * instead.
+     * </p>
      * @param gl the current GL state
      * @param font {@link Font} to be used
-     * @param fontSize font size
+     * @param pixelSize Use {@link Font#getPixelSize(float, float)} for resolution correct pixel-size.
      * @param str text to be rendered
-     * @param texWidth desired texture width for multipass-rendering.
-     *        The actual used texture-width is written back when mp rendering is enabled, otherwise the store is untouched.
+     * @param sampleCount desired multisampling sample count for msaa-rendering.
+     *        The actual used scample-count is written back when msaa-rendering is enabled, otherwise the store is untouched.
      * @throws Exception if TextRenderer not initialized
      */
     public static void drawString3D(final RegionRenderer renderer, final GL2ES2 gl,
-                                    final Font font, final float fontSize, final CharSequence str,
-                                    final int[/*1*/] texSize) {
+                                    final Font font, final float pixelSize, final CharSequence str,
+                                    final int[/*1*/] sampleCount) {
         if(!renderer.isInitialized()){
             throw new GLException("TextRendererImpl01: not initialized!");
         }
-        final RenderState rs = renderer.getRenderState();
         final GLRegion region = GLRegion.create(renderer.getRenderModes());
-        addStringToRegion(region, rs.getVertexFactory(), font, fontSize, str);
-        region.draw(gl, renderer, texSize);
+        addStringToRegion(region, renderer.getRenderState().getVertexFactory(), font, pixelSize, str);
+        region.draw(gl, renderer, sampleCount);
         region.destroy(gl, renderer);
     }
 
+    /**
+     * Render the string in 3D space w.r.t. the font and pixelSize
+     * using the given {@link GLRegion}, which will {@link GLRegion#clear(GL2ES2, RegionRenderer) cleared} beforehand.
+     * @param gl the current GL state
+     * @param font {@link Font} to be used
+     * @param pixelSize Use {@link Font#getPixelSize(float, float)} for resolution correct pixel-size.
+     * @param str text to be rendered
+     * @param sampleCount desired multisampling sample count for msaa-rendering.
+     *        The actual used scample-count is written back when msaa-rendering is enabled, otherwise the store is untouched.
+     * @throws Exception if TextRenderer not initialized
+     */
+    public static void drawString3D(final GLRegion region, final RegionRenderer renderer, final GL2ES2 gl,
+                                    final Font font, final float pixelSize, final CharSequence str,
+                                    final int[/*1*/] sampleCount) {
+        if(!renderer.isInitialized()){
+            throw new GLException("TextRendererImpl01: not initialized!");
+        }
+        region.clear(gl, renderer);
+        addStringToRegion(region, renderer.getRenderState().getVertexFactory(), font, pixelSize, str);
+        region.draw(gl, renderer, sampleCount);
+    }
+
    /**
     * Clear all cached {@link GLRegions}.
     */
@@ -213,13 +239,13 @@ public class TextRegionUtil {
        }
    }
 
-   protected final GLRegion getCachedRegion(Font font, CharSequence str, float fontSize, int special) {
-       return stringCacheMap.get(getKey(font, str, fontSize, special));
+   protected final GLRegion getCachedRegion(Font font, CharSequence str, float pixelSize, int special) {
+       return stringCacheMap.get(getKey(font, str, pixelSize, special));
    }
 
-   protected final void addCachedRegion(GL2ES2 gl, Font font, CharSequence str, float fontSize, int special, GLRegion glyphString) {
+   protected final void addCachedRegion(GL2ES2 gl, Font font, CharSequence str, float pixelSize, int special, GLRegion glyphString) {
        if ( 0 != getCacheLimit() ) {
-           final String key = getKey(font, str, fontSize, special);
+           final String key = getKey(font, str, pixelSize, special);
            final GLRegion oldRegion = stringCacheMap.put(key, glyphString);
            if ( null == oldRegion ) {
                // new entry ..
@@ -229,8 +255,8 @@ public class TextRegionUtil {
        }
    }
 
-   protected final void removeCachedRegion(GL2ES2 gl, Font font, CharSequence str, int fontSize, int special) {
-       final String key = getKey(font, str, fontSize, special);
+   protected final void removeCachedRegion(GL2ES2 gl, Font font, CharSequence str, int pixelSize, int special) {
+       final String key = getKey(font, str, pixelSize, special);
        final GLRegion region = stringCacheMap.remove(key);
        if(null != region) {
            region.destroy(gl, renderer);
@@ -248,10 +274,10 @@ public class TextRegionUtil {
        }
    }
 
-   protected final String getKey(Font font, CharSequence str, float fontSize, int special) {
+   protected final String getKey(Font font, CharSequence str, float pixelSize, int special) {
        final StringBuilder sb = new StringBuilder();
        return font.getName(sb, Font.NAME_UNIQUNAME)
-              .append(".").append(str.hashCode()).append(".").append(Float.floatToIntBits(fontSize)).append(special).toString();
+              .append(".").append(str.hashCode()).append(".").append(Float.floatToIntBits(pixelSize)).append(special).toString();
    }
 
    /** Default cache limit, see {@link #setCacheLimit(int)} */
diff --git a/src/jogl/classes/com/jogamp/graph/font/Font.java b/src/jogl/classes/com/jogamp/graph/font/Font.java
index 9758e4d41..2f21fd214 100644
--- a/src/jogl/classes/com/jogamp/graph/font/Font.java
+++ b/src/jogl/classes/com/jogamp/graph/font/Font.java
@@ -32,14 +32,28 @@ import com.jogamp.opengl.math.geom.AABBox;
 
 /**
  * Interface wrapper for font implementation.
- *
+ * <p>
  * TrueType Font Specification:
- *   http://developer.apple.com/fonts/ttrefman/rm06/Chap6.html
- *   http://www.microsoft.com/typography/SpecificationsOverview.mspx
- *   http://www.microsoft.com/typography/otspec/
- *
+ * <ul>
+ *   <li>http://www.freetype.org/freetype2/documentation.html</li>
+ *   <li>http://developer.apple.com/fonts/ttrefman/rm06/Chap6.html</li>
+ *   <li>http://www.microsoft.com/typography/SpecificationsOverview.mspx</li>
+ *   <li>http://www.microsoft.com/typography/otspec/</li>
+ * </ul>
+ * </p>
+ * <p>
  * TrueType Font Table Introduction:
- *   http://scripts.sil.org/cms/scripts/page.php?item_id=IWS-Chapter08
+ * <ul>
+ *   <li>http://scripts.sil.org/cms/scripts/page.php?item_id=IWS-Chapter08</li>
+ * </ul>
+ * </p>
+ * <p>
+ * Misc.:
+ * <ul>
+ *   <li>Treatis on Font <code>Rasterization https://freddie.witherden.org/pages/font-rasterisation/</code></li>
+ *   <li>Glyph Hell <code>http://walon.org/pub/ttf/ttf_glyphs.htm</code></li>
+ * </ul>
+ * </p>
  */
 
 public interface Font {
@@ -109,6 +123,22 @@ public interface Font {
 
     public StringBuilder getAllNames(StringBuilder string, String separator);
 
+    /**
+     * <pre>
+        Font Scale Formula:
+         inch: 25.4 mm
+         pointSize: [point] = [1/72 inch]
+
+         [1]      Scale := pointSize * resolution / ( 72 points per inch * units_per_em )
+         [2]  PixelSize := pointSize * resolution / ( 72 points per inch )
+         [3]      Scale := PixelSize / units_per_em
+     * </pre>
+     * @param fontSize in point-per-inch
+     * @param resolution display resolution in dots-per-inch
+     * @return pixel-per-inch, pixelSize scale factor for font operations.
+     */
+    public float getPixelSize(float fontSize /* points per inch */, float resolution);
+
     public float getAdvanceWidth(int glyphID, float pixelSize);
     public Metrics getMetrics();
     public Glyph getGlyph(char symbol);
diff --git a/src/jogl/classes/com/jogamp/graph/font/FontFactory.java b/src/jogl/classes/com/jogamp/graph/font/FontFactory.java
index d39bda004..948600a4a 100644
--- a/src/jogl/classes/com/jogamp/graph/font/FontFactory.java
+++ b/src/jogl/classes/com/jogamp/graph/font/FontFactory.java
@@ -29,10 +29,13 @@ package com.jogamp.graph.font;
 
 import java.io.File;
 import java.io.IOException;
+import java.net.URI;
 import java.net.URLConnection;
 
+import com.jogamp.common.util.IOUtil;
 import com.jogamp.common.util.PropertyAccess;
 import com.jogamp.common.util.ReflectionUtil;
+import com.jogamp.common.util.cache.TempJarCache;
 
 import jogamp.graph.font.FontConstructor;
 import jogamp.graph.font.JavaFontLoader;
@@ -92,6 +95,24 @@ public class FontFactory {
         return fontConstr.create(conn);
     }
 
+    public static final Font get(final Class<?> context, final String fname, final boolean useTempJarCache) throws IOException {
+        URLConnection conn = null;
+        if( useTempJarCache ) {
+            try {
+                final URI uri = TempJarCache.getResource(fname);
+                conn = null != uri ? uri.toURL().openConnection() : null;
+            } catch (Exception e) {
+                throw new IOException(e);
+            }
+        } else {
+            conn = IOUtil.getResource(context, fname);
+        }
+        if(null != conn) {
+            return FontFactory.get ( conn ) ;
+        }
+        return null;
+    }
+
     public static boolean isPrintableChar( char c ) {
         if( Character.isWhitespace(c) ) {
             return true;