179 lines
12 KiB
HTML
179 lines
12 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 Namespace 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="hierarchy.html">Class Hierarchy</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 Namespace Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Namespace for <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> classes and utility functions.
|
|
<p>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
<table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Class for use in <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>.</em> <a href="classZE_1_1ZConfigFile.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZCF_Variable</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Variable class.</em> <a href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZCF_Section</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Section class.</em> <a href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Main <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Singleton Class.</em> <a href="classZE_1_1ZEngine.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZError.html">ZError</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZError.html">ZError</a> class for describing errors.</em> <a href="classZE_1_1ZError.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html">ZFont</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZFont.html">ZFont</a> class for basic Font use.</em> <a href="classZE_1_1ZFont.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html">ZImage</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZImage.html">ZImage</a> class for basic Image use.</em> <a href="classZE_1_1ZImage.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html">ZMusic</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZMusic.html">ZMusic</a> class for playing full length music (eg. ogg or wav).</em> <a href="classZE_1_1ZMusic.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZObject.html">ZObject</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZObject.html">ZObject</a> base class for other <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> objects.</em> <a href="classZE_1_1ZObject.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html">ZRect</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> class for simplified rectangle use.</em> <a href="classZE_1_1ZRect.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html">ZSound</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZSound.html">ZSound</a> class for playing sound effects. (WAV).</em> <a href="classZE_1_1ZSound.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html">ZTimer</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em><a class="el" href="classZE_1_1ZTimer.html">ZTimer</a> class for Timer use.</em> <a href="classZE_1_1ZTimer.html#_details">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="namespaceZE.html#a16">ZErrorCode</a> { <br>
|
|
<a class="el" href="namespaceZE.html#a16a0">ZERR_NONE</a>,
|
|
<a class="el" href="namespaceZE.html#a16a1">ZERR_SDL_INTERNAL</a>,
|
|
<a class="el" href="namespaceZE.html#a16a2">ZERR_SDL_INIT</a>,
|
|
<a class="el" href="namespaceZE.html#a16a3">ZERR_MIX_INIT</a>,
|
|
<br>
|
|
<a class="el" href="namespaceZE.html#a16a4">ZERR_TTF_INIT</a>,
|
|
<a class="el" href="namespaceZE.html#a16a5">ZERR_VIDMODE</a>,
|
|
<a class="el" href="namespaceZE.html#a16a6">ZERR_LOAD_IMAGE</a>,
|
|
<a class="el" href="namespaceZE.html#a16a7">ZERR_LOAD_SOUND</a>,
|
|
<br>
|
|
<a class="el" href="namespaceZE.html#a16a8">ZERR_LOAD_MUSIC</a>,
|
|
<a class="el" href="namespaceZE.html#a16a9">ZERR_LOAD_FONT</a>,
|
|
<a class="el" href="namespaceZE.html#a16a10">ZERR_NOIMAGE</a>,
|
|
<a class="el" href="namespaceZE.html#a16a11">ZERR_NOSOUND</a>,
|
|
<br>
|
|
<a class="el" href="namespaceZE.html#a16a12">ZERR_NOMUSIC</a>,
|
|
<a class="el" href="namespaceZE.html#a16a13">ZERR_NOFONT</a>,
|
|
<a class="el" href="namespaceZE.html#a16a14">ZERR_LAST</a>
|
|
<br>
|
|
}</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Enumeration of ZEngine error codes.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>string </td><td valign=bottom><a class="el" href="namespaceZE.html#a15">FormatStr</a> (const char *fmtstr,...)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Parses a string and interprets variable arguments, similar to sprintf.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><h2>Enumeration Type Documentation</h2>
|
|
<a name="a16" doxytag="ZE::ZErrorCode"></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"> enum ZE::ZErrorCode
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
All the error codes currently possibly by <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>, note that ZERR_LAST is not used as an error code, but instead as a range check on the others. <dl compact><dt><b>Enumeration values: </b></dt><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em><a name="a16a0" doxytag="ZERR_NONE"></a><em>ZERR_NONE</em></em> </td><td>
|
|
No error has occured. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a1" doxytag="ZERR_SDL_INTERNAL"></a><em>ZERR_SDL_INTERNAL</em></em> </td><td>
|
|
Error internal to SDL has occured, usually more detail is given by SDL. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a2" doxytag="ZERR_SDL_INIT"></a><em>ZERR_SDL_INIT</em></em> </td><td>
|
|
Error Initializing SDL. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a3" doxytag="ZERR_MIX_INIT"></a><em>ZERR_MIX_INIT</em></em> </td><td>
|
|
Error Initializing SDL_mixer. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a4" doxytag="ZERR_TTF_INIT"></a><em>ZERR_TTF_INIT</em></em> </td><td>
|
|
Error Initializing SDL_ttf. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a5" doxytag="ZERR_VIDMODE"></a><em>ZERR_VIDMODE</em></em> </td><td>
|
|
Error setting up the display. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a6" doxytag="ZERR_LOAD_IMAGE"></a><em>ZERR_LOAD_IMAGE</em></em> </td><td>
|
|
Error loading an image. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a7" doxytag="ZERR_LOAD_SOUND"></a><em>ZERR_LOAD_SOUND</em></em> </td><td>
|
|
Error loading a sound sample. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a8" doxytag="ZERR_LOAD_MUSIC"></a><em>ZERR_LOAD_MUSIC</em></em> </td><td>
|
|
Error loading music. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a9" doxytag="ZERR_LOAD_FONT"></a><em>ZERR_LOAD_FONT</em></em> </td><td>
|
|
Error loading a font. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a10" doxytag="ZERR_NOIMAGE"></a><em>ZERR_NOIMAGE</em></em> </td><td>
|
|
Error trying to use a <a class="el" href="classZE_1_1ZImage.html">ZImage</a> without properly loading an image. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a11" doxytag="ZERR_NOSOUND"></a><em>ZERR_NOSOUND</em></em> </td><td>
|
|
Error trying to use a <a class="el" href="classZE_1_1ZSound.html">ZSound</a> without properly loading a sound. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a12" doxytag="ZERR_NOMUSIC"></a><em>ZERR_NOMUSIC</em></em> </td><td>
|
|
Error trying to use a <a class="el" href="classZE_1_1ZMusic.html">ZMusic</a> without properly loading music. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a13" doxytag="ZERR_NOFONT"></a><em>ZERR_NOFONT</em></em> </td><td>
|
|
Error trying to use a <a class="el" href="classZE_1_1ZFont.html">ZFont</a> without properly loading a font. </td></tr>
|
|
<tr><td valign=top><em><a name="a16a14" doxytag="ZERR_LAST"></a><em>ZERR_LAST</em></em> </td><td>
|
|
Value used as range index, not a valid error code. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a name="a15" doxytag="ZE::FormatStr"></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"> string ZE::FormatStr </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const char * </td>
|
|
<td class="mdname" nowrap> <em>fmtstr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>... </td>
|
|
<td class="mdname" nowrap> </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>
|
|
Takes identifiers out of fmtstr and parses them, replacing them with cooresponding values in the variable arguments list. For more detail view stdarg documentation. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>fmtstr</em> </td><td>defines format of resulting string </td></tr>
|
|
<tr><td valign=top><em>...</em> </td><td>variable number of arguments after fmtstr </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>string of parsed and combined string </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><address style="align: right;"><small>Generated on Sat Jan 18 17:53:20 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>
|