<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FTGL: FTFont Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FTGL <span id="projectnumber">2.1.3~rc5</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>FTFont Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="FTFont" -->
<p><a class="el" href="classFTFont.html" title="FTFont is the public interface for the FTGL library.">FTFont</a> is the public interface for the <a class="el" href="namespaceFTGL.html">FTGL</a> library.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="FTFont_8h_source.html">FTFont.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FTFont:</div>
<div class="dyncontent">
<div class="center">
<img src="classFTFont.png" usemap="#FTFont_map" alt=""/>
<map id="FTFont_map" name="FTFont_map">
<area href="classFTBitmapFont.html" alt="FTBitmapFont" shape="rect" coords="0,56,98,80"/>
<area href="classFTBufferFont.html" alt="FTBufferFont" shape="rect" coords="108,56,206,80"/>
<area href="classFTExtrudeFont.html" alt="FTExtrudeFont" shape="rect" coords="216,56,314,80"/>
<area href="classFTOutlineFont.html" alt="FTOutlineFont" shape="rect" coords="324,56,422,80"/>
<area href="classFTPixmapFont.html" alt="FTPixmapFont" shape="rect" coords="432,56,530,80"/>
<area href="classFTPolygonFont.html" alt="FTPolygonFont" shape="rect" coords="540,56,638,80"/>
<area href="classFTTextureFont.html" alt="FTTextureFont" shape="rect" coords="648,56,746,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a9df9b873c582024867ff6b9dfff0face">~FTFont</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a7ec6a20a092c338648626b98ec879e0c">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="#a7ec6a20a092c338648626b98ec879e0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a95f86388d8cb2ba1c94679d30c68aba5">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="#a95f86388d8cb2ba1c94679d30c68aba5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#af29f89a8aa0f4e43a3a229ed1d3beacd">GlyphLoadFlags</a> (FT_Int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the glyph loading flags. <a href="#af29f89a8aa0f4e43a3a229ed1d3beacd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a64f7346221e90325220829eeaa238e93">CharMap</a> (FT_Encoding encoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the character map for the face. <a href="#a64f7346221e90325220829eeaa238e93"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a78cfce358a1b95d7b3792fcc3f99aa73">CharMapCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of character maps in this face. <a href="#a78cfce358a1b95d7b3792fcc3f99aa73"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual FT_Encoding * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a160ad04d573a6bcd0ecb709d7ded4fa3">CharMapList</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of character maps in this face. <a href="#a160ad04d573a6bcd0ecb709d7ded4fa3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#aae95510a733d6755bbbaf92d67796ff9">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="#aae95510a733d6755bbbaf92d67796ff9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a9cbb507fc57e6d50c5967d2ab3c50041">FaceSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current face size in points (1/72 inch). <a href="#a9cbb507fc57e6d50c5967d2ab3c50041"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a7fc7825ca4089e12a679f788e0cb9d2c">Depth</a> (float depth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the extrusion distance for the font. <a href="#a7fc7825ca4089e12a679f788e0cb9d2c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#aff29fad8b2a53f518311d06e2c25b227">Outset</a> (float outset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the outset distance for the font. <a href="#aff29fad8b2a53f518311d06e2c25b227"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a4a03161e954de3ae3c6f3f0872628a09">Outset</a> (float front, float back)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the front and back outset distances for the font. <a href="#a4a03161e954de3ae3c6f3f0872628a09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a5d3dfcf608bb1e07a7ceeec23f079600">UseDisplayList</a> (bool useList)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable the use of Display Lists inside <a class="el" href="namespaceFTGL.html">FTGL</a>. <a href="#a5d3dfcf608bb1e07a7ceeec23f079600"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#ac4659028a0be30e8bc85814e7e53ee87">Ascender</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global ascender height for the face. <a href="#ac4659028a0be30e8bc85814e7e53ee87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#aa72f172f4f9a39970913e176f38866bc">Descender</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the global descender height for the face. <a href="#aa72f172f4f9a39970913e176f38866bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#ac85ec080661ab10f124dbd0bb058556d">LineHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the line spacing for the font. <a href="#ac85ec080661ab10f124dbd0bb058556d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFTBBox.html">FTBBox</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a05b5c069ab8e958935096df78f8af16f">BBox</a> (const char *string, const int len=-1, <a class="el" href="classFTPoint.html">FTPoint</a> position=<a class="el" href="classFTPoint.html">FTPoint</a>(), <a class="el" href="classFTPoint.html">FTPoint</a> spacing=<a class="el" href="classFTPoint.html">FTPoint</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for a string. <a href="#a05b5c069ab8e958935096df78f8af16f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a45078d6f0b74334030558d10cfeab4b9">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 (deprecated). <a href="#a45078d6f0b74334030558d10cfeab4b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFTBBox.html">FTBBox</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a5ae3599880a9ee459be17f0a1d4ce67c">BBox</a> (const wchar_t *string, const int len=-1, <a class="el" href="classFTPoint.html">FTPoint</a> position=<a class="el" href="classFTPoint.html">FTPoint</a>(), <a class="el" href="classFTPoint.html">FTPoint</a> spacing=<a class="el" href="classFTPoint.html">FTPoint</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for a string. <a href="#a5ae3599880a9ee459be17f0a1d4ce67c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#af495e078c9f8bad2b6fb0b5d04416fe7">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 (deprecated). <a href="#af495e078c9f8bad2b6fb0b5d04416fe7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#ae606eb0323341d1a521dae7a712f1b6e">Advance</a> (const char *string, const int len=-1, <a class="el" href="classFTPoint.html">FTPoint</a> spacing=<a class="el" href="classFTPoint.html">FTPoint</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the advance for a string. <a href="#ae606eb0323341d1a521dae7a712f1b6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a030a33368ab7fcbcb082909e4c2d6b89">Advance</a> (const wchar_t *string, const int len=-1, <a class="el" href="classFTPoint.html">FTPoint</a> spacing=<a class="el" href="classFTPoint.html">FTPoint</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the advance for a string. <a href="#a030a33368ab7fcbcb082909e4c2d6b89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFTPoint.html">FTPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#ac6de580b27cc4df4986855967639de87">Render</a> (const char *string, const int len=-1, <a class="el" href="classFTPoint.html">FTPoint</a> position=<a class="el" href="classFTPoint.html">FTPoint</a>(), <a class="el" href="classFTPoint.html">FTPoint</a> spacing=<a class="el" href="classFTPoint.html">FTPoint</a>(), int renderMode=FTGL::RENDER_ALL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render a string of characters. <a href="#ac6de580b27cc4df4986855967639de87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFTPoint.html">FTPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a0dc25b01d7ef4120910bc63d0a791251">Render</a> (const wchar_t *string, const int len=-1, <a class="el" href="classFTPoint.html">FTPoint</a> position=<a class="el" href="classFTPoint.html">FTPoint</a>(), <a class="el" href="classFTPoint.html">FTPoint</a> spacing=<a class="el" href="classFTPoint.html">FTPoint</a>(), int renderMode=FTGL::RENDER_ALL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render a string of characters. <a href="#a0dc25b01d7ef4120910bc63d0a791251"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual FT_Error </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a1b535e3a7fef84c073988ab6f74f9ec1">Error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Queries the Font for errors. <a href="#a1b535e3a7fef84c073988ab6f74f9ec1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#af7edeab8bc77784a537dc63e54315cc9">FTFont</a> (char const *fontFilePath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open and read a font file. <a href="#af7edeab8bc77784a537dc63e54315cc9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a8911254ec56e3b9c36891459b98beaf2">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="#a8911254ec56e3b9c36891459b98beaf2"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a07f8bef6c3bd52e7d905e6db17c9b8e6">MakeGlyph</a> (FT_GlyphSlot slot)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a glyph of the correct type. <a href="#a07f8bef6c3bd52e7d905e6db17c9b8e6"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a7ba5a198d501799828a37b4b808b9352">FTBitmapFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#ab7dc21f40be33fee50c41b3ba3d49c73">FTBufferFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a06be1600e211ee41aa1b1ed9c7d25639">FTExtrudeFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a17f6eed308c6d1116a7f1d86010f6c9e">FTOutlineFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#ac7f382db9ff9f02888b67b7434d7edd4">FTPixmapFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#abd1c273c43e47346ad6c178ec173cc41">FTPolygonFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a7870c341f7269dfae257e93406c17c92">FTTextureFont</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html#a7ae54d130cb58f258d2b036a544c7a9b">FTFontImpl</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classFTFont.html" title="FTFont is the public interface for the FTGL library.">FTFont</a> is the public interface for the <a class="el" href="namespaceFTGL.html">FTGL</a> library. </p>
<p>Specific font classes are derived from this class. It uses the helper classes FTFace and FTSize 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>
<p>It is good practice after using these functions to test the error code returned. <code>FT_Error <a class="el" href="classFTFont.html#a1b535e3a7fef84c073988ab6f74f9ec1" title="Queries the Font for errors.">Error()</a></code>. Check the freetype file fterrdef.h for error definitions.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>FTFace </dd>
<dd>
FTSize </dd></dl>
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00056">56</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af7edeab8bc77784a537dc63e54315cc9"></a><!-- doxytag: member="FTFont::FTFont" ref="af7edeab8bc77784a537dc63e54315cc9" args="(char const *fontFilePath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FTFont::FTFont </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>fontFilePath</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open and read a font file. </p>
<p>Sets Error flag.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fontFilePath</td><td>font file path. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8911254ec56e3b9c36891459b98beaf2"></a><!-- doxytag: member="FTFont::FTFont" ref="a8911254ec56e3b9c36891459b98beaf2" args="(const unsigned char *pBufferBytes, size_t bufferSizeInBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FTFont::FTFont </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>pBufferBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufferSizeInBytes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open and read a font from a buffer in memory. </p>
<p>Sets Error flag. The buffer is owned by the client and is NOT copied by <a class="el" href="namespaceFTGL.html">FTGL</a>. The pointer must be valid while using <a class="el" href="namespaceFTGL.html">FTGL</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pBufferBytes</td><td>the in-memory buffer </td></tr>
<tr><td class="paramname">bufferSizeInBytes</td><td>the length of the buffer in bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9df9b873c582024867ff6b9dfff0face"></a><!-- doxytag: member="FTFont::~FTFont" ref="a9df9b873c582024867ff6b9dfff0face" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FTFont::~FTFont </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae606eb0323341d1a521dae7a712f1b6e"></a><!-- doxytag: member="FTFont::Advance" ref="ae606eb0323341d1a521dae7a712f1b6e" args="(const char *string, const int len=-1, FTPoint spacing=FTPoint())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float FTFont::Advance </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>len</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>spacing</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the advance for a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>'C' style string to be checked. </td></tr>
<tr><td class="paramname">len</td><td>The length of the string. If < 0 then all characters will be checked until a null character is encountered (optional). </td></tr>
<tr><td class="paramname">spacing</td><td>A displacement vector to add after each character has been checked (optional). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The string's advance width. </dd></dl>
</div>
</div>
<a class="anchor" id="a030a33368ab7fcbcb082909e4c2d6b89"></a><!-- doxytag: member="FTFont::Advance" ref="a030a33368ab7fcbcb082909e4c2d6b89" args="(const wchar_t *string, const int len=-1, FTPoint spacing=FTPoint())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float FTFont::Advance </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>len</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>spacing</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the advance for a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>A wchar_t string </td></tr>
<tr><td class="paramname">len</td><td>The length of the string. If < 0 then all characters will be checked until a null character is encountered (optional). </td></tr>
<tr><td class="paramname">spacing</td><td>A displacement vector to add after each character has been checked (optional). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The string's advance width. </dd></dl>
</div>
</div>
<a class="anchor" id="ac4659028a0be30e8bc85814e7e53ee87"></a><!-- doxytag: member="FTFont::Ascender" ref="ac4659028a0be30e8bc85814e7e53ee87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float FTFont::Ascender </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the global ascender height for the face. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Ascender height </dd></dl>
</div>
</div>
<a class="anchor" id="a95f86388d8cb2ba1c94679d30c68aba5"></a><!-- doxytag: member="FTFont::Attach" ref="a95f86388d8cb2ba1c94679d30c68aba5" args="(const unsigned char *pBufferBytes, size_t bufferSizeInBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FTFont::Attach </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>pBufferBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufferSizeInBytes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach auxilliary data to font e.g font metrics, from memory. </p>
<p>Note: not all font formats implement this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pBufferBytes</td><td>the in-memory buffer. </td></tr>
<tr><td class="paramname">bufferSizeInBytes</td><td>the length of the buffer in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if file has been attached successfully. </dd></dl>
</div>
</div>
<a class="anchor" id="a7ec6a20a092c338648626b98ec879e0c"></a><!-- doxytag: member="FTFont::Attach" ref="a7ec6a20a092c338648626b98ec879e0c" args="(const char *fontFilePath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FTFont::Attach </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fontFilePath</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach auxilliary file to font e.g font metrics. </p>
<p>Note: not all font formats implement this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fontFilePath</td><td>auxilliary font file path. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if file has been attached successfully. </dd></dl>
</div>
</div>
<a class="anchor" id="a05b5c069ab8e958935096df78f8af16f"></a><!-- doxytag: member="FTFont::BBox" ref="a05b5c069ab8e958935096df78f8af16f" args="(const char *string, const int len=-1, FTPoint position=FTPoint(), FTPoint spacing=FTPoint())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFTBBox.html">FTBBox</a> FTFont::BBox </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>len</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>position</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>spacing</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the bounding box for a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>A char buffer. </td></tr>
<tr><td class="paramname">len</td><td>The length of the string. If < 0 then all characters will be checked until a null character is encountered (optional). </td></tr>
<tr><td class="paramname">position</td><td>The pen position of the first character (optional). </td></tr>
<tr><td class="paramname">spacing</td><td>A displacement vector to add after each character has been checked (optional). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The corresponding bounding box. </dd></dl>
<p>Referenced by <a class="el" href="FTFont_8h_source.html#l00251">BBox()</a>.</p>
</div>
</div>
<a class="anchor" id="a45078d6f0b74334030558d10cfeab4b9"></a><!-- doxytag: member="FTFont::BBox" ref="a45078d6f0b74334030558d10cfeab4b9" args="(const char *string, float &llx, float &lly, float &llz, float &urx, float &ury, float &urz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FTFont::BBox </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>llx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>lly</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>llz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>urx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>ury</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>urz</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the bounding box for a string (deprecated). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>A char buffer. </td></tr>
<tr><td class="paramname">llx</td><td>Lower left near x coordinate. </td></tr>
<tr><td class="paramname">lly</td><td>Lower left near y coordinate. </td></tr>
<tr><td class="paramname">llz</td><td>Lower left near z coordinate. </td></tr>
<tr><td class="paramname">urx</td><td>Upper right far x coordinate. </td></tr>
<tr><td class="paramname">ury</td><td>Upper right far y coordinate. </td></tr>
<tr><td class="paramname">urz</td><td>Upper right far z coordinate. </td></tr>
</table>
</dd>
</dl>
<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>.</p>
<p>References <a class="el" href="classFTFont.html#a05b5c069ab8e958935096df78f8af16f">BBox()</a>, <a class="el" href="FTBBox_8h_source.html#l00165">FTBBox::Lower()</a>, <a class="el" href="FTBBox_8h_source.html#l00159">FTBBox::Upper()</a>, <a class="el" href="FTPoint_8h_source.html#l00260">FTPoint::Xf()</a>, <a class="el" href="FTPoint_8h_source.html#l00261">FTPoint::Yf()</a>, and <a class="el" href="FTPoint_8h_source.html#l00262">FTPoint::Zf()</a>.</p>
</div>
</div>
<a class="anchor" id="a5ae3599880a9ee459be17f0a1d4ce67c"></a><!-- doxytag: member="FTFont::BBox" ref="a5ae3599880a9ee459be17f0a1d4ce67c" args="(const wchar_t *string, const int len=-1, FTPoint position=FTPoint(), FTPoint spacing=FTPoint())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFTBBox.html">FTBBox</a> FTFont::BBox </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>len</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>position</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>spacing</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the bounding box for a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>A wchar_t buffer. </td></tr>
<tr><td class="paramname">len</td><td>The length of the string. If < 0 then all characters will be checked until a null character is encountered (optional). </td></tr>
<tr><td class="paramname">position</td><td>The pen position of the first character (optional). </td></tr>
<tr><td class="paramname">spacing</td><td>A displacement vector to add after each character has been checked (optional). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The corresponding bounding box. </dd></dl>
</div>
</div>
<a class="anchor" id="af495e078c9f8bad2b6fb0b5d04416fe7"></a><!-- doxytag: member="FTFont::BBox" ref="af495e078c9f8bad2b6fb0b5d04416fe7" args="(const wchar_t *string, float &llx, float &lly, float &llz, float &urx, float &ury, float &urz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FTFont::BBox </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>llx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>lly</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>llz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>urx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>ury</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>urz</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the bounding box for a string (deprecated). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>A wchar_t buffer. </td></tr>
<tr><td class="paramname">llx</td><td>Lower left near x coordinate. </td></tr>
<tr><td class="paramname">lly</td><td>Lower left near y coordinate. </td></tr>
<tr><td class="paramname">llz</td><td>Lower left near z coordinate. </td></tr>
<tr><td class="paramname">urx</td><td>Upper right far x coordinate. </td></tr>
<tr><td class="paramname">ury</td><td>Upper right far y coordinate. </td></tr>
<tr><td class="paramname">urz</td><td>Upper right far z coordinate. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00286">286</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
<p>References <a class="el" href="classFTFont.html#a05b5c069ab8e958935096df78f8af16f">BBox()</a>, <a class="el" href="FTBBox_8h_source.html#l00165">FTBBox::Lower()</a>, <a class="el" href="FTBBox_8h_source.html#l00159">FTBBox::Upper()</a>, <a class="el" href="FTPoint_8h_source.html#l00260">FTPoint::Xf()</a>, <a class="el" href="FTPoint_8h_source.html#l00261">FTPoint::Yf()</a>, and <a class="el" href="FTPoint_8h_source.html#l00262">FTPoint::Zf()</a>.</p>
</div>
</div>
<a class="anchor" id="a64f7346221e90325220829eeaa238e93"></a><!-- doxytag: member="FTFont::CharMap" ref="a64f7346221e90325220829eeaa238e93" args="(FT_Encoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FTFont::CharMap </td>
<td>(</td>
<td class="paramtype">FT_Encoding </td>
<td class="paramname"><em>encoding</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the character map for the face. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">encoding</td><td>Freetype enumerate for char map code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if charmap was valid and set correctly. </dd></dl>
</div>
</div>
<a class="anchor" id="a78cfce358a1b95d7b3792fcc3f99aa73"></a><!-- doxytag: member="FTFont::CharMapCount" ref="a78cfce358a1b95d7b3792fcc3f99aa73" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int FTFont::CharMapCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of character maps in this face. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>character map count. </dd></dl>
</div>
</div>
<a class="anchor" id="a160ad04d573a6bcd0ecb709d7ded4fa3"></a><!-- doxytag: member="FTFont::CharMapList" ref="a160ad04d573a6bcd0ecb709d7ded4fa3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FT_Encoding* FTFont::CharMapList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a list of character maps in this face. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the first encoding. </dd></dl>
</div>
</div>
<a class="anchor" id="a7fc7825ca4089e12a679f788e0cb9d2c"></a><!-- doxytag: member="FTFont::Depth" ref="a7fc7825ca4089e12a679f788e0cb9d2c" args="(float depth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FTFont::Depth </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>depth</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the extrusion distance for the font. </p>
<p>Only implemented by <a class="el" href="classFTExtrudeFont.html" title="FTExtrudeFont is a specialisation of the FTFont class for handling extruded Polygon fonts...">FTExtrudeFont</a></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">depth</td><td>The extrusion distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa72f172f4f9a39970913e176f38866bc"></a><!-- doxytag: member="FTFont::Descender" ref="aa72f172f4f9a39970913e176f38866bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float FTFont::Descender </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the global descender height for the face. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Descender height </dd></dl>
</div>
</div>
<a class="anchor" id="a1b535e3a7fef84c073988ab6f74f9ec1"></a><!-- doxytag: member="FTFont::Error" ref="a1b535e3a7fef84c073988ab6f74f9ec1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FT_Error FTFont::Error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Queries the Font for errors. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current error code. </dd></dl>
</div>
</div>
<a class="anchor" id="a9cbb507fc57e6d50c5967d2ab3c50041"></a><!-- doxytag: member="FTFont::FaceSize" ref="a9cbb507fc57e6d50c5967d2ab3c50041" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int FTFont::FaceSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current face size in points (1/72 inch). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>face size </dd></dl>
</div>
</div>
<a class="anchor" id="aae95510a733d6755bbbaf92d67796ff9"></a><!-- doxytag: member="FTFont::FaceSize" ref="aae95510a733d6755bbbaf92d67796ff9" args="(const unsigned int size, const unsigned int res=72)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FTFont::FaceSize </td>
<td>(</td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>res</em> = <code>72</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the char size for the current face. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>the face size in points (1/72 inch) </td></tr>
<tr><td class="paramname">res</td><td>the resolution of the target device. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if size was set correctly </dd></dl>
</div>
</div>
<a class="anchor" id="af29f89a8aa0f4e43a3a229ed1d3beacd"></a><!-- doxytag: member="FTFont::GlyphLoadFlags" ref="af29f89a8aa0f4e43a3a229ed1d3beacd" args="(FT_Int flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FTFont::GlyphLoadFlags </td>
<td>(</td>
<td class="paramtype">FT_Int </td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the glyph loading flags. </p>
<p>By default, fonts use the most sensible flags when loading a font's glyph using FT_Load_Glyph(). This function allows to override the default flags.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>The glyph loading flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac85ec080661ab10f124dbd0bb058556d"></a><!-- doxytag: member="FTFont::LineHeight" ref="ac85ec080661ab10f124dbd0bb058556d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float FTFont::LineHeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the line spacing for the font. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Line height </dd></dl>
</div>
</div>
<a class="anchor" id="a07f8bef6c3bd52e7d905e6db17c9b8e6"></a><!-- doxytag: member="FTFont::MakeGlyph" ref="a07f8bef6c3bd52e7d905e6db17c9b8e6" args="(FT_GlyphSlot slot)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFTGlyph.html">FTGlyph</a>* FTFont::MakeGlyph </td>
<td>(</td>
<td class="paramtype">FT_GlyphSlot </td>
<td class="paramname"><em>slot</em></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a glyph of the correct type. </p>
<p>Clients must override the function and return their specialised <a class="el" href="classFTGlyph.html" title="FTGlyph is the base class for FTGL glyphs.">FTGlyph</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>A FreeType glyph slot. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An FT****Glyph or <code>null</code> on failure. </dd></dl>
<p>Implemented in <a class="el" href="classFTBufferFont.html#a8a70fe36e8a627f88cef4dc156fdd2d7">FTBufferFont</a>, <a class="el" href="classFTBitmapFont.html#a4596e73990af0b6e8ab16f94d0915b93">FTBitmapFont</a>, <a class="el" href="classFTExtrudeFont.html#a096fcfe612dc98f49dbc818ac47d2680">FTExtrudeFont</a>, <a class="el" href="classFTOutlineFont.html#a39df452446d15bd1d78ede61ae3f8c27">FTOutlineFont</a>, <a class="el" href="classFTPixmapFont.html#ad0c48c6be9dca736f6f37032a8a25d84">FTPixmapFont</a>, <a class="el" href="classFTPolygonFont.html#a3ce00692583b8cdddfffbe284c42ccf6">FTPolygonFont</a>, and <a class="el" href="classFTTextureFont.html#a3873876ac71776fcb9a3afe6e6e726e6">FTTextureFont</a>.</p>
</div>
</div>
<a class="anchor" id="a4a03161e954de3ae3c6f3f0872628a09"></a><!-- doxytag: member="FTFont::Outset" ref="a4a03161e954de3ae3c6f3f0872628a09" args="(float front, float back)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FTFont::Outset </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>front</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>back</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the front and back outset distances for the font. </p>
<p>Only implemented by <a class="el" href="classFTExtrudeFont.html" title="FTExtrudeFont is a specialisation of the FTFont class for handling extruded Polygon fonts...">FTExtrudeFont</a></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">front</td><td>The front outset distance. </td></tr>
<tr><td class="paramname">back</td><td>The back outset distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aff29fad8b2a53f518311d06e2c25b227"></a><!-- doxytag: member="FTFont::Outset" ref="aff29fad8b2a53f518311d06e2c25b227" args="(float outset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FTFont::Outset </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>outset</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the outset distance for the font. </p>
<p>Only implemented by <a class="el" href="classFTOutlineFont.html" title="FTOutlineFont is a specialisation of the FTFont class for handling Vector Outline fonts...">FTOutlineFont</a>, <a class="el" href="classFTPolygonFont.html" title="FTPolygonFont is a specialisation of the FTFont class for handling tesselated Polygon Mesh fonts...">FTPolygonFont</a> and <a class="el" href="classFTExtrudeFont.html" title="FTExtrudeFont is a specialisation of the FTFont class for handling extruded Polygon fonts...">FTExtrudeFont</a></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">outset</td><td>The outset distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac6de580b27cc4df4986855967639de87"></a><!-- doxytag: member="FTFont::Render" ref="ac6de580b27cc4df4986855967639de87" args="(const char *string, const int len=-1, FTPoint position=FTPoint(), FTPoint spacing=FTPoint(), int renderMode=FTGL::RENDER_ALL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFTPoint.html">FTPoint</a> FTFont::Render </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>len</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>position</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>spacing</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>renderMode</em> = <code>FTGL::RENDER_ALL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Render a string of characters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>'C' style string to be output. </td></tr>
<tr><td class="paramname">len</td><td>The length of the string. If < 0 then all characters will be displayed until a null character is encountered (optional). </td></tr>
<tr><td class="paramname">position</td><td>The pen position of the first character (optional). </td></tr>
<tr><td class="paramname">spacing</td><td>A displacement vector to add after each character has been displayed (optional). </td></tr>
<tr><td class="paramname">renderMode</td><td>Render mode to use for display (optional). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new pen position after the last character was output. </dd></dl>
</div>
</div>
<a class="anchor" id="a0dc25b01d7ef4120910bc63d0a791251"></a><!-- doxytag: member="FTFont::Render" ref="a0dc25b01d7ef4120910bc63d0a791251" args="(const wchar_t *string, const int len=-1, FTPoint position=FTPoint(), FTPoint spacing=FTPoint(), int renderMode=FTGL::RENDER_ALL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFTPoint.html">FTPoint</a> FTFont::Render </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>len</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>position</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td>
<td class="paramname"><em>spacing</em> = <code><a class="el" href="classFTPoint.html">FTPoint</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>renderMode</em> = <code>FTGL::RENDER_ALL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Render a string of characters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>wchar_t string to be output. </td></tr>
<tr><td class="paramname">len</td><td>The length of the string. If < 0 then all characters will be displayed until a null character is encountered (optional). </td></tr>
<tr><td class="paramname">position</td><td>The pen position of the first character (optional). </td></tr>
<tr><td class="paramname">spacing</td><td>A displacement vector to add after each character has been displayed (optional). </td></tr>
<tr><td class="paramname">renderMode</td><td>Render mode to use for display (optional). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new pen position after the last character was output. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d3dfcf608bb1e07a7ceeec23f079600"></a><!-- doxytag: member="FTFont::UseDisplayList" ref="a5d3dfcf608bb1e07a7ceeec23f079600" args="(bool useList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FTFont::UseDisplayList </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useList</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable or disable the use of Display Lists inside <a class="el" href="namespaceFTGL.html">FTGL</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">useList</td><td><code>true</code> turns ON display lists. <code>false</code> turns OFF display lists. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a7ba5a198d501799828a37b4b808b9352"></a><!-- doxytag: member="FTFont::FTBitmapFont" ref="a7ba5a198d501799828a37b4b808b9352" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTBitmapFont.html">FTBitmapFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00078">78</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab7dc21f40be33fee50c41b3ba3d49c73"></a><!-- doxytag: member="FTFont::FTBufferFont" ref="ab7dc21f40be33fee50c41b3ba3d49c73" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTBufferFont.html">FTBufferFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00079">79</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="a06be1600e211ee41aa1b1ed9c7d25639"></a><!-- doxytag: member="FTFont::FTExtrudeFont" ref="a06be1600e211ee41aa1b1ed9c7d25639" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTExtrudeFont.html">FTExtrudeFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00080">80</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7ae54d130cb58f258d2b036a544c7a9b"></a><!-- doxytag: member="FTFont::FTFontImpl" ref="a7ae54d130cb58f258d2b036a544c7a9b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class FTFontImpl<code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00367">367</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17f6eed308c6d1116a7f1d86010f6c9e"></a><!-- doxytag: member="FTFont::FTOutlineFont" ref="a17f6eed308c6d1116a7f1d86010f6c9e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTOutlineFont.html">FTOutlineFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00081">81</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac7f382db9ff9f02888b67b7434d7edd4"></a><!-- doxytag: member="FTFont::FTPixmapFont" ref="ac7f382db9ff9f02888b67b7434d7edd4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTPixmapFont.html">FTPixmapFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00082">82</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="abd1c273c43e47346ad6c178ec173cc41"></a><!-- doxytag: member="FTFont::FTPolygonFont" ref="abd1c273c43e47346ad6c178ec173cc41" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTPolygonFont.html">FTPolygonFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00083">83</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7870c341f7269dfae257e93406c17c92"></a><!-- doxytag: member="FTFont::FTTextureFont" ref="a7870c341f7269dfae257e93406c17c92" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTTextureFont.html">FTTextureFont</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00084">84</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FTFont_8h_source.html">FTFont.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 for FTGL by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
