<!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: FTLayout.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>FTLayout.h File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <FTGL/ftgl.h></code><br/>
</div>
<p><a href="FTLayout_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="classFTLayout.html">FTLayout</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classFTLayout.html" title="FTLayout is the interface for layout managers that render text.">FTLayout</a> is the interface for layout managers that render text. <a href="classFTLayout.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 _FTGLlayout </td><td class="memItemRight" valign="bottom"><a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTLayout_8h.html#a8a825731fa3f4740fac3549984cf8b6d">ftglDestroyLayout</a> (<a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> *layout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an <a class="el" href="namespaceFTGL.html">FTGL</a> layout object. <a href="#a8a825731fa3f4740fac3549984cf8b6d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTLayout_8h.html#a39fe0c68f82e72915d980d201cf5fede">ftglGetLayoutBBox</a> (<a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> *layout, const char *string, float bounds[6])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for a string. <a href="#a39fe0c68f82e72915d980d201cf5fede"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="FTLayout_8h.html#a6e5301b487c422a361fdd469136d9536">ftglRenderLayout</a> (<a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> *layout, const char *string, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render a string of characters. <a href="#a6e5301b487c422a361fdd469136d9536"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FT_Error </td><td class="memItemRight" valign="bottom"><a class="el" href="FTLayout_8h.html#a5f9f222eb0bf9997076e3ac7da8e7f71">ftglGetLayoutError</a> (<a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> *layout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query a layout for errors. <a href="#a5f9f222eb0bf9997076e3ac7da8e7f71"></a><br/></td></tr>
</table>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a0aeec097978c2d2c070cf463b6d2a00f"></a><!-- doxytag: member="FTLayout.h::FTGLlayout" ref="a0aeec097978c2d2c070cf463b6d2a00f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _FTGLlayout <a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FTLayout_8h_source.html#l00151">151</a> of file <a class="el" href="FTLayout_8h_source.html">FTLayout.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a8a825731fa3f4740fac3549984cf8b6d"></a><!-- doxytag: member="FTLayout.h::ftglDestroyLayout" ref="a8a825731fa3f4740fac3549984cf8b6d" args="(FTGLlayout *layout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglDestroyLayout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> * </td>
<td class="paramname"><em>layout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy an <a class="el" href="namespaceFTGL.html">FTGL</a> layout object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">layout</td><td>An FTGLlayout* object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a39fe0c68f82e72915d980d201cf5fede"></a><!-- doxytag: member="FTLayout.h::ftglGetLayoutBBox" ref="a39fe0c68f82e72915d980d201cf5fede" args="(FTGLlayout *layout, const char *string, float bounds[6])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglGetLayoutBBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> * </td>
<td class="paramname"><em>layout</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">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">layout</td><td>An FTGLlayout* object. </td></tr>
<tr><td class="paramname">string</td><td>A char buffer </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="a5f9f222eb0bf9997076e3ac7da8e7f71"></a><!-- doxytag: member="FTLayout.h::ftglGetLayoutError" ref="a5f9f222eb0bf9997076e3ac7da8e7f71" args="(FTGLlayout *layout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FT_Error ftglGetLayoutError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> * </td>
<td class="paramname"><em>layout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query a layout for errors. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">layout</td><td>An FTGLlayout* 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="a6e5301b487c422a361fdd469136d9536"></a><!-- doxytag: member="FTLayout.h::ftglRenderLayout" ref="a6e5301b487c422a361fdd469136d9536" args="(FTGLlayout *layout, const char *string, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ftglRenderLayout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> * </td>
<td class="paramname"><em>layout</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">layout</td><td>An FTGLlayout* 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>
</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>
