Google Git
Sign in
gfiber / vendor / opensource / projectM / b82e9b0d19af7e840f567433c3273422c3aa3c4f / . / src / macos / FTGL / docs / html / classFTGLBitmapFont.html
blob: 3f9d2b8ba5c5770c26c5e0da1bbc10c350264443 [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: FTGLBitmapFont 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>FTGLBitmapFont Class Reference</h1><code>#include &lt;<a class="el" href="FTGLBitmapFont_8h-source.html">FTGLBitmapFont.h</a>&gt;</code>
<p>
<p>Inheritance diagram for FTGLBitmapFont:
<p><center><img src="classFTGLBitmapFont.png" usemap="#FTGLBitmapFont_map" border="0" alt=""></center>
<map name="FTGLBitmapFont_map">
<area href="classFTFont.html" alt="FTFont" shape="rect" coords="0,0,105,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
FTGLBitmapFont is a specialisation of the <a class="el" href="classFTFont.html">FTFont</a> class for handling Bitmap fonts.
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classFTFont.html">FTFont</a> </dd></dl>
<p>
<p>
Definition at line <a class="el" href="FTGLBitmapFont_8h-source.html#l00016">16</a> of file <a class="el" href="FTGLBitmapFont_8h-source.html">FTGLBitmapFont.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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTGLBitmapFont.html#a0">FTGLBitmapFont</a> (const char *fontFilePath)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open and read a font file. <a href="#a0"></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="classFTGLBitmapFont.html#a1">FTGLBitmapFont</a> (const unsigned char *pBufferBytes, size_t bufferSizeInBytes)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open and read a font from a buffer in memory. <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="classFTGLBitmapFont.html#a2">~FTGLBitmapFont</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTGLBitmapFont.html#a3">Render</a> (const char *string)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Renders a string of characters. <a href="#a3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTGLBitmapFont.html#a4">Render</a> (const wchar_t *string)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Renders a string of characters. <a href="#a4"></a><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="FTGLBitmapFont::FTGLBitmapFont" ></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"> FTGLBitmapFont::FTGLBitmapFont </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>fontFilePath</em> </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>
Open and read a font file.
<p>
Sets Error flag.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>fontFilePath</em>&nbsp;</td><td>font file path. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="FTGLBitmapFont_8cpp-source.html#l00005">5</a> of file <a class="el" href="FTGLBitmapFont_8cpp-source.html">FTGLBitmapFont.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="FTGLBitmapFont::FTGLBitmapFont" ></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"> FTGLBitmapFont::FTGLBitmapFont </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const unsigned char *&nbsp;</td>
<td class="mdname" nowrap> <em>pBufferBytes</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>size_t&nbsp;</td>
<td class="mdname" nowrap> <em>bufferSizeInBytes</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Open and read a font from a buffer in memory.
<p>
Sets Error flag.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pBufferBytes</em>&nbsp;</td><td>the in-memory buffer </td></tr>
<tr><td valign=top><em>bufferSizeInBytes</em>&nbsp;</td><td>the length of the buffer in bytes </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="FTGLBitmapFont_8cpp-source.html#l00010">10</a> of file <a class="el" href="FTGLBitmapFont_8cpp-source.html">FTGLBitmapFont.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="FTGLBitmapFont::~FTGLBitmapFont" ></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"> FTGLBitmapFont::~<a class="el" href="classFTGLBitmapFont.html">FTGLBitmapFont</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>
<p>
Definition at line <a class="el" href="FTGLBitmapFont_8cpp-source.html#l00015">15</a> of file <a class="el" href="FTGLBitmapFont_8cpp-source.html">FTGLBitmapFont.cpp</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4" doxytag="FTGLBitmapFont::Render" ></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"> void FTGLBitmapFont::Render </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const wchar_t *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>string</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Renders a string of characters.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>string</em>&nbsp;</td><td>'C' style wide string to be output. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classFTFont.html#a20">FTFont</a>.
<p>
Definition at line <a class="el" href="FTGLBitmapFont_8cpp-source.html#l00051">51</a> of file <a class="el" href="FTGLBitmapFont_8cpp-source.html">FTGLBitmapFont.cpp</a>.
<p>
References <a class="el" href="FTFont_8cpp-source.html#l00245">FTFont::Render()</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="FTGLBitmapFont::Render" ></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"> void FTGLBitmapFont::Render </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>string</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Renders a string of characters.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>string</em>&nbsp;</td><td>'C' style string to be output. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classFTFont.html#a19">FTFont</a>.
<p>
Definition at line <a class="el" href="FTGLBitmapFont_8cpp-source.html#l00034">34</a> of file <a class="el" href="FTGLBitmapFont_8cpp-source.html">FTGLBitmapFont.cpp</a>.
<p>
References <a class="el" href="FTFont_8cpp-source.html#l00245">FTFont::Render()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="FTGLBitmapFont_8h-source.html">FTGLBitmapFont.h</a><li><a class="el" href="FTGLBitmapFont_8cpp-source.html">FTGLBitmapFont.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>