718 lines
32 KiB
HTML
718 lines
32 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>JGE++: JTTFont Class Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.5.3 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>JTTFont Class Reference</h1><!-- doxytag: class="JTTFont" --><code>#include <JTTFont.h></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for JTTFont:</div>
|
|
<div class="dynsection">
|
|
</div>
|
|
|
|
<p>
|
|
<a href="class_j_t_t_font-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#7a328115c9f86b2d93370a31b903042c">FONT_LOADING_MODE</a> { <a class="el" href="class_j_t_t_font.html#7a328115c9f86b2d93370a31b903042c4faa365f93bea3ee30b7da76559b5003">MODE_NORMAL</a>,
|
|
<a class="el" href="class_j_t_t_font.html#7a328115c9f86b2d93370a31b903042cd192129155378911d9c07dc61cc21efe">MODE_PRECACHE_ASCII</a>,
|
|
<a class="el" href="class_j_t_t_font.html#7a328115c9f86b2d93370a31b903042c344916a0d03f0aafe1be46882e626a98">MODE_PRECACHE_ASCII_EX</a>
|
|
}</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#2ce5bb908b3aaeb2b6c32fce294f292b">CACHE_IMAGE_SIZE</a> { <a class="el" href="class_j_t_t_font.html#2ce5bb908b3aaeb2b6c32fce294f292b2e5de6bc8d0ca27a23212da91a07f421">CACHE_IMAGE_64x64</a>,
|
|
<a class="el" href="class_j_t_t_font.html#2ce5bb908b3aaeb2b6c32fce294f292b1a35da04980b668438ed4c2ab6cbfd4b">CACHE_IMAGE_128x128</a>,
|
|
<a class="el" href="class_j_t_t_font.html#2ce5bb908b3aaeb2b6c32fce294f292bda08b4d85b0bade648822756e8ff13e2">CACHE_IMAGE_256x256</a>,
|
|
<a class="el" href="class_j_t_t_font.html#2ce5bb908b3aaeb2b6c32fce294f292b9414757d17b6f3cb6e34cd26a49655a2">CACHE_IMAGE_512x512</a>
|
|
}</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#48fa409e5e7c8316dda0b4de6bf6c769">JTTFont</a> (int cacheImageSize=CACHE_IMAGE_256x256)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#cc098bd764ec2e58a91d44185fdfc9c9">SetColor</a> (PIXEL_TYPE color)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#e211b246c278df403b3d3de23daba576">SetAngle</a> (float angle)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#4cf982139b7953d651e2ba71988466f4">SetSize</a> (int size)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#851be526856f2f5f492b78ab55f4d788">Load</a> (const char *filename, int size=12, int mode=MODE_NORMAL)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#14c4f08cdfc7853cd694c3e30b849040">Load</a> (<a class="el" href="class_j_t_t_font.html">JTTFont</a> *fontSource, int size=12, int mode=MODE_NORMAL)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#612eefb3219e7b6a20f57d2ad859d1e7">Unload</a> (void)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#24440eda93882d2909b863a76d14ba06">RenderString</a> (const u16 *text, float x, float y, int alignment=JGETEXT_LEFT)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#8c346d7ebf1662e0fec706dfaee4a02f">RenderString</a> (const char *text, float x, float y, int alignment=JGETEXT_LEFT)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#503c53b441688982e4271ca2ff9bcd31">RenderString</a> (const u8 *text, float x, float y, int alignment=JGETEXT_LEFT)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#615820fde8b4b29431c7f707fbcc6231">PreCacheString</a> (const u16 *text)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#0b447223afdf08dccb898606dbb31009">PreCacheString</a> (const char *text)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#019569ab1dc49efb289f5551f233dd80">PreCacheString</a> (const u8 *text)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#3f6bdd4c7fbb2dc4e787d3d639132a97">GetWidth</a> (const u16 *text)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#69682546bbbcfd3ab497029798c34e82">GetWidth</a> (const char *text)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#5bdebc7509836ad106b3f91ab5708709">GetWidth</a> (const u8 *text)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#959f6698937c30bcd066e4c7d8d3bc88">PreCacheASCII</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_t_t_font.html#babc7ff0ddbc600b6da3cf4b92369bc6">PreCacheExtendedASCII</a> ()</td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
True Type font support with the help of Freetype library. <a class="el" href="class_j_t_t_font.html">JTTFont</a> has a simple caching system so that a character which has been rendered before can be retrieved from the cache instead of drawing it again by the Freetype library. This can give you a much faster rendering speed. Also, if you only need to use a limited number of characters in your game, you can actually cache all your characters in the cache beforehand and unload the font to save memory.<p>
|
|
<dl class="user" compact><dt><b>For example, if you only want to use the standard ASCII characters in</b></dt><dd>your game:</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> <span class="comment">// in Create()</span>
|
|
mTTFont = <span class="keyword">new</span> <a class="code" href="class_j_t_t_font.html#48fa409e5e7c8316dda0b4de6bf6c769">JTTFont</a>();
|
|
mTTFont->Load(<span class="stringliteral">"arial.ttf"</span>, 32); <span class="comment">// size 32</span>
|
|
|
|
<span class="keywordflow">if</span> (mTTFont->PreCacheASCII())
|
|
mTTFont->Unload();
|
|
...
|
|
|
|
<span class="comment">// in Render()</span>
|
|
mTTFont->RenderString(<span class="stringliteral">"Hello World!"</span>, 240, 80, JGETEXT_CENTER);
|
|
</pre></div> <hr><h2>Member Enumeration Documentation</h2>
|
|
<a class="anchor" name="7a328115c9f86b2d93370a31b903042c"></a><!-- doxytag: member="JTTFont::FONT_LOADING_MODE" ref="7a328115c9f86b2d93370a31b903042c" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="class_j_t_t_font.html#7a328115c9f86b2d93370a31b903042c">JTTFont::FONT_LOADING_MODE</a> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Font loading options. <dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" name="7a328115c9f86b2d93370a31b903042c4faa365f93bea3ee30b7da76559b5003"></a><!-- doxytag: member="MODE_NORMAL" ref="7a328115c9f86b2d93370a31b903042c4faa365f93bea3ee30b7da76559b5003" args="" -->MODE_NORMAL</em> </td><td>
|
|
Load only. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="7a328115c9f86b2d93370a31b903042cd192129155378911d9c07dc61cc21efe"></a><!-- doxytag: member="MODE_PRECACHE_ASCII" ref="7a328115c9f86b2d93370a31b903042cd192129155378911d9c07dc61cc21efe" args="" -->MODE_PRECACHE_ASCII</em> </td><td>
|
|
Load the font and cache all ASCII characters. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="7a328115c9f86b2d93370a31b903042c344916a0d03f0aafe1be46882e626a98"></a><!-- doxytag: member="MODE_PRECACHE_ASCII_EX" ref="7a328115c9f86b2d93370a31b903042c344916a0d03f0aafe1be46882e626a98" args="" -->MODE_PRECACHE_ASCII_EX</em> </td><td>
|
|
Load the font and cache all Extended ASCII characters. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="2ce5bb908b3aaeb2b6c32fce294f292b"></a><!-- doxytag: member="JTTFont::CACHE_IMAGE_SIZE" ref="2ce5bb908b3aaeb2b6c32fce294f292b" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="class_j_t_t_font.html#2ce5bb908b3aaeb2b6c32fce294f292b">JTTFont::CACHE_IMAGE_SIZE</a> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Size of the texture used for caching. <dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" name="2ce5bb908b3aaeb2b6c32fce294f292b2e5de6bc8d0ca27a23212da91a07f421"></a><!-- doxytag: member="CACHE_IMAGE_64x64" ref="2ce5bb908b3aaeb2b6c32fce294f292b2e5de6bc8d0ca27a23212da91a07f421" args="" -->CACHE_IMAGE_64x64</em> </td><td>
|
|
64x64 </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="2ce5bb908b3aaeb2b6c32fce294f292b1a35da04980b668438ed4c2ab6cbfd4b"></a><!-- doxytag: member="CACHE_IMAGE_128x128" ref="2ce5bb908b3aaeb2b6c32fce294f292b1a35da04980b668438ed4c2ab6cbfd4b" args="" -->CACHE_IMAGE_128x128</em> </td><td>
|
|
128x128 </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="2ce5bb908b3aaeb2b6c32fce294f292bda08b4d85b0bade648822756e8ff13e2"></a><!-- doxytag: member="CACHE_IMAGE_256x256" ref="2ce5bb908b3aaeb2b6c32fce294f292bda08b4d85b0bade648822756e8ff13e2" args="" -->CACHE_IMAGE_256x256</em> </td><td>
|
|
256x256 </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="2ce5bb908b3aaeb2b6c32fce294f292b9414757d17b6f3cb6e34cd26a49655a2"></a><!-- doxytag: member="CACHE_IMAGE_512x512" ref="2ce5bb908b3aaeb2b6c32fce294f292b9414757d17b6f3cb6e34cd26a49655a2" args="" -->CACHE_IMAGE_512x512</em> </td><td>
|
|
512x512 </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="48fa409e5e7c8316dda0b4de6bf6c769"></a><!-- doxytag: member="JTTFont::JTTFont" ref="48fa409e5e7c8316dda0b4de6bf6c769" args="(int cacheImageSize=CACHE_IMAGE_256x256)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">JTTFont::JTTFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>cacheImageSize</em> = <code>CACHE_IMAGE_256x256</code> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Constructor.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>cacheImageSize</em> </td><td>- Size of the texture used for caching. This can be 64x64, 128x128(default), 256x256 or 512x512. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="cc098bd764ec2e58a91d44185fdfc9c9"></a><!-- doxytag: member="JTTFont::SetColor" ref="cc098bd764ec2e58a91d44185fdfc9c9" args="(PIXEL_TYPE color)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::SetColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">PIXEL_TYPE </td>
|
|
<td class="paramname"> <em>color</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set color of font.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>color</em> </td><td>- Font color. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e211b246c278df403b3d3de23daba576"></a><!-- doxytag: member="JTTFont::SetAngle" ref="e211b246c278df403b3d3de23daba576" args="(float angle)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::SetAngle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>angle</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set angle of the font for rendering.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>angle</em> </td><td>- Angle in radians. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4cf982139b7953d651e2ba71988466f4"></a><!-- doxytag: member="JTTFont::SetSize" ref="4cf982139b7953d651e2ba71988466f4" args="(int size)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JTTFont::SetSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>size</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set font size.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>- Font size.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="note" compact><dt><b>Note:</b></dt><dd>Setting font size will clear the cache. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="851be526856f2f5f492b78ab55f4d788"></a><!-- doxytag: member="JTTFont::Load" ref="851be526856f2f5f492b78ab55f4d788" args="(const char *filename, int size=12, int mode=MODE_NORMAL)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JTTFont::Load </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"> <em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>size</em> = <code>12</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>mode</em> = <code>MODE_NORMAL</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Load font file.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>- Name of True Type font. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>- Initial font size. Default is 12. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>- Loading mode.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- True if no error. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="14c4f08cdfc7853cd694c3e30b849040"></a><!-- doxytag: member="JTTFont::Load" ref="14c4f08cdfc7853cd694c3e30b849040" args="(JTTFont *fontSource, int size=12, int mode=MODE_NORMAL)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JTTFont::Load </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_j_t_t_font.html">JTTFont</a> * </td>
|
|
<td class="paramname"> <em>fontSource</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>size</em> = <code>12</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>mode</em> = <code>MODE_NORMAL</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Create font using font data from another <a class="el" href="class_j_t_t_font.html">JTTFont</a> instance.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>fontSource</em> </td><td>- Source of font data. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>- Initial font size. Default is 12. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>- Loading mode.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- True if no error. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="612eefb3219e7b6a20f57d2ad859d1e7"></a><!-- doxytag: member="JTTFont::Unload" ref="612eefb3219e7b6a20f57d2ad859d1e7" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::Unload </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Unload font file and related Freetype objects from memory.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="24440eda93882d2909b863a76d14ba06"></a><!-- doxytag: member="JTTFont::RenderString" ref="24440eda93882d2909b863a76d14ba06" args="(const u16 *text, float x, float y, int alignment=JGETEXT_LEFT)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::RenderString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const u16 * </td>
|
|
<td class="paramname"> <em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>alignment</em> = <code>JGETEXT_LEFT</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Render Unicode string to screen.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated Unicode-16 string. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>- X position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>alignment</em> </td><td>- Text alignment: JGETEXT_LEFT, JGETEXT_RIGHT, JGETEXT_CENTER </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8c346d7ebf1662e0fec706dfaee4a02f"></a><!-- doxytag: member="JTTFont::RenderString" ref="8c346d7ebf1662e0fec706dfaee4a02f" args="(const char *text, float x, float y, int alignment=JGETEXT_LEFT)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::RenderString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"> <em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>alignment</em> = <code>JGETEXT_LEFT</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Render ASCII string to screen.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated ASCII string. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>- X position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>alignment</em> </td><td>- Text alignment: JGETEXT_LEFT, JGETEXT_RIGHT, JGETEXT_CENTER </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="503c53b441688982e4271ca2ff9bcd31"></a><!-- doxytag: member="JTTFont::RenderString" ref="503c53b441688982e4271ca2ff9bcd31" args="(const u8 *text, float x, float y, int alignment=JGETEXT_LEFT)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::RenderString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const u8 * </td>
|
|
<td class="paramname"> <em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>alignment</em> = <code>JGETEXT_LEFT</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Render Chinese (GBK) string to screen.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated GBK encoded string. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>- X position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>alignment</em> </td><td>- Text alignment: JGETEXT_LEFT, JGETEXT_RIGHT, JGETEXT_CENTER </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="615820fde8b4b29431c7f707fbcc6231"></a><!-- doxytag: member="JTTFont::PreCacheString" ref="615820fde8b4b29431c7f707fbcc6231" args="(const u16 *text)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::PreCacheString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const u16 * </td>
|
|
<td class="paramname"> <em>text</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Put characters of an Unicode string into cache<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated Unicode-16 string. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0b447223afdf08dccb898606dbb31009"></a><!-- doxytag: member="JTTFont::PreCacheString" ref="0b447223afdf08dccb898606dbb31009" args="(const char *text)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::PreCacheString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"> <em>text</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Put characters of an ASCII string into cache.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated ASCII string. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="019569ab1dc49efb289f5551f233dd80"></a><!-- doxytag: member="JTTFont::PreCacheString" ref="019569ab1dc49efb289f5551f233dd80" args="(const u8 *text)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JTTFont::PreCacheString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const u8 * </td>
|
|
<td class="paramname"> <em>text</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Put characters of a Chinese (GBK) string into cache.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated GBK encoded string. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3f6bdd4c7fbb2dc4e787d3d639132a97"></a><!-- doxytag: member="JTTFont::GetWidth" ref="3f6bdd4c7fbb2dc4e787d3d639132a97" args="(const u16 *text)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int JTTFont::GetWidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const u16 * </td>
|
|
<td class="paramname"> <em>text</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get width of Unicode string on screen.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated Unicode-16 string.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- Width in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="69682546bbbcfd3ab497029798c34e82"></a><!-- doxytag: member="JTTFont::GetWidth" ref="69682546bbbcfd3ab497029798c34e82" args="(const char *text)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int JTTFont::GetWidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"> <em>text</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get width of ASCII string on screen.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated ASCII string.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- Width in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5bdebc7509836ad106b3f91ab5708709"></a><!-- doxytag: member="JTTFont::GetWidth" ref="5bdebc7509836ad106b3f91ab5708709" args="(const u8 *text)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int JTTFont::GetWidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const u8 * </td>
|
|
<td class="paramname"> <em>text</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get width of Chinese (GBK) string on screen.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- NULL terminated GBK encoded string.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- Width in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="959f6698937c30bcd066e4c7d8d3bc88"></a><!-- doxytag: member="JTTFont::PreCacheASCII" ref="959f6698937c30bcd066e4c7d8d3bc88" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JTTFont::PreCacheASCII </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Put all standard ASCII characters (0x20-0x7F) into cache.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- True if success. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="babc7ff0ddbc600b6da3cf4b92369bc6"></a><!-- doxytag: member="JTTFont::PreCacheExtendedASCII" ref="babc7ff0ddbc600b6da3cf4b92369bc6" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JTTFont::PreCacheExtendedASCII </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Put all ASCII characters (0x20-0xFF) into cache.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- True if success. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:23 2007 for JGE++ by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
</body>
|
|
</html>
|