| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| <title>FTGL: FTFont class Reference</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"> |
| </head><body> |
| <!-- Generated by Doxygen 1.3.6 --> |
| <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> |
| <h1>FTFont Class Reference</h1><code>#include <<a class="el" href="FTFont_8h-source.html">FTFont.h</a>></code> |
| <p> |
| <p>Inheritance diagram for FTFont: |
| <p><center><img src="classFTFont.png" usemap="#FTFont_map" border="0" alt=""></center> |
| <map name="FTFont_map"> |
| <area href="classFTGLBitmapFont.html" alt="FTGLBitmapFont" shape="rect" coords="0,56,114,80"> |
| <area href="classFTGLExtrdFont.html" alt="FTGLExtrdFont" shape="rect" coords="124,56,238,80"> |
| <area href="classFTGLOutlineFont.html" alt="FTGLOutlineFont" shape="rect" coords="248,56,362,80"> |
| <area href="classFTGLPixmapFont.html" alt="FTGLPixmapFont" shape="rect" coords="372,56,486,80"> |
| <area href="classFTGLPolygonFont.html" alt="FTGLPolygonFont" shape="rect" coords="496,56,610,80"> |
| <area href="classFTGLTextureFont.html" alt="FTGLTextureFont" shape="rect" coords="620,56,734,80"> |
| </map> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| FTFont is the public interface for the FTGL library. |
| <p> |
| Specific font classes are derived from this class. It uses the helper classes <a class="el" href="classFTFace.html">FTFace</a> and <a class="el" href="classFTSize.html">FTSize</a> to access the Freetype library. This class is abstract and deriving classes must implement the protected <code>MakeGlyph</code> function to create glyphs of the appropriate type.<p> |
| It is good practice after using these functions to test the error code returned. <code>FT_Error <a class="el" href="classFTFont.html#a21">Error()</a></code>. Check the freetype file fterrdef.h for error definitions.<p> |
| <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classFTFace.html">FTFace</a> <p> |
| <a class="el" href="classFTSize.html">FTSize</a> <p> |
| <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> <p> |
| <a class="el" href="classFTGlyph.html">FTGlyph</a> </dd></dl> |
| |
| <p> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00032">32</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>.<table border=0 cellpadding=0 cellspacing=0> |
| <tr><td></td></tr> |
| <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a0">FTFont</a> (const char *fontFilePath)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Open and read a font file. <a href="#a0"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a1">FTFont</a> (const unsigned char *pBufferBytes, size_t bufferSizeInBytes)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Open and read a font from a buffer in memory. <a href="#a1"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a2">~FTFont</a> ()</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a3">Attach</a> (const char *fontFilePath)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Attach auxilliary file to font e.g font metrics. <a href="#a3"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a4">Attach</a> (const unsigned char *pBufferBytes, size_t bufferSizeInBytes)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Attach auxilliary data to font e.g font metrics, from memory. <a href="#a4"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a5">CharMap</a> (FT_Encoding encoding)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the character map for the face. <a href="#a5"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a6">CharMapCount</a> ()</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of character maps in this face. <a href="#a6"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>FT_Encoding * </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a7">CharMapList</a> ()</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of character maps in this face. <a href="#a7"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a8">FaceSize</a> (const unsigned int size, const unsigned int res=72)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the char size for the current face. <a href="#a8"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a9">FaceSize</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current face size in points. <a href="#a9"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a10">Depth</a> (float depth)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the extrusion distance for the font. <a href="#a10"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a11">UseDisplayList</a> (bool useList)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable the use of Display Lists inside FTGL. <a href="#a11"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a12">Ascender</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global ascender height for the face. <a href="#a12"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a13">Descender</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the global descender height for the face. <a href="#a13"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a14">LineHeight</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the line spacing for the font. <a href="#a14"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a15">BBox</a> (const char *string, float &llx, float &lly, float &llz, float &urx, float &ury, float &urz)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for a string. <a href="#a15"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a16">BBox</a> (const wchar_t *string, float &llx, float &lly, float &llz, float &urx, float &ury, float &urz)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for a string. <a href="#a16"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a17">Advance</a> (const wchar_t *string)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the advance width for a string. <a href="#a17"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a18">Advance</a> (const char *string)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the advance width for a string. <a href="#a18"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a19">Render</a> (const char *string)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Render a string of characters. <a href="#a19"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a20">Render</a> (const wchar_t *string)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Render a string of characters. <a href="#a20"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>FT_Error </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#a21">Error</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Queries the Font for errors. <a href="#a21"></a><br><br></td></tr> |
| <tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classFTGlyph.html">FTGlyph</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#b0">MakeGlyph</a> (unsigned int g)=0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a glyph of the correct type. <a href="#b0"></a><br><br></td></tr> |
| <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFTFace.html">FTFace</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#p0">face</a></td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Current face object. <a href="#p0"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFTSize.html">FTSize</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#p1">charSize</a></td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Current size object. <a href="#p1"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#p2">useDisplayLists</a></td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Flag to enable or disable the use of Display Lists inside FTGL <code>true</code> turns ON display lists. <a href="#p2"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>FT_Error </td><td class="memItemRight" valign=bottom><a class="el" href="classFTFont.html#p3">err</a></td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Current error code. <a href="#p3"></a><br><br></td></tr> |
| </table> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" name="a0" doxytag="FTFont::FTFont" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FTFont::FTFont </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const char * </td> |
| <td class="mdname1" valign="top" nowrap> <em>fontFilePath</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Open and read a font file. |
| <p> |
| Sets Error flag.<p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>fontFilePath</em> </td><td>font file path. </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00007">7</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8h-source.html#l00115">FTFace::Error()</a>, and <a class="el" href="FTFont_8h-source.html#l00234">face</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a1" doxytag="FTFont::FTFont" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FTFont::FTFont </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const unsigned char * </td> |
| <td class="mdname" nowrap> <em>pBufferBytes</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>size_t </td> |
| <td class="mdname" nowrap> <em>bufferSizeInBytes</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Open and read a font from a buffer in memory. |
| <p> |
| Sets Error flag. The buffer is owned by the client and is NOT copied by FTGL. The pointer must be valid while using FTGL.<p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>pBufferBytes</em> </td><td>the in-memory buffer </td></tr> |
| <tr><td valign=top><em>bufferSizeInBytes</em> </td><td>the length of the buffer in bytes </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00020">20</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8h-source.html#l00115">FTFace::Error()</a>, and <a class="el" href="FTFont_8h-source.html#l00234">face</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a2" doxytag="FTFont::~FTFont" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FTFont::~<a class="el" href="classFTFont.html">FTFont</a> </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Destructor. |
| <p> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00032">32</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="a18" doxytag="FTFont::Advance" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> float FTFont::Advance </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const char * </td> |
| <td class="mdname1" valign="top" nowrap> <em>string</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the advance width for a string. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>string</em> </td><td>a char string </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd>advance width </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00227">227</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00063">FTGlyphContainer::Advance()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a17" doxytag="FTFont::Advance" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> float FTFont::Advance </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const wchar_t * </td> |
| <td class="mdname1" valign="top" nowrap> <em>string</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the advance width for a string. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>string</em> </td><td>a wchar_t string </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd>advance width </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00209">209</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00063">FTGlyphContainer::Advance()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a12" doxytag="FTFont::Ascender" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> float FTFont::Ascender </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the global ascender height for the face. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>Ascender height </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00119">119</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTSize_8cpp-source.html#l00052">FTSize::Ascender()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a4" doxytag="FTFont::Attach" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool FTFont::Attach </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const unsigned char * </td> |
| <td class="mdname" nowrap> <em>pBufferBytes</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>size_t </td> |
| <td class="mdname" nowrap> <em>bufferSizeInBytes</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Attach auxilliary data to font e.g font metrics, from memory. |
| <p> |
| Note: not all font formats implement this function.<p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>pBufferBytes</em> </td><td>the in-memory buffer </td></tr> |
| <tr><td valign=top><em>bufferSizeInBytes</em> </td><td>the length of the buffer in bytes </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if file has been attached successfully. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00053">53</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8cpp-source.html#l00061">FTFace::Attach()</a>, <a class="el" href="FTFace_8h-source.html#l00115">FTFace::Error()</a>, and <a class="el" href="FTFont_8h-source.html#l00234">face</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a3" doxytag="FTFont::Attach" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool FTFont::Attach </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const char * </td> |
| <td class="mdname1" valign="top" nowrap> <em>fontFilePath</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Attach auxilliary file to font e.g font metrics. |
| <p> |
| Note: not all font formats implement this function.<p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>fontFilePath</em> </td><td>auxilliary font file path. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if file has been attached successfully. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00038">38</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8cpp-source.html#l00061">FTFace::Attach()</a>, <a class="el" href="FTFace_8h-source.html#l00115">FTFace::Error()</a>, and <a class="el" href="FTFont_8h-source.html#l00234">face</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a16" doxytag="FTFont::BBox" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void FTFont::BBox </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const wchar_t * </td> |
| <td class="mdname" nowrap> <em>string</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>llx</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>lly</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>llz</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>urx</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>ury</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>urz</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the bounding box for a string. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>string</em> </td><td>a wchar_t string </td></tr> |
| <tr><td valign=top><em>llx</em> </td><td>lower left near x coord </td></tr> |
| <tr><td valign=top><em>lly</em> </td><td>lower left near y coord </td></tr> |
| <tr><td valign=top><em>llz</em> </td><td>lower left near z coord </td></tr> |
| <tr><td valign=top><em>urx</em> </td><td>upper right far x coord </td></tr> |
| <tr><td valign=top><em>ury</em> </td><td>upper right far y coord </td></tr> |
| <tr><td valign=top><em>urz</em> </td><td>upper right far z coord </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00172">172</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00063">FTGlyphContainer::Advance()</a>, <a class="el" href="FTGlyphContainer_8cpp-source.html#l00057">FTGlyphContainer::BBox()</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::lowerX</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::lowerY</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::lowerZ</a>, <a class="el" href="FTBBox_8h-source.html#l00081">FTBBox::Move()</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::upperX</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::upperY</a>, and <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::upperZ</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a15" doxytag="FTFont::BBox" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void FTFont::BBox </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const char * </td> |
| <td class="mdname" nowrap> <em>string</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>llx</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>lly</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>llz</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>urx</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>ury</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>float & </td> |
| <td class="mdname" nowrap> <em>urz</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the bounding box for a string. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>string</em> </td><td>a char string </td></tr> |
| <tr><td valign=top><em>llx</em> </td><td>lower left near x coord </td></tr> |
| <tr><td valign=top><em>lly</em> </td><td>lower left near y coord </td></tr> |
| <tr><td valign=top><em>llz</em> </td><td>lower left near z coord </td></tr> |
| <tr><td valign=top><em>urx</em> </td><td>upper right far x coord </td></tr> |
| <tr><td valign=top><em>ury</em> </td><td>upper right far y coord </td></tr> |
| <tr><td valign=top><em>urz</em> </td><td>upper right far z coord </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00135">135</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00063">FTGlyphContainer::Advance()</a>, <a class="el" href="FTGlyphContainer_8cpp-source.html#l00057">FTGlyphContainer::BBox()</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::lowerX</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::lowerY</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::lowerZ</a>, <a class="el" href="FTBBox_8h-source.html#l00081">FTBBox::Move()</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::upperX</a>, <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::upperY</a>, and <a class="el" href="FTBBox_8h-source.html#l00114">FTBBox::upperZ</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a5" doxytag="FTFont::CharMap" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool FTFont::CharMap </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">FT_Encoding </td> |
| <td class="mdname1" valign="top" nowrap> <em>encoding</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set the character map for the face. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>encoding</em> </td><td>Freetype enumerate for char map code. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if charmap was valid and set correctly </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00094">94</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00029">FTGlyphContainer::CharMap()</a>, and <a class="el" href="FTGlyphContainer_8h-source.html#l00102">FTGlyphContainer::Error()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a6" doxytag="FTFont::CharMapCount" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> unsigned int FTFont::CharMapCount </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the number of character maps in this face. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>character map count. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00102">102</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8cpp-source.html#l00090">FTFace::CharMapCount()</a>, and <a class="el" href="FTFont_8h-source.html#l00234">face</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a7" doxytag="FTFont::CharMapList" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FT_Encoding * FTFont::CharMapList </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get a list of character maps in this face. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>pointer to the first encoding. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00108">108</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8cpp-source.html#l00096">FTFace::CharMapList()</a>, and <a class="el" href="FTFont_8h-source.html#l00234">face</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a10" doxytag="FTFont::Depth" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> virtual void FTFont::Depth </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">float </td> |
| <td class="mdname1" valign="top" nowrap> <em>depth</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [inline, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set the extrusion distance for the font. |
| <p> |
| Only implemented by <a class="el" href="classFTGLExtrdFont.html">FTGLExtrdFont</a><p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>depth</em> </td><td>The extrusion distance. </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Reimplemented in <a class="el" href="classFTGLExtrdFont.html#a3">FTGLExtrdFont</a>. |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00125">125</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a13" doxytag="FTFont::Descender" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> float FTFont::Descender </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Gets the global descender height for the face. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>Descender height </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00125">125</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTSize_8cpp-source.html#l00058">FTSize::Descender()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a21" doxytag="FTFont::Error" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FT_Error FTFont::Error </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Queries the Font for errors. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>The current error code. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00217">217</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a9" doxytag="FTFont::FaceSize" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> unsigned int FTFont::FaceSize </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the current face size in points. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>face size </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00088">88</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTSize_8cpp-source.html#l00018">FTSize::CharSize()</a>. |
| <p> |
| Referenced by <a class="el" href="FTGLTextureFont_8cpp-source.html#l00140">FTGLTextureFont::FaceSize()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a8" doxytag="FTFont::FaceSize" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool FTFont::FaceSize </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const unsigned int </td> |
| <td class="mdname" nowrap> <em>size</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>const unsigned int </td> |
| <td class="mdname" nowrap> <em>res</em> = 72</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set the char size for the current face. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>size</em> </td><td>the face size in points (1/72 inch) </td></tr> |
| <tr><td valign=top><em>res</em> </td><td>the resolution of the target device. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if size was set correctly </dd></dl> |
| |
| <p> |
| Reimplemented in <a class="el" href="classFTGLTextureFont.html#a3">FTGLTextureFont</a>. |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00068">68</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFace_8h-source.html#l00115">FTFace::Error()</a>, <a class="el" href="FTFont_8h-source.html#l00234">face</a>, and <a class="el" href="FTFace_8cpp-source.html#l00081">FTFace::Size()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a14" doxytag="FTFont::LineHeight" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> float FTFont::LineHeight </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Gets the line spacing for the font. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>Line height </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00130">130</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTSize_8cpp-source.html#l00064">FTSize::Height()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b0" doxytag="FTFont::MakeGlyph" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> virtual <a class="el" href="classFTGlyph.html">FTGlyph</a>* FTFont::MakeGlyph </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">unsigned int </td> |
| <td class="mdname1" valign="top" nowrap> <em>g</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [protected, pure virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Construct a glyph of the correct type. |
| <p> |
| Clients must overide the function and return their specialised <a class="el" href="classFTGlyph.html">FTGlyph</a>.<p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>g</em> </td><td>The glyph index NOT the char code. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd>An FT****Glyph or <code>null</code> on failure. </dd></dl> |
| </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a20" doxytag="FTFont::Render" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void FTFont::Render </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const wchar_t * </td> |
| <td class="mdname1" valign="top" nowrap> <em>string</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Render a string of characters. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>string</em> </td><td>wchar_t string to be output. </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Reimplemented in <a class="el" href="classFTGLBitmapFont.html#a4">FTGLBitmapFont</a>, <a class="el" href="classFTGLOutlineFont.html#a4">FTGLOutlineFont</a>, <a class="el" href="classFTGLPixmapFont.html#a4">FTGLPixmapFont</a>, and <a class="el" href="classFTGLTextureFont.html#a5">FTGLTextureFont</a>. |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00261">261</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00075">FTGlyphContainer::Render()</a>, <a class="el" href="FTPoint_8h-source.html#l00142">FTPoint::X()</a>, and <a class="el" href="FTPoint_8h-source.html#l00143">FTPoint::Y()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a19" doxytag="FTFont::Render" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void FTFont::Render </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const char * </td> |
| <td class="mdname1" valign="top" nowrap> <em>string</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Render a string of characters. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>string</em> </td><td>'C' style string to be output. </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Reimplemented in <a class="el" href="classFTGLBitmapFont.html#a3">FTGLBitmapFont</a>, <a class="el" href="classFTGLOutlineFont.html#a3">FTGLOutlineFont</a>, <a class="el" href="classFTGLPixmapFont.html#a3">FTGLPixmapFont</a>, and <a class="el" href="classFTGLTextureFont.html#a4">FTGLTextureFont</a>. |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00245">245</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTGlyphContainer_8cpp-source.html#l00075">FTGlyphContainer::Render()</a>, <a class="el" href="FTPoint_8h-source.html#l00142">FTPoint::X()</a>, and <a class="el" href="FTPoint_8h-source.html#l00143">FTPoint::Y()</a>. |
| <p> |
| Referenced by <a class="el" href="FTGLTextureFont_8cpp-source.html#l00153">FTGLTextureFont::Render()</a>, <a class="el" href="FTGLPixmapFont_8cpp-source.html#l00034">FTGLPixmapFont::Render()</a>, <a class="el" href="FTGLOutlineFont_8cpp-source.html#l00034">FTGLOutlineFont::Render()</a>, and <a class="el" href="FTGLBitmapFont_8cpp-source.html#l00034">FTGLBitmapFont::Render()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a11" doxytag="FTFont::UseDisplayList" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void FTFont::UseDisplayList </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">bool </td> |
| <td class="mdname1" valign="top" nowrap> <em>useList</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Enable or disable the use of Display Lists inside FTGL. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>useList</em> </td><td><code>true</code> turns ON display lists. <code>false</code> turns OFF display lists. </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8cpp-source.html#l00114">114</a> of file <a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a>. |
| <p> |
| References <a class="el" href="FTFont_8h-source.html#l00246">useDisplayLists</a>. </td> |
| </tr> |
| </table> |
| <hr><h2>Field Documentation</h2> |
| <a class="anchor" name="p1" doxytag="FTFont::charSize" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="classFTSize.html">FTSize</a> <a class="el" href="classFTFont.html#p1">FTFont::charSize</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Current size object. |
| <p> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00239">239</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="p3" doxytag="FTFont::err" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FT_Error <a class="el" href="classFTFont.html#p3">FTFont::err</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Current error code. |
| <p> |
| Zero means no error. |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00251">251</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="p0" doxytag="FTFont::face" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="classFTFace.html">FTFace</a> <a class="el" href="classFTFont.html#p0">FTFont::face</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Current face object. |
| <p> |
| |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00234">234</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>. |
| <p> |
| Referenced by <a class="el" href="FTFont_8cpp-source.html#l00038">Attach()</a>, <a class="el" href="FTFont_8cpp-source.html#l00102">CharMapCount()</a>, <a class="el" href="FTFont_8cpp-source.html#l00108">CharMapList()</a>, <a class="el" href="FTFont_8cpp-source.html#l00068">FaceSize()</a>, and <a class="el" href="FTFont_8cpp-source.html#l00007">FTFont()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="p2" doxytag="FTFont::useDisplayLists" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool <a class="el" href="classFTFont.html#p2">FTFont::useDisplayLists</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Flag to enable or disable the use of Display Lists inside FTGL <code>true</code> turns ON display lists. |
| <p> |
| <code>false</code> turns OFF display lists. |
| <p> |
| Definition at line <a class="el" href="FTFont_8h-source.html#l00246">246</a> of file <a class="el" href="FTFont_8h-source.html">FTFont.h</a>. |
| <p> |
| Referenced by <a class="el" href="FTFont_8cpp-source.html#l00114">UseDisplayList()</a>. </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following files:<ul> |
| <li><a class="el" href="FTFont_8h-source.html">FTFont.h</a><li><a class="el" href="FTFont_8cpp-source.html">FTFont.cpp</a></ul> |
| <hr size="1"><address style="align: right;"><small>Generated on Sun Dec 5 22:24:07 2004 for FTGL by |
| <a href="http://www.doxygen.org/index.html"> |
| <img src="doxygen.png" alt="doxygen" align="middle" border=0 > |
| </a>1.3.6 </small></address> |
| </body> |
| </html> |