Commit 989d224ef01d800df8e6968f9a50b2694f8bb8ef

sammy 2009-07-19T15:56:38

Document FTFont::renderMode usage, courtesy of Christopher Sean Morrison.

diff --git a/src/FTGL/FTFont.h b/src/FTGL/FTFont.h
index d5cdb60..0de2de5 100644
--- a/src/FTGL/FTFont.h
+++ b/src/FTGL/FTFont.h
@@ -330,6 +330,13 @@ class FTGL_EXPORT FTFont
          * @param spacing  A displacement vector to add after each character
          *                 has been displayed (optional).
          * @param renderMode  Render mode to use for display (optional).
+         *                    Gives the application the ability to
+         *                    control whether to render the font's
+         *                    front and back faces via
+         *                    FTGL::RENDER_FRONT and FTGL::RENDER_BACK
+         *                    respectively, or font sides via
+         *                    FTGL::RENDER_SIDE for extruded glyph
+         *                    fonts.
          * @return  The new pen position after the last character was output.
          */
         virtual FTPoint Render(const char* string, const int len = -1,
@@ -348,6 +355,13 @@ class FTGL_EXPORT FTFont
          * @param spacing  A displacement vector to add after each character
          *                 has been displayed (optional).
          * @param renderMode  Render mode to use for display (optional).
+         *                    Gives the application the ability to
+         *                    control whether to render the font's
+         *                    front and back faces via
+         *                    FTGL::RENDER_FRONT and FTGL::RENDER_BACK
+         *                    respectively, or font sides via
+         *                    FTGL::RENDER_SIDE for extruded glyph
+         *                    fonts.
          * @return  The new pen position after the last character was output.
          */
         virtual FTPoint Render(const wchar_t *string, const int len = -1,