<!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.h File 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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>FTFont.h File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <FTGL/ftgl.h></code><br/>
</div>
<p><a href="FTFont_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTFont.html">FTFont</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><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="classFTFont.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct _FTGLfont </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a3f54c50d3bfa9b5c0b103b0f9a2debb2">ftglCreateCustomFont</a> (char const *fontFilePath, void *data, <a class="el" href="FTGlyph_8h.html#a155b37e19e0844502e473bb32c31a558">FTGLglyph</a> *(*makeglyphCallback)(FT_GlyphSlot, void *))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a custom <a class="el" href="namespaceFTGL.html">FTGL</a> font object. <a href="#a3f54c50d3bfa9b5c0b103b0f9a2debb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#af0dc4b1c8987895d19e863416ae8d174">ftglDestroyFont</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an <a class="el" href="namespaceFTGL.html">FTGL</a> font object. <a href="#af0dc4b1c8987895d19e863416ae8d174"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a4452c327ff636fc2f0ecb1859687bfe0">ftglAttachFile</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, const char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach auxilliary file to font e.g. <a href="#a4452c327ff636fc2f0ecb1859687bfe0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#ad9fba15428fb163a34f9ee824e748162">ftglAttachData</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, const unsigned char *data, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach auxilliary data to font, e.g. <a href="#ad9fba15428fb163a34f9ee824e748162"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a905390158041bc80509997c414133ddc">ftglSetFontCharMap</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, FT_Encoding encoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the character map for the face. <a href="#a905390158041bc80509997c414133ddc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a1ebde0e8531774259e234ccd9d067624">ftglGetFontCharMapCount</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of character maps in this face. <a href="#a1ebde0e8531774259e234ccd9d067624"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FT_Encoding * </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a7c7657c95cdbf9f4f84b4754cddc7aca">ftglGetFontCharMapList</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of character maps in this face. <a href="#a7c7657c95cdbf9f4f84b4754cddc7aca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a00c8f893cbeb98b663f9755647a34e8c">ftglSetFontFaceSize</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, unsigned int size, unsigned int res)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the char size for the current face. <a href="#a00c8f893cbeb98b663f9755647a34e8c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a8440b2e4f21d60eb9e3efc6ca9666bee">ftglGetFontFaceSize</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current face size in points (1/72 inch). <a href="#a8440b2e4f21d60eb9e3efc6ca9666bee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a92c51879d3c2ed1bf42350c620421eb2">ftglSetFontDepth</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, float depth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the extrusion distance for the font. <a href="#a92c51879d3c2ed1bf42350c620421eb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#aa070c4b773378fe159bd0356183f710e">ftglSetFontOutset</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, float front, float back)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the outset distance for the font. <a href="#aa070c4b773378fe159bd0356183f710e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a08f284adddb91d67d6a31077cc0f7ef1">ftglSetFontDisplayList</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, int 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="#a08f284adddb91d67d6a31077cc0f7ef1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a6f931a3b2bfad1511e80324717a7f00e">ftglGetFontAscender</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global ascender height for the face. <a href="#a6f931a3b2bfad1511e80324717a7f00e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a210968a0e92685b9b8522c869708425a">ftglGetFontDescender</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the global descender height for the face. <a href="#a210968a0e92685b9b8522c869708425a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#aab9088d0d1261b75d31cbee909783aed">ftglGetFontLineHeight</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the line spacing for the font. <a href="#aab9088d0d1261b75d31cbee909783aed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#ae2f41b36c47bb3cbcb6f3e7f3d12ed74">ftglGetFontBBox</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, const char *string, int len, float bounds[6])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for a string. <a href="#ae2f41b36c47bb3cbcb6f3e7f3d12ed74"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a0886ea1dd82291182b2c9acd43f24571">ftglGetFontAdvance</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, const char *string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the advance width for a string. <a href="#a0886ea1dd82291182b2c9acd43f24571"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a048872ff0cf567ef94884ee7ea4d16d9">ftglRenderFont</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font, const char *string, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render a string of characters. <a href="#a048872ff0cf567ef94884ee7ea4d16d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FT_Error </td><td class="memItemRight" valign="bottom"><a class="el" href="FTFont_8h.html#a7c334b38242e448749165dfdac5054fc">ftglGetFontError</a> (<a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query a font for errors. <a href="#a7c334b38242e448749165dfdac5054fc"></a><br/></td></tr>
</table>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="af121f8e0374785b92e3155992d703b17"></a><!-- doxytag: member="FTFont.h::FTGLfont" ref="af121f8e0374785b92e3155992d703b17" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _FTGLfont <a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTFont_8h_source.html#l00399">399</a> of file <a class="el" href="FTFont_8h_source.html">FTFont.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad9fba15428fb163a34f9ee824e748162"></a><!-- doxytag: member="FTFont.h::ftglAttachData" ref="ad9fba15428fb163a34f9ee824e748162" args="(FTGLfont *font, const unsigned char *data, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ftglAttachData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach auxilliary data to font, e.g. </p>
<p>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">font</td><td>An FTGLfont* object. </td></tr>
<tr><td class="paramname">data</td><td>The in-memory buffer. </td></tr>
<tr><td class="paramname">size</td><td>The length of the buffer in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if file has been attached successfully. </dd></dl>
</div>
</div>
<a class="anchor" id="a4452c327ff636fc2f0ecb1859687bfe0"></a><!-- doxytag: member="FTFont.h::ftglAttachFile" ref="a4452c327ff636fc2f0ecb1859687bfe0" args="(FTGLfont *font, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ftglAttachFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach auxilliary file to font e.g. </p>
<p>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">font</td><td>An FTGLfont* object. </td></tr>
<tr><td class="paramname">path</td><td>Auxilliary font file path. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if file has been attached successfully. </dd></dl>
</div>
</div>
<a class="anchor" id="a3f54c50d3bfa9b5c0b103b0f9a2debb2"></a><!-- doxytag: member="FTFont.h::ftglCreateCustomFont" ref="a3f54c50d3bfa9b5c0b103b0f9a2debb2" args="(char const *fontFilePath, void *data, FTGLglyph *(*makeglyphCallback)(FT_GlyphSlot, void *))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a>* ftglCreateCustomFont </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>fontFilePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="FTGlyph_8h.html#a155b37e19e0844502e473bb32c31a558">FTGLglyph</a> *(*)(FT_GlyphSlot, void *) </td>
<td class="paramname"><em>makeglyphCallback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a custom <a class="el" href="namespaceFTGL.html">FTGL</a> font object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fontFilePath</td><td>The font file name. </td></tr>
<tr><td class="paramname">data</td><td>A pointer to private data that will be passed to callbacks. </td></tr>
<tr><td class="paramname">makeglyphCallback</td><td>A glyph-making callback function. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An FTGLfont* object. </dd></dl>
</div>
</div>
<a class="anchor" id="af0dc4b1c8987895d19e863416ae8d174"></a><!-- doxytag: member="FTFont.h::ftglDestroyFont" ref="af0dc4b1c8987895d19e863416ae8d174" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglDestroyFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy an <a class="el" href="namespaceFTGL.html">FTGL</a> font object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0886ea1dd82291182b2c9acd43f24571"></a><!-- doxytag: member="FTFont.h::ftglGetFontAdvance" ref="a0886ea1dd82291182b2c9acd43f24571" args="(FTGLfont *font, const char *string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float ftglGetFontAdvance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the advance width for a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
<tr><td class="paramname">string</td><td>A char string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Advance width </dd></dl>
</div>
</div>
<a class="anchor" id="a6f931a3b2bfad1511e80324717a7f00e"></a><!-- doxytag: member="FTFont.h::ftglGetFontAscender" ref="a6f931a3b2bfad1511e80324717a7f00e" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float ftglGetFontAscender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the global ascender height for the face. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Ascender height </dd></dl>
</div>
</div>
<a class="anchor" id="ae2f41b36c47bb3cbcb6f3e7f3d12ed74"></a><!-- doxytag: member="FTFont.h::ftglGetFontBBox" ref="ae2f41b36c47bb3cbcb6f3e7f3d12ed74" args="(FTGLfont *font, const char *string, int len, float bounds[6])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglGetFontBBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">int </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>bounds</em>[6] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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">font</td><td>An FTGLfont* object. </td></tr>
<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">bounds</td><td>An array of 6 float values where the bounding box's lower left near and upper right far 3D coordinates will be stored. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1ebde0e8531774259e234ccd9d067624"></a><!-- doxytag: member="FTFont.h::ftglGetFontCharMapCount" ref="a1ebde0e8531774259e234ccd9d067624" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ftglGetFontCharMapCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of character maps in this face. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>character map count. </dd></dl>
</div>
</div>
<a class="anchor" id="a7c7657c95cdbf9f4f84b4754cddc7aca"></a><!-- doxytag: member="FTFont.h::ftglGetFontCharMapList" ref="a7c7657c95cdbf9f4f84b4754cddc7aca" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FT_Encoding* ftglGetFontCharMapList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a list of character maps in this face. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the first encoding. </dd></dl>
</div>
</div>
<a class="anchor" id="a210968a0e92685b9b8522c869708425a"></a><!-- doxytag: member="FTFont.h::ftglGetFontDescender" ref="a210968a0e92685b9b8522c869708425a" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float ftglGetFontDescender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the global descender height for the face. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Descender height </dd></dl>
</div>
</div>
<a class="anchor" id="a7c334b38242e448749165dfdac5054fc"></a><!-- doxytag: member="FTFont.h::ftglGetFontError" ref="a7c334b38242e448749165dfdac5054fc" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FT_Error ftglGetFontError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query a font for errors. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current error code. </dd></dl>
</div>
</div>
<a class="anchor" id="a8440b2e4f21d60eb9e3efc6ca9666bee"></a><!-- doxytag: member="FTFont.h::ftglGetFontFaceSize" ref="a8440b2e4f21d60eb9e3efc6ca9666bee" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ftglGetFontFaceSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current face size in points (1/72 inch). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>face size </dd></dl>
</div>
</div>
<a class="anchor" id="aab9088d0d1261b75d31cbee909783aed"></a><!-- doxytag: member="FTFont.h::ftglGetFontLineHeight" ref="aab9088d0d1261b75d31cbee909783aed" args="(FTGLfont *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float ftglGetFontLineHeight </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the line spacing for the font. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Line height </dd></dl>
</div>
</div>
<a class="anchor" id="a048872ff0cf567ef94884ee7ea4d16d9"></a><!-- doxytag: member="FTFont.h::ftglRenderFont" ref="a048872ff0cf567ef94884ee7ea4d16d9" args="(FTGLfont *font, const char *string, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglRenderFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">int </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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">font</td><td>An FTGLfont* object. </td></tr>
<tr><td class="paramname">string</td><td>Char string to be output. </td></tr>
<tr><td class="paramname">mode</td><td>Render mode to display. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a905390158041bc80509997c414133ddc"></a><!-- doxytag: member="FTFont.h::ftglSetFontCharMap" ref="a905390158041bc80509997c414133ddc" args="(FTGLfont *font, FT_Encoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ftglSetFontCharMap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FT_Encoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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">font</td><td>An FTGLfont* object. </td></tr>
<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>1 if charmap was valid and set correctly. </dd></dl>
</div>
</div>
<a class="anchor" id="a92c51879d3c2ed1bf42350c620421eb2"></a><!-- doxytag: member="FTFont.h::ftglSetFontDepth" ref="a92c51879d3c2ed1bf42350c620421eb2" args="(FTGLfont *font, float depth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglSetFontDepth </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>depth</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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">font</td><td>An FTGLfont* object. </td></tr>
<tr><td class="paramname">depth</td><td>The extrusion distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a08f284adddb91d67d6a31077cc0f7ef1"></a><!-- doxytag: member="FTFont.h::ftglSetFontDisplayList" ref="a08f284adddb91d67d6a31077cc0f7ef1" args="(FTGLfont *font, int useList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglSetFontDisplayList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>useList</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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">font</td><td>An FTGLfont* object. </td></tr>
<tr><td class="paramname">useList</td><td>1 turns ON display lists. 0 turns OFF display lists. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a00c8f893cbeb98b663f9755647a34e8c"></a><!-- doxytag: member="FTFont.h::ftglSetFontFaceSize" ref="a00c8f893cbeb98b663f9755647a34e8c" args="(FTGLfont *font, unsigned int size, unsigned int res)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ftglSetFontFaceSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>res</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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">font</td><td>An FTGLfont* object. </td></tr>
<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, or 0 to use the default value of 72. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if size was set correctly. </dd></dl>
</div>
</div>
<a class="anchor" id="aa070c4b773378fe159bd0356183f710e"></a><!-- doxytag: member="FTFont.h::ftglSetFontOutset" ref="aa070c4b773378fe159bd0356183f710e" args="(FTGLfont *font, float front, float back)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglSetFontOutset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTFont_8h.html#af121f8e0374785b92e3155992d703b17">FTGLfont</a> * </td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the outset distance for the font. </p>
<p>Only <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> implement front outset. Only <a class="el" href="classFTExtrudeFont.html" title="FTExtrudeFont is a specialisation of the FTFont class for handling extruded Polygon fonts...">FTExtrudeFont</a> implements back outset.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>An FTGLfont* object. </td></tr>
<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>
</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>
