773 lines
29 KiB
HTML
773 lines
29 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||
|
|
<title>ZE::ZFont class Reference</title>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
||
|
|
</head><body>
|
||
|
|
<!-- Generated by Doxygen 1.3-rc2 -->
|
||
|
|
<center>
|
||
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
|
||
|
|
<hr><h1>ZE::ZFont Class Reference</h1><code>#include <<a class="el" href="ZE__ZFont_8h-source.html">ZE_ZFont.h</a>></code>
|
||
|
|
<p>
|
||
|
|
<a href="classZE_1_1ZFont-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
<a class="el" href="classZE_1_1ZFont.html">ZFont</a> font container class, class wraps common features of SDL_TTF. Inherited from ZObject.
|
||
|
|
<p>
|
||
|
|
<table border=0 cellpadding=0 cellspacing=0>
|
||
|
|
<tr><td></td></tr>
|
||
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a0">ZFont</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Default Constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a1">ZFont</a> (string filename, int size)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Constructor that opens a font with a certain size.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a2">~ZFont</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Destructor, frees memory.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a3">Open</a> (string filename, int size)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Opens a font with a certain size.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a4">Release</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Release font.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a5">DrawText</a> (string text, <a class="el" href="classZE_1_1ZImage.html">ZImage</a> &image) const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Draws a string in a color to a <a class="el" href="classZE_1_1ZImage.html">ZImage</a>.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a6">DrawShadedText</a> (string text, <a class="el" href="classZE_1_1ZImage.html">ZImage</a> &image) const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Draws a string with a colored background to a <a class="el" href="classZE_1_1ZImage.html">ZImage</a>.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a7">SetColor</a> (Uint8 r, Uint8 g, Uint8 b)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Set Text rColor.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a8">SetBGColor</a> (Uint8 r, Uint8 g, Uint8 b)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Set Background rColor.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a9">SetStyle</a> (bool bold, bool italic, bool underline)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Set display format.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a10">Resize</a> (int size)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Resize Font.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a11">IsLoaded</a> () const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Check if file is loaded.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a12">IsBold</a> () const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Bold Setting.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a13">IsItalic</a> () const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Italic Setting.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a14">IsUnderlined</a> () const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Underlined Setting.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a15">Height</a> () const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Height of Font.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a16">LineSkip</a> () const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Line Skip for Font.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a17">StringWidth</a> (string text) const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get String Width.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a18">StringHeight</a> (string text) const</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get String Height.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="n0" doxytag="ZE::ZFont::rEngine"></a>
|
||
|
|
<a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> * </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n0">rEngine</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Pointer to <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Object.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZFont::rFont"></a>
|
||
|
|
TTF_Font * </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n1">rFont</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Pointer to font data.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZFont::rFilename"></a>
|
||
|
|
string </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n2">rFilename</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Filename, for resizing.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZFont::rColor"></a>
|
||
|
|
SDL_Color </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n3">rColor</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>SDL_Color for current text color.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="n4" doxytag="ZE::ZFont::rBGColor"></a>
|
||
|
|
SDL_Color </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n4">rBGColor</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>SDL_Color for background color to be used in shaded draws.</em></font><br><br></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
|
|
<a name="a0" doxytag="ZE::ZFont::ZFont"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> ZE::ZFont::ZFont </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Default Constructor, does nothing. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a1" doxytag="ZE::ZFont::ZFont"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> ZE::ZFont::ZFont </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname" nowrap> <em>filename</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>int </td>
|
||
|
|
<td class="mdname" nowrap> <em>size</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Constructor simply calls <a class="el" href="classZE_1_1ZFont.html#a3">ZFont::Open()</a> with same parameters. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>filename</em> </td><td>Font to open. </td></tr>
|
||
|
|
<tr><td valign=top><em>size</em> </td><td>Size to use for font. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a2" doxytag="ZE::ZFont::~ZFont"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> virtual ZE::ZFont::~ZFont </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Destructor calls <a class="el" href="classZE_1_1ZFont.html#a4">ZFont::Release()</a>. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<hr><h2>Member Function Documentation</h2>
|
||
|
|
<a name="a3" doxytag="ZE::ZFont::Open"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::Open </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname" nowrap> <em>filename</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>int </td>
|
||
|
|
<td class="mdname" nowrap> <em>size</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Opens a font given a filename and a point size. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>filename</em> </td><td>Font to open. </td></tr>
|
||
|
|
<tr><td valign=top><em>size</em> </td><td>Size to use for font. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a4" doxytag="ZE::ZFont::Release"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::Release </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Release memory held by font. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a5" doxytag="ZE::ZFont::DrawText"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::DrawText </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname" nowrap> <em>text</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap><a class="el" href="classZE_1_1ZImage.html">ZImage</a> & </td>
|
||
|
|
<td class="mdname" nowrap> <em>image</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Draw to a surface in specified color and associate that surface with a <a class="el" href="classZE_1_1ZImage.html">ZImage</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>text</em> </td><td>String to write. </td></tr>
|
||
|
|
<tr><td valign=top><em>image</em> </td><td><a class="el" href="classZE_1_1ZImage.html">ZImage</a> to draw to. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a6" doxytag="ZE::ZFont::DrawShadedText"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::DrawShadedText </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname" nowrap> <em>text</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap><a class="el" href="classZE_1_1ZImage.html">ZImage</a> & </td>
|
||
|
|
<td class="mdname" nowrap> <em>image</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Draw to a surface a string with a background of rBGColor and lettering in the normal color and associate that surface with a <a class="el" href="classZE_1_1ZImage.html">ZImage</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>text</em> </td><td>String to write. </td></tr>
|
||
|
|
<tr><td valign=top><em>image</em> </td><td><a class="el" href="classZE_1_1ZImage.html">ZImage</a> to draw to. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a7" doxytag="ZE::ZFont::SetColor"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::SetColor </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>r</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>g</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>b</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Set rColor of Text Output. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>r</em> </td><td>Red component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>g</em> </td><td>Green component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>b</em> </td><td>Blue component of color (0-255). </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a8" doxytag="ZE::ZFont::SetBGColor"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::SetBGColor </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>r</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>g</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>b</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Set rColor of Background for Shaded Draw. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>r</em> </td><td>Red component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>g</em> </td><td>Green component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>b</em> </td><td>Blue component of color (0-255). </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a9" doxytag="ZE::ZFont::SetStyle"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::SetStyle </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">bool </td>
|
||
|
|
<td class="mdname" nowrap> <em>bold</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>bool </td>
|
||
|
|
<td class="mdname" nowrap> <em>italic</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>bool </td>
|
||
|
|
<td class="mdname" nowrap> <em>underline</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Set display format (bold, italic, underline). <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>bold</em> </td><td>Decides bold setting of font. </td></tr>
|
||
|
|
<tr><td valign=top><em>italic</em> </td><td>Decides italic setting of font. </td></tr>
|
||
|
|
<tr><td valign=top><em>underline</em> </td><td>Decides underline setting of font. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a10" doxytag="ZE::ZFont::Resize"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> void ZE::ZFont::Resize </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">int </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Release and Reopen font in new size. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>size</em> </td><td>New size for font. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a11" doxytag="ZE::ZFont::IsLoaded"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> bool ZE::ZFont::IsLoaded </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Check if file is loaded and pointer to data is non-NULL. <dl compact><dt><b>Returns:</b></dt><dd>Loaded or Unloaded state of data. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a12" doxytag="ZE::ZFont::IsBold"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> bool ZE::ZFont::IsBold </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Check if font output is currently bold. <dl compact><dt><b>Returns:</b></dt><dd>True or False state of bold. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a13" doxytag="ZE::ZFont::IsItalic"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> bool ZE::ZFont::IsItalic </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Check if font output is currently italic. <dl compact><dt><b>Returns:</b></dt><dd>True or False state of italic. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a14" doxytag="ZE::ZFont::IsUnderlined"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> bool ZE::ZFont::IsUnderlined </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Check if font output is currently underline. <dl compact><dt><b>Returns:</b></dt><dd>True or False state of underline. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a15" doxytag="ZE::ZFont::Height"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> int ZE::ZFont::Height </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Check font height as reported by SDL_ttf. <dl compact><dt><b>Returns:</b></dt><dd>Height of font. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a16" doxytag="ZE::ZFont::LineSkip"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> int ZE::ZFont::LineSkip </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Check font line skip as reported by SDL_ttf. <dl compact><dt><b>Returns:</b></dt><dd>Recommended Line Skip of font. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a17" doxytag="ZE::ZFont::StringWidth"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> int ZE::ZFont::StringWidth </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>text</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get Width of String in Current Font in Pixels. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>text</em> </td><td>String to get width of. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Width of String in Current font. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a18" doxytag="ZE::ZFont::StringHeight"></a><p>
|
||
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md">
|
||
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
||
|
|
<tr>
|
||
|
|
<td class="md" nowrap valign="top"> int ZE::ZFont::StringHeight </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>text</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap> const</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get Height of String in Current Font in Pixels. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>text</em> </td><td>String to get height of. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Height of String in Current font. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>/include/<a class="el" href="ZE__ZFont_8h-source.html">ZE_ZFont.h</a></ul>
|
||
|
|
<hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:01 2003 for ZEngine by
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0
|
||
|
|
width=110 height=53></a>1.3-rc2 </small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|