Google Git
Sign in
gfiber / vendor / opensource / projectM / b82e9b0d19af7e840f567433c3273422c3aa3c4f / . / src / macos / FTGL / docs / html / classFTLibrary.html
blob: 1e9381a302e7fd0f1a770ae8ccfe814556133ba0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>FTGL: FTLibrary class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
<h1>FTLibrary Class Reference</h1><code>#include &lt;<a class="el" href="FTLibrary_8h-source.html">FTLibrary.h</a>&gt;</code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
FTLibrary class is the global accessor for the Freetype library.
<p>
This class encapsulates the Freetype Library. This is a singleton class and ensures that only one FT_Library is in existence at any one time. All constructors are private therefore clients cannot create or instantiate this class themselves and must access it's methods via the static <code><a class="el" href="classFTLibrary.html#e0">FTLibrary::Instance()</a></code> function.<p>
Just because this class returns a valid <code>FTLibrary</code> object doesn't mean that the Freetype Library has been successfully initialised. Clients should check for errors. You can initialse the library AND check for errors using the following code... <code>err = <a class="el" href="classFTLibrary.html#e0">FTLibrary::Instance()</a>.<a class="el" href="classFTLibrary.html#a1">Error()</a>;</code><p>
<dl compact><dt><b>See also:</b></dt><dd>"Freetype 2 Documentation" </dd></dl>
<p>
<p>
Definition at line <a class="el" href="FTLibrary_8h-source.html#l00029">29</a> of file <a class="el" href="FTLibrary_8h-source.html">FTLibrary.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FT_Library *const &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTLibrary.html#a0">GetLibrary</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets a pointer to the native Freetype library. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>FT_Error&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTLibrary.html#a1">Error</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Queries the library for errors. <a href="#a1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTLibrary.html#a2">~FTLibrary</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#a2"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classFTLibrary.html">FTLibrary</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTLibrary.html#e0">Instance</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Global acces point to the single FTLibrary object. <a href="#e0"></a><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a2" doxytag="FTLibrary::~FTLibrary" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FTLibrary::~<a class="el" href="classFTLibrary.html">FTLibrary</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor.
<p>
Disposes of the Freetype library
<p>
Definition at line <a class="el" href="FTLibrary_8cpp-source.html#l00011">11</a> of file <a class="el" href="FTLibrary_8cpp-source.html">FTLibrary.cpp</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="FTLibrary::Error" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FT_Error FTLibrary::Error </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Queries the library for errors.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current error code. </dd></dl>
<p>
Definition at line <a class="el" href="FTLibrary_8h-source.html#l00051">51</a> of file <a class="el" href="FTLibrary_8h-source.html">FTLibrary.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="FTLibrary::GetLibrary" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const FT_Library* const FTLibrary::GetLibrary </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Gets a pointer to the native Freetype library.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A handle to a FreeType library instance. </dd></dl>
<p>
Definition at line <a class="el" href="FTLibrary_8h-source.html#l00044">44</a> of file <a class="el" href="FTLibrary_8h-source.html">FTLibrary.h</a>. </td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="FTLibrary::Instance" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classFTLibrary.html">FTLibrary</a> &amp; FTLibrary::Instance </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Global acces point to the single FTLibrary object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The global <code>FTLibrary</code> object. </dd></dl>
<p>
Definition at line <a class="el" href="FTLibrary_8cpp-source.html#l00004">4</a> of file <a class="el" href="FTLibrary_8cpp-source.html">FTLibrary.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="FTLibrary_8h-source.html">FTLibrary.h</a><li><a class="el" href="FTLibrary_8cpp-source.html">FTLibrary.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Dec 5 22:24:07 2004 for FTGL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.6 </small></address>
</body>
</html>