<!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: FTGlyph 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>FTGlyph Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="FTGlyph" -->
<p><a class="el" href="classFTGlyph.html" title="FTGlyph is the base class for FTGL glyphs.">FTGlyph</a> is the base class for <a class="el" href="namespaceFTGL.html">FTGL</a> glyphs.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FTGlyph:</div>
<div class="dyncontent">
<div class="center">
<img src="classFTGlyph.png" usemap="#FTGlyph_map" alt=""/>
<map id="FTGlyph_map" name="FTGlyph_map">
<area href="classFTBitmapGlyph.html" alt="FTBitmapGlyph" shape="rect" coords="0,56,106,80"/>
<area href="classFTBufferGlyph.html" alt="FTBufferGlyph" shape="rect" coords="116,56,222,80"/>
<area href="classFTExtrudeGlyph.html" alt="FTExtrudeGlyph" shape="rect" coords="232,56,338,80"/>
<area href="classFTOutlineGlyph.html" alt="FTOutlineGlyph" shape="rect" coords="348,56,454,80"/>
<area href="classFTPixmapGlyph.html" alt="FTPixmapGlyph" shape="rect" coords="464,56,570,80"/>
<area href="classFTPolygonGlyph.html" alt="FTPolygonGlyph" shape="rect" coords="580,56,686,80"/>
<area href="classFTTextureGlyph.html" alt="FTTextureGlyph" shape="rect" coords="696,56,802,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="classFTGlyph.html#ad93a5124ddd9fe408e07f5054ab92452">~FTGlyph</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad93a5124ddd9fe408e07f5054ab92452"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classFTPoint.html">FTPoint</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#abcf3aef56d4bf022f6d95d5e287800df">Render</a> (const <a class="el" href="classFTPoint.html">FTPoint</a> &pen, int renderMode)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Renders this glyph at the current pen position. <a href="#abcf3aef56d4bf022f6d95d5e287800df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#a42fdc90fefe9d5550aca4339f88fbc5f">Advance</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the advance width for this glyph. <a href="#a42fdc90fefe9d5550aca4339f88fbc5f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classFTBBox.html">FTBBox</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#aa165c4c7de25de0a989753f56a3bc252">BBox</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the bounding box for this glyph. <a href="#aa165c4c7de25de0a989753f56a3bc252"></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="classFTGlyph.html#a14fd6a0dc8b6e0e04a769e2e239b104b">Error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Queries for errors. <a href="#a14fd6a0dc8b6e0e04a769e2e239b104b"></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="classFTGlyph.html#a4673d2a5da6ab44bcc0f2eb3326c30e8">FTGlyph</a> (FT_GlyphSlot glyph)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a glyph. <a href="#a4673d2a5da6ab44bcc0f2eb3326c30e8"></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="classFTGlyph.html#aa3f0c28a7cfbfa0e896973476f7ed49d">FTBitmapGlyph</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#a385e2288042fd77f037a715e7801b451">FTBufferGlyph</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#a43bdcab05c1db93d9474fee8176c1fb0">FTExtrudeGlyph</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#accb6ff0274a52a67e706edda49d6a201">FTOutlineGlyph</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#ab141fccf761e39b9e4bec64cda0507a7">FTPixmapGlyph</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#a0e33f7bc34e1097f8f9adcb6252d1bc0">FTPolygonGlyph</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTGlyph.html#a01c2ee1e01ccd33e4f1f26f2478a74a0">FTTextureGlyph</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classFTGlyph.html" title="FTGlyph is the base class for FTGL glyphs.">FTGlyph</a> is the base class for <a class="el" href="namespaceFTGL.html">FTGL</a> glyphs. </p>
<p>It provides the interface between Freetype glyphs and their openGL renderable counterparts. This is an abstract class and derived classes must implement the <code>Render</code> function.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classFTBBox.html" title="FTBBox is a convenience class for handling bounding boxes.">FTBBox</a> </dd>
<dd>
<a class="el" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> </dd></dl>
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00050">50</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4673d2a5da6ab44bcc0f2eb3326c30e8"></a><!-- doxytag: member="FTGlyph::FTGlyph" ref="a4673d2a5da6ab44bcc0f2eb3326c30e8" args="(FT_GlyphSlot glyph)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FTGlyph::FTGlyph </td>
<td>(</td>
<td class="paramtype">FT_GlyphSlot </td>
<td class="paramname"><em>glyph</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a glyph. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">glyph</td><td>The Freetype glyph to be processed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad93a5124ddd9fe408e07f5054ab92452"></a><!-- doxytag: member="FTGlyph::~FTGlyph" ref="ad93a5124ddd9fe408e07f5054ab92452" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FTGlyph::~FTGlyph </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a42fdc90fefe9d5550aca4339f88fbc5f"></a><!-- doxytag: member="FTGlyph::Advance" ref="a42fdc90fefe9d5550aca4339f88fbc5f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float FTGlyph::Advance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the advance width for this glyph. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>advance width. </dd></dl>
</div>
</div>
<a class="anchor" id="aa165c4c7de25de0a989753f56a3bc252"></a><!-- doxytag: member="FTGlyph::BBox" ref="aa165c4c7de25de0a989753f56a3bc252" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classFTBBox.html">FTBBox</a>& FTGlyph::BBox </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the bounding box for this glyph. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>bounding box. </dd></dl>
</div>
</div>
<a class="anchor" id="a14fd6a0dc8b6e0e04a769e2e239b104b"></a><!-- doxytag: member="FTGlyph::Error" ref="a14fd6a0dc8b6e0e04a769e2e239b104b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FT_Error FTGlyph::Error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Queries for errors. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current error code. </dd></dl>
</div>
</div>
<a class="anchor" id="abcf3aef56d4bf022f6d95d5e287800df"></a><!-- doxytag: member="FTGlyph::Render" ref="abcf3aef56d4bf022f6d95d5e287800df" args="(const FTPoint &pen, int renderMode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classFTPoint.html">FTPoint</a>& FTGlyph::Render </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFTPoint.html">FTPoint</a> & </td>
<td class="paramname"><em>pen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>renderMode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Renders this glyph at the current pen position. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pen</td><td>The current pen position. </td></tr>
<tr><td class="paramname">renderMode</td><td>Render mode to display </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The advance distance for this glyph. </dd></dl>
<p>Implemented in <a class="el" href="classFTBitmapGlyph.html#a7286040897f117da9f52023da795de42">FTBitmapGlyph</a>, <a class="el" href="classFTBufferGlyph.html#a33bc5176b9c5739f20d634eca04a45a5">FTBufferGlyph</a>, <a class="el" href="classFTExtrudeGlyph.html#a48cc5da5e2e6491d79bcee8a9107bc60">FTExtrudeGlyph</a>, <a class="el" href="classFTOutlineGlyph.html#ac0fcbe2023f8e8127144ad6a04627519">FTOutlineGlyph</a>, <a class="el" href="classFTPixmapGlyph.html#ac18ec8c2864d45d805e4fac5a980cddd">FTPixmapGlyph</a>, <a class="el" href="classFTPolygonGlyph.html#ae790f0d5d4d85bafb7c63edf537255b7">FTPolygonGlyph</a>, and <a class="el" href="classFTTextureGlyph.html#a23d91684651a5cc913e6232c60dc58f4">FTTextureGlyph</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aa3f0c28a7cfbfa0e896973476f7ed49d"></a><!-- doxytag: member="FTGlyph::FTBitmapGlyph" ref="aa3f0c28a7cfbfa0e896973476f7ed49d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTBitmapGlyph.html">FTBitmapGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00070">70</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<a class="anchor" id="a385e2288042fd77f037a715e7801b451"></a><!-- doxytag: member="FTGlyph::FTBufferGlyph" ref="a385e2288042fd77f037a715e7801b451" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTBufferGlyph.html">FTBufferGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00071">71</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<a class="anchor" id="a43bdcab05c1db93d9474fee8176c1fb0"></a><!-- doxytag: member="FTGlyph::FTExtrudeGlyph" ref="a43bdcab05c1db93d9474fee8176c1fb0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTExtrudeGlyph.html">FTExtrudeGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00072">72</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<a class="anchor" id="accb6ff0274a52a67e706edda49d6a201"></a><!-- doxytag: member="FTGlyph::FTOutlineGlyph" ref="accb6ff0274a52a67e706edda49d6a201" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTOutlineGlyph.html">FTOutlineGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00073">73</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab141fccf761e39b9e4bec64cda0507a7"></a><!-- doxytag: member="FTGlyph::FTPixmapGlyph" ref="ab141fccf761e39b9e4bec64cda0507a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTPixmapGlyph.html">FTPixmapGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00074">74</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0e33f7bc34e1097f8f9adcb6252d1bc0"></a><!-- doxytag: member="FTGlyph::FTPolygonGlyph" ref="a0e33f7bc34e1097f8f9adcb6252d1bc0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTPolygonGlyph.html">FTPolygonGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00075">75</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<a class="anchor" id="a01c2ee1e01ccd33e4f1f26f2478a74a0"></a><!-- doxytag: member="FTGlyph::FTTextureGlyph" ref="a01c2ee1e01ccd33e4f1f26f2478a74a0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classFTTextureGlyph.html">FTTextureGlyph</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTGlyph_8h_source.html#l00076">76</a> of file <a class="el" href="FTGlyph_8h_source.html">FTGlyph.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FTGlyph_8h_source.html">FTGlyph.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>
