Mahtan/wagic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f9d5620d38327312fd614b061c9a889adcc073ec
wagic/JGE/docs/html/class_j_l_b_font.html
wagic.the.homebrew d45e3b101b
2008-11-02 09:50:16 +00:00

473 lines
19 KiB
HTML
Raw Blame History

<!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++: JLBFont 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&nbsp;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&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>JLBFont Class Reference</h1><!-- doxytag: class="JLBFont" --><code>#include &lt;JLBFont.h&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for JLBFont:</div>
<div class="dynsection">
</div>
<p>
<a href="class_j_l_b_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 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="class_j_l_b_font.html#470b6123554d4568784d82318ad7761d">JLBFont</a> (const char *fontname, int lineheight, bool useVideoRAM=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#95aa6d79da0788ea9d0fbc09b106c108">DrawString</a> (const char *string, float x, float y, int align=JGETEXT_LEFT)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#4248a475d9d99f52a689f99e2b5d76e7">printf</a> (float x, float y, const char *format,...)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#f7cf878ac7e358c19aa57190d1ecff59">SetColor</a> (PIXEL_TYPE color)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#d9d349b3541e253ef07d341e642228db">SetScale</a> (float scale)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#406f077c55ce2168d59b0e16a7899e06">SetRotation</a> (float rot)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#1c20dfebc4c1702de5fd5d7515fafa03">SetTracking</a> (float tracking)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PIXEL_TYPE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#0eb9a818ec2e353403187fc6fa736760">GetColor</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#11ea8905c8fc33514d495c3f22c7f11f">GetScale</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#d4c9da2453523a41f32cdcf24e67329b">GetRotation</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#e9697a8fcb10bd81440f7b37d16b5b22">GetTracking</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#0b1b2344d392c7fd5d33bb8be8b0024d">GetHeight</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#3b13a252ea5a5014f61c673f76efc8dd">GetStringWidth</a> (const char *string) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_l_b_font.html#9951b8fd23fbc6abd1f0bd33e147fdf3">SetBase</a> (int base)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Bitmap font class for LMNOpc's Bitmap Font Builder: <a href="http://www.lmnopc.com/bitmapfontbuilder/">http://www.lmnopc.com/bitmapfontbuilder/</a><p>
Two files are used for each font: 1: xxx.png, font bitmap. 2: xxx.dat, widths for each character Each font contains 2 sets of characters ASCII code (32-159). <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="470b6123554d4568784d82318ad7761d"></a><!-- doxytag: member="JLBFont::JLBFont" ref="470b6123554d4568784d82318ad7761d" args="(const char *fontname, int lineheight, bool useVideoRAM=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JLBFont::JLBFont </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>fontname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>lineheight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>useVideoRAM</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>fontname</em>&nbsp;</td><td>- Name of the font WITHOUT extensions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lineheight</em>&nbsp;</td><td>- Font height. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>useVideoRAM</em>&nbsp;</td><td>- Indicate to use video RAM to store the font image or not (PSP only). </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="95aa6d79da0788ea9d0fbc09b106c108"></a><!-- doxytag: member="JLBFont::DrawString" ref="95aa6d79da0788ea9d0fbc09b106c108" args="(const char *string, float x, float y, int align=JGETEXT_LEFT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::DrawString </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>align</em> = <code>JGETEXT_LEFT</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rendering text 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>string</em>&nbsp;</td><td>- text for rendering. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>- X position of text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>- Y position of text. - Text aligment. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4248a475d9d99f52a689f99e2b5d76e7"></a><!-- doxytag: member="JLBFont::printf" ref="4248a475d9d99f52a689f99e2b5d76e7" args="(float x, float y, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::printf </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"> <em>...</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rendering text to screen with syntax similar to printf of C/C++.<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>x</em>&nbsp;</td><td>- X position of text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>- Y position of text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em>&nbsp;</td><td>- String formatting. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f7cf878ac7e358c19aa57190d1ecff59"></a><!-- doxytag: member="JLBFont::SetColor" ref="f7cf878ac7e358c19aa57190d1ecff59" args="(PIXEL_TYPE color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::SetColor </td>
<td>(</td>
<td class="paramtype">PIXEL_TYPE&nbsp;</td>
<td class="paramname"> <em>color</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set font color.<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>&nbsp;</td><td>- color of font. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d9d349b3541e253ef07d341e642228db"></a><!-- doxytag: member="JLBFont::SetScale" ref="d9d349b3541e253ef07d341e642228db" args="(float scale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::SetScale </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>scale</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set scale 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>scale</em>&nbsp;</td><td>- Scale for rendering characters. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="406f077c55ce2168d59b0e16a7899e06"></a><!-- doxytag: member="JLBFont::SetRotation" ref="406f077c55ce2168d59b0e16a7899e06" args="(float rot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::SetRotation </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>rot</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set angle 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>rot</em>&nbsp;</td><td>- Rotation angle in radian. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1c20dfebc4c1702de5fd5d7515fafa03"></a><!-- doxytag: member="JLBFont::SetTracking" ref="1c20dfebc4c1702de5fd5d7515fafa03" args="(float tracking)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::SetTracking </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>tracking</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set font tracking.<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>tracking</em>&nbsp;</td><td>- Font tracking. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0eb9a818ec2e353403187fc6fa736760"></a><!-- doxytag: member="JLBFont::GetColor" ref="0eb9a818ec2e353403187fc6fa736760" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PIXEL_TYPE JLBFont::GetColor </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get font color.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Font color. </dd></dl>
</div>
</div><p>
<a class="anchor" name="11ea8905c8fc33514d495c3f22c7f11f"></a><!-- doxytag: member="JLBFont::GetScale" ref="11ea8905c8fc33514d495c3f22c7f11f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JLBFont::GetScale </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get rendering scale.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Rendering scale. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d4c9da2453523a41f32cdcf24e67329b"></a><!-- doxytag: member="JLBFont::GetRotation" ref="d4c9da2453523a41f32cdcf24e67329b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JLBFont::GetRotation </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get rendering angle.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Rendering angle. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e9697a8fcb10bd81440f7b37d16b5b22"></a><!-- doxytag: member="JLBFont::GetTracking" ref="e9697a8fcb10bd81440f7b37d16b5b22" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JLBFont::GetTracking </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get font tracking.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Font tracking. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0b1b2344d392c7fd5d33bb8be8b0024d"></a><!-- doxytag: member="JLBFont::GetHeight" ref="0b1b2344d392c7fd5d33bb8be8b0024d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JLBFont::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get height of font.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Height of font. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3b13a252ea5a5014f61c673f76efc8dd"></a><!-- doxytag: member="JLBFont::GetStringWidth" ref="3b13a252ea5a5014f61c673f76efc8dd" args="(const char *string) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JLBFont::GetStringWidth </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>string</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get width of rendering 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>string</em>&nbsp;</td><td>- NULL terminated 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="9951b8fd23fbc6abd1f0bd33e147fdf3"></a><!-- doxytag: member="JLBFont::SetBase" ref="9951b8fd23fbc6abd1f0bd33e147fdf3" args="(int base)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JLBFont::SetBase </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>base</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
There are usually 2 sets of characters in the font image. The first set is from index 0-127 and the second from 128-255. You should use this function to select which set of characters you want to use. The index base should be either 0 or 128.<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>base</em>&nbsp;</td><td>- Base for the character set to use. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:22 2007 for JGE++ by&nbsp;
<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>
Reference in New Issue View Git Blame Copy Permalink