Updating documentation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
diff --git a/include/FTExtrdGlyph.h b/include/FTExtrdGlyph.h
index 01e7c9e..d1d9d87 100644
--- a/include/FTExtrdGlyph.h
+++ b/include/FTExtrdGlyph.h
@@ -26,8 +26,11 @@ class FTGL_EXPORT FTExtrdGlyph : public FTGlyph
*
* @param glyph The Freetype glyph to be processed
* @param depth The distance along the z axis to extrude the glyph
+ * @param useDisplayList Enable or disable the use of Display Lists for this glyph
+ * <code>true</code> turns ON display lists.
+ * <code>false</code> turns OFF display lists.
*/
- FTExtrdGlyph( FT_GlyphSlot glyph, float depth);
+ FTExtrdGlyph( FT_GlyphSlot glyph, float depth, bool useDisplayList);
/**
* Destructor
diff --git a/include/FTGLExtrdFont.h b/include/FTGLExtrdFont.h
index dc784bb..f175e79 100644
--- a/include/FTGLExtrdFont.h
+++ b/include/FTGLExtrdFont.h
@@ -36,6 +36,11 @@ class FTGL_EXPORT FTGLExtrdFont : public FTFont
*/
~FTGLExtrdFont();
+ /**
+ * Set the extrusion distance for the font.
+ *
+ * @param d The extrusion distance.
+ */
void Depth( float d) { depth = d;}
private:
@@ -47,6 +52,9 @@ class FTGL_EXPORT FTGLExtrdFont : public FTFont
*/
inline virtual FTGlyph* MakeGlyph( unsigned int glyphIndex);
+ /**
+ * The extrusion distance for the font.
+ */
float depth;
};
diff --git a/include/FTGlyph.h b/include/FTGlyph.h
index c38d51e..2083964 100755
--- a/include/FTGlyph.h
+++ b/include/FTGlyph.h
@@ -27,8 +27,13 @@ class FTGL_EXPORT FTGlyph
public:
/**
* Constructor
+ *
+ * @param glyph The Freetype glyph to be processed
+ * @param useDisplayList Enable or disable the use of Display Lists for this glyph
+ * <code>true</code> turns ON display lists.
+ * <code>false</code> turns OFF display lists.
*/
- FTGlyph( FT_GlyphSlot glyph);
+ FTGlyph( FT_GlyphSlot glyph, bool useDisplayList = true);
/**
* Destructor
@@ -76,6 +81,13 @@ class FTGL_EXPORT FTGlyph
FTBBox bBox;
/**
+ * Flag to enable or disable the use of Display Lists inside FTGL
+ * <code>true</code> turns ON display lists.
+ * <code>false</code> turns OFF display lists.
+ */
+ bool useDisplayList;
+
+ /**
* Current error code. Zero means no error.
*/
FT_Error err;
diff --git a/include/FTOutlineGlyph.h b/include/FTOutlineGlyph.h
index 7dd0ba0..0333d56 100644
--- a/include/FTOutlineGlyph.h
+++ b/include/FTOutlineGlyph.h
@@ -25,8 +25,11 @@ class FTGL_EXPORT FTOutlineGlyph : public FTGlyph
* Constructor. Sets the Error to Invalid_Outline if the glyphs isn't an outline.
*
* @param glyph The Freetype glyph to be processed
+ * @param useDisplayList Enable or disable the use of Display Lists for this glyph
+ * <code>true</code> turns ON display lists.
+ * <code>false</code> turns OFF display lists.
*/
- FTOutlineGlyph( FT_GlyphSlot glyph);
+ FTOutlineGlyph( FT_GlyphSlot glyph, bool useDisplayList);
/**
* Destructor
diff --git a/include/FTPolyGlyph.h b/include/FTPolyGlyph.h
index c8faeff..bd25d6d 100644
--- a/include/FTPolyGlyph.h
+++ b/include/FTPolyGlyph.h
@@ -26,8 +26,12 @@ class FTGL_EXPORT FTPolyGlyph : public FTGlyph
* Constructor. Sets the Error to Invalid_Outline if the glyphs isn't an outline.
*
* @param glyph The Freetype glyph to be processed
+ * @param glyph The Freetype glyph to be processed
+ * @param useDisplayList Enable or disable the use of Display Lists for this glyph
+ * <code>true</code> turns ON display lists.
+ * <code>false</code> turns OFF display lists.
*/
- FTPolyGlyph( FT_GlyphSlot glyph);
+ FTPolyGlyph( FT_GlyphSlot glyph, bool useDisplayList);
/**
* Destructor