jpt-archive/zengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

0.8.3 docs

Browse Source
This commit is contained in:
James Turk 2003-04-27 22:15:26 +00:00
parent 814f3cb35f
commit ab9be88eda
74 changed files with 11369 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
doc/html/ZE__Defines_8h-source.html Normal file
View File

@ -0,0 +1,45 @@
<!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>/include/ZE_Defines.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_Defines.h</h1><a href="ZE__Defines_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_defines_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_defines_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="comment">//Defines- undefine any of these if you dont have the indicated SDL extension//</span>
00028
<a name="l00030"></a><a class="code" href="ZE__Defines_8h.html#a0">00030</a> <span class="preprocessor">#define VERSION "0.8.3"</span>
00031 <span class="preprocessor"></span>
<a name="l00033"></a><a class="code" href="ZE__Defines_8h.html#a1">00033</a> <span class="preprocessor">#define USE_SDL_TTF</span>
00034 <span class="preprocessor"></span>
<a name="l00035"></a><a class="code" href="ZE__Defines_8h.html#a2">00035</a> <span class="preprocessor">#define USE_SDL_IMAGE</span>
00036 <span class="preprocessor"></span>
<a name="l00037"></a><a class="code" href="ZE__Defines_8h.html#a3">00037</a> <span class="preprocessor">#define USE_SDL_MIXER</span>
00038 <span class="preprocessor"></span>
00039 <span class="comment">//#define USE_SDL_NET</span>
00041 <span class="comment">//#define USE_PHYSFS</span>
00042
<a name="l00044"></a><a class="code" href="ZE__Defines_8h.html#a4">00044</a> <span class="preprocessor">#define MAX_MSG_LEN 10240</span>
00045 <span class="preprocessor"></span>
<a name="l00046"></a><a class="code" href="ZE__Defines_8h.html#a5">00046</a> <span class="keyword">typedef</span> <span class="keywordtype">char</span> <a class="code" href="ZE__Defines_8h.html#a5">ZByte</a>;
00047
00048 <span class="preprocessor">#endif //__ze_defines_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

50
doc/html/ZE__Defines_8h.html Normal file
View File

@ -0,0 +1,50 @@
<!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_Defines.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_Defines.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__Defines_8h.html">ZE_Defines.h</a> <br>
Description: Defines header file for ZEngine class, where all #define statements to control compilation options are placed. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__Defines_8h.html">ZE_Defines.h</a>,v 1.12 2003/04/27 18:55:00 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file, holds #define statements describing optional features of ZEngine.
<p>
<p>
<a href="ZE__Defines_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="ZE_Defines.h::VERSION"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Defines_8h.html#a0">VERSION</a>&nbsp;&nbsp;&nbsp;"0.8.3"</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Version number.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="ZE_Defines.h::USE_SDL_TTF"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Defines_8h.html#a1">USE_SDL_TTF</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Define to include font support.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="ZE_Defines.h::USE_SDL_IMAGE"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Defines_8h.html#a2">USE_SDL_IMAGE</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Define to include non-bmp image file support.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="ZE_Defines.h::USE_SDL_MIXER"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Defines_8h.html#a3">USE_SDL_MIXER</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Define to include sound support.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="ZE_Defines.h::MAX_MSG_LEN"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Defines_8h.html#a4">MAX_MSG_LEN</a>&nbsp;&nbsp;&nbsp;10240</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Maximum message length (for SDL_net). (10kb [10240] default).</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="ZE_Defines.h::ZByte"></a>
typedef char&nbsp;</td><td valign=bottom><a class="el" href="ZE__Defines_8h.html#a5">ZByte</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Define a ZByte as a plain char (for SDL_net).</em></font><br><br></td></tr>
</table>
<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>

63
doc/html/ZE__Includes_8h-source.html Normal file
View File

@ -0,0 +1,63 @@
<!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>/include/ZE_Includes.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_Includes.h</h1><a href="ZE__Includes_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00025 <span class="preprocessor">#ifndef __ze_includes_h__</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define __ze_includes_h__</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include "<a class="code" href="ZE__Defines_8h.html">ZE_Defines.h</a>"</span>
00029
00030 <span class="preprocessor">#include "SDL.h"</span>
00031 <span class="preprocessor">#include "SDL_opengl.h"</span>
00032 <span class="preprocessor">#include "external/SDLGL_Util.h"</span>
00033 <span class="preprocessor">#ifdef USE_SDL_IMAGE</span>
00034 <span class="preprocessor"></span><span class="preprocessor">#include "SDL_image.h"</span>
00035 <span class="preprocessor">#endif</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_SDL_TTF</span>
00037 <span class="preprocessor"></span><span class="preprocessor">#include "SDL_ttf.h"</span>
00038 <span class="preprocessor">#endif</span>
00039 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00040 <span class="preprocessor"></span><span class="preprocessor">#include "SDL_mixer.h"</span>
00041 <span class="preprocessor">#endif</span>
00042 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_SDL_NET</span>
00043 <span class="preprocessor"></span><span class="preprocessor">#include "SDL_net.h"</span>
00044 <span class="preprocessor">#endif</span>
00045 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_PHYSFS</span>
00046 <span class="preprocessor"></span><span class="preprocessor">#include "physfs.h"</span>
00047 <span class="preprocessor">#include "external/physfsrwops.h"</span>
00048 <span class="preprocessor">#endif</span>
00049 <span class="preprocessor"></span><span class="preprocessor">#include "external/mt19937ar.h"</span>
00050
00051 <span class="preprocessor">#include &lt;string&gt;</span>
00052 <span class="preprocessor">#include &lt;vector&gt;</span>
00053 <span class="preprocessor">#include &lt;queue&gt;</span>
00054 <span class="preprocessor">#include &lt;list&gt;</span>
00055 <span class="preprocessor">#include &lt;fstream&gt;</span>
00056 <span class="preprocessor">#include &lt;cstdio&gt;</span>
00057 <span class="preprocessor">#include &lt;cstdlib&gt;</span>
00058 <span class="preprocessor">#include &lt;cstdarg&gt;</span>
00059 <span class="preprocessor">#include &lt;cctype&gt;</span>
00060 <span class="preprocessor">#include &lt;ctime&gt;</span>
00061 <span class="keyword">using</span> <span class="keyword">namespace </span>std;
00062
00063 <span class="preprocessor">#endif //__ze_includes_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

50
doc/html/ZE__Includes_8h.html Normal file
View File

@ -0,0 +1,50 @@
<!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_Includes.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_Includes.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__Includes_8h.html">ZE_Includes.h</a> <br>
Description: Header file for ZEngine universal includes. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__Includes_8h.html">ZE_Includes.h</a>,v 1.8 2003/04/27 22:05:25 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
ZE_*.h files should only include this file and any other ZE_*.h files that they need, External Library or C/C++ Standard Library files should be included from within this file.
<p>
<code>#include "<a class="el" href="ZE__Defines_8h-source.html">ZE_Defines.h</a>"</code><br>
<code>#include "SDL.h"</code><br>
<code>#include "SDL_opengl.h"</code><br>
<code>#include "external/SDLGL_Util.h"</code><br>
<code>#include "SDL_image.h"</code><br>
<code>#include "SDL_ttf.h"</code><br>
<code>#include "SDL_mixer.h"</code><br>
<code>#include "external/mt19937ar.h"</code><br>
<code>#include &lt;string&gt;</code><br>
<code>#include &lt;vector&gt;</code><br>
<code>#include &lt;queue&gt;</code><br>
<code>#include &lt;list&gt;</code><br>
<code>#include &lt;fstream&gt;</code><br>
<code>#include &lt;cstdio&gt;</code><br>
<code>#include &lt;cstdlib&gt;</code><br>
<code>#include &lt;cstdarg&gt;</code><br>
<code>#include &lt;cctype&gt;</code><br>
<code>#include &lt;ctime&gt;</code><br>
<p>
<a href="ZE__Includes_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><b>std</b></td></tr>
</table>
<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>

31
doc/html/ZE__Utility_8cpp.html Executable file
View File

@ -0,0 +1,31 @@
<!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_Utility.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_Utility.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__Utility_8cpp.html">ZE_Utility.cpp</a> <br>
Description: Implementation source file for ZEngine Utilities. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__Utility_8cpp.html">ZE_Utility.cpp</a>,v 1.4 2003/01/19 01:03:57 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Source file containing open utilities for use inside and alongside ZEngine.
<p>
<code>#include "<a class="el" href="ZE__Utility_8h-source.html">ZE_Utility.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

55
doc/html/ZE__Utility_8h-source.html Executable file
View File

@ -0,0 +1,55 @@
<!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>/include/ZE_Utility.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_Utility.h</h1><a href="ZE__Utility_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00025 <span class="preprocessor">#ifndef __ze_utility_h__</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define __ze_utility_h__</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include "<a class="code" href="ZE__Includes_8h.html">ZE_Includes.h</a>"</span>
00029
<a name="l00030"></a><a class="code" href="namespaceZE.html">00030</a> <span class="keyword">namespace </span>ZE
00031 {
00032
00042 string <a class="code" href="namespaceZE.html#a19">FormatStr</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmtstr, ...);
00043
00045 <span class="comment">//Macros//</span>
00047 <span class="comment"></span>
<a name="l00051"></a><a class="code" href="ZE__Utility_8h.html#a0">00051</a> <span class="comment"></span><span class="preprocessor">#define FreeImage(image) if(image){SDL_FreeSurface(image); image = NULL;}</span>
00052 <span class="preprocessor"></span>
00053 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00054 <span class="preprocessor"></span>
<a name="l00057"></a><a class="code" href="ZE__Utility_8h.html#a1">00057</a> <span class="preprocessor">#define FreeSound(sound) if(sound){Mix_FreeChunk(sound); sound = NULL;}</span>
00058 <span class="preprocessor"></span>
<a name="l00061"></a><a class="code" href="ZE__Utility_8h.html#a2">00061</a> <span class="preprocessor">#define FreeMusic(music) if(music){Mix_FreeMusic(music); music = NULL;}</span>
00062 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
00063 <span class="preprocessor"></span>
00064 <span class="preprocessor">#ifdef USE_SDL_TTF</span>
00065 <span class="preprocessor"></span>
<a name="l00068"></a><a class="code" href="ZE__Utility_8h.html#a3">00068</a> <span class="preprocessor">#define FreeFont(font) if(font){TTF_CloseFont(font); font = NULL;}</span>
00069 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
00070 <span class="preprocessor"></span>
00071
00072 }
00073
00074 <span class="preprocessor">#endif //__ze_utility_h__</span>
00075 <span class="preprocessor"></span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

147
doc/html/ZE__Utility_8h.html Executable file
View File

@ -0,0 +1,147 @@
<!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_Utility.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_Utility.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__Utility_8h.html">ZE_Utility.h</a> <br>
Description: Header file for ZEngine Utilities. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__Utility_8h.html">ZE_Utility.h</a>,v 1.1 2003/01/15 05:31:51 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZEngine Utilities which are used throughout the engine and can be used in conjunction with ZEngine.
<p>
<code>#include "<a class="el" href="ZE__Includes_8h-source.html">ZE_Includes.h</a>"</code><br>
<p>
<a href="ZE__Utility_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a0">FreeImage</a>(image)&nbsp;&nbsp;&nbsp;if(image){SDL_FreeSurface(image); image = NULL;}</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a1">FreeSound</a>(sound)&nbsp;&nbsp;&nbsp;if(sound){Mix_FreeChunk(sound); sound = NULL;}</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a2">FreeMusic</a>(music)&nbsp;&nbsp;&nbsp;if(music){Mix_FreeMusic(music); music = NULL;}</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a3">FreeFont</a>(font)&nbsp;&nbsp;&nbsp;if(font){TTF_CloseFont(font); font = NULL;}</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a name="a0" doxytag="ZE_Utility.h::FreeImage"></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"> #define FreeImage</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">image&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;if(image){SDL_FreeSurface(image); image = NULL;}
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Safely free an SDL_Surface* and set it to NULL. </td>
</tr>
</table>
<a name="a1" doxytag="ZE_Utility.h::FreeSound"></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"> #define FreeSound</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">sound&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;if(sound){Mix_FreeChunk(sound); sound = NULL;}
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Safely free a Mix_Chunk* and set it to NULL. </td>
</tr>
</table>
<a name="a2" doxytag="ZE_Utility.h::FreeMusic"></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"> #define FreeMusic</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">music&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;if(music){Mix_FreeMusic(music); music = NULL;}
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Safely free a Mix_Music* and set it to NULL. </td>
</tr>
</table>
<a name="a3" doxytag="ZE_Utility.h::FreeFont"></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"> #define FreeFont</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">font&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;if(font){TTF_CloseFont(font); font = NULL;}
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Safely free a TTF_Font and set it to NULL. </td>
</tr>
</table>
<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>

29
doc/html/ZE__ZClient_8cpp.html Executable file
View File

@ -0,0 +1,29 @@
<!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_ZClient.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZClient.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZClient_8cpp.html">ZE_ZClient.cpp</a> <br>
Description: Implementation source file for core ZEngine TCP Client Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZClient_8cpp.html">ZE_ZClient.cpp</a>,v 1.5 2003/04/27 19:12:48 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation file for ZClient, the TCP Client class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZClient_8h-source.html">ZE_ZClient.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

68
doc/html/ZE__ZClient_8h-source.html Executable file
View File

@ -0,0 +1,68 @@
<!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>/include/ZE_ZClient.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZClient.h</h1><a href="ZE__ZClient_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zclient_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zclient_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="preprocessor">#ifdef USE_SDL_NET</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>ZE
00032 {
00033
00040 <span class="keyword">class </span>ZClient
00041 {
00042 <span class="keyword">protected</span>:
00044 ZEngine *rEngine;
00046 TCPsocket rSocket;
00048 SDLNet_SocketSet rSocketSet;
00050 <span class="keywordtype">bool</span> rVerbose;
00052 <span class="keywordtype">int</span> rWaitTime;
00053
00054 <span class="keyword">public</span>:
00061 ZClient(<span class="keywordtype">bool</span> verbose=<span class="keyword">false</span>);
00062
00068 <span class="keyword">virtual</span> ~ZClient();
00069
00078 <span class="keywordtype">bool</span> Connect(<span class="keywordtype">char</span> *server, Uint16 port);
00079
00085 <span class="keywordtype">void</span> Disconnect();
00086
00094 <span class="keywordtype">void</span> SetWaitTime(<span class="keywordtype">int</span> wait);
00095
00104 <span class="keywordtype">bool</span> Send(ZByte *data, <span class="keywordtype">int</span> size);
00105
00113 <span class="keywordtype">int</span> Receive(ZByte *data);
00114
00121 <span class="keywordtype">bool</span> Connected();
00122
00129 <span class="keywordtype">int</span> WaitTime();
00130 };
00131
00132 } <span class="comment">//namespace ZE</span>
00133
00134 <span class="preprocessor">#endif //USE_SDL_NET</span>
00135 <span class="preprocessor"></span>
00136 <span class="preprocessor">#endif //__ze_zclient_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

31
doc/html/ZE__ZClient_8h.html Executable file
View File

@ -0,0 +1,31 @@
<!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_ZClient.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZClient.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZClient_8h.html">ZE_ZClient.h</a> <br>
Description: Header file for core ZEngine TCP Client Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZClient_8h.html">ZE_ZClient.h</a>,v 1.4 2003/04/27 22:05:25 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZClient, the TCP Client class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZClient_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

31
doc/html/ZE__ZConfigFile_8cpp.html Normal file
View File

@ -0,0 +1,31 @@
<!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_ZConfigFile.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZConfigFile.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZConfigFile_8cpp.html">ZE_ZConfigFile.cpp</a> <br>
Description: Implementation source file for ZConfigFile, the ZEngine INI-Style Config File. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZConfigFile_8cpp.html">ZE_ZConfigFile.cpp</a>,v 1.7 2003/04/08 03:30:50 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZConfigFile, the ZEngine INI-Style Config File.
<p>
<code>#include "<a class="el" href="ZE__ZConfigFile_8h-source.html">ZE_ZConfigFile.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

100
doc/html/ZE__ZConfigFile_8h-source.html Normal file
View File

@ -0,0 +1,100 @@
<!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>/include/ZE_ZConfigFile.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZConfigFile.h</h1><a href="ZE__ZConfigFile_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00025 <span class="preprocessor">#ifndef __ze_zconfigfile_h__</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zconfigfile_h__</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00029
00030 <span class="keyword">namespace </span>ZE
00031 {
00032
<a name="l00038"></a><a class="code" href="classZE_1_1ZConfigFile.html">00038</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZConfigFile.html">ZConfigFile</a>
00039 {
00040 <span class="keyword">private</span>:
00041
00042 <span class="comment">//Private Types//</span>
00043
<a name="l00050"></a><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">00050</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZCF_Variable</a>
00051 {
00052 <span class="keyword">public</span>:
<a name="l00054"></a><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m0">00054</a> string <a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m0">var</a>;
<a name="l00056"></a><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m1">00056</a> string <a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m1">val</a>;
00057 };
00058
<a name="l00064"></a><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">00064</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZCF_Section</a>
00065 {
00066 <span class="keyword">public</span>:
<a name="l00068"></a><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m0">00068</a> string <a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m0">section</a>;
<a name="l00070"></a><a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m1">00070</a> list&lt;ZCF_Variable&gt; <a class="code" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m1">varList</a>;
00071 };
00072
00073 <span class="keyword">protected</span>:
<a name="l00075"></a><a class="code" href="classZE_1_1ZConfigFile.html#n0">00075</a> list&lt;ZCF_Section&gt; <a class="code" href="classZE_1_1ZConfigFile.html#n0">rFileLayout</a>;
<a name="l00077"></a><a class="code" href="classZE_1_1ZConfigFile.html#n1">00077</a> string <a class="code" href="classZE_1_1ZConfigFile.html#n1">rFilename</a>;
00078
00086 string <a class="code" href="classZE_1_1ZConfigFile.html#b0">CleanString</a>(string str) <span class="keyword">const</span>;
00087
00095 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZConfigFile.html#b1">Exists</a>(string sec) <span class="keyword">const</span>;
00096
00105 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZConfigFile.html#b1">Exists</a>(string sec, string var) <span class="keyword">const</span>;
00106
00115 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#b3">SetVariable</a>(string sec, string var, string val);
00116
00126 string <a class="code" href="classZE_1_1ZConfigFile.html#b4">GetVariable</a>(string sec, string var, string defVal) <span class="keyword">const</span>;
00127
00128 <span class="keyword">public</span>:
00129
00135 <a class="code" href="classZE_1_1ZConfigFile.html#a0">ZConfigFile</a>();
00136
00143 <a class="code" href="classZE_1_1ZConfigFile.html#a0">ZConfigFile</a>(string filename);
00144
00150 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZConfigFile.html#a2">~ZConfigFile</a>();
00151
00158 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a3">Process</a>(string filename);
00159
00170 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZConfigFile.html#a4">GetFloat</a>(string section, string var, <span class="keywordtype">float</span> defVal) <span class="keyword">const</span>;
00171
00181 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZConfigFile.html#a5">GetInt</a>(string section, string var, <span class="keywordtype">int</span> defVal) <span class="keyword">const</span>;
00182
00193 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZConfigFile.html#a6">GetBool</a>(string section, string var, <span class="keywordtype">bool</span> defVal) <span class="keyword">const</span>;
00194
00204 string <a class="code" href="classZE_1_1ZConfigFile.html#a7">GetString</a>(string section, string var, string defVal) <span class="keyword">const</span>;
00205
00216 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a8">SetFloat</a>(string section, string var, <span class="keywordtype">float</span> val);
00217
00227 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a9">SetInt</a>(string section, string var, <span class="keywordtype">int</span> val);
00228
00238 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a10">SetBool</a>(string section, string var, <span class="keywordtype">bool</span> val);
00239
00249 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a11">SetString</a>(string section, string var, string val);
00250
00256 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a12">Flush</a>();
00257
00263 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZConfigFile.html#a13">Close</a>();
00264 };
00265
00266 }
00267
00268 <span class="preprocessor">#endif //__ze_zconfigfile_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

33
doc/html/ZE__ZConfigFile_8h.html Normal file
View File

@ -0,0 +1,33 @@
<!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_ZConfigFile.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZConfigFile.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: Types/ZE_ZConfigFile.h <br>
Description: Header file for ZEngine INI-Style Config Files.<br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZConfigFile_8h.html">ZE_ZConfigFile.h</a>,v 1.9 2003/02/10 04:40:16 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZConfigFile, an INI-style Config format.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZConfigFile_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

31
doc/html/ZE__ZEngine_8cpp.html Normal file
View File

@ -0,0 +1,31 @@
<!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_ZEngine.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZEngine.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZEngine_8cpp.html">ZE_ZEngine.cpp</a> <br>
Description: Implementation source file for ZEngine library main singleton class. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZEngine_8cpp.html">ZE_ZEngine.cpp</a>,v 1.36 2003/04/27 22:05:25 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Actual implementation of ZEngine singleton class, the core of ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

238
doc/html/ZE__ZEngine_8h-source.html Normal file
View File

@ -0,0 +1,238 @@
<!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>/include/ZE_ZEngine.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZEngine.h</h1><a href="ZE__ZEngine_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zengine_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zengine_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__Defines_8h.html">ZE_Defines.h</a>"</span>
00028 <span class="preprocessor">#include "<a class="code" href="ZE__Utility_8h.html">ZE_Utility.h</a>"</span>
00029 <span class="preprocessor">#include "<a class="code" href="ZE__Includes_8h.html">ZE_Includes.h</a>"</span>
00030 <span class="preprocessor">#include "<a class="code" href="ZE__ZError_8h.html">ZE_ZError.h</a>"</span>
00031
00037 <span class="keyword">namespace </span>ZE
00038 {
00039
<a name="l00046"></a><a class="code" href="classZE_1_1ZEngine.html">00046</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>
00047 {
00048
00049 <span class="keyword">private</span>:
00051 <span class="keyword">static</span> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a> *<a class="code" href="classZE_1_1ZEngine.html#r0">sInstance</a>;
<a name="l00053"></a><a class="code" href="classZE_1_1ZEngine.html#o0">00053</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#o0">mWidth</a>;
<a name="l00055"></a><a class="code" href="classZE_1_1ZEngine.html#o1">00055</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#o1">mHeight</a>;
<a name="l00057"></a><a class="code" href="classZE_1_1ZEngine.html#o2">00057</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#o2">mBPP</a>;
<a name="l00059"></a><a class="code" href="classZE_1_1ZEngine.html#o3">00059</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o3">mFullscreen</a>;
<a name="l00061"></a><a class="code" href="classZE_1_1ZEngine.html#o4">00061</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o4">mInitialized</a>;
<a name="l00063"></a><a class="code" href="classZE_1_1ZEngine.html#o5">00063</a> SDL_Surface *<a class="code" href="classZE_1_1ZEngine.html#o5">mScreen</a>;
<a name="l00065"></a><a class="code" href="classZE_1_1ZEngine.html#o6">00065</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o6">mPaused</a>;
<a name="l00067"></a><a class="code" href="classZE_1_1ZEngine.html#o7">00067</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o7">mUnpauseOnActive</a>;
<a name="l00069"></a><a class="code" href="classZE_1_1ZEngine.html#o8">00069</a> Uint8 <a class="code" href="classZE_1_1ZEngine.html#o8">mDesiredFramerate</a>;
<a name="l00071"></a><a class="code" href="classZE_1_1ZEngine.html#o9">00071</a> Uint32 <a class="code" href="classZE_1_1ZEngine.html#o9">mNextUpdate</a>;
<a name="l00073"></a><a class="code" href="classZE_1_1ZEngine.html#o10">00073</a> Uint32 <a class="code" href="classZE_1_1ZEngine.html#o10">mLastPause</a>;
<a name="l00075"></a><a class="code" href="classZE_1_1ZEngine.html#o11">00075</a> Uint32 <a class="code" href="classZE_1_1ZEngine.html#o11">mPausedTime</a>;
<a name="l00077"></a><a class="code" href="classZE_1_1ZEngine.html#o12">00077</a> Uint32 <a class="code" href="classZE_1_1ZEngine.html#o12">mLastTime</a>;
<a name="l00079"></a><a class="code" href="classZE_1_1ZEngine.html#o13">00079</a> <span class="keywordtype">double</span> <a class="code" href="classZE_1_1ZEngine.html#o13">mSecPerFrame</a>;
<a name="l00081"></a><a class="code" href="classZE_1_1ZEngine.html#o14">00081</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o14">mNeedReload</a>;
<a name="l00083"></a><a class="code" href="classZE_1_1ZEngine.html#o15">00083</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o15">mActive</a>;
<a name="l00085"></a><a class="code" href="classZE_1_1ZEngine.html#o16">00085</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o16">mQuit</a>;
<a name="l00087"></a><a class="code" href="classZE_1_1ZEngine.html#o17">00087</a> Uint8 *<a class="code" href="classZE_1_1ZEngine.html#o17">mKeyIsPressed</a>;
<a name="l00089"></a><a class="code" href="classZE_1_1ZEngine.html#o18">00089</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o18">mKeyPress</a>[SDLK_LAST];
<a name="l00091"></a><a class="code" href="classZE_1_1ZEngine.html#o19">00091</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#o19">mMouseX</a>;
<a name="l00093"></a><a class="code" href="classZE_1_1ZEngine.html#o20">00093</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#o20">mMouseY</a>;
<a name="l00095"></a><a class="code" href="classZE_1_1ZEngine.html#o21">00095</a> Uint8 <a class="code" href="classZE_1_1ZEngine.html#o21">mMouseB</a>;
<a name="l00097"></a><a class="code" href="classZE_1_1ZEngine.html#o22">00097</a> queue&lt;ZError&gt; <a class="code" href="classZE_1_1ZEngine.html#o22">mErrorQueue</a>;
<a name="l00099"></a><a class="code" href="classZE_1_1ZEngine.html#o23">00099</a> <a class="code" href="classZE_1_1ZError.html">ZError</a> <a class="code" href="classZE_1_1ZEngine.html#o23">mCurError</a>;
<a name="l00101"></a><a class="code" href="classZE_1_1ZEngine.html#o24">00101</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o24">mLogAllErrors</a>;
<a name="l00103"></a><a class="code" href="classZE_1_1ZEngine.html#o25">00103</a> FILE *<a class="code" href="classZE_1_1ZEngine.html#o25">mErrlog</a>;
00104
00105 <span class="preprocessor">#ifdef USE_SDL_MIXER </span>
00106 <span class="preprocessor"></span>
<a name="l00107"></a><a class="code" href="classZE_1_1ZEngine.html#o26">00107</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#o26">mRate</a>;
<a name="l00109"></a><a class="code" href="classZE_1_1ZEngine.html#o27">00109</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#o27">mStereo</a>;
00110 <span class="preprocessor">#endif </span>
00111 <span class="preprocessor"></span>
00113 <span class="comment">//Singleton + Memory Management//</span>
00115 <span class="comment"></span>
00116 <span class="keyword">private</span>:
00122 <a class="code" href="classZE_1_1ZEngine.html#c0">ZEngine</a>();
00123
00124 <span class="keyword">public</span>:
00125
00132 <span class="keyword">static</span> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZEngine.html#d0">GetInstance</a>();
00133
00139 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#d1">ReleaseInstance</a>();
00140
00147 <span class="keyword">static</span> string <a class="code" href="classZE_1_1ZEngine.html#d2">GetVersion</a>();
00148
00150 <span class="comment">//Initialization//</span>
00152 <span class="comment"></span>
00163 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a0">SetupDisplay</a>(<span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height, <span class="keywordtype">int</span> bpp, <span class="keywordtype">bool</span> fullscreen);
00164
00165 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00166 <span class="preprocessor"></span>
00174 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a1">SetupSound</a>(<span class="keywordtype">int</span> rate, <span class="keywordtype">bool</span> stereo);
00175 <span class="preprocessor">#endif </span>
00176 <span class="preprocessor"></span>
00188 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a2">CreateDisplay</a>(string title, string icon=<span class="stringliteral">""</span>);
00189
00195 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a3">CloseDisplay</a>();
00196
00204 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a4">ToggleFullscreen</a>();
00205
00213 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a5">Initialized</a>();
00214
00216 <span class="comment">//Screen Access//</span>
00218 <span class="comment"></span>
00225 <span class="comment"></span> SDL_Surface *<a class="code" href="classZE_1_1ZEngine.html#a6">Display</a>();
00226
00233 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a7">Update</a>();
00234
00244 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a8">Clear</a>(<span class="keywordtype">float</span> red=0.0f, <span class="keywordtype">float</span> green=0.0f, <span class="keywordtype">float</span> blue=0.0f, <span class="keywordtype">float</span> alpha=1.0f);
00245
00247 <span class="comment">//OpenGL Specific Functions//</span>
00249 <span class="comment"></span>
00256 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a9">SetGL2D</a>();
00257
00259 <span class="comment">//Timer and Framerate Independent Movement//</span>
00261 <span class="comment"></span>
00268 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a10">Delay</a>(Uint32 milliseconds);
00269
00276 Uint32 <a class="code" href="classZE_1_1ZEngine.html#a11">GetTime</a>();
00277
00283 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a12">PauseTimer</a>();
00284
00290 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a13">UnpauseTimer</a>();
00291
00298 <span class="keywordtype">double</span> <a class="code" href="classZE_1_1ZEngine.html#a14">GetFrameTime</a>();
00299
00307 <span class="keywordtype">double</span> <a class="code" href="classZE_1_1ZEngine.html#a15">GetFramerate</a>();
00308
00318 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a16">SetDesiredFramerate</a>(Uint8 rate);
00319
00327 Uint8 <a class="code" href="classZE_1_1ZEngine.html#a17">GetDesiredFramerate</a>();
00328
00335 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a18">IsPaused</a>();
00336
00338 <span class="comment">//Event and Input Handling//</span>
00340 <span class="comment"></span>
00347 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a19">IsActive</a>();
00348
00355 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a20">RequestQuit</a>();
00356
00364 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a21">QuitRequested</a>();
00365
00370 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a22">SetReloadNeed</a>(<span class="keywordtype">bool</span> state);
00371
00379 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a23">ImagesNeedReload</a>();
00380
00389 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a24">SetKeyRepeatRate</a>(<span class="keywordtype">int</span> rate);
00390
00398 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a25">KeyIsPressed</a>(SDLKey key);
00399
00407 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a26">KeyPress</a>(SDLKey key);
00408
00414 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a27">HideCursor</a>();
00415
00421 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a28">ShowCursor</a>();
00422
00429 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#a29">MouseX</a>();
00430
00437 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#a30">MouseY</a>();
00438
00445 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a31">LButtonPressed</a>();
00446
00453 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a32">RButtonPressed</a>();
00454
00462 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a33">MouseInRect</a>(SDL_Rect *rect);
00463
00469 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a34">CheckEvents</a>();
00470
00481 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a35">SetEventFilter</a>(SDL_EventFilter filter);
00482
00483 <span class="preprocessor">#ifdef USE_PHYSFS</span>
00484 <span class="preprocessor"></span>
00485 <span class="comment">//Physfs Utilities//</span>
00487 <span class="comment"></span>
00493 <span class="comment"></span> <span class="keywordtype">void</span> InitPhysFS(string argv);
00494
00501 <span class="keywordtype">void</span> AddPhysFSDir(string dir);
00502
00503 <span class="preprocessor">#endif //USE_PHYSFS</span>
00504 <span class="preprocessor"></span>
00506 <span class="comment">//Error Logging//</span>
00508 <span class="comment"> private:</span>
00516 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#c1">LogError</a>(<a class="code" href="classZE_1_1ZError.html">ZError</a> error);
00517
00518 <span class="keyword">public</span>:
00529 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a36">SetErrorLog</a>(<span class="keywordtype">bool</span> logAll, string logFile=<span class="stringliteral">""</span>);
00530
00541 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a37">ReportError</a>(ZErrorCode code, string desc=<span class="stringliteral">""</span>, string file=<span class="stringliteral">""</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> line=0);
00542
00550 <a class="code" href="namespaceZE.html#a20">ZErrorCode</a> <a class="code" href="classZE_1_1ZEngine.html#a38">GetLastError</a>();
00551
00559 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a39">WriteLog</a>(string str);
00560
00567 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a40">FlushErrors</a>();
00568
00570 <span class="comment">//Random Number Generation//</span>
00572 <span class="comment"></span>
00580 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZEngine.html#a41">SeedRandom</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> seed);
00581
00590 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classZE_1_1ZEngine.html#a42">RandLong</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> max);
00591
00601 <span class="keywordtype">long</span> <a class="code" href="classZE_1_1ZEngine.html#a42">RandLong</a>(<span class="keywordtype">long</span> min, <span class="keywordtype">long</span> max);
00602
00610 <span class="keywordtype">double</span> <a class="code" href="classZE_1_1ZEngine.html#a44">RandDouble</a>();
00611
00621 <span class="keywordtype">double</span> <a class="code" href="classZE_1_1ZEngine.html#a44">RandDouble</a>(<span class="keywordtype">double</span> min, <span class="keywordtype">double</span> max);
00622
00624 <span class="comment">//Data Loading + Unloading//</span>
00626 <span class="comment"></span>
00633 <span class="comment"></span> SDL_Surface* <a class="code" href="classZE_1_1ZEngine.html#a46">LoadImage</a>(string filename);
00634
00635 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00636 <span class="preprocessor"></span>
00643 Mix_Chunk* <a class="code" href="classZE_1_1ZEngine.html#a47">LoadSound</a>(string filename);
00644
00652 Mix_Music* <a class="code" href="classZE_1_1ZEngine.html#a48">LoadMusic</a>(string filename);
00653 <span class="preprocessor">#endif</span>
00654 <span class="preprocessor"></span>
00655 <span class="preprocessor">#ifdef USE_SDL_TTF</span>
00656 <span class="preprocessor"></span>
00664 TTF_Font* <a class="code" href="classZE_1_1ZEngine.html#a49">LoadFont</a>(string filename, <span class="keywordtype">int</span> size);
00665 <span class="preprocessor">#endif </span>
00666 <span class="preprocessor"></span>
00668 <span class="comment">//Accessors//</span>
00670 <span class="comment"></span>
00677 <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#a50">Width</a>();
00678
00685 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#a51">Height</a>();
00686
00693 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZEngine.html#a52">BPP</a>();
00694
00701 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZEngine.html#a53">IsFullscreen</a>();
00702 };
00703
00704 }
00705
00706 <span class="preprocessor">#endif //__ze_zengine_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

36
doc/html/ZE__ZEngine_8h.html Normal file
View File

@ -0,0 +1,36 @@
<!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_ZEngine.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZEngine.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a> <br>
Description: Header file for ZEngine class, the core of the ZEngine. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>,v 1.22 2003/04/27 21:50:47 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
ZEngine Game Engine core Engine definition.
<p>
<code>#include "<a class="el" href="ZE__Defines_8h-source.html">ZE_Defines.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__Utility_8h-source.html">ZE_Utility.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__Includes_8h-source.html">ZE_Includes.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZError_8h-source.html">ZE_ZError.h</a>"</code><br>
<p>
<a href="ZE__ZEngine_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

31
doc/html/ZE__ZError_8cpp.html Executable file
View File

@ -0,0 +1,31 @@
<!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_ZError.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZError.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__ZError_8cpp.html">ZE_ZError.cpp</a> <br>
Description: Implementation source file for core ZEngine Error Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZError_8cpp.html">ZE_ZError.cpp</a>,v 1.5 2003/03/01 20:43:41 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZError, the ZEngine internal error information storage class.
<p>
<code>#include "<a class="el" href="ZE__ZError_8h-source.html">ZE_ZError.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

88
doc/html/ZE__ZError_8h-source.html Executable file
View File

@ -0,0 +1,88 @@
<!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>/include/ZE_ZError.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZError.h</h1><a href="ZE__ZError_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00025 <span class="preprocessor">#ifndef __ze_zerror_h__</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zerror_h__</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include "<a class="code" href="ZE__Utility_8h.html">ZE_Utility.h</a>"</span>
00029 <span class="preprocessor">#include &lt;string&gt;</span>
00030 <span class="keyword">using</span> <span class="keyword">namespace </span>std;
00031
00032 <span class="keyword">namespace </span>ZE
00033 {
00034
00036
<a name="l00040"></a><a class="code" href="namespaceZE.html#a20">00040</a> <span class="keyword">enum</span> <a class="code" href="namespaceZE.html#a20">ZErrorCode</a>
00041 {
00042 <a class="code" href="namespaceZE.html#a20a0">ZERR_NONE</a>,
00043 <a class="code" href="namespaceZE.html#a20a1">ZERR_SDL_INTERNAL</a>,
00044 <a class="code" href="namespaceZE.html#a20a2">ZERR_SDL_INIT</a>,
00045 <a class="code" href="namespaceZE.html#a20a3">ZERR_MIX_INIT</a>,
00046 <a class="code" href="namespaceZE.html#a20a4">ZERR_TTF_INIT</a>,
00047 <a class="code" href="namespaceZE.html#a20a5">ZERR_NET_INIT</a>,
00048 <a class="code" href="namespaceZE.html#a20a6">ZERR_VIDMODE</a>,
00049 <a class="code" href="namespaceZE.html#a20a7">ZERR_LOAD_IMAGE</a>,
00050 <a class="code" href="namespaceZE.html#a20a8">ZERR_LOAD_SOUND</a>,
00051 <a class="code" href="namespaceZE.html#a20a9">ZERR_LOAD_MUSIC</a>,
00052 <a class="code" href="namespaceZE.html#a20a10">ZERR_LOAD_FONT</a>,
00053 <a class="code" href="namespaceZE.html#a20a11">ZERR_NOIMAGE</a>,
00054 <a class="code" href="namespaceZE.html#a20a12">ZERR_NOSOUND</a>,
00055 <a class="code" href="namespaceZE.html#a20a13">ZERR_NOMUSIC</a>,
00056 <a class="code" href="namespaceZE.html#a20a14">ZERR_NOFONT</a>,
00057 <a class="code" href="namespaceZE.html#a20a15">ZERR_NOSOCKET</a>,
00058 <a class="code" href="namespaceZE.html#a20a16">ZERR_NET_CLIENT</a>,
00059 <a class="code" href="namespaceZE.html#a20a17">ZERR_NET_SERVER</a>,
00060 <a class="code" href="namespaceZE.html#a20a18">ZERR_LAST</a>
00061 };
00062
<a name="l00069"></a><a class="code" href="classZE_1_1ZError.html">00069</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZError.html">ZError</a>
00070 {
00071 <span class="keyword">protected</span>:
00073 <span class="keyword">static</span> string *<a class="code" href="classZE_1_1ZError.html#q0">sErrorDesc</a>;
<a name="l00075"></a><a class="code" href="classZE_1_1ZError.html#n0">00075</a> <a class="code" href="namespaceZE.html#a20">ZErrorCode</a> <a class="code" href="classZE_1_1ZError.html#n0">rCode</a>;
<a name="l00077"></a><a class="code" href="classZE_1_1ZError.html#n1">00077</a> string <a class="code" href="classZE_1_1ZError.html#n1">rDescription</a>;
<a name="l00079"></a><a class="code" href="classZE_1_1ZError.html#n2">00079</a> string <a class="code" href="classZE_1_1ZError.html#n2">rFilename</a>;
<a name="l00081"></a><a class="code" href="classZE_1_1ZError.html#n3">00081</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZError.html#n3">rLine</a>;
00082
00083 <span class="keyword">public</span>:
00089 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZError.html#d0">CreateStringTable</a>();
00090
00096 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZError.html#d1">DestroyStringTable</a>();
00097
00107 <a class="code" href="classZE_1_1ZError.html#a0">ZError</a>(ZErrorCode code=ZERR_NONE, string desc=<span class="stringliteral">""</span>, string file=<span class="stringliteral">""</span>, <span class="keywordtype">int</span> line=0);
00108
00114 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZError.html#a1">~ZError</a>();
00115
00125 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZError.html#a2">Create</a>(ZErrorCode code, string desc=<span class="stringliteral">""</span>, string file=<span class="stringliteral">""</span>, <span class="keywordtype">int</span> line=0);
00126
00128 <span class="comment">//Accessors//</span>
00130 <span class="comment"></span>
00137 <span class="comment"></span> <a class="code" href="namespaceZE.html#a20">ZErrorCode</a> <a class="code" href="classZE_1_1ZError.html#a3">Code</a>() <span class="keyword">const</span>;
00138
00144 string <a class="code" href="classZE_1_1ZError.html#a4">LogString</a>() <span class="keyword">const</span>;
00145 };
00146
00147 }
00148
00149 <span class="preprocessor">#endif //__ze_zerror_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

34
doc/html/ZE__ZError_8h.html Executable file
View File

@ -0,0 +1,34 @@
<!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_ZError.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZError.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZError_8h.html">ZE_ZError.h</a> <br>
Description: Header file for ZEngine Error Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZError_8h.html">ZE_ZError.h</a>,v 1.7 2003/03/01 20:42:52 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZError, the Error logging class for ZEngine. This class should never be used by the average user, it is used by ZEngine to store information on an error.
<p>
<code>#include "<a class="el" href="ZE__Utility_8h-source.html">ZE_Utility.h</a>"</code><br>
<code>#include &lt;string&gt;</code><br>
<p>
<a href="ZE__ZError_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

29
doc/html/ZE__ZFont_8cpp.html Normal file
View File

@ -0,0 +1,29 @@
<!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.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZFont.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZFont_8cpp.html">ZE_ZFont.cpp</a> <br>
Description: Implementation source file for core ZEngine Font Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZFont_8cpp.html">ZE_ZFont.cpp</a>,v 1.8 2003/04/08 03:34:25 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZFont, the basic Font class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZFont_8h-source.html">ZE_ZFont.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

96
doc/html/ZE__ZFont_8h-source.html Normal file
View File

@ -0,0 +1,96 @@
<!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>/include/ZE_ZFont.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZFont.h</h1><a href="ZE__ZFont_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zfont_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zfont_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028 <span class="preprocessor">#include "<a class="code" href="ZE__ZImage_8h.html">ZE_ZImage.h</a>"</span>
00029
00030 <span class="preprocessor">#ifdef USE_SDL_TTF</span>
00031 <span class="preprocessor"></span>
00032 <span class="keyword">namespace </span>ZE
00033 {
00034
<a name="l00040"></a><a class="code" href="classZE_1_1ZFont.html">00040</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZFont.html">ZFont</a>
00041 {
00042 <span class="keyword">protected</span>:
<a name="l00044"></a><a class="code" href="classZE_1_1ZFont.html#n0">00044</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZFont.html#n0">rEngine</a>;
<a name="l00046"></a><a class="code" href="classZE_1_1ZFont.html#n1">00046</a> TTF_Font *<a class="code" href="classZE_1_1ZFont.html#n1">rFont</a>;
<a name="l00048"></a><a class="code" href="classZE_1_1ZFont.html#n2">00048</a> string <a class="code" href="classZE_1_1ZFont.html#n2">rFilename</a>;
<a name="l00050"></a><a class="code" href="classZE_1_1ZFont.html#n3">00050</a> SDL_Color <a class="code" href="classZE_1_1ZFont.html#n3">rColor</a>;
<a name="l00052"></a><a class="code" href="classZE_1_1ZFont.html#n4">00052</a> SDL_Color <a class="code" href="classZE_1_1ZFont.html#n4">rBGColor</a>;
00053
00054 <span class="keyword">public</span>:
00055
00057 <span class="comment">//Opening and Closing//</span>
00059 <span class="comment"></span>
00065 <span class="comment"></span> <a class="code" href="classZE_1_1ZFont.html#a0">ZFont</a>();
00066
00074 <a class="code" href="classZE_1_1ZFont.html#a0">ZFont</a>(string filename, <span class="keywordtype">int</span> size);
00075
00081 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZFont.html#a2">~ZFont</a>();
00082
00090 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a3">Open</a>(string filename, <span class="keywordtype">int</span> size);
00091
00097 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a4">Release</a>();
00098
00100 <span class="comment">//Settings and Drawing//</span>
00102 <span class="comment"></span>
00110 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a5">DrawText</a>(string text, <a class="code" href="classZE_1_1ZImage.html">ZImage</a> &amp;image) <span class="keyword">const</span>;
00111
00119 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a6">DrawShadedText</a>(string text, <a class="code" href="classZE_1_1ZImage.html">ZImage</a> &amp;image) <span class="keyword">const</span>;
00120
00129 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a7">SetColor</a>(Uint8 r, Uint8 g, Uint8 b);
00130
00139 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a8">SetBGColor</a>(Uint8 r, Uint8 g, Uint8 b);
00140
00149 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a9">SetStyle</a>(<span class="keywordtype">bool</span> bold, <span class="keywordtype">bool</span> italic, <span class="keywordtype">bool</span> underline);
00150
00157 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZFont.html#a10">Resize</a>(<span class="keywordtype">int</span> size);
00158
00160 <span class="comment">//Accessors//</span>
00162 <span class="comment"></span>
00169 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZFont.html#a11">IsLoaded</a>() <span class="keyword">const</span>;
00170
00177 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZFont.html#a12">IsBold</a>() <span class="keyword">const</span>;
00178
00185 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZFont.html#a13">IsItalic</a>() <span class="keyword">const</span>;
00186
00193 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZFont.html#a14">IsUnderlined</a>() <span class="keyword">const</span>;
00194
00201 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZFont.html#a15">Height</a>() <span class="keyword">const</span>;
00202
00209 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZFont.html#a16">LineSkip</a>() <span class="keyword">const</span>;
00210
00218 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZFont.html#a17">StringWidth</a>(string text) <span class="keyword">const</span>;
00219
00227 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZFont.html#a18">StringHeight</a>(string text) <span class="keyword">const</span>;
00228 };
00229
00230 }
00231
00232 <span class="preprocessor">#endif //USE_SDL_TTF</span>
00233 <span class="preprocessor"></span>
00234 <span class="preprocessor">#endif //__ze_zfont_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

34
doc/html/ZE__ZFont_8h.html Normal file
View File

@ -0,0 +1,34 @@
<!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.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZFont.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZFont_8h.html">ZE_ZFont.h</a> <br>
Description: Header file for core ZEngine Font Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZFont_8h.html">ZE_ZFont.h</a>,v 1.6 2003/02/10 04:40:16 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZFont, the basic Font class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a>"</code><br>
<p>
<a href="ZE__ZFont_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

31
doc/html/ZE__ZImage_8cpp.html Normal file
View File

@ -0,0 +1,31 @@
<!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_ZImage.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZImage.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZImage_8cpp.html">ZE_ZImage.cpp</a> <br>
Description: Implementation source file for core ZEngine Image or Texture Object. <br>
Author(s): James Turk, Gamer Tazar <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZImage_8cpp.html">ZE_ZImage.cpp</a>,v 1.30 2003/04/18 21:52:49 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZImage, the Image class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

114
doc/html/ZE__ZImage_8h-source.html Normal file
View File

@ -0,0 +1,114 @@
<!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>/include/ZE_ZImage.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZImage.h</h1><a href="ZE__ZImage_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zimage_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zimage_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="keyword">namespace </span>ZE
00030 {
00031
<a name="l00037"></a><a class="code" href="classZE_1_1ZImage.html">00037</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZImage.html">ZImage</a>
00038 {
00039 <span class="keyword">protected</span>:
<a name="l00041"></a><a class="code" href="classZE_1_1ZImage.html#n0">00041</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZImage.html#n0">rEngine</a>;
<a name="l00043"></a><a class="code" href="classZE_1_1ZImage.html#n1">00043</a> GLfloat <a class="code" href="classZE_1_1ZImage.html#n1">rTexMinX</a>;
<a name="l00045"></a><a class="code" href="classZE_1_1ZImage.html#n2">00045</a> GLfloat <a class="code" href="classZE_1_1ZImage.html#n2">rTexMinY</a>;
<a name="l00047"></a><a class="code" href="classZE_1_1ZImage.html#n3">00047</a> GLfloat <a class="code" href="classZE_1_1ZImage.html#n3">rTexMaxX</a>;
<a name="l00049"></a><a class="code" href="classZE_1_1ZImage.html#n4">00049</a> GLfloat <a class="code" href="classZE_1_1ZImage.html#n4">rTexMaxY</a>;
<a name="l00051"></a><a class="code" href="classZE_1_1ZImage.html#n5">00051</a> SDL_Surface *<a class="code" href="classZE_1_1ZImage.html#n5">rImage</a>;
<a name="l00053"></a><a class="code" href="classZE_1_1ZImage.html#n6">00053</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZImage.html#n6">rTexID</a>;
<a name="l00055"></a><a class="code" href="classZE_1_1ZImage.html#n7">00055</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZImage.html#n7">rWidth</a>;
<a name="l00057"></a><a class="code" href="classZE_1_1ZImage.html#n8">00057</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZImage.html#n8">rHeight</a>;
<a name="l00059"></a><a class="code" href="classZE_1_1ZImage.html#n9">00059</a> Uint8 <a class="code" href="classZE_1_1ZImage.html#n9">rAlpha</a>;
00060
00061 <span class="keyword">public</span>:
00062
00068 <a class="code" href="classZE_1_1ZImage.html#a0">ZImage</a>();
00069
00076 <a class="code" href="classZE_1_1ZImage.html#a0">ZImage</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZImage.html">ZImage</a> &amp;rhs);
00077
00084 <a class="code" href="classZE_1_1ZImage.html#a0">ZImage</a>(string filename);
00085
00092 <a class="code" href="classZE_1_1ZImage.html#a0">ZImage</a>(SDL_Surface *surface);
00093
00105 <a class="code" href="classZE_1_1ZImage.html#a0">ZImage</a>(SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
00106
00118 <a class="code" href="classZE_1_1ZImage.html#a0">ZImage</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZImage.html">ZImage</a> &amp;img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
00119
00125 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZImage.html#a6">~ZImage</a>();
00126
00128 <span class="comment">//Opening and Closing//</span>
00130 <span class="comment"></span>
00137 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a7">Open</a>(string filename);
00138
00150 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a8">OpenFromImage</a>(SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
00151
00163 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a8">OpenFromImage</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZImage.html">ZImage</a> &amp;img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
00164
00171 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a10">Attach</a>(SDL_Surface *surface);
00172
00178 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a11">Reload</a>();
00179
00185 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a12">Release</a>();
00186
00188 <span class="comment">//Graphics//</span>
00190 <span class="comment"></span>
00198 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a13">SetAlpha</a>(Uint8 alpha);
00199
00208 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a14">SetColorKey</a>(Uint8 red, Uint8 green, Uint8 blue);
00209
00217 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a15">Flip</a>(<span class="keywordtype">bool</span> horizontal, <span class="keywordtype">bool</span> vertical);
00218
00226 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a16">Stretch</a>(<span class="keywordtype">float</span> xFactor, <span class="keywordtype">float</span> yFactor);
00227
00235 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a17">Resize</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> width, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> height);
00236
00243 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a18">Bind</a>() <span class="keyword">const</span>;
00244
00252 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a19">Draw</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">const</span>;
00253
00262 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a19">Draw</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y) <span class="keyword">const</span>;
00263
00272 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a21">DrawRotated</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">float</span> angle) <span class="keyword">const</span>;
00273
00283 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZImage.html#a21">DrawRotated</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> angle) <span class="keyword">const</span>;
00284
00286 <span class="comment">//Accessors//</span>
00288 <span class="comment"></span>
00295 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZImage.html#a23">IsLoaded</a>() <span class="keyword">const</span>;
00296
00302 SDL_Surface *<a class="code" href="classZE_1_1ZImage.html#a24">Surface</a>() <span class="keyword">const</span>;
00303
00310 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZImage.html#a25">Width</a>() <span class="keyword">const</span>;
00311
00318 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZImage.html#a26">Height</a>() <span class="keyword">const</span>;
00319
00327 Uint8 <a class="code" href="classZE_1_1ZImage.html#a27">Alpha</a>() <span class="keyword">const</span>;
00328 };
00329
00330 }
00331
00332 <span class="preprocessor">#endif</span>
</pre></div><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>

33
doc/html/ZE__ZImage_8h.html Normal file
View File

@ -0,0 +1,33 @@
<!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_ZImage.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZImage.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__ZImage_8h.html">ZE_ZImage.h</a> <br>
Description: Header file for core ZEngine Image and Texture Object. <br>
Author(s): James Turk, Gamer Tazar <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZImage_8h.html">ZE_ZImage.h</a>,v 1.16 2003/02/10 05:26:18 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZImage, the OpenGL version of the ZImage class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZImage_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

29
doc/html/ZE__ZMusic_8cpp.html Normal file
View File

@ -0,0 +1,29 @@
<!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_ZMusic.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZMusic.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__ZMusic_8cpp.html">ZE_ZMusic.cpp</a> <br>
Description: Implementation source file for core ZEngine Music Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZMusic_8cpp.html">ZE_ZMusic.cpp</a>,v 1.6 2003/02/10 04:02:38 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZMusic, the basic Music class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZMusic_8h-source.html">ZE_ZMusic.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

86
doc/html/ZE__ZMusic_8h-source.html Normal file
View File

@ -0,0 +1,86 @@
<!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>/include/ZE_ZMusic.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZMusic.h</h1><a href="ZE__ZMusic_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zmusic_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zmusic_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>ZE
00032 {
00033
<a name="l00039"></a><a class="code" href="classZE_1_1ZMusic.html">00039</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZMusic.html">ZMusic</a>
00040 {
00041 <span class="keyword">protected</span>:
<a name="l00043"></a><a class="code" href="classZE_1_1ZMusic.html#n0">00043</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZMusic.html#n0">rEngine</a>;
<a name="l00045"></a><a class="code" href="classZE_1_1ZMusic.html#n1">00045</a> Mix_Music *<a class="code" href="classZE_1_1ZMusic.html#n1">rMusic</a>;
00046
00047 <span class="keyword">public</span>:
<a name="l00049"></a><a class="code" href="classZE_1_1ZMusic.html#p0">00049</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZMusic.html#p0">LoopInfinite</a>;
00050
00052 <span class="comment">//Opening and Closing//</span>
00054 <span class="comment"></span>
00060 <span class="comment"></span> <a class="code" href="classZE_1_1ZMusic.html#a0">ZMusic</a>();
00061
00068 <a class="code" href="classZE_1_1ZMusic.html#a0">ZMusic</a>(string filename);
00069
00075 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZMusic.html#a2">~ZMusic</a>();
00076
00083 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a3">Open</a>(string filename);
00084
00090 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a4">Release</a>();
00091
00093 <span class="comment">//Play Controls//</span>
00095 <span class="comment"></span>
00104 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a5">Play</a>(<span class="keywordtype">int</span> loopNum=0, <span class="keywordtype">int</span> fadeTime=0) <span class="keyword">const</span>;
00105
00111 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a6">Pause</a>() <span class="keyword">const</span>;
00112
00118 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a7">Unpause</a>() <span class="keyword">const</span>;
00119
00125 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a8">Rewind</a>() <span class="keyword">const</span>;
00126
00133 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a9">Stop</a>(<span class="keywordtype">int</span> fadeTime=0) <span class="keyword">const</span>;
00134
00141 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a10">SetVolume</a>(<span class="keywordtype">int</span> volume);
00142
00144 <span class="comment">//Accessors//</span>
00146 <span class="comment"></span>
00153 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a11">IsLoaded</a>() <span class="keyword">const</span>;
00154
00161 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a12">IsPlaying</a>() <span class="keyword">const</span>;
00162
00169 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a13">IsPaused</a>() <span class="keyword">const</span>;
00170
00177 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZMusic.html#a14">Volume</a>() <span class="keyword">const</span>;
00178 };
00179
00180
00181 }
00182
00183 <span class="preprocessor">#endif //USE_SDL_MIXER</span>
00184 <span class="preprocessor"></span>
00185 <span class="preprocessor">#endif //__ze_zmusic_h__</span>
</pre></div><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>

33
doc/html/ZE__ZMusic_8h.html Normal file
View File

@ -0,0 +1,33 @@
<!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_ZMusic.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZMusic.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZMusic_8h.html">ZE_ZMusic.h</a> <br>
Description: Header file for core ZEngine Music Wrapper Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZMusic_8h.html">ZE_ZMusic.h</a>,v 1.6 2003/02/10 04:40:16 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZMusic, the Music file wrapper for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZMusic_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

31
doc/html/ZE__ZRect_8cpp.html Normal file
View File

@ -0,0 +1,31 @@
<!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_ZRect.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZRect.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZRect_8cpp.html">ZE_ZRect.cpp</a> <br>
Description: Implementation source file for core ZEngine Rectangle Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZRect_8cpp.html">ZE_ZRect.cpp</a>,v 1.9 2003/02/10 05:40:28 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZRect, the Rectangle class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZRect_8h-source.html">ZE_ZRect.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

96
doc/html/ZE__ZRect_8h-source.html Normal file
View File

@ -0,0 +1,96 @@
<!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>/include/ZE_ZRect.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZRect.h</h1><a href="ZE__ZRect_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zrect_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zrect_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="keyword">namespace </span>ZE
00030 {
00031
<a name="l00037"></a><a class="code" href="classZE_1_1ZRect.html">00037</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZRect.html">ZRect</a>
00038 {
00039 <span class="keyword">protected</span>:
<a name="l00041"></a><a class="code" href="classZE_1_1ZRect.html#n0">00041</a> <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#n0">rX</a>;
<a name="l00043"></a><a class="code" href="classZE_1_1ZRect.html#n1">00043</a> <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#n1">rY</a>;
<a name="l00045"></a><a class="code" href="classZE_1_1ZRect.html#n2">00045</a> <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#n2">rWidth</a>;
<a name="l00047"></a><a class="code" href="classZE_1_1ZRect.html#n3">00047</a> <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#n3">rHeight</a>;
00048
00049 <span class="keyword">public</span>:
00050
00056 <a class="code" href="classZE_1_1ZRect.html#a0">ZRect</a>();
00057
00067 <a class="code" href="classZE_1_1ZRect.html#a0">ZRect</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> width, <span class="keywordtype">float</span> height);
00068
00075 <a class="code" href="classZE_1_1ZRect.html#a0">ZRect</a>(<span class="keyword">const</span> SDL_Rect &amp;rect);
00076
00083 <a class="code" href="classZE_1_1ZRect.html#a0">ZRect</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a> &amp;rhs);
00084
00092 <span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a>&amp; <a class="code" href="classZE_1_1ZRect.html#a4">operator=</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a> &amp;rhs);
00093
00099 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZRect.html#a5">~ZRect</a>();
00100
00109 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZRect.html#a6">operator&lt;</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a> &amp;rhs) <span class="keyword">const</span>;
00110
00120 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZRect.html#a7">Draw</a>(Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) <span class="keyword">const</span>;
00121
00129 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZRect.html#a8">Move</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y);
00130
00138 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZRect.html#a9">MoveRel</a>(<span class="keywordtype">float</span> xMove, <span class="keywordtype">float</span> yMove);
00139
00147 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZRect.html#a10">Resize</a>(<span class="keywordtype">float</span> width, <span class="keywordtype">float</span> height);
00148
00156 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZRect.html#a11">ResizeRel</a>(<span class="keywordtype">float</span> widthChange, <span class="keywordtype">float</span> heightChange);
00157
00165 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZRect.html#a12">Intersects</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a> &amp;rect) <span class="keyword">const</span>;
00166
00175 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZRect.html#a13">Contains</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y) <span class="keyword">const</span>;
00176
00184 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZRect.html#a13">Contains</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a> &amp;rect) <span class="keyword">const</span>;
00185
00193 <a class="code" href="classZE_1_1ZRect.html">ZRect</a> <a class="code" href="classZE_1_1ZRect.html#a15">Intersection</a>(<span class="keyword">const</span> <a class="code" href="classZE_1_1ZRect.html">ZRect</a> &amp;rect) <span class="keyword">const</span>;
00194
00201 SDL_Rect <a class="code" href="classZE_1_1ZRect.html#a16">SDLrect</a>() <span class="keyword">const</span>;
00202
00209 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a17">X</a>() <span class="keyword">const</span>;
00210
00217 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a18">Y</a>() <span class="keyword">const</span>;
00218
00225 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a19">Left</a>() <span class="keyword">const</span>;
00226
00233 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a20">Right</a>() <span class="keyword">const</span>;
00234
00241 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a21">Top</a>() <span class="keyword">const</span>;
00242
00249 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a22">Bottom</a>() <span class="keyword">const</span>;
00250
00257 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a23">Width</a>() <span class="keyword">const</span>;
00258
00265 <span class="keywordtype">float</span> <a class="code" href="classZE_1_1ZRect.html#a24">Height</a>() <span class="keyword">const</span>;
00266 };
00267
00268 } <span class="comment">//namespace ZE</span>
00269
00270 <span class="preprocessor">#endif //__ze_zrect_h__</span>
</pre></div><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>

33
doc/html/ZE__ZRect_8h.html Normal file
View File

@ -0,0 +1,33 @@
<!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_ZRect.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZRect.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZRect_8h.html">ZE_ZRect.h</a> <br>
Description: Header file for core ZEngine Rectangle Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZRect_8h.html">ZE_ZRect.h</a>,v 1.9 2003/02/16 21:54:29 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZRect, the Rectangle class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZRect_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

29
doc/html/ZE__ZServer_8cpp.html Executable file
View File

@ -0,0 +1,29 @@
<!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_ZServer.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZServer.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZServer_8cpp.html">ZE_ZServer.cpp</a> <br>
Description: Implementation source file for core ZEngine TCP Server Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZServer_8cpp.html">ZE_ZServer.cpp</a>,v 1.4 2003/04/08 03:30:50 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation file for ZServer, the TCP Server class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZServer_8h-source.html">ZE_ZServer.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

70
doc/html/ZE__ZServer_8h-source.html Executable file
View File

@ -0,0 +1,70 @@
<!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>/include/ZE_ZServer.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZServer.h</h1><a href="ZE__ZServer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zserver_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zserver_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="preprocessor">#ifdef USE_SDL_NET</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>ZE
00032 {
00033
00041 <span class="keyword">class </span>ZServer
00042 {
00043 <span class="keyword">private</span>:
00045 ZEngine *rEngine;
00047 TCPsocket rSocket;
00049 SDLNet_SocketSet rSocketSet;
00051 TCPsocket *rClientSockets;
00053 <span class="keywordtype">int</span> rMaxClients;
00055 <span class="keywordtype">bool</span> rVerbose;
00057 <span class="keywordtype">int</span> rWaitTime;
00058
00065 <span class="keywordtype">void</span> CloseSocket(<span class="keywordtype">int</span> num);
00066
00067 <span class="keyword">public</span>:
00074 ZServer(<span class="keywordtype">bool</span> verbose=<span class="keyword">false</span>);
00075
00081 <span class="keyword">virtual</span> ~ZServer();
00082
00091 <span class="keywordtype">bool</span> Start(<span class="keywordtype">int</span> maxClients, Uint16 port);
00092
00098 <span class="keywordtype">void</span> Stop();
00099
00107 <span class="keywordtype">void</span> SetWaitTime(<span class="keywordtype">int</span> wait);
00108
00115 <span class="keywordtype">void</span> CheckSockets();
00116
00123 <span class="keywordtype">int</span> Clients();
00124
00131 <span class="keywordtype">int</span> WaitTime();
00132 };
00133
00134 } <span class="comment">//namespace ZE</span>
00135
00136 <span class="preprocessor">#endif //USE_SDL_NET</span>
00137 <span class="preprocessor"></span>
00138 <span class="preprocessor">#endif //__ze_zserver_h__</span>
</pre></div><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>

31
doc/html/ZE__ZServer_8h.html Executable file
View File

@ -0,0 +1,31 @@
<!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_ZServer.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZServer.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZServer_8h.html">ZE_ZServer.h</a> <br>
Description: Header file for core ZEngine TCP Server Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZServer_8h.html">ZE_ZServer.h</a>,v 1.5 2003/04/27 22:05:25 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZServer, the TCP Server class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZServer_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

29
doc/html/ZE__ZSound_8cpp.html Normal file
View File

@ -0,0 +1,29 @@
<!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_ZSound.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZSound.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZE__ZSound_8cpp.html">ZE_ZSound.cpp</a> <br>
Description: Implementation source file for core ZEngine Sound Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZSound_8cpp.html">ZE_ZSound.cpp</a>,v 1.6 2003/02/10 04:02:39 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZSound, the basic Sound class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZSound_8h-source.html">ZE_ZSound.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

85
doc/html/ZE__ZSound_8h-source.html Normal file
View File

@ -0,0 +1,85 @@
<!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>/include/ZE_ZSound.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZSound.h</h1><a href="ZE__ZSound_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zsound_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zsound_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>ZE
00032 {
00033
<a name="l00039"></a><a class="code" href="classZE_1_1ZSound.html">00039</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZSound.html">ZSound</a>
00040 {
00041 <span class="keyword">protected</span>:
<a name="l00043"></a><a class="code" href="classZE_1_1ZSound.html#n0">00043</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZSound.html#n0">rEngine</a>;
<a name="l00045"></a><a class="code" href="classZE_1_1ZSound.html#n1">00045</a> Mix_Chunk* <a class="code" href="classZE_1_1ZSound.html#n1">rSound</a>;
<a name="l00047"></a><a class="code" href="classZE_1_1ZSound.html#n2">00047</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#n2">rChannelID</a>;
00048
00049 <span class="keyword">public</span>:
<a name="l00051"></a><a class="code" href="classZE_1_1ZSound.html#p0">00051</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#p0">LoopInfinite</a>;
00052
00054 <span class="comment">//Opening and Closing//</span>
00056 <span class="comment"></span>
00062 <span class="comment"></span> <a class="code" href="classZE_1_1ZSound.html#a0">ZSound</a>();
00063
00070 <a class="code" href="classZE_1_1ZSound.html#a0">ZSound</a>(string filename);
00071
00077 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZSound.html#a2">~ZSound</a>();
00078
00085 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a3">Open</a>(string filename);
00086
00092 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a4">Release</a>();
00093
00095 <span class="comment">//Play Controls//</span>
00097 <span class="comment"></span>
00106 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a5">Play</a>(<span class="keywordtype">int</span> loopNum=0, <span class="keywordtype">int</span> fadeTime=0);
00107
00113 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a6">Pause</a>() <span class="keyword">const</span>;
00114
00120 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a7">Unpause</a>() <span class="keyword">const</span>;
00121
00128 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a8">Stop</a>(<span class="keywordtype">int</span> fadeTime=0) <span class="keyword">const</span>;
00129
00136 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a9">SetVolume</a>(<span class="keywordtype">int</span> volume);
00137
00139 <span class="comment">//Accessors//</span>
00141 <span class="comment"></span>
00148 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a10">IsLoaded</a>() <span class="keyword">const</span>;
00149
00156 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a11">IsPlaying</a>() <span class="keyword">const</span>;
00157
00164 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a12">IsPaused</a>() <span class="keyword">const</span>;
00165
00172 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#a13">Volume</a>() <span class="keyword">const</span>;
00173 };
00174
00175
00176 }
00177
00178 <span class="preprocessor">#endif //USE_SDL_MIXER</span>
00179 <span class="preprocessor"></span>
00180 <span class="preprocessor">#endif //__ze_zsound_h__</span>
</pre></div><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>

33
doc/html/ZE__ZSound_8h.html Normal file
View File

@ -0,0 +1,33 @@
<!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_ZSound.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZSound.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZSound_8h.html">ZE_ZSound.h</a> <br>
Description: Header file for core ZEngine Sound Wrapper Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZSound_8h.html">ZE_ZSound.h</a>,v 1.6 2003/02/10 04:40:16 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZSound, the Sound Effect wrapper for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZSound_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

31
doc/html/ZE__ZTimer_8cpp.html Normal file
View File

@ -0,0 +1,31 @@
<!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_ZTimer.cpp File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/src/ZE_ZTimer.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZTimer_8cpp.html">ZE_ZTimer.cpp</a> <br>
Description: Implementation source file for core ZEngine Timer Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZTimer_8cpp.html">ZE_ZTimer.cpp</a>,v 1.6 2003/02/10 04:40:30 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Implementation of ZTimer, the basic Timer class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZTimer_8h-source.html">ZE_ZTimer.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

63
doc/html/ZE__ZTimer_8h-source.html Normal file
View File

@ -0,0 +1,63 @@
<!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>/include/ZE_ZTimer.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZTimer.h</h1><a href="ZE__ZTimer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.net</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_ztimer_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_ztimer_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00028
00029 <span class="keyword">namespace </span>ZE
00030 {
00031
<a name="l00037"></a><a class="code" href="classZE_1_1ZTimer.html">00037</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZTimer.html">ZTimer</a>
00038 {
00039 <span class="keyword">protected</span>:
<a name="l00041"></a><a class="code" href="classZE_1_1ZTimer.html#n0">00041</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZTimer.html#n0">rEngine</a>;
<a name="l00043"></a><a class="code" href="classZE_1_1ZTimer.html#n1">00043</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZTimer.html#n1">rPaused</a>;
<a name="l00045"></a><a class="code" href="classZE_1_1ZTimer.html#n2">00045</a> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZTimer.html#n2">rUseZEngine</a>;
<a name="l00047"></a><a class="code" href="classZE_1_1ZTimer.html#n3">00047</a> Uint32 <a class="code" href="classZE_1_1ZTimer.html#n3">rPausedTime</a>;
<a name="l00049"></a><a class="code" href="classZE_1_1ZTimer.html#n4">00049</a> Uint32 <a class="code" href="classZE_1_1ZTimer.html#n4">rLastPause</a>;
00050
00057 Uint32 <a class="code" href="classZE_1_1ZTimer.html#b0">GetParentTime</a>() <span class="keyword">const</span>;
00058
00059 <span class="keyword">public</span>:
00060
00067 <a class="code" href="classZE_1_1ZTimer.html#a0">ZTimer</a>(<span class="keywordtype">bool</span> useZEngine=<span class="keyword">true</span>);
00068
00074 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZTimer.html#a1">~ZTimer</a>();
00075
00081 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZTimer.html#a2">Reset</a>();
00082
00088 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZTimer.html#a3">Pause</a>();
00089
00095 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZTimer.html#a4">Unpause</a>();
00096
00103 Uint32 <a class="code" href="classZE_1_1ZTimer.html#a5">GetTime</a>() <span class="keyword">const</span>;
00104
00111 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZTimer.html#a6">IsPaused</a>() <span class="keyword">const</span>;
00112 };
00113
00114 }
00115
00116 <span class="preprocessor">#endif //__ze_ztimer_h__</span>
</pre></div><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>

33
doc/html/ZE__ZTimer_8h.html Normal file
View File

@ -0,0 +1,33 @@
<!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_ZTimer.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZE_ZTimer.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__ZTimer_8h.html">ZE_ZTimer.h</a> <br>
Description: Header file for core ZEngine Timer Object. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__ZTimer_8h.html">ZE_ZTimer.h</a>,v 1.6 2003/02/10 04:40:16 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Definition file for ZTimer, the Timer class for ZEngine.
<p>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<p>
<a href="ZE__ZTimer_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
</table>
<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>

38
doc/html/ZEngine_8h-source.html Normal file
View File

@ -0,0 +1,38 @@
<!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>/include/ZEngine.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZEngine.h</h1><a href="ZEngine_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
00054 <span class="preprocessor">#ifndef __zengine_h__</span>
00055 <span class="preprocessor"></span><span class="preprocessor">#define __zengine_h__</span>
00056 <span class="preprocessor"></span>
00057 <span class="preprocessor">#include "<a class="code" href="ZE__Defines_8h.html">ZE_Defines.h</a>"</span>
00058 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00059 <span class="preprocessor">#include "<a class="code" href="ZE__Utility_8h.html">ZE_Utility.h</a>"</span>
00060 <span class="preprocessor">#include "<a class="code" href="ZE__ZImage_8h.html">ZE_ZImage.h</a>"</span>
00061 <span class="preprocessor">#include "<a class="code" href="ZE__ZTimer_8h.html">ZE_ZTimer.h</a>"</span>
00062 <span class="preprocessor">#include "<a class="code" href="ZE__ZConfigFile_8h.html">ZE_ZConfigFile.h</a>"</span>
00063 <span class="preprocessor">#include "<a class="code" href="ZE__ZRect_8h.html">ZE_ZRect.h</a>"</span>
00064 <span class="preprocessor">#ifdef USE_SDL_TTF</span>
00065 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="ZE__ZFont_8h.html">ZE_ZFont.h</a>"</span>
00066 <span class="preprocessor">#endif</span>
00067 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00068 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="ZE__ZSound_8h.html">ZE_ZSound.h</a>"</span>
00069 <span class="preprocessor">#include "<a class="code" href="ZE__ZMusic_8h.html">ZE_ZMusic.h</a>"</span>
00070 <span class="preprocessor">#endif</span>
00071 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_SDL_NET</span>
00072 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="ZE__ZClient_8h.html">ZE_ZClient.h</a>"</span>
00073 <span class="preprocessor">#include "<a class="code" href="ZE__ZServer_8h.html">ZE_ZServer.h</a>"</span>
00074 <span class="preprocessor">#endif</span>
00075 <span class="preprocessor"></span>
00076 <span class="preprocessor">#endif //__zengine_h__</span>
</pre></div><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>

40
doc/html/ZEngine_8h.html Normal file
View File

@ -0,0 +1,40 @@
<!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>ZEngine.h File 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/ZEngine.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>File Header:</b></dt><dd>File: <a class="el" href="ZEngine_8h.html">ZEngine.h</a> <br>
Description: Public Header File for ZEngine. <br>
Author(s): James Turk <br>
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZEngine_8h.html">ZEngine.h</a>,v 1.24 2003/04/27 18:55:00 cozman Exp </dd></dl>
<br>
</dd></dl>
<p>
Header file for ZEngine Game Engine from Concept of Zero, this is the file that programs that wish to utilize ZEngine should include.
<p>
<code>#include "<a class="el" href="ZE__Defines_8h-source.html">ZE_Defines.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__Utility_8h-source.html">ZE_Utility.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZTimer_8h-source.html">ZE_ZTimer.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZConfigFile_8h-source.html">ZE_ZConfigFile.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZRect_8h-source.html">ZE_ZRect.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZFont_8h-source.html">ZE_ZFont.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZSound_8h-source.html">ZE_ZSound.h</a>"</code><br>
<code>#include "<a class="el" href="ZE__ZMusic_8h-source.html">ZE_ZMusic.h</a>"</code><br>
<p>
<a href="ZEngine_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
</table>
<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>

27
doc/html/annotated.html Normal file
View File

@ -0,0 +1,27 @@
<!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>Annotated Index</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Class for use in <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a></td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZE::ZConfigFile::ZCF_Section</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Section class</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZE::ZConfigFile::ZCF_Variable</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Variable class</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td class="indexvalue">Main <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Singleton Class</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZError.html">ZError</a> class for describing errors</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZFont.html">ZFont</a> class for basic Font use</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZImage.html">ZImage</a> class for basic Image use</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZMusic.html">ZMusic</a> class for playing full length music (eg. ogg or wav)</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> class for simplified rectangle use</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZSound.html">ZSound</a> class for playing sound effects. (WAV)</td></tr>
<tr><td class="indexkey"><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZTimer.html">ZTimer</a> class for Timer use</td></tr>
</table>
<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>

36
doc/html/classZE_1_1ZConfigFile-members.html Normal file
View File

@ -0,0 +1,36 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZConfigFile Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#b0">CleanString</a>(string str) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a13">Close</a>()</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#b1">Exists</a>(string sec) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#b2">Exists</a>(string sec, string var) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a12">Flush</a>()</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a6">GetBool</a>(string section, string var, bool defVal) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a4">GetFloat</a>(string section, string var, float defVal) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a5">GetInt</a>(string section, string var, int defVal) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a7">GetString</a>(string section, string var, string defVal) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#b4">GetVariable</a>(string sec, string var, string defVal) const</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a3">Process</a>(string filename)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#n0">rFileLayout</a></td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#n1">rFilename</a></td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a10">SetBool</a>(string section, string var, bool val)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a8">SetFloat</a>(string section, string var, float val)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a9">SetInt</a>(string section, string var, int val)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a11">SetString</a>(string section, string var, string val)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#b3">SetVariable</a>(string sec, string var, string val)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a0">ZConfigFile</a>()</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a1">ZConfigFile</a>(string filename)</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile.html#a2">~ZConfigFile</a>()</td><td><a class="el" href="classZE_1_1ZConfigFile.html">ZE::ZConfigFile</a></td><td><code> [virtual]</code></td></tr>
</table><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>

885
doc/html/classZE_1_1ZConfigFile.html Normal file
View File

@ -0,0 +1,885 @@
<!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::ZConfigFile 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZConfigFile Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZConfigFile_8h-source.html">ZE_ZConfigFile.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZConfigFile-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> class for INI-style configuration files for games or applications. 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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a0">ZConfigFile</a> ()</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a1">ZConfigFile</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor which takes filename.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a2">~ZConfigFile</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destructor, flushes file.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a3">Process</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Parse a file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a4">GetFloat</a> (string section, string var, float defVal) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get value in floating point format from file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a5">GetInt</a> (string section, string var, int defVal) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get value in integer format from file.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a6">GetBool</a> (string section, string var, bool defVal) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get value in boolean format from file.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a7">GetString</a> (string section, string var, string defVal) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get value in string format from file.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a8">SetFloat</a> (string section, string var, float val)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set value in floating point format in file.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a9">SetInt</a> (string section, string var, int val)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set value in integer format in file.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a10">SetBool</a> (string section, string var, bool val)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set value in boolean format in file.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a11">SetString</a> (string section, string var, string val)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set value in string format in file.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a12">Flush</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Write all values to file.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#a13">Close</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Close the file.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#b0">CleanString</a> (string str) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reformat a string in a form more suitable to parsing.</em> <a href="#b0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#b1">Exists</a> (string sec) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if a section exists.</em> <a href="#b1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#b2">Exists</a> (string sec, string var) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if a variable exists.</em> <a href="#b2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#b3">SetVariable</a> (string sec, string var, string val)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Internal function to set variables.</em> <a href="#b3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#b4">GetVariable</a> (string sec, string var, string defVal) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Internal function to get value of a variable.</em> <a href="#b4"></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::ZConfigFile::rFileLayout"></a>
list&lt; <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZCF_Section</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#n0">rFileLayout</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>List of sections of internal type.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZConfigFile::rFilename"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html#n1">rFilename</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Filename of file currently open.</em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZConfigFile::ZConfigFile"></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::ZConfigFile::ZConfigFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
A no-op default constructor. </td>
</tr>
</table>
<a name="a1" doxytag="ZE::ZConfigFile::ZConfigFile"></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::ZConfigFile::ZConfigFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor takes filename, and calls process on it. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>File to load as <a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZConfigFile::~ZConfigFile"></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::ZConfigFile::~ZConfigFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flushes the file, ensures a flush if the file is left open. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b0" doxytag="ZE::ZConfigFile::CleanString"></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::ZConfigFile::CleanString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>str</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Removes whitespace from a string and makes all characters lowercase. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>str</em>&nbsp;</td><td>The string to get a clean version of. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Cleaned string. </dd></dl>
</td>
</tr>
</table>
<a name="b1" doxytag="ZE::ZConfigFile::Exists"></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::ZConfigFile::Exists </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>sec</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find out if a section currently exists. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>sec</em>&nbsp;</td><td>Section to check for. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>bool, true if section exists in file. </dd></dl>
</td>
</tr>
</table>
<a name="b2" doxytag="ZE::ZConfigFile::Exists"></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::ZConfigFile::Exists </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>sec</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find out if a variable currently exists. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>sec</em>&nbsp;</td><td>Section to check in. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Variable to check for. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>bool, true if section exists in file. </dd></dl>
</td>
</tr>
</table>
<a name="b3" doxytag="ZE::ZConfigFile::SetVariable"></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::ZConfigFile::SetVariable </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>sec</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>val</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set variable to value, called internally only. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>sec</em>&nbsp;</td><td>Section for variable. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Variable to set. </td></tr>
<tr><td valign=top><em>val</em>&nbsp;</td><td>Value to set variable to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="b4" doxytag="ZE::ZConfigFile::GetVariable"></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::ZConfigFile::GetVariable </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>sec</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>defVal</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get value of variable, called internally only. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>sec</em>&nbsp;</td><td>Section for variable. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Variable to get. </td></tr>
<tr><td valign=top><em>defVal</em>&nbsp;</td><td>Value to return if variable doesnt exist. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Value of variable. </dd></dl>
</td>
</tr>
</table>
<a name="a3" doxytag="ZE::ZConfigFile::Process"></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::ZConfigFile::Process </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Parses the file, reading the contents into the fileLayout map. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>File to parse and attach this ZDataFile to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a4" doxytag="ZE::ZConfigFile::GetFloat"></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"> float ZE::ZConfigFile::GetFloat </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>defVal</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the current value of a variable in the file, or defVal if not found in file. <dl compact><dt><b>Since:</b></dt><dd>0.8.3 </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to seek variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to seek value for. </td></tr>
<tr><td valign=top><em>defVal</em>&nbsp;</td><td>Value to return if var does not exist within section. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Contents of the variable in floating point format. </dd></dl>
</td>
</tr>
</table>
<a name="a5" doxytag="ZE::ZConfigFile::GetInt"></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::ZConfigFile::GetInt </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>defVal</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the current value of a variable in the file, or defVal if not found in file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to seek variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to seek value for. </td></tr>
<tr><td valign=top><em>defVal</em>&nbsp;</td><td>Value to return if var does not exist within section. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Contents of the variable in integer format. </dd></dl>
</td>
</tr>
</table>
<a name="a6" doxytag="ZE::ZConfigFile::GetBool"></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::ZConfigFile::GetBool </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>defVal</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the current value of a variable in the file, or defVal if not found in file. (Valid values are "0","1","true" and "false") <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to seek variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to seek value for. </td></tr>
<tr><td valign=top><em>defVal</em>&nbsp;</td><td>Value to return if var does not exist within section. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Contents of the variable in boolean format. </dd></dl>
</td>
</tr>
</table>
<a name="a7" doxytag="ZE::ZConfigFile::GetString"></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::ZConfigFile::GetString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>defVal</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the current value of a variable in the file, or defVal if not found in file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to seek variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to seek value for. </td></tr>
<tr><td valign=top><em>defVal</em>&nbsp;</td><td>Value to return if var does not exist within section. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Contents of the variable in string format. </dd></dl>
</td>
</tr>
</table>
<a name="a8" doxytag="ZE::ZConfigFile::SetFloat"></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::ZConfigFile::SetFloat </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>val</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the new value of a variable in the file to val, creating the section and variable if not already found in file. <dl compact><dt><b>Since:</b></dt><dd>0.8.3 </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to edit variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to set value for. </td></tr>
<tr><td valign=top><em>val</em>&nbsp;</td><td>Floating point value to set variable to in file. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a9" doxytag="ZE::ZConfigFile::SetInt"></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::ZConfigFile::SetInt </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>val</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the new value of a variable in the file to val, creating the section and variable if not already found in file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to edit variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to set value for. </td></tr>
<tr><td valign=top><em>val</em>&nbsp;</td><td>Integer value to set variable to in file. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a10" doxytag="ZE::ZConfigFile::SetBool"></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::ZConfigFile::SetBool </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>val</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the new value of a variable in the file to val, creating the section and variable if not already found in file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to edit variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to set value for. </td></tr>
<tr><td valign=top><em>val</em>&nbsp;</td><td>Boolean value to set variable to in file. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a11" doxytag="ZE::ZConfigFile::SetString"></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::ZConfigFile::SetString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>section</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>var</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>val</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the new value of a variable in the file to val, creating the section and variable if not already found in file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>section</em>&nbsp;</td><td>Name of section to edit variable under. </td></tr>
<tr><td valign=top><em>var</em>&nbsp;</td><td>Name of variable to set value for. </td></tr>
<tr><td valign=top><em>val</em>&nbsp;</td><td>String value to set variable to in file. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a12" doxytag="ZE::ZConfigFile::Flush"></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::ZConfigFile::Flush </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Writes all values and sections to file. </td>
</tr>
</table>
<a name="a13" doxytag="ZE::ZConfigFile::Close"></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::ZConfigFile::Close </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flush the file and clear the filename. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="ZE__ZConfigFile_8h-source.html">ZE_ZConfigFile.h</a><li>/src/<a class="el" href="ZE__ZConfigFile_8cpp.html">ZE_ZConfigFile.cpp</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>

17
doc/html/classZE_1_1ZConfigFile_1_1ZCF__Section-members.html Executable file
View File

@ -0,0 +1,17 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZConfigFile::ZCF_Section Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZE::ZConfigFile::ZCF_Section</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m0">section</a></td><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZE::ZConfigFile::ZCF_Section</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m1">varList</a></td><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZE::ZConfigFile::ZCF_Section</a></td><td></td></tr>
</table><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>

29
doc/html/classZE_1_1ZConfigFile_1_1ZCF__Section.html Executable file
View File

@ -0,0 +1,29 @@
<!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::ZConfigFile::ZCF_Section 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZConfigFile::ZCF_Section Class Reference</h1><a href="classZE_1_1ZConfigFile_1_1ZCF__Section-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> class for mapping a section name to a list of variables in that section.
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="m0" doxytag="ZE::ZConfigFile::ZCF_Section::section"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m0">section</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Section name.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m1" doxytag="ZE::ZConfigFile::ZCF_Section::varList"></a>
list&lt; <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZCF_Variable</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m1">varList</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>STL list of variables.</em></font><br><br></td></tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>/include/<a class="el" href="ZE__ZConfigFile_8h-source.html">ZE_ZConfigFile.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>

17
doc/html/classZE_1_1ZConfigFile_1_1ZCF__Variable-members.html Executable file
View File

@ -0,0 +1,17 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZConfigFile::ZCF_Variable Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZE::ZConfigFile::ZCF_Variable</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m1">val</a></td><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZE::ZConfigFile::ZCF_Variable</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m0">var</a></td><td><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZE::ZConfigFile::ZCF_Variable</a></td><td></td></tr>
</table><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>

29
doc/html/classZE_1_1ZConfigFile_1_1ZCF__Variable.html Executable file
View File

@ -0,0 +1,29 @@
<!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::ZConfigFile::ZCF_Variable 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZConfigFile::ZCF_Variable Class Reference</h1><a href="classZE_1_1ZConfigFile_1_1ZCF__Variable-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> class for mapping a variable name to it's value, stored in string form (later converted to bool or int if needed).
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="m0" doxytag="ZE::ZConfigFile::ZCF_Variable::var"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m0">var</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Variable name.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m1" doxytag="ZE::ZConfigFile::ZCF_Variable::val"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m1">val</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Value associated with variable.</em></font><br><br></td></tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>/include/<a class="el" href="ZE__ZConfigFile_8h-source.html">ZE_ZConfigFile.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>

103
doc/html/classZE_1_1ZEngine-members.html Normal file
View File

@ -0,0 +1,103 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZEngine Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a52">BPP</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a34">CheckEvents</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a8">Clear</a>(float red=0.0f, float green=0.0f, float blue=0.0f, float alpha=1.0f)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a3">CloseDisplay</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a2">CreateDisplay</a>(string title, string icon="")</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a10">Delay</a>(Uint32 milliseconds)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a6">Display</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a40">FlushErrors</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a17">GetDesiredFramerate</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a15">GetFramerate</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a14">GetFrameTime</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#d0">GetInstance</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a38">GetLastError</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a11">GetTime</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#d2">GetVersion</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a51">Height</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a27">HideCursor</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a23">ImagesNeedReload</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a5">Initialized</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a19">IsActive</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a53">IsFullscreen</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a18">IsPaused</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a25">KeyIsPressed</a>(SDLKey key)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a26">KeyPress</a>(SDLKey key)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a31">LButtonPressed</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a49">LoadFont</a>(string filename, int size)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a46">LoadImage</a>(string filename)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a48">LoadMusic</a>(string filename)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a47">LoadSound</a>(string filename)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#c1">LogError</a>(ZError error)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o15">mActive</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o2">mBPP</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o23">mCurError</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o8">mDesiredFramerate</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o25">mErrlog</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o22">mErrorQueue</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o3">mFullscreen</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o1">mHeight</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o4">mInitialized</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o17">mKeyIsPressed</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o18">mKeyPress</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o10">mLastPause</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o12">mLastTime</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o24">mLogAllErrors</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o21">mMouseB</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o19">mMouseX</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o20">mMouseY</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o14">mNeedReload</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o9">mNextUpdate</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a33">MouseInRect</a>(SDL_Rect *rect)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a29">MouseX</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a30">MouseY</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o6">mPaused</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o11">mPausedTime</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o16">mQuit</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o26">mRate</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o5">mScreen</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o13">mSecPerFrame</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o27">mStereo</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o7">mUnpauseOnActive</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#o0">mWidth</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a12">PauseTimer</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a21">QuitRequested</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a44">RandDouble</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a45">RandDouble</a>(double min, double max)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a42">RandLong</a>(unsigned long max)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a43">RandLong</a>(long min, long max)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a32">RButtonPressed</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#d1">ReleaseInstance</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a37">ReportError</a>(ZErrorCode code, string desc="", string file="", unsigned int line=0)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a20">RequestQuit</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a41">SeedRandom</a>(unsigned long seed)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a16">SetDesiredFramerate</a>(Uint8 rate)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a36">SetErrorLog</a>(bool logAll, string logFile="")</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a35">SetEventFilter</a>(SDL_EventFilter filter)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a9">SetGL2D</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a24">SetKeyRepeatRate</a>(int rate)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a22">SetReloadNeed</a>(bool state)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a0">SetupDisplay</a>(int width, int height, int bpp, bool fullscreen)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a1">SetupSound</a>(int rate, bool stereo)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a28">ShowCursor</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#r0">sInstance</a></td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private, static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a4">ToggleFullscreen</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a13">UnpauseTimer</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a7">Update</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a50">Width</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#a39">WriteLog</a>(string str)</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZEngine.html#c0">ZEngine</a>()</td><td><a class="el" href="classZE_1_1ZEngine.html">ZE::ZEngine</a></td><td><code> [private]</code></td></tr>
</table><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>

2222
doc/html/classZE_1_1ZEngine.html Normal file
View File

File diff suppressed because it is too large Load Diff

27
doc/html/classZE_1_1ZError-members.html Executable file
View File

@ -0,0 +1,27 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZError Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZError.html">ZE::ZError</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#a3">Code</a>() const</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#a2">Create</a>(ZErrorCode code, string desc="", string file="", int line=0)</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#d0">CreateStringTable</a>()</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#d1">DestroyStringTable</a>()</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#a4">LogString</a>() const</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#n0">rCode</a></td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#n1">rDescription</a></td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#n2">rFilename</a></td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#n3">rLine</a></td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#q0">sErrorDesc</a></td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [protected, static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#a0">ZError</a>(ZErrorCode code=ZERR_NONE, string desc="", string file="", int line=0)</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZError.html#a1">~ZError</a>()</td><td><a class="el" href="classZE_1_1ZError.html">ZE::ZError</a></td><td><code> [virtual]</code></td></tr>
</table><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>

317
doc/html/classZE_1_1ZError.html Executable file
View File

@ -0,0 +1,317 @@
<!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::ZError 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZError Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZError_8h-source.html">ZE_ZError.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZError-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZError.html">ZError</a> class for storing and printing information on errors. Inherited from ZObject and tied closely to <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. <dl compact><dt><b>Since:</b></dt><dd>0.8.2 </dd></dl>
<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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a0">ZError</a> (<a class="el" href="namespaceZE.html#a20">ZErrorCode</a> code=ZERR_NONE, string desc="", string file="", int line=0)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor for <a class="el" href="classZE_1_1ZError.html">ZError</a>.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a1">~ZError</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Virtual Destructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a2">Create</a> (<a class="el" href="namespaceZE.html#a20">ZErrorCode</a> code, string desc="", string file="", int line=0)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set members of error object.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceZE.html#a20">ZErrorCode</a>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a3">Code</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get ZErrorCode of error.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a4">LogString</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get formatted string for log file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#d0">CreateStringTable</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Construct string table for error strings.</em> <a href="#d0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#d1">DestroyStringTable</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destroy string table of error strings.</em> <a href="#d1"></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::ZError::rCode"></a>
<a class="el" href="namespaceZE.html#a20">ZErrorCode</a>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n0">rCode</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Error ID.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZError::rDescription"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n1">rDescription</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Error Description.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZError::rFilename"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n2">rFilename</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>File which error occured in.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZError::rLine"></a>
unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n3">rLine</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Line which error occured on.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="q0" doxytag="ZE::ZError::sErrorDesc"></a>
string *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#q0">sErrorDesc</a> = NULL</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static Array of Error Identifiers.</em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZError::ZError"></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::ZError::ZError </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceZE.html#a20">ZErrorCode</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>code</em> = ZERR_NONE, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>desc</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>file</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>line</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Make new <a class="el" href="classZE_1_1ZError.html">ZError</a> object, by default set rCode to ZERR_NONE with no description. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>code</em>&nbsp;</td><td>ZErrorCode to set object to, defaults to ZERR_NONE. </td></tr>
<tr><td valign=top><em>desc</em>&nbsp;</td><td>Description to use for object, defaults to nothing. </td></tr>
<tr><td valign=top><em>file</em>&nbsp;</td><td>Optional argument specifying the file the error occured in. </td></tr>
<tr><td valign=top><em>line</em>&nbsp;</td><td>Optional argument specifying the line the error occured on. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a1" doxytag="ZE::ZError::~ZError"></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::ZError::~ZError </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Virtual destructor making future inheritance safe. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d0" doxytag="ZE::ZError::CreateStringTable"></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::ZError::CreateStringTable </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructs a string table for errors, enabling <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> to properly delete the table on exit. </td>
</tr>
</table>
<a name="d1" doxytag="ZE::ZError::DestroyStringTable"></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::ZError::DestroyStringTable </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Properly delete the string table, freeing all memory used by the strings. </td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZError::Create"></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::ZError::Create </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceZE.html#a20">ZErrorCode</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>code</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>desc</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>file</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>line</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set new values in <a class="el" href="classZE_1_1ZError.html">ZError</a> object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>code</em>&nbsp;</td><td>ZErrorCode to set object to. </td></tr>
<tr><td valign=top><em>desc</em>&nbsp;</td><td>Description to use for object, defaults to nothing. </td></tr>
<tr><td valign=top><em>file</em>&nbsp;</td><td>Optional argument specifying the file the error occured in. </td></tr>
<tr><td valign=top><em>line</em>&nbsp;</td><td>Optional argument specifying the line the error occured on. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a3" doxytag="ZE::ZError::Code"></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"> <a class="el" href="namespaceZE.html#a20">ZErrorCode</a> ZE::ZError::Code </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Access ZErrorCode of the <a class="el" href="classZE_1_1ZError.html">ZError</a> object. <dl compact><dt><b>Returns:</b></dt><dd>The error ZErrorCode. </dd></dl>
</td>
</tr>
</table>
<a name="a4" doxytag="ZE::ZError::LogString"></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::ZError::LogString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the string to be written to the logfile. Called by <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> in LogError. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="ZE__ZError_8h-source.html">ZE_ZError.h</a><li>/src/<a class="el" href="ZE__ZError_8cpp.html">ZE_ZError.cpp</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>

39
doc/html/classZE_1_1ZFont-members.html Normal file
View File

@ -0,0 +1,39 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZFont Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a6">DrawShadedText</a>(string text, ZImage &amp;image) const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a5">DrawText</a>(string text, ZImage &amp;image) const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a15">Height</a>() const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a12">IsBold</a>() const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a13">IsItalic</a>() const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a11">IsLoaded</a>() const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a14">IsUnderlined</a>() const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a16">LineSkip</a>() const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a3">Open</a>(string filename, int size)</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#n4">rBGColor</a></td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#n3">rColor</a></td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a4">Release</a>()</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#n0">rEngine</a></td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a10">Resize</a>(int size)</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#n2">rFilename</a></td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#n1">rFont</a></td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a8">SetBGColor</a>(Uint8 r, Uint8 g, Uint8 b)</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a7">SetColor</a>(Uint8 r, Uint8 g, Uint8 b)</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a9">SetStyle</a>(bool bold, bool italic, bool underline)</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a18">StringHeight</a>(string text) const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a17">StringWidth</a>(string text) const</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a0">ZFont</a>()</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a1">ZFont</a>(string filename, int size)</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZFont.html#a2">~ZFont</a>()</td><td><a class="el" href="classZE_1_1ZFont.html">ZE::ZFont</a></td><td><code> [virtual]</code></td></tr>
</table><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>

772
doc/html/classZE_1_1ZFont.html Normal file
View File

@ -0,0 +1,772 @@
<!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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZFont Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZFont_8h-source.html">ZE_ZFont.h</a>&gt;</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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a0">ZFont</a> ()</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a1">ZFont</a> (string filename, int size)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a2">~ZFont</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a3">Open</a> (string filename, int size)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a4">Release</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</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> &amp;image) const</td></tr>
<tr><td>&nbsp;</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&nbsp;</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> &amp;image) const</td></tr>
<tr><td>&nbsp;</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&nbsp;</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>&nbsp;</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&nbsp;</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>&nbsp;</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&nbsp;</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>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a10">Resize</a> (int size)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a11">IsLoaded</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a12">IsBold</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a13">IsItalic</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a14">IsUnderlined</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a15">Height</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a16">LineSkip</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a17">StringWidth</a> (string text) const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#a18">StringHeight</a> (string text) const</td></tr>
<tr><td>&nbsp;</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> *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n0">rEngine</a></td></tr>
<tr><td>&nbsp;</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 *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n1">rFont</a></td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n2">rFilename</a></td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n3">rColor</a></td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html#n4">rBGColor</a></td></tr>
<tr><td>&nbsp;</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 &amp; 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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>filename</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>size</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</td><td>Font to open. </td></tr>
<tr><td valign=top><em>size</em>&nbsp;</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>filename</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>size</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</td><td>Font to open. </td></tr>
<tr><td valign=top><em>size</em>&nbsp;</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>text</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classZE_1_1ZImage.html">ZImage</a> &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>image</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>String to write. </td></tr>
<tr><td valign=top><em>image</em>&nbsp;</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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>text</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classZE_1_1ZImage.html">ZImage</a> &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>image</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>String to write. </td></tr>
<tr><td valign=top><em>image</em>&nbsp;</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">(&nbsp;</td>
<td class="md" nowrap valign="top">Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>r</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>g</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</td><td>Red component of color (0-255). </td></tr>
<tr><td valign=top><em>g</em>&nbsp;</td><td>Green component of color (0-255). </td></tr>
<tr><td valign=top><em>b</em>&nbsp;</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">(&nbsp;</td>
<td class="md" nowrap valign="top">Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>r</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>g</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</td><td>Red component of color (0-255). </td></tr>
<tr><td valign=top><em>g</em>&nbsp;</td><td>Green component of color (0-255). </td></tr>
<tr><td valign=top><em>b</em>&nbsp;</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">(&nbsp;</td>
<td class="md" nowrap valign="top">bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>bold</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>italic</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>underline</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</td><td>Decides bold setting of font. </td></tr>
<tr><td valign=top><em>italic</em>&nbsp;</td><td>Decides italic setting of font. </td></tr>
<tr><td valign=top><em>underline</em>&nbsp;</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">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>size</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>text</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>text</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</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>

53
doc/html/classZE_1_1ZImage-members.html Normal file
View File

@ -0,0 +1,53 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZImage Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a27">Alpha</a>() const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a10">Attach</a>(SDL_Surface *surface)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a18">Bind</a>() const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a19">Draw</a>(int x, int y) const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a20">Draw</a>(float x, float y) const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a21">DrawRotated</a>(int x, int y, float angle) const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a22">DrawRotated</a>(float x, float y, float angle) const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a15">Flip</a>(bool horizontal, bool vertical)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a26">Height</a>() const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a23">IsLoaded</a>() const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a7">Open</a>(string filename)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a8">OpenFromImage</a>(SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a9">OpenFromImage</a>(const ZImage &amp;img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n9">rAlpha</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a12">Release</a>()</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a11">Reload</a>()</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n0">rEngine</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a17">Resize</a>(unsigned int width, unsigned int height)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n8">rHeight</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n5">rImage</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n6">rTexID</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n3">rTexMaxX</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n4">rTexMaxY</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n1">rTexMinX</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n2">rTexMinY</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#n7">rWidth</a></td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a13">SetAlpha</a>(Uint8 alpha)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a14">SetColorKey</a>(Uint8 red, Uint8 green, Uint8 blue)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a16">Stretch</a>(float xFactor, float yFactor)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a24">Surface</a>() const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a25">Width</a>() const</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a0">ZImage</a>()</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a1">ZImage</a>(const ZImage &amp;rhs)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a2">ZImage</a>(string filename)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a3">ZImage</a>(SDL_Surface *surface)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a4">ZImage</a>(SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a5">ZImage</a>(const ZImage &amp;img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZImage.html#a6">~ZImage</a>()</td><td><a class="el" href="classZE_1_1ZImage.html">ZE::ZImage</a></td><td><code> [virtual]</code></td></tr>
</table><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>

1248
doc/html/classZE_1_1ZImage.html Normal file
View File

File diff suppressed because it is too large Load Diff

33
doc/html/classZE_1_1ZMusic-members.html Normal file
View File

@ -0,0 +1,33 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZMusic Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a11">IsLoaded</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a13">IsPaused</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a12">IsPlaying</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#p0">LoopInfinite</a></td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a3">Open</a>(string filename)</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a6">Pause</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a5">Play</a>(int loopNum=0, int fadeTime=0) const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a4">Release</a>()</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#n0">rEngine</a></td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a8">Rewind</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#n1">rMusic</a></td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a10">SetVolume</a>(int volume)</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a9">Stop</a>(int fadeTime=0) const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a7">Unpause</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a14">Volume</a>() const</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a0">ZMusic</a>()</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a1">ZMusic</a>(string filename)</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZMusic.html#a2">~ZMusic</a>()</td><td><a class="el" href="classZE_1_1ZMusic.html">ZE::ZMusic</a></td><td><code> [virtual]</code></td></tr>
</table><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>

532
doc/html/classZE_1_1ZMusic.html Normal file
View File

@ -0,0 +1,532 @@
<!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::ZMusic 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZMusic Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZMusic_8h-source.html">ZE_ZMusic.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZMusic-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZMusic.html">ZMusic</a> music class, class wraps common features for SDL_Mixer's Mix_Music. 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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a0">ZMusic</a> ()</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a1">ZMusic</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor that opens a music file.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a2">~ZMusic</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a3">Open</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Opens a music file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a4">Release</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Release music.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a5">Play</a> (int loopNum=0, int fadeTime=0) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Play currently loaded music.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a6">Pause</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pause music.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a7">Unpause</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Unpause music.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a8">Rewind</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Rewind music.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a9">Stop</a> (int fadeTime=0) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop music.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a10">SetVolume</a> (int volume)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Change Volume.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a11">IsLoaded</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a12">IsPlaying</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if music is Playing.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a13">IsPaused</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if music is Paused.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#a14">Volume</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Find Current Volume of Music.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="p0" doxytag="ZE::ZMusic::LoopInfinite"></a>
const int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#p0">LoopInfinite</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static Variable For Infinite loop of sound. (Defined as -1).</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::ZMusic::rEngine"></a>
<a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#n0">rEngine</a></td></tr>
<tr><td>&nbsp;</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::ZMusic::rMusic"></a>
Mix_Music *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html#n1">rMusic</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pointer to music data.</em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZMusic::ZMusic"></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::ZMusic::ZMusic </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default Constructor, does nothing. </td>
</tr>
</table>
<a name="a1" doxytag="ZE::ZMusic::ZMusic"></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::ZMusic::ZMusic </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor simply calls <a class="el" href="classZE_1_1ZMusic.html#a3">ZMusic::Open()</a> with same filename. (WAV,MOD,MID,OGG) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>Music to open. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZMusic::~ZMusic"></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::ZMusic::~ZMusic </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor calls <a class="el" href="classZE_1_1ZMusic.html#a4">ZMusic::Release()</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="ZE::ZMusic::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::ZMusic::Open </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Open a music file to be used. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>Music to open. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a4" doxytag="ZE::ZMusic::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::ZMusic::Release </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Release memory held by music data. </td>
</tr>
</table>
<a name="a5" doxytag="ZE::ZMusic::Play"></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::ZMusic::Play </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>loopNum</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>fadeTime</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Play music currently loaded in <a class="el" href="classZE_1_1ZMusic.html">ZMusic</a>, looping loopNum times. (use <a class="el" href="classZE_1_1ZMusic.html#p0">ZMusic::LoopInfinite</a> to loop forever.) If fade is not zero (which it defaults to) music will fade in over specified number of milliseconds. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>loopNum</em>&nbsp;</td><td>Number of times to loop song, defaults to zero. </td></tr>
<tr><td valign=top><em>fadeTime</em>&nbsp;</td><td>Milliseconds to fade to full volume, defaults to zero for no fade. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a6" doxytag="ZE::ZMusic::Pause"></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::ZMusic::Pause </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Pause currently playing music. </td>
</tr>
</table>
<a name="a7" doxytag="ZE::ZMusic::Unpause"></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::ZMusic::Unpause </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Unpause currently paused music. </td>
</tr>
</table>
<a name="a8" doxytag="ZE::ZMusic::Rewind"></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::ZMusic::Rewind </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Rewind music to beginning. </td>
</tr>
</table>
<a name="a9" doxytag="ZE::ZMusic::Stop"></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::ZMusic::Stop </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>fadeTime</em> = 0 </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Stop currently playing music, if fadeTime is not zero, fade out over specified time. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>fadeTime</em>&nbsp;</td><td>Milliseconds to fade out over, defaults to zero for immediate stop. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a10" doxytag="ZE::ZMusic::SetVolume"></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::ZMusic::SetVolume </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>volume</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Change volume of currently playing music. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>volume</em>&nbsp;</td><td>Volume to change to, can be in a range from 0 to 128 </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a11" doxytag="ZE::ZMusic::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::ZMusic::IsLoaded </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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::ZMusic::IsPlaying"></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::ZMusic::IsPlaying </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if music is playing, specifically if it is not stopped. (Paused state should be checked for by IsPaused) <dl compact><dt><b>Returns:</b></dt><dd>Playing / Not Playing State of Music. </dd></dl>
</td>
</tr>
</table>
<a name="a13" doxytag="ZE::ZMusic::IsPaused"></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::ZMusic::IsPaused </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if music is "playing" but currently paused. <dl compact><dt><b>Returns:</b></dt><dd>Paused / Not Paused State of Music. </dd></dl>
</td>
</tr>
</table>
<a name="a14" doxytag="ZE::ZMusic::Volume"></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::ZMusic::Volume </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get current volume of music represented as a value from 0-128. <dl compact><dt><b>Returns:</b></dt><dd>Volume of music, 0-128. </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__ZMusic_8h-source.html">ZE_ZMusic.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>

44
doc/html/classZE_1_1ZRect-members.html Normal file
View File

@ -0,0 +1,44 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZRect Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a22">Bottom</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a13">Contains</a>(float x, float y) const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a14">Contains</a>(const ZRect &amp;rect) const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a7">Draw</a>(Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a24">Height</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a15">Intersection</a>(const ZRect &amp;rect) const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a12">Intersects</a>(const ZRect &amp;rect) const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a19">Left</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a8">Move</a>(float x, float y)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a9">MoveRel</a>(float xMove, float yMove)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a6">operator&lt;</a>(const ZRect &amp;rhs) const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a4">operator=</a>(const ZRect &amp;rhs)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a10">Resize</a>(float width, float height)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a11">ResizeRel</a>(float widthChange, float heightChange)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#n3">rHeight</a></td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a20">Right</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#n2">rWidth</a></td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#n0">rX</a></td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#n1">rY</a></td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a16">SDLrect</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a21">Top</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a23">Width</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a17">X</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a18">Y</a>() const</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a0">ZRect</a>()</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a1">ZRect</a>(float x, float y, float width, float height)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a2">ZRect</a>(const SDL_Rect &amp;rect)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a3">ZRect</a>(const ZRect &amp;rhs)</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZRect.html#a5">~ZRect</a>()</td><td><a class="el" href="classZE_1_1ZRect.html">ZE::ZRect</a></td><td><code> [virtual]</code></td></tr>
</table><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>

987
doc/html/classZE_1_1ZRect.html Normal file
View File

@ -0,0 +1,987 @@
<!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::ZRect 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZRect Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZRect_8h-source.html">ZE_ZRect.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZRect-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZRect.html">ZRect</a> Rectangle class, used to define a rectangular area or perform operations on the defined area.
<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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a0">ZRect</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor for <a class="el" href="classZE_1_1ZRect.html">ZRect</a>.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a1">ZRect</a> (float x, float y, float width, float height)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor for <a class="el" href="classZE_1_1ZRect.html">ZRect</a> that takes inital values.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a2">ZRect</a> (const SDL_Rect &amp;rect)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor for <a class="el" href="classZE_1_1ZRect.html">ZRect</a> that uses an SDL_Rect.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a3">ZRect</a> (const ZRect &amp;rhs)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Copy constructor for <a class="el" href="classZE_1_1ZRect.html">ZRect</a>.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const ZRect &amp;&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a4">operator=</a> (const ZRect &amp;rhs)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Overload for = operator with <a class="el" href="classZE_1_1ZRect.html">ZRect</a>.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a5">~ZRect</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Virtual Destructor.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a6">operator&lt;</a> (const ZRect &amp;rhs) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Overload for &lt; operator with <a class="el" href="classZE_1_1ZRect.html">ZRect</a>, based upon location then size.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a7">Draw</a> (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Draw rectangle. (filled).</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a8">Move</a> (float x, float y)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Changes the location of the rectangle.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a9">MoveRel</a> (float xMove, float yMove)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Changes the location of the rectangle based upon the current location.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a10">Resize</a> (float width, float height)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Resize rectangle.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a11">ResizeRel</a> (float widthChange, float heightChange)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Grows or shrinks current rectangle.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a12">Intersects</a> (const ZRect &amp;rect) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if one <a class="el" href="classZE_1_1ZRect.html">ZRect</a> intersects another.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a13">Contains</a> (float x, float y) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if a rectangle contains a given point.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a14">Contains</a> (const ZRect &amp;rect) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if a rectangle contains a given point.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>ZRect&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a15">Intersection</a> (const ZRect &amp;rect) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Finds intersection of two rectangles.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>SDL_Rect&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a16">SDLrect</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns an SDL_Rect representing the rectangle.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a17">X</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns X Location.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a18">Y</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns Y Location.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a19">Left</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return position of left side.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a20">Right</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return position of right side.</em> <a href="#a20"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a21">Top</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return position of top side.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a22">Bottom</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return position of bottom side.</em> <a href="#a22"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a23">Width</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns Width.</em> <a href="#a23"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#a24">Height</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns Height.</em> <a href="#a24"></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::ZRect::rX"></a>
float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#n0">rX</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>X Position of top left corner of rectangle.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZRect::rY"></a>
float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#n1">rY</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Y Position of top left corner of rectangle.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZRect::rWidth"></a>
float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#n2">rWidth</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Width of Rectangle.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZRect::rHeight"></a>
float&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html#n3">rHeight</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Height of Rectangle.</em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZRect::ZRect"></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::ZRect::ZRect </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default constructor, initializes all values to zero. </td>
</tr>
</table>
<a name="a1" doxytag="ZE::ZRect::ZRect"></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::ZRect::ZRect </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>width</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>height</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor for <a class="el" href="classZE_1_1ZRect.html">ZRect</a> that takes inital values for all four members. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x</em>&nbsp;</td><td>Value for x position. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Value for y position. </td></tr>
<tr><td valign=top><em>width</em>&nbsp;</td><td>Value for width. </td></tr>
<tr><td valign=top><em>height</em>&nbsp;</td><td>Value for height. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZRect::ZRect"></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::ZRect::ZRect </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const SDL_Rect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rect</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor for <a class="el" href="classZE_1_1ZRect.html">ZRect</a> that initializes from an SDL_Rect. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rect</em>&nbsp;</td><td>SDL_Rect to intialize from. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a3" doxytag="ZE::ZRect::ZRect"></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::ZRect::ZRect </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZRect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rhs</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Takes a <a class="el" href="classZE_1_1ZRect.html">ZRect</a> and constructs a new identical rectangle. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rhs</em>&nbsp;</td><td>Rectangle to construct from. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a5" doxytag="ZE::ZRect::~ZRect"></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::ZRect::~ZRect </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Virtual destructor making future inheritance safe. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a4" doxytag="ZE::ZRect::operator="></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"> const ZRect &amp; ZE::ZRect::operator= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZRect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rhs</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Copies all values from one <a class="el" href="classZE_1_1ZRect.html">ZRect</a> into another. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rhs</em>&nbsp;</td><td>Rectangle to copy values from. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>New value of the <a class="el" href="classZE_1_1ZRect.html">ZRect</a>. </dd></dl>
</td>
</tr>
</table>
<a name="a6" doxytag="ZE::ZRect::operator<"></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::ZRect::operator&lt; </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZRect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rhs</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Rectangles are sorted by y value, followed by x value, if they start at the same place, the smaller of the two is deemed less than the other. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rhs</em>&nbsp;</td><td>Rectangle to compare. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if this rectangle is smaller than the rhs rectangle, false otherwise. </dd></dl>
</td>
</tr>
</table>
<a name="a7" doxytag="ZE::ZRect::Draw"></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::ZRect::Draw </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>red</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>green</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>blue</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>alpha</em> = 255</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Draw the <a class="el" href="classZE_1_1ZRect.html">ZRect</a>, this function is mainly provided for testing purposes. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>red</em>&nbsp;</td><td>Red component of color (0-255). </td></tr>
<tr><td valign=top><em>green</em>&nbsp;</td><td>Green component of color (0-255). </td></tr>
<tr><td valign=top><em>blue</em>&nbsp;</td><td>Blue component of color (0-255). </td></tr>
<tr><td valign=top><em>alpha</em>&nbsp;</td><td>Alpha component of color (0-255). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a8" doxytag="ZE::ZRect::Move"></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::ZRect::Move </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Changes the current x,y position of the rectangle. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x</em>&nbsp;</td><td>New x position for rectangle. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>New y position for rectangle. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a9" doxytag="ZE::ZRect::MoveRel"></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::ZRect::MoveRel </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>xMove</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>yMove</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Changes the current x,y position of the rectangle relative to the current location. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>xMove</em>&nbsp;</td><td>Offset for new x position from current. </td></tr>
<tr><td valign=top><em>yMove</em>&nbsp;</td><td>Offset for new y position from current. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a10" doxytag="ZE::ZRect::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::ZRect::Resize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>width</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>height</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Changes the current width and height of the rectangle. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>width</em>&nbsp;</td><td>New width for rectangle. </td></tr>
<tr><td valign=top><em>height</em>&nbsp;</td><td>New height for rectangle. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a11" doxytag="ZE::ZRect::ResizeRel"></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::ZRect::ResizeRel </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>widthChange</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>heightChange</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Changes the current width and height of the rectangle based upon current values. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>widthChange</em>&nbsp;</td><td>Amount to add or subtract from width. </td></tr>
<tr><td valign=top><em>heightChange</em>&nbsp;</td><td>Amount to add or subtract from height. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a12" doxytag="ZE::ZRect::Intersects"></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::ZRect::Intersects </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZRect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rect</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Checks for overlap and returns boolean value based on if overlap exists. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rect</em>&nbsp;</td><td>Rectangle to check for intersection with. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if intersection occured, false otherwise. </dd></dl>
</td>
</tr>
</table>
<a name="a13" doxytag="ZE::ZRect::Contains"></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::ZRect::Contains </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Checks point against boundaries of rectangle and returns result. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x</em>&nbsp;</td><td>X value of point to check. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y value of poitn to check. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Boolean variable, true if point is inside rectangle, false otherwise. </dd></dl>
</td>
</tr>
</table>
<a name="a14" doxytag="ZE::ZRect::Contains"></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::ZRect::Contains </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZRect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rect</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Checks point against boundaries of rectangle and returns result. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rect</em>&nbsp;</td><td>Rectangle to check for point. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Boolean variable, true if point is inside rectangle, false otherwise. </dd></dl>
</td>
</tr>
</table>
<a name="a15" doxytag="ZE::ZRect::Intersection"></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"> ZRect ZE::ZRect::Intersection </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZRect &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rect</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Checks for intersection, and returns rectangle where the two rectangles intersect. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rect</em>&nbsp;</td><td>Rectangle to check intersection with. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classZE_1_1ZRect.html">ZRect</a> describing intersection area. </dd></dl>
</td>
</tr>
</table>
<a name="a16" doxytag="ZE::ZRect::SDLrect"></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"> SDL_Rect ZE::ZRect::SDLrect </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Makes a SDL_Rect representing the rectangle, for use where functions require an SDL_Rect. <dl compact><dt><b>Returns:</b></dt><dd>SDL_Rect representing the <a class="el" href="classZE_1_1ZRect.html">ZRect</a>. </dd></dl>
</td>
</tr>
</table>
<a name="a17" doxytag="ZE::ZRect::X"></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"> float ZE::ZRect::X </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Access private X location member. <dl compact><dt><b>Returns:</b></dt><dd>Value of mX. </dd></dl>
</td>
</tr>
</table>
<a name="a18" doxytag="ZE::ZRect::Y"></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"> float ZE::ZRect::Y </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Access private Y location member. <dl compact><dt><b>Returns:</b></dt><dd>Value of mY. </dd></dl>
</td>
</tr>
</table>
<a name="a19" doxytag="ZE::ZRect::Left"></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"> float ZE::ZRect::Left </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find X position of left side of rectangle. <dl compact><dt><b>Returns:</b></dt><dd>X position of left side. </dd></dl>
</td>
</tr>
</table>
<a name="a20" doxytag="ZE::ZRect::Right"></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"> float ZE::ZRect::Right </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find X position of right side of rectangle. <dl compact><dt><b>Returns:</b></dt><dd>X position of right side. </dd></dl>
</td>
</tr>
</table>
<a name="a21" doxytag="ZE::ZRect::Top"></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"> float ZE::ZRect::Top </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find Y position of top side of rectangle. <dl compact><dt><b>Returns:</b></dt><dd>Y position of top side. </dd></dl>
</td>
</tr>
</table>
<a name="a22" doxytag="ZE::ZRect::Bottom"></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"> float ZE::ZRect::Bottom </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find Y position of left side of rectangle. <dl compact><dt><b>Returns:</b></dt><dd>Y position of bottom side. </dd></dl>
</td>
</tr>
</table>
<a name="a23" doxytag="ZE::ZRect::Width"></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"> float ZE::ZRect::Width </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Access private width member. <dl compact><dt><b>Returns:</b></dt><dd>Value of mWidth. </dd></dl>
</td>
</tr>
</table>
<a name="a24" doxytag="ZE::ZRect::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"> float ZE::ZRect::Height </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Access private height member. <dl compact><dt><b>Returns:</b></dt><dd>Value of mHeight. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="ZE__ZRect_8h-source.html">ZE_ZRect.h</a><li>/src/<a class="el" href="ZE__ZRect_8cpp.html">ZE_ZRect.cpp</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>

33
doc/html/classZE_1_1ZSound-members.html Normal file
View File

@ -0,0 +1,33 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZSound Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a10">IsLoaded</a>() const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a12">IsPaused</a>() const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a11">IsPlaying</a>() const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#p0">LoopInfinite</a></td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td><code> [static]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a3">Open</a>(string filename)</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a6">Pause</a>() const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a5">Play</a>(int loopNum=0, int fadeTime=0)</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#n2">rChannelID</a></td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a4">Release</a>()</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#n0">rEngine</a></td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#n1">rSound</a></td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a9">SetVolume</a>(int volume)</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a8">Stop</a>(int fadeTime=0) const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a7">Unpause</a>() const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a13">Volume</a>() const</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a0">ZSound</a>()</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a1">ZSound</a>(string filename)</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZSound.html#a2">~ZSound</a>()</td><td><a class="el" href="classZE_1_1ZSound.html">ZE::ZSound</a></td><td><code> [virtual]</code></td></tr>
</table><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>

505
doc/html/classZE_1_1ZSound.html Normal file
View File

@ -0,0 +1,505 @@
<!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::ZSound 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZSound Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZSound_8h-source.html">ZE_ZSound.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZSound-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZSound.html">ZSound</a> music class, class wraps common features for SDL_Mixer's Mix_Chunk. 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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a0">ZSound</a> ()</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a1">ZSound</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor that opens a sound effect file.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a2">~ZSound</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a3">Open</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Opens a sound effect file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a4">Release</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Release sound effect.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a5">Play</a> (int loopNum=0, int fadeTime=0)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Play currently loaded sound effect.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a6">Pause</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pause sound.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a7">Unpause</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Unpause sound.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a8">Stop</a> (int fadeTime=0) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop sound.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a9">SetVolume</a> (int volume)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Change Volume.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a10">IsLoaded</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if file is loaded.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a11">IsPlaying</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if sound is Playing.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a12">IsPaused</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if sound is Paused.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#a13">Volume</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Find Current Volume of Sound Channel.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="p0" doxytag="ZE::ZSound::LoopInfinite"></a>
const int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#p0">LoopInfinite</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static Variable For Infinite loop of sound. (Defined as -1).</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::ZSound::rEngine"></a>
<a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#n0">rEngine</a></td></tr>
<tr><td>&nbsp;</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::ZSound::rSound"></a>
Mix_Chunk *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#n1">rSound</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pointer to music data.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZSound::rChannelID"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html#n2">rChannelID</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Channel ID Number from SDL_Mixer.</em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZSound::ZSound"></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::ZSound::ZSound </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default Constructor, does nothing. </td>
</tr>
</table>
<a name="a1" doxytag="ZE::ZSound::ZSound"></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::ZSound::ZSound </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor simply calls <a class="el" href="classZE_1_1ZSound.html#a3">ZSound::Open()</a> with same filename. (WAV,MOD,MID,OGG) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>Sound effect to open. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZSound::~ZSound"></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::ZSound::~ZSound </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor calls <a class="el" href="classZE_1_1ZSound.html#a4">ZSound::Release()</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="ZE::ZSound::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::ZSound::Open </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Open a music file to be used. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>Music to open. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a4" doxytag="ZE::ZSound::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::ZSound::Release </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Release memory held by sample data. </td>
</tr>
</table>
<a name="a5" doxytag="ZE::ZSound::Play"></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::ZSound::Play </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>loopNum</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>fadeTime</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Play sound effect, looping loopNum times. (use <a class="el" href="classZE_1_1ZSound.html#p0">ZSound::LoopInfinite</a> to loop forever.) If fade is not zero (which it defaults to) music will fade in over specified number of milliseconds. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>loopNum</em>&nbsp;</td><td>Number of times to loop song, defaults to zero. </td></tr>
<tr><td valign=top><em>fadeTime</em>&nbsp;</td><td>Milliseconds to fade to full volume, defaults to zero for no fade. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a6" doxytag="ZE::ZSound::Pause"></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::ZSound::Pause </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Pause currently playing sound. </td>
</tr>
</table>
<a name="a7" doxytag="ZE::ZSound::Unpause"></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::ZSound::Unpause </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Unpause currently playing sound. </td>
</tr>
</table>
<a name="a8" doxytag="ZE::ZSound::Stop"></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::ZSound::Stop </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>fadeTime</em> = 0 </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Stop currently playing sound, if fadeTime is not zero, fade out over specified time. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>fadeTime</em>&nbsp;</td><td>Milliseconds to fade out over, defaults to zero for immediate stop. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a9" doxytag="ZE::ZSound::SetVolume"></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::ZSound::SetVolume </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>volume</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Change volume of currently playing sample. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>volume</em>&nbsp;</td><td>Volume to change to, can be in a range from 0 to 128. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a10" doxytag="ZE::ZSound::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::ZSound::IsLoaded </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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="a11" doxytag="ZE::ZSound::IsPlaying"></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::ZSound::IsPlaying </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if sound is playing, specifically if it is not stopped. (Paused state should be checked for by IsPaused) <dl compact><dt><b>Returns:</b></dt><dd>Playing / Not Playing State of sound. </dd></dl>
</td>
</tr>
</table>
<a name="a12" doxytag="ZE::ZSound::IsPaused"></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::ZSound::IsPaused </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if sound is "playing" but currently paused. <dl compact><dt><b>Returns:</b></dt><dd>Paused / Not Paused State of Sound. </dd></dl>
</td>
</tr>
</table>
<a name="a13" doxytag="ZE::ZSound::Volume"></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::ZSound::Volume </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get current volume of sound channel represented as a value from 0-128. <dl compact><dt><b>Returns:</b></dt><dd>Volume of sound channel, 0-128. </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__ZSound_8h-source.html">ZE_ZSound.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>

28
doc/html/classZE_1_1ZTimer-members.html Normal file
View File

@ -0,0 +1,28 @@
<!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>Member List</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZTimer Member List</h1>This is the complete list of members for <a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a>, including all inherited members.<table>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#b0">GetParentTime</a>() const</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a5">GetTime</a>() const</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a6">IsPaused</a>() const</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a3">Pause</a>()</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#n0">rEngine</a></td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a2">Reset</a>()</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#n4">rLastPause</a></td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#n1">rPaused</a></td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#n3">rPausedTime</a></td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#n2">rUseZEngine</a></td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [protected]</code></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a4">Unpause</a>()</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a0">ZTimer</a>(bool useZEngine=true)</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td></td></tr>
<tr bgcolor="#f0f0f0"><td><a class="el" href="classZE_1_1ZTimer.html#a1">~ZTimer</a>()</td><td><a class="el" href="classZE_1_1ZTimer.html">ZE::ZTimer</a></td><td><code> [virtual]</code></td></tr>
</table><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>

293
doc/html/classZE_1_1ZTimer.html Normal file
View File

@ -0,0 +1,293 @@
<!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::ZTimer 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZTimer Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZTimer_8h-source.html">ZE_ZTimer.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZTimer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZTimer.html">ZTimer</a> timing class, class wraps common features of SDL timer. Inherited from ZObject and tied to <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> main timer.
<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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a0">ZTimer</a> (bool useZEngine=true)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructs a new Timer.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a1">~ZTimer</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Virtual Destructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a2">Reset</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reset Timer.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a3">Pause</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pause Timer.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a4">Unpause</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Unpause Timer.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Uint32&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a5">GetTime</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get Time of Timer.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#a6">IsPaused</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get paused state.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>Uint32&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#b0">GetParentTime</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get time from parent timer.</em> <a href="#b0"></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::ZTimer::rEngine"></a>
<a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#n0">rEngine</a></td></tr>
<tr><td>&nbsp;</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::ZTimer::rPaused"></a>
bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#n1">rPaused</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Paused / Unpaused state of Timer.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZTimer::rUseZEngine"></a>
bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#n2">rUseZEngine</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Using <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> timer or SDL global timer.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZTimer::rPausedTime"></a>
Uint32&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#n3">rPausedTime</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Total time this timer has been paused.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n4" doxytag="ZE::ZTimer::rLastPause"></a>
Uint32&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html#n4">rLastPause</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Time this Timer was paused.</em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZTimer::ZTimer"></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::ZTimer::ZTimer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">bool&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>useZEngine</em> = true </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Sets TimePaused to current <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> time if useZEngine is true, otherwise uses SDL timer. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>useZEngine</em>&nbsp;</td><td>Tells if timer should use <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> or SDL. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a1" doxytag="ZE::ZTimer::~ZTimer"></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::ZTimer::~ZTimer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Virtual destructor making future inheritance safe. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b0" doxytag="ZE::ZTimer::GetParentTime"></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"> Uint32 ZE::ZTimer::GetParentTime </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Protected method to get time from whichever timer is parent. <dl compact><dt><b>Returns:</b></dt><dd>Time on parent timer. </dd></dl>
</td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZTimer::Reset"></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::ZTimer::Reset </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set Timer back to Zero, will also unpause timer if it was paused. </td>
</tr>
</table>
<a name="a3" doxytag="ZE::ZTimer::Pause"></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::ZTimer::Pause </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Pause the timer if it is unpaused. </td>
</tr>
</table>
<a name="a4" doxytag="ZE::ZTimer::Unpause"></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::ZTimer::Unpause </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Unpause the timer if it is paused. </td>
</tr>
</table>
<a name="a5" doxytag="ZE::ZTimer::GetTime"></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"> Uint32 ZE::ZTimer::GetTime </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get current time accounting for time paused. <dl compact><dt><b>Returns:</b></dt><dd>Current Timer Time. </dd></dl>
</td>
</tr>
</table>
<a name="a6" doxytag="ZE::ZTimer::IsPaused"></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::ZTimer::IsPaused </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Find out paused state of timer. <dl compact><dt><b>Returns:</b></dt><dd>Paused state for timer. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="ZE__ZTimer_8h-source.html">ZE_ZTimer.h</a><li>/src/<a class="el" href="ZE__ZTimer_8cpp.html">ZE_ZTimer.cpp</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>

46
doc/html/files.html Normal file
View File

@ -0,0 +1,46 @@
<!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>File Index</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine File List</h1>Here is a list of all documented files with brief descriptions:<table>
<tr><td class="indexkey">/include/<a class="el" href="ZE__Defines_8h.html">ZE_Defines.h</a> <a href="ZE__Defines_8h-source.html">[code]</a></td><td class="indexvalue">Define file for ZEngine</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__Includes_8h.html">ZE_Includes.h</a> <a href="ZE__Includes_8h-source.html">[code]</a></td><td class="indexvalue">Include file for SDL and C++ Includes that many ZEngine files need</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__Utility_8h.html">ZE_Utility.h</a> <a href="ZE__Utility_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZEngine Utilities</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZClient_8h.html">ZE_ZClient.h</a> <a href="ZE__ZClient_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZClient</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZConfigFile_8h.html">ZE_ZConfigFile.h</a> <a href="ZE__ZConfigFile_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZConfigFile</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a> <a href="ZE__ZEngine_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for core ZEngine class</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZError_8h.html">ZE_ZError.h</a> <a href="ZE__ZError_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZError</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZFont_8h.html">ZE_ZFont.h</a> <a href="ZE__ZFont_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZFont</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZImage_8h.html">ZE_ZImage.h</a> <a href="ZE__ZImage_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZImage</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZMusic_8h.html">ZE_ZMusic.h</a> <a href="ZE__ZMusic_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZMusic</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZRect_8h.html">ZE_ZRect.h</a> <a href="ZE__ZRect_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZRect</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZServer_8h.html">ZE_ZServer.h</a> <a href="ZE__ZServer_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZServer</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZSound_8h.html">ZE_ZSound.h</a> <a href="ZE__ZSound_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZSound</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZE__ZTimer_8h.html">ZE_ZTimer.h</a> <a href="ZE__ZTimer_8h-source.html">[code]</a></td><td class="indexvalue">Definition file for ZTimer</td></tr>
<tr><td class="indexkey">/include/<a class="el" href="ZEngine_8h.html">ZEngine.h</a> <a href="ZEngine_8h-source.html">[code]</a></td><td class="indexvalue">Header file for ZEngine</td></tr>
<tr><td class="indexkey">/include/external/<b>mt19937ar.h</b> <a href="mt19937ar_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey">/include/external/<b>physfsrwops.h</b> <a href="physfsrwops_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey">/include/external/<b>SDLGL_Util.h</b> <a href="SDLGL__Util_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__Utility_8cpp.html">ZE_Utility.cpp</a></td><td class="indexvalue">Source file for ZEngine utility functions</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZClient_8cpp.html">ZE_ZClient.cpp</a></td><td class="indexvalue">Source file for ZClient</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZConfigFile_8cpp.html">ZE_ZConfigFile.cpp</a></td><td class="indexvalue">Source file for ZConfigFile</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZEngine_8cpp.html">ZE_ZEngine.cpp</a></td><td class="indexvalue">Central source file for ZEngine</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZError_8cpp.html">ZE_ZError.cpp</a></td><td class="indexvalue">Source file for ZError</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZFont_8cpp.html">ZE_ZFont.cpp</a></td><td class="indexvalue">Source file for ZFont</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZImage_8cpp.html">ZE_ZImage.cpp</a></td><td class="indexvalue">Source file for ZImage</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZMusic_8cpp.html">ZE_ZMusic.cpp</a></td><td class="indexvalue">Source file for ZMusic</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZRect_8cpp.html">ZE_ZRect.cpp</a></td><td class="indexvalue">Source file for ZRect</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZServer_8cpp.html">ZE_ZServer.cpp</a></td><td class="indexvalue">Source file for ZServer</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZSound_8cpp.html">ZE_ZSound.cpp</a></td><td class="indexvalue">Source file for ZSound</td></tr>
<tr><td class="indexkey">/src/<a class="el" href="ZE__ZTimer_8cpp.html">ZE_ZTimer.cpp</a></td><td class="indexvalue">Source file for ZTimer</td></tr>
</table>
<hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

300
doc/html/functions.html Normal file
View File

@ -0,0 +1,300 @@
<!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>Compound Member Index</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine Compound Members</h1><center>
<a href="#index_a">a</a>&nbsp;|&nbsp;<a href="#index_b">b</a>&nbsp;|&nbsp;<a href="#index_c">c</a>&nbsp;|&nbsp;<a href="#index_d">d</a>&nbsp;|&nbsp;<a href="#index_e">e</a>&nbsp;|&nbsp;<a href="#index_f">f</a>&nbsp;|&nbsp;<a href="#index_g">g</a>&nbsp;|&nbsp;<a href="#index_h">h</a>&nbsp;|&nbsp;<a href="#index_i">i</a>&nbsp;|&nbsp;<a href="#index_k">k</a>&nbsp;|&nbsp;<a href="#index_l">l</a>&nbsp;|&nbsp;<a href="#index_m">m</a>&nbsp;|&nbsp;<a href="#index_o">o</a>&nbsp;|&nbsp;<a href="#index_p">p</a>&nbsp;|&nbsp;<a href="#index_q">q</a>&nbsp;|&nbsp;<a href="#index_r">r</a>&nbsp;|&nbsp;<a href="#index_s">s</a>&nbsp;|&nbsp;<a href="#index_t">t</a>&nbsp;|&nbsp;<a href="#index_u">u</a>&nbsp;|&nbsp;<a href="#index_v">v</a>&nbsp;|&nbsp;<a href="#index_w">w</a>&nbsp;|&nbsp;<a href="#index_x">x</a>&nbsp;|&nbsp;<a href="#index_y">y</a>&nbsp;|&nbsp;<a href="#index_z">z</a>&nbsp;|&nbsp;<a href="#index_~">~</a></center>
<p>
Here is a list of all documented class members with links to the class documentation for each member:<h3><a name="index_a">- a -</a>
</h3><ul>
<li>Alpha()
: <a class="el" href="classZE_1_1ZImage.html#a27">ZE::ZImage</a><li>Attach()
: <a class="el" href="classZE_1_1ZImage.html#a10">ZE::ZImage</a></ul>
<h3><a name="index_b">- b -</a>
</h3><ul>
<li>Bind()
: <a class="el" href="classZE_1_1ZImage.html#a18">ZE::ZImage</a><li>Bottom()
: <a class="el" href="classZE_1_1ZRect.html#a22">ZE::ZRect</a><li>BPP()
: <a class="el" href="classZE_1_1ZEngine.html#a52">ZE::ZEngine</a></ul>
<h3><a name="index_c">- c -</a>
</h3><ul>
<li>CheckEvents()
: <a class="el" href="classZE_1_1ZEngine.html#a34">ZE::ZEngine</a><li>CleanString()
: <a class="el" href="classZE_1_1ZConfigFile.html#b0">ZE::ZConfigFile</a><li>Clear()
: <a class="el" href="classZE_1_1ZEngine.html#a8">ZE::ZEngine</a><li>Close()
: <a class="el" href="classZE_1_1ZConfigFile.html#a13">ZE::ZConfigFile</a><li>CloseDisplay()
: <a class="el" href="classZE_1_1ZEngine.html#a3">ZE::ZEngine</a><li>Code()
: <a class="el" href="classZE_1_1ZError.html#a3">ZE::ZError</a><li>Contains()
: <a class="el" href="classZE_1_1ZRect.html#a14">ZE::ZRect</a><li>Create()
: <a class="el" href="classZE_1_1ZError.html#a2">ZE::ZError</a><li>CreateDisplay()
: <a class="el" href="classZE_1_1ZEngine.html#a2">ZE::ZEngine</a><li>CreateStringTable()
: <a class="el" href="classZE_1_1ZError.html#d0">ZE::ZError</a></ul>
<h3><a name="index_d">- d -</a>
</h3><ul>
<li>Delay()
: <a class="el" href="classZE_1_1ZEngine.html#a10">ZE::ZEngine</a><li>DestroyStringTable()
: <a class="el" href="classZE_1_1ZError.html#d1">ZE::ZError</a><li>Display()
: <a class="el" href="classZE_1_1ZEngine.html#a6">ZE::ZEngine</a><li>Draw()
: <a class="el" href="classZE_1_1ZRect.html#a7">ZE::ZRect</a>, <a class="el" href="classZE_1_1ZImage.html#a20">ZE::ZImage</a><li>DrawRotated()
: <a class="el" href="classZE_1_1ZImage.html#a22">ZE::ZImage</a><li>DrawShadedText()
: <a class="el" href="classZE_1_1ZFont.html#a6">ZE::ZFont</a><li>DrawText()
: <a class="el" href="classZE_1_1ZFont.html#a5">ZE::ZFont</a></ul>
<h3><a name="index_e">- e -</a>
</h3><ul>
<li>Exists()
: <a class="el" href="classZE_1_1ZConfigFile.html#b2">ZE::ZConfigFile</a></ul>
<h3><a name="index_f">- f -</a>
</h3><ul>
<li>Flip()
: <a class="el" href="classZE_1_1ZImage.html#a15">ZE::ZImage</a><li>Flush()
: <a class="el" href="classZE_1_1ZConfigFile.html#a12">ZE::ZConfigFile</a><li>FlushErrors()
: <a class="el" href="classZE_1_1ZEngine.html#a40">ZE::ZEngine</a></ul>
<h3><a name="index_g">- g -</a>
</h3><ul>
<li>GetBool()
: <a class="el" href="classZE_1_1ZConfigFile.html#a6">ZE::ZConfigFile</a><li>GetDesiredFramerate()
: <a class="el" href="classZE_1_1ZEngine.html#a17">ZE::ZEngine</a><li>GetFloat()
: <a class="el" href="classZE_1_1ZConfigFile.html#a4">ZE::ZConfigFile</a><li>GetFramerate()
: <a class="el" href="classZE_1_1ZEngine.html#a15">ZE::ZEngine</a><li>GetFrameTime()
: <a class="el" href="classZE_1_1ZEngine.html#a14">ZE::ZEngine</a><li>GetInstance()
: <a class="el" href="classZE_1_1ZEngine.html#d0">ZE::ZEngine</a><li>GetInt()
: <a class="el" href="classZE_1_1ZConfigFile.html#a5">ZE::ZConfigFile</a><li>GetLastError()
: <a class="el" href="classZE_1_1ZEngine.html#a38">ZE::ZEngine</a><li>GetParentTime()
: <a class="el" href="classZE_1_1ZTimer.html#b0">ZE::ZTimer</a><li>GetString()
: <a class="el" href="classZE_1_1ZConfigFile.html#a7">ZE::ZConfigFile</a><li>GetTime()
: <a class="el" href="classZE_1_1ZTimer.html#a5">ZE::ZTimer</a>, <a class="el" href="classZE_1_1ZEngine.html#a11">ZE::ZEngine</a><li>GetVariable()
: <a class="el" href="classZE_1_1ZConfigFile.html#b4">ZE::ZConfigFile</a><li>GetVersion()
: <a class="el" href="classZE_1_1ZEngine.html#d2">ZE::ZEngine</a></ul>
<h3><a name="index_h">- h -</a>
</h3><ul>
<li>Height()
: <a class="el" href="classZE_1_1ZRect.html#a24">ZE::ZRect</a>, <a class="el" href="classZE_1_1ZImage.html#a26">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZFont.html#a15">ZE::ZFont</a>, <a class="el" href="classZE_1_1ZEngine.html#a51">ZE::ZEngine</a><li>HideCursor()
: <a class="el" href="classZE_1_1ZEngine.html#a27">ZE::ZEngine</a></ul>
<h3><a name="index_i">- i -</a>
</h3><ul>
<li>ImagesNeedReload()
: <a class="el" href="classZE_1_1ZEngine.html#a23">ZE::ZEngine</a><li>Initialized()
: <a class="el" href="classZE_1_1ZEngine.html#a5">ZE::ZEngine</a><li>Intersection()
: <a class="el" href="classZE_1_1ZRect.html#a15">ZE::ZRect</a><li>Intersects()
: <a class="el" href="classZE_1_1ZRect.html#a12">ZE::ZRect</a><li>IsActive()
: <a class="el" href="classZE_1_1ZEngine.html#a19">ZE::ZEngine</a><li>IsBold()
: <a class="el" href="classZE_1_1ZFont.html#a12">ZE::ZFont</a><li>IsFullscreen()
: <a class="el" href="classZE_1_1ZEngine.html#a53">ZE::ZEngine</a><li>IsItalic()
: <a class="el" href="classZE_1_1ZFont.html#a13">ZE::ZFont</a><li>IsLoaded()
: <a class="el" href="classZE_1_1ZSound.html#a10">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a11">ZE::ZMusic</a>, <a class="el" href="classZE_1_1ZImage.html#a23">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZFont.html#a11">ZE::ZFont</a><li>IsPaused()
: <a class="el" href="classZE_1_1ZTimer.html#a6">ZE::ZTimer</a>, <a class="el" href="classZE_1_1ZSound.html#a12">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a13">ZE::ZMusic</a>, <a class="el" href="classZE_1_1ZEngine.html#a18">ZE::ZEngine</a><li>IsPlaying()
: <a class="el" href="classZE_1_1ZSound.html#a11">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a12">ZE::ZMusic</a><li>IsUnderlined()
: <a class="el" href="classZE_1_1ZFont.html#a14">ZE::ZFont</a></ul>
<h3><a name="index_k">- k -</a>
</h3><ul>
<li>KeyIsPressed()
: <a class="el" href="classZE_1_1ZEngine.html#a25">ZE::ZEngine</a><li>KeyPress()
: <a class="el" href="classZE_1_1ZEngine.html#a26">ZE::ZEngine</a></ul>
<h3><a name="index_l">- l -</a>
</h3><ul>
<li>LButtonPressed()
: <a class="el" href="classZE_1_1ZEngine.html#a31">ZE::ZEngine</a><li>Left()
: <a class="el" href="classZE_1_1ZRect.html#a19">ZE::ZRect</a><li>LineSkip()
: <a class="el" href="classZE_1_1ZFont.html#a16">ZE::ZFont</a><li>LoadFont()
: <a class="el" href="classZE_1_1ZEngine.html#a49">ZE::ZEngine</a><li>LoadImage()
: <a class="el" href="classZE_1_1ZEngine.html#a46">ZE::ZEngine</a><li>LoadMusic()
: <a class="el" href="classZE_1_1ZEngine.html#a48">ZE::ZEngine</a><li>LoadSound()
: <a class="el" href="classZE_1_1ZEngine.html#a47">ZE::ZEngine</a><li>LogError()
: <a class="el" href="classZE_1_1ZEngine.html#c1">ZE::ZEngine</a><li>LogString()
: <a class="el" href="classZE_1_1ZError.html#a4">ZE::ZError</a><li>LoopInfinite
: <a class="el" href="classZE_1_1ZSound.html#p0">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#p0">ZE::ZMusic</a></ul>
<h3><a name="index_m">- m -</a>
</h3><ul>
<li>mActive
: <a class="el" href="classZE_1_1ZEngine.html#o15">ZE::ZEngine</a><li>mBPP
: <a class="el" href="classZE_1_1ZEngine.html#o2">ZE::ZEngine</a><li>mCurError
: <a class="el" href="classZE_1_1ZEngine.html#o23">ZE::ZEngine</a><li>mDesiredFramerate
: <a class="el" href="classZE_1_1ZEngine.html#o8">ZE::ZEngine</a><li>mErrlog
: <a class="el" href="classZE_1_1ZEngine.html#o25">ZE::ZEngine</a><li>mErrorQueue
: <a class="el" href="classZE_1_1ZEngine.html#o22">ZE::ZEngine</a><li>mFullscreen
: <a class="el" href="classZE_1_1ZEngine.html#o3">ZE::ZEngine</a><li>mHeight
: <a class="el" href="classZE_1_1ZEngine.html#o1">ZE::ZEngine</a><li>mInitialized
: <a class="el" href="classZE_1_1ZEngine.html#o4">ZE::ZEngine</a><li>mKeyIsPressed
: <a class="el" href="classZE_1_1ZEngine.html#o17">ZE::ZEngine</a><li>mKeyPress
: <a class="el" href="classZE_1_1ZEngine.html#o18">ZE::ZEngine</a><li>mLastPause
: <a class="el" href="classZE_1_1ZEngine.html#o10">ZE::ZEngine</a><li>mLastTime
: <a class="el" href="classZE_1_1ZEngine.html#o12">ZE::ZEngine</a><li>mLogAllErrors
: <a class="el" href="classZE_1_1ZEngine.html#o24">ZE::ZEngine</a><li>mMouseB
: <a class="el" href="classZE_1_1ZEngine.html#o21">ZE::ZEngine</a><li>mMouseX
: <a class="el" href="classZE_1_1ZEngine.html#o19">ZE::ZEngine</a><li>mMouseY
: <a class="el" href="classZE_1_1ZEngine.html#o20">ZE::ZEngine</a><li>mNeedReload
: <a class="el" href="classZE_1_1ZEngine.html#o14">ZE::ZEngine</a><li>mNextUpdate
: <a class="el" href="classZE_1_1ZEngine.html#o9">ZE::ZEngine</a><li>MouseInRect()
: <a class="el" href="classZE_1_1ZEngine.html#a33">ZE::ZEngine</a><li>MouseX()
: <a class="el" href="classZE_1_1ZEngine.html#a29">ZE::ZEngine</a><li>MouseY()
: <a class="el" href="classZE_1_1ZEngine.html#a30">ZE::ZEngine</a><li>Move()
: <a class="el" href="classZE_1_1ZRect.html#a8">ZE::ZRect</a><li>MoveRel()
: <a class="el" href="classZE_1_1ZRect.html#a9">ZE::ZRect</a><li>mPaused
: <a class="el" href="classZE_1_1ZEngine.html#o6">ZE::ZEngine</a><li>mPausedTime
: <a class="el" href="classZE_1_1ZEngine.html#o11">ZE::ZEngine</a><li>mQuit
: <a class="el" href="classZE_1_1ZEngine.html#o16">ZE::ZEngine</a><li>mRate
: <a class="el" href="classZE_1_1ZEngine.html#o26">ZE::ZEngine</a><li>mScreen
: <a class="el" href="classZE_1_1ZEngine.html#o5">ZE::ZEngine</a><li>mSecPerFrame
: <a class="el" href="classZE_1_1ZEngine.html#o13">ZE::ZEngine</a><li>mStereo
: <a class="el" href="classZE_1_1ZEngine.html#o27">ZE::ZEngine</a><li>mUnpauseOnActive
: <a class="el" href="classZE_1_1ZEngine.html#o7">ZE::ZEngine</a><li>mWidth
: <a class="el" href="classZE_1_1ZEngine.html#o0">ZE::ZEngine</a></ul>
<h3><a name="index_o">- o -</a>
</h3><ul>
<li>Open()
: <a class="el" href="classZE_1_1ZSound.html#a3">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a3">ZE::ZMusic</a>, <a class="el" href="classZE_1_1ZImage.html#a7">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZFont.html#a3">ZE::ZFont</a><li>OpenFromImage()
: <a class="el" href="classZE_1_1ZImage.html#a9">ZE::ZImage</a><li>operator&lt;()
: <a class="el" href="classZE_1_1ZRect.html#a6">ZE::ZRect</a><li>operator=()
: <a class="el" href="classZE_1_1ZRect.html#a4">ZE::ZRect</a></ul>
<h3><a name="index_p">- p -</a>
</h3><ul>
<li>Pause()
: <a class="el" href="classZE_1_1ZTimer.html#a3">ZE::ZTimer</a>, <a class="el" href="classZE_1_1ZSound.html#a6">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a6">ZE::ZMusic</a><li>PauseTimer()
: <a class="el" href="classZE_1_1ZEngine.html#a12">ZE::ZEngine</a><li>Play()
: <a class="el" href="classZE_1_1ZSound.html#a5">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a5">ZE::ZMusic</a><li>Process()
: <a class="el" href="classZE_1_1ZConfigFile.html#a3">ZE::ZConfigFile</a></ul>
<h3><a name="index_q">- q -</a>
</h3><ul>
<li>QuitRequested()
: <a class="el" href="classZE_1_1ZEngine.html#a21">ZE::ZEngine</a></ul>
<h3><a name="index_r">- r -</a>
</h3><ul>
<li>rAlpha
: <a class="el" href="classZE_1_1ZImage.html#n9">ZE::ZImage</a><li>RandDouble()
: <a class="el" href="classZE_1_1ZEngine.html#a45">ZE::ZEngine</a><li>RandLong()
: <a class="el" href="classZE_1_1ZEngine.html#a43">ZE::ZEngine</a><li>rBGColor
: <a class="el" href="classZE_1_1ZFont.html#n4">ZE::ZFont</a><li>RButtonPressed()
: <a class="el" href="classZE_1_1ZEngine.html#a32">ZE::ZEngine</a><li>rChannelID
: <a class="el" href="classZE_1_1ZSound.html#n2">ZE::ZSound</a><li>rCode
: <a class="el" href="classZE_1_1ZError.html#n0">ZE::ZError</a><li>rColor
: <a class="el" href="classZE_1_1ZFont.html#n3">ZE::ZFont</a><li>rDescription
: <a class="el" href="classZE_1_1ZError.html#n1">ZE::ZError</a><li>Release()
: <a class="el" href="classZE_1_1ZSound.html#a4">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a4">ZE::ZMusic</a>, <a class="el" href="classZE_1_1ZImage.html#a12">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZFont.html#a4">ZE::ZFont</a><li>ReleaseInstance()
: <a class="el" href="classZE_1_1ZEngine.html#d1">ZE::ZEngine</a><li>Reload()
: <a class="el" href="classZE_1_1ZImage.html#a11">ZE::ZImage</a><li>rEngine
: <a class="el" href="classZE_1_1ZTimer.html#n0">ZE::ZTimer</a>, <a class="el" href="classZE_1_1ZSound.html#n0">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#n0">ZE::ZMusic</a>, <a class="el" href="classZE_1_1ZImage.html#n0">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZFont.html#n0">ZE::ZFont</a><li>ReportError()
: <a class="el" href="classZE_1_1ZEngine.html#a37">ZE::ZEngine</a><li>RequestQuit()
: <a class="el" href="classZE_1_1ZEngine.html#a20">ZE::ZEngine</a><li>Reset()
: <a class="el" href="classZE_1_1ZTimer.html#a2">ZE::ZTimer</a><li>Resize()
: <a class="el" href="classZE_1_1ZRect.html#a10">ZE::ZRect</a>, <a class="el" href="classZE_1_1ZImage.html#a17">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZFont.html#a10">ZE::ZFont</a><li>ResizeRel()
: <a class="el" href="classZE_1_1ZRect.html#a11">ZE::ZRect</a><li>Rewind()
: <a class="el" href="classZE_1_1ZMusic.html#a8">ZE::ZMusic</a><li>rFileLayout
: <a class="el" href="classZE_1_1ZConfigFile.html#n0">ZE::ZConfigFile</a><li>rFilename
: <a class="el" href="classZE_1_1ZFont.html#n2">ZE::ZFont</a>, <a class="el" href="classZE_1_1ZError.html#n2">ZE::ZError</a>, <a class="el" href="classZE_1_1ZConfigFile.html#n1">ZE::ZConfigFile</a><li>rFont
: <a class="el" href="classZE_1_1ZFont.html#n1">ZE::ZFont</a><li>rHeight
: <a class="el" href="classZE_1_1ZRect.html#n3">ZE::ZRect</a>, <a class="el" href="classZE_1_1ZImage.html#n8">ZE::ZImage</a><li>Right()
: <a class="el" href="classZE_1_1ZRect.html#a20">ZE::ZRect</a><li>rImage
: <a class="el" href="classZE_1_1ZImage.html#n5">ZE::ZImage</a><li>rLastPause
: <a class="el" href="classZE_1_1ZTimer.html#n4">ZE::ZTimer</a><li>rLine
: <a class="el" href="classZE_1_1ZError.html#n3">ZE::ZError</a><li>rMusic
: <a class="el" href="classZE_1_1ZMusic.html#n1">ZE::ZMusic</a><li>rPaused
: <a class="el" href="classZE_1_1ZTimer.html#n1">ZE::ZTimer</a><li>rPausedTime
: <a class="el" href="classZE_1_1ZTimer.html#n3">ZE::ZTimer</a><li>rSound
: <a class="el" href="classZE_1_1ZSound.html#n1">ZE::ZSound</a><li>rTexID
: <a class="el" href="classZE_1_1ZImage.html#n6">ZE::ZImage</a><li>rTexMaxX
: <a class="el" href="classZE_1_1ZImage.html#n3">ZE::ZImage</a><li>rTexMaxY
: <a class="el" href="classZE_1_1ZImage.html#n4">ZE::ZImage</a><li>rTexMinX
: <a class="el" href="classZE_1_1ZImage.html#n1">ZE::ZImage</a><li>rTexMinY
: <a class="el" href="classZE_1_1ZImage.html#n2">ZE::ZImage</a><li>rUseZEngine
: <a class="el" href="classZE_1_1ZTimer.html#n2">ZE::ZTimer</a><li>rWidth
: <a class="el" href="classZE_1_1ZRect.html#n2">ZE::ZRect</a>, <a class="el" href="classZE_1_1ZImage.html#n7">ZE::ZImage</a><li>rX
: <a class="el" href="classZE_1_1ZRect.html#n0">ZE::ZRect</a><li>rY
: <a class="el" href="classZE_1_1ZRect.html#n1">ZE::ZRect</a></ul>
<h3><a name="index_s">- s -</a>
</h3><ul>
<li>SDLrect()
: <a class="el" href="classZE_1_1ZRect.html#a16">ZE::ZRect</a><li>section
: <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m0">ZE::ZConfigFile::ZCF_Section</a><li>SeedRandom()
: <a class="el" href="classZE_1_1ZEngine.html#a41">ZE::ZEngine</a><li>sErrorDesc
: <a class="el" href="classZE_1_1ZError.html#q0">ZE::ZError</a><li>SetAlpha()
: <a class="el" href="classZE_1_1ZImage.html#a13">ZE::ZImage</a><li>SetBGColor()
: <a class="el" href="classZE_1_1ZFont.html#a8">ZE::ZFont</a><li>SetBool()
: <a class="el" href="classZE_1_1ZConfigFile.html#a10">ZE::ZConfigFile</a><li>SetColor()
: <a class="el" href="classZE_1_1ZFont.html#a7">ZE::ZFont</a><li>SetColorKey()
: <a class="el" href="classZE_1_1ZImage.html#a14">ZE::ZImage</a><li>SetDesiredFramerate()
: <a class="el" href="classZE_1_1ZEngine.html#a16">ZE::ZEngine</a><li>SetErrorLog()
: <a class="el" href="classZE_1_1ZEngine.html#a36">ZE::ZEngine</a><li>SetEventFilter()
: <a class="el" href="classZE_1_1ZEngine.html#a35">ZE::ZEngine</a><li>SetFloat()
: <a class="el" href="classZE_1_1ZConfigFile.html#a8">ZE::ZConfigFile</a><li>SetGL2D()
: <a class="el" href="classZE_1_1ZEngine.html#a9">ZE::ZEngine</a><li>SetInt()
: <a class="el" href="classZE_1_1ZConfigFile.html#a9">ZE::ZConfigFile</a><li>SetKeyRepeatRate()
: <a class="el" href="classZE_1_1ZEngine.html#a24">ZE::ZEngine</a><li>SetReloadNeed()
: <a class="el" href="classZE_1_1ZEngine.html#a22">ZE::ZEngine</a><li>SetString()
: <a class="el" href="classZE_1_1ZConfigFile.html#a11">ZE::ZConfigFile</a><li>SetStyle()
: <a class="el" href="classZE_1_1ZFont.html#a9">ZE::ZFont</a><li>SetupDisplay()
: <a class="el" href="classZE_1_1ZEngine.html#a0">ZE::ZEngine</a><li>SetupSound()
: <a class="el" href="classZE_1_1ZEngine.html#a1">ZE::ZEngine</a><li>SetVariable()
: <a class="el" href="classZE_1_1ZConfigFile.html#b3">ZE::ZConfigFile</a><li>SetVolume()
: <a class="el" href="classZE_1_1ZSound.html#a9">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a10">ZE::ZMusic</a><li>ShowCursor()
: <a class="el" href="classZE_1_1ZEngine.html#a28">ZE::ZEngine</a><li>sInstance
: <a class="el" href="classZE_1_1ZEngine.html#r0">ZE::ZEngine</a><li>Stop()
: <a class="el" href="classZE_1_1ZSound.html#a8">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a9">ZE::ZMusic</a><li>Stretch()
: <a class="el" href="classZE_1_1ZImage.html#a16">ZE::ZImage</a><li>StringHeight()
: <a class="el" href="classZE_1_1ZFont.html#a18">ZE::ZFont</a><li>StringWidth()
: <a class="el" href="classZE_1_1ZFont.html#a17">ZE::ZFont</a><li>Surface()
: <a class="el" href="classZE_1_1ZImage.html#a24">ZE::ZImage</a></ul>
<h3><a name="index_t">- t -</a>
</h3><ul>
<li>ToggleFullscreen()
: <a class="el" href="classZE_1_1ZEngine.html#a4">ZE::ZEngine</a><li>Top()
: <a class="el" href="classZE_1_1ZRect.html#a21">ZE::ZRect</a></ul>
<h3><a name="index_u">- u -</a>
</h3><ul>
<li>Unpause()
: <a class="el" href="classZE_1_1ZTimer.html#a4">ZE::ZTimer</a>, <a class="el" href="classZE_1_1ZSound.html#a7">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a7">ZE::ZMusic</a><li>UnpauseTimer()
: <a class="el" href="classZE_1_1ZEngine.html#a13">ZE::ZEngine</a><li>Update()
: <a class="el" href="classZE_1_1ZEngine.html#a7">ZE::ZEngine</a></ul>
<h3><a name="index_v">- v -</a>
</h3><ul>
<li>val
: <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m1">ZE::ZConfigFile::ZCF_Variable</a><li>var
: <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#m0">ZE::ZConfigFile::ZCF_Variable</a><li>varList
: <a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#m1">ZE::ZConfigFile::ZCF_Section</a><li>Volume()
: <a class="el" href="classZE_1_1ZSound.html#a13">ZE::ZSound</a>, <a class="el" href="classZE_1_1ZMusic.html#a14">ZE::ZMusic</a></ul>
<h3><a name="index_w">- w -</a>
</h3><ul>
<li>Width()
: <a class="el" href="classZE_1_1ZRect.html#a23">ZE::ZRect</a>, <a class="el" href="classZE_1_1ZImage.html#a25">ZE::ZImage</a>, <a class="el" href="classZE_1_1ZEngine.html#a50">ZE::ZEngine</a><li>WriteLog()
: <a class="el" href="classZE_1_1ZEngine.html#a39">ZE::ZEngine</a></ul>
<h3><a name="index_x">- x -</a>
</h3><ul>
<li>X()
: <a class="el" href="classZE_1_1ZRect.html#a17">ZE::ZRect</a></ul>
<h3><a name="index_y">- y -</a>
</h3><ul>
<li>Y()
: <a class="el" href="classZE_1_1ZRect.html#a18">ZE::ZRect</a></ul>
<h3><a name="index_z">- z -</a>
</h3><ul>
<li>ZConfigFile()
: <a class="el" href="classZE_1_1ZConfigFile.html#a1">ZE::ZConfigFile</a><li>ZEngine()
: <a class="el" href="classZE_1_1ZEngine.html#c0">ZE::ZEngine</a><li>ZError()
: <a class="el" href="classZE_1_1ZError.html#a0">ZE::ZError</a><li>ZFont()
: <a class="el" href="classZE_1_1ZFont.html#a1">ZE::ZFont</a><li>ZImage()
: <a class="el" href="classZE_1_1ZImage.html#a5">ZE::ZImage</a><li>ZMusic()
: <a class="el" href="classZE_1_1ZMusic.html#a1">ZE::ZMusic</a><li>ZRect()
: <a class="el" href="classZE_1_1ZRect.html#a3">ZE::ZRect</a><li>ZSound()
: <a class="el" href="classZE_1_1ZSound.html#a1">ZE::ZSound</a><li>ZTimer()
: <a class="el" href="classZE_1_1ZTimer.html#a0">ZE::ZTimer</a></ul>
<h3><a name="index_~">- ~ -</a>
</h3><ul>
<li>~ZConfigFile()
: <a class="el" href="classZE_1_1ZConfigFile.html#a2">ZE::ZConfigFile</a><li>~ZError()
: <a class="el" href="classZE_1_1ZError.html#a1">ZE::ZError</a><li>~ZFont()
: <a class="el" href="classZE_1_1ZFont.html#a2">ZE::ZFont</a><li>~ZImage()
: <a class="el" href="classZE_1_1ZImage.html#a6">ZE::ZImage</a><li>~ZMusic()
: <a class="el" href="classZE_1_1ZMusic.html#a2">ZE::ZMusic</a><li>~ZRect()
: <a class="el" href="classZE_1_1ZRect.html#a5">ZE::ZRect</a><li>~ZSound()
: <a class="el" href="classZE_1_1ZSound.html#a2">ZE::ZSound</a><li>~ZTimer()
: <a class="el" href="classZE_1_1ZTimer.html#a1">ZE::ZTimer</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>

43
doc/html/globals.html Normal file
View File

@ -0,0 +1,43 @@
<!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>File Member Index</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine File Members</h1><center>
<a href="#index_f">f</a>&nbsp;|&nbsp;<a href="#index_m">m</a>&nbsp;|&nbsp;<a href="#index_u">u</a>&nbsp;|&nbsp;<a href="#index_v">v</a>&nbsp;|&nbsp;<a href="#index_z">z</a></center>
<p>
Here is a list of all documented file members with links to the documentation:<h3><a name="index_f">- f -</a>
</h3><ul>
<li>FreeFont
: <a class="el" href="ZE__Utility_8h.html#a3">ZE_Utility.h</a><li>FreeImage
: <a class="el" href="ZE__Utility_8h.html#a0">ZE_Utility.h</a><li>FreeMusic
: <a class="el" href="ZE__Utility_8h.html#a2">ZE_Utility.h</a><li>FreeSound
: <a class="el" href="ZE__Utility_8h.html#a1">ZE_Utility.h</a></ul>
<h3><a name="index_m">- m -</a>
</h3><ul>
<li>MAX_MSG_LEN
: <a class="el" href="ZE__Defines_8h.html#a4">ZE_Defines.h</a></ul>
<h3><a name="index_u">- u -</a>
</h3><ul>
<li>USE_SDL_IMAGE
: <a class="el" href="ZE__Defines_8h.html#a2">ZE_Defines.h</a><li>USE_SDL_MIXER
: <a class="el" href="ZE__Defines_8h.html#a3">ZE_Defines.h</a><li>USE_SDL_TTF
: <a class="el" href="ZE__Defines_8h.html#a1">ZE_Defines.h</a></ul>
<h3><a name="index_v">- v -</a>
</h3><ul>
<li>VERSION
: <a class="el" href="ZE__Defines_8h.html#a0">ZE_Defines.h</a></ul>
<h3><a name="index_z">- z -</a>
</h3><ul>
<li>ZByte
: <a class="el" href="ZE__Defines_8h.html#a5">ZE_Defines.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>

44
doc/html/index.html Normal file
View File

@ -0,0 +1,44 @@
<!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>ZEngine Documentation</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine Documentation</h1>
<p>
<h3 align="center">0.8.3</h3><dl compact><dt><b>Author:</b></dt><dd>James Turk </dd></dl>
<dl compact><dt><b>Version:</b></dt><dd>0.8.3 </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>April 27, 2003</dd></dl>
<h2><a name="ZEngine"></a>
About ZEngine</h2>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;-ZEngine is designed to provide a powerful yet easy to use 2D game engine in a well designed Object Oriented manner, and uses cross platform libraries such as SDL and OpenGL. (ZEngine can use SDL_ttf,SDL_image, SDL_mixer, and PhysFS all of which are cross platform as well as Open Source.)<br>
&nbsp;&nbsp;&nbsp;&nbsp;-It is licensed under a BSD-style license, and anyone is free to suggest or implement changes to be added to the Engine, as well as modify the engine to their own needs or use it however they like.<br>
&nbsp;&nbsp;&nbsp;&nbsp;-ZEngine now uses OpenGL rather than SDL to do 2D drawing, thus increasing the uses of the engine and making the engine much faster in all test cases, and the engine was tested for memory leaks with MSVC and is known to have no leaks.<br>
&nbsp;&nbsp;&nbsp;&nbsp;-The ZEngine website : <a href="http://zengine.sourceforge.net/.">http://zengine.sourceforge.net/.</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;-The ZEngine tutorials : <a href="http://conceptofzero.net/tutorials/zengine/.">http://conceptofzero.net/tutorials/zengine/.</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;-The ZEngine forums : <a href="http://www.conceptofzero.net/forums/index.php?act=SF&f=15">http://www.conceptofzero.net/forums/index.php?act=SF&amp;f=15</a><h2><a name="Licensing"></a>
Licensing</h2>
<br>
<pre> This file is Part of the ZEngine Library for 2D game development.
Copyright (C) 2002, 2003 James Turk
Licensed under a BSD-style license.
The maintainer of this library is James Turk (<a href="mailto:james@conceptofzero.net">james@conceptofzero.net</a>)
and the home of this Library is <a href="http://zengine.sourceforge.net">http://zengine.sourceforge.net</a>
</pre>
<h2><a name="Authors"></a>
Contributing Authors</h2>
<br>
James Turk <a href="mailto:james@conceptofzero.net"><a href="mailto:james@conceptofzero.net">james@conceptofzero.net</a></a> - Core Engine, Design, Docs, and Classes<br>
Gamer Tazar <a href="mailto:tazar@conceptofzero.net"><a href="mailto:tazar@conceptofzero.net">tazar@conceptofzero.net</a></a> - OpenGL assistance<br>
Sean <a href="mailto:sean@conceptofzero.net"><a href="mailto:sean@conceptofzero.net">sean@conceptofzero.net</a></a> - MSVC++6 Project Files<br>
Kevin Watters <a href="mailto:kwatters@adelphia.net"><a href="mailto:kwatters@adelphia.net">kwatters@adelphia.net</a></a> - Fix to ZImage::SetColorKey&lt;br&gt;<hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

37
doc/html/mt19937ar_8h-source.html Executable file
View File

@ -0,0 +1,37 @@
<!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>/include/external/mt19937ar.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/external/mt19937ar.h</h1><div class="fragment"><pre>00001 <span class="preprocessor">#ifndef __mt19937ar__</span>
00002 <span class="preprocessor"></span><span class="preprocessor">#define __mt19937ar__</span>
00003 <span class="preprocessor"></span>
00004 <span class="comment">//This .h file written for ZEngine by James Turk to declare the methods implemented in mt19937ar.c</span>
00005 <span class="comment">//See mt19937ar.c for license of the Mersenne Twister.</span>
00006
00007 <span class="preprocessor">#include &lt;cstdio&gt;</span> <span class="comment">//changed for ZEngine</span>
00008 <span class="comment">/* Period parameters */</span>
00009 <span class="preprocessor">#define N 624</span>
00010 <span class="preprocessor"></span><span class="preprocessor">#define M 397</span>
00011 <span class="preprocessor"></span><span class="preprocessor">#define MATRIX_A 0x9908b0dfUL </span><span class="comment">/* constant vector a */</span>
00012 <span class="preprocessor">#define UPPER_MASK 0x80000000UL </span><span class="comment">/* most significant w-r bits */</span>
00013 <span class="preprocessor">#define LOWER_MASK 0x7fffffffUL </span><span class="comment">/* least significant r bits */</span>
00014
00015 <span class="keywordtype">void</span> init_genrand(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> s);
00016 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> genrand_int32(<span class="keywordtype">void</span>);
00017 <span class="keywordtype">long</span> genrand_int31(<span class="keywordtype">void</span>);
00018 <span class="keywordtype">double</span> genrand_real1(<span class="keywordtype">void</span>);
00019 <span class="keywordtype">double</span> genrand_real2(<span class="keywordtype">void</span>);
00020 <span class="keywordtype">double</span> genrand_real3(<span class="keywordtype">void</span>);
00021 <span class="keywordtype">double</span> genrand_res53(<span class="keywordtype">void</span>);
00022
00023 <span class="preprocessor">#endif //__mt19937ar__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>

189
doc/html/namespaceZE.html Normal file
View File

@ -0,0 +1,189 @@
<!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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZCF_Variable</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZCF_Section</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html">ZError</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html">ZFont</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html">ZImage</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html">ZMusic</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html">ZRect</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html">ZSound</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html">ZTimer</a></td></tr>
<tr><td>&nbsp;</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 &nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html#a20">ZErrorCode</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceZE.html#a20a0">ZERR_NONE</a>,
<a class="el" href="namespaceZE.html#a20a1">ZERR_SDL_INTERNAL</a>,
<a class="el" href="namespaceZE.html#a20a2">ZERR_SDL_INIT</a>,
<a class="el" href="namespaceZE.html#a20a3">ZERR_MIX_INIT</a>,
<br>
&nbsp;&nbsp;<a class="el" href="namespaceZE.html#a20a4">ZERR_TTF_INIT</a>,
<a class="el" href="namespaceZE.html#a20a5">ZERR_NET_INIT</a>,
<a class="el" href="namespaceZE.html#a20a6">ZERR_VIDMODE</a>,
<a class="el" href="namespaceZE.html#a20a7">ZERR_LOAD_IMAGE</a>,
<br>
&nbsp;&nbsp;<a class="el" href="namespaceZE.html#a20a8">ZERR_LOAD_SOUND</a>,
<a class="el" href="namespaceZE.html#a20a9">ZERR_LOAD_MUSIC</a>,
<a class="el" href="namespaceZE.html#a20a10">ZERR_LOAD_FONT</a>,
<a class="el" href="namespaceZE.html#a20a11">ZERR_NOIMAGE</a>,
<br>
&nbsp;&nbsp;<a class="el" href="namespaceZE.html#a20a12">ZERR_NOSOUND</a>,
<a class="el" href="namespaceZE.html#a20a13">ZERR_NOMUSIC</a>,
<a class="el" href="namespaceZE.html#a20a14">ZERR_NOFONT</a>,
<a class="el" href="namespaceZE.html#a20a15">ZERR_NOSOCKET</a>,
<br>
&nbsp;&nbsp;<a class="el" href="namespaceZE.html#a20a16">ZERR_NET_CLIENT</a>,
<a class="el" href="namespaceZE.html#a20a17">ZERR_NET_SERVER</a>,
<a class="el" href="namespaceZE.html#a20a18">ZERR_LAST</a>
<br>
}</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Enumeration of ZEngine error codes.</em> <a href="#a20">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&nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html#a19">FormatStr</a> (const char *fmtstr,...)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Parses a string and interprets variable arguments, similar to sprintf.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a name="a20" 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>
&nbsp;
</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="a20a0" doxytag="ZERR_NONE"></a><em>ZERR_NONE</em></em>&nbsp;</td><td>
No error has occured. </td></tr>
<tr><td valign=top><em><a name="a20a1" doxytag="ZERR_SDL_INTERNAL"></a><em>ZERR_SDL_INTERNAL</em></em>&nbsp;</td><td>
Error internal to SDL has occured, usually more detail is given by SDL. </td></tr>
<tr><td valign=top><em><a name="a20a2" doxytag="ZERR_SDL_INIT"></a><em>ZERR_SDL_INIT</em></em>&nbsp;</td><td>
Error Initializing SDL. </td></tr>
<tr><td valign=top><em><a name="a20a3" doxytag="ZERR_MIX_INIT"></a><em>ZERR_MIX_INIT</em></em>&nbsp;</td><td>
Error Initializing SDL_mixer. </td></tr>
<tr><td valign=top><em><a name="a20a4" doxytag="ZERR_TTF_INIT"></a><em>ZERR_TTF_INIT</em></em>&nbsp;</td><td>
Error Initializing SDL_ttf. </td></tr>
<tr><td valign=top><em><a name="a20a5" doxytag="ZERR_NET_INIT"></a><em>ZERR_NET_INIT</em></em>&nbsp;</td><td>
Error Initializing SDL_net. </td></tr>
<tr><td valign=top><em><a name="a20a6" doxytag="ZERR_VIDMODE"></a><em>ZERR_VIDMODE</em></em>&nbsp;</td><td>
Error setting up the display. </td></tr>
<tr><td valign=top><em><a name="a20a7" doxytag="ZERR_LOAD_IMAGE"></a><em>ZERR_LOAD_IMAGE</em></em>&nbsp;</td><td>
Error loading an image. </td></tr>
<tr><td valign=top><em><a name="a20a8" doxytag="ZERR_LOAD_SOUND"></a><em>ZERR_LOAD_SOUND</em></em>&nbsp;</td><td>
Error loading a sound sample. </td></tr>
<tr><td valign=top><em><a name="a20a9" doxytag="ZERR_LOAD_MUSIC"></a><em>ZERR_LOAD_MUSIC</em></em>&nbsp;</td><td>
Error loading music. </td></tr>
<tr><td valign=top><em><a name="a20a10" doxytag="ZERR_LOAD_FONT"></a><em>ZERR_LOAD_FONT</em></em>&nbsp;</td><td>
Error loading a font. </td></tr>
<tr><td valign=top><em><a name="a20a11" doxytag="ZERR_NOIMAGE"></a><em>ZERR_NOIMAGE</em></em>&nbsp;</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="a20a12" doxytag="ZERR_NOSOUND"></a><em>ZERR_NOSOUND</em></em>&nbsp;</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="a20a13" doxytag="ZERR_NOMUSIC"></a><em>ZERR_NOMUSIC</em></em>&nbsp;</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="a20a14" doxytag="ZERR_NOFONT"></a><em>ZERR_NOFONT</em></em>&nbsp;</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="a20a15" doxytag="ZERR_NOSOCKET"></a><em>ZERR_NOSOCKET</em></em>&nbsp;</td><td>
Error trying to use a ZClient without having an open socket. </td></tr>
<tr><td valign=top><em><a name="a20a16" doxytag="ZERR_NET_CLIENT"></a><em>ZERR_NET_CLIENT</em></em>&nbsp;</td><td>
Error using SDL_net in ZClient. </td></tr>
<tr><td valign=top><em><a name="a20a17" doxytag="ZERR_NET_SERVER"></a><em>ZERR_NET_SERVER</em></em>&nbsp;</td><td>
Error using SDL_net in ZClient. </td></tr>
<tr><td valign=top><em><a name="a20a18" doxytag="ZERR_LAST"></a><em>ZERR_LAST</em></em>&nbsp;</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="a19" 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">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>fmtstr</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>...&nbsp;</td>
<td class="mdname" nowrap>&nbsp;</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>&nbsp;</td><td>defines format of resulting string </td></tr>
<tr><td valign=top><em>...</em>&nbsp;</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 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>

45
doc/html/namespacemembers.html Normal file
View File

@ -0,0 +1,45 @@
<!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>Namespace Member Index</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine Namespace Members</h1><center>
<a href="#index_f">f</a>&nbsp;|&nbsp;<a href="#index_z">z</a></center>
<p>
Here is a list of all documented namespace members with links to the namespaces they belong to:<h3><a name="index_f">- f -</a>
</h3><ul>
<li>FormatStr()
: <a class="el" href="namespaceZE.html#a19">ZE</a></ul>
<h3><a name="index_z">- z -</a>
</h3><ul>
<li>ZERR_LAST
: <a class="el" href="namespaceZE.html#a20a18">ZE</a><li>ZERR_LOAD_FONT
: <a class="el" href="namespaceZE.html#a20a10">ZE</a><li>ZERR_LOAD_IMAGE
: <a class="el" href="namespaceZE.html#a20a7">ZE</a><li>ZERR_LOAD_MUSIC
: <a class="el" href="namespaceZE.html#a20a9">ZE</a><li>ZERR_LOAD_SOUND
: <a class="el" href="namespaceZE.html#a20a8">ZE</a><li>ZERR_MIX_INIT
: <a class="el" href="namespaceZE.html#a20a3">ZE</a><li>ZERR_NET_CLIENT
: <a class="el" href="namespaceZE.html#a20a16">ZE</a><li>ZERR_NET_INIT
: <a class="el" href="namespaceZE.html#a20a5">ZE</a><li>ZERR_NET_SERVER
: <a class="el" href="namespaceZE.html#a20a17">ZE</a><li>ZERR_NOFONT
: <a class="el" href="namespaceZE.html#a20a14">ZE</a><li>ZERR_NOIMAGE
: <a class="el" href="namespaceZE.html#a20a11">ZE</a><li>ZERR_NOMUSIC
: <a class="el" href="namespaceZE.html#a20a13">ZE</a><li>ZERR_NONE
: <a class="el" href="namespaceZE.html#a20a0">ZE</a><li>ZERR_NOSOCKET
: <a class="el" href="namespaceZE.html#a20a15">ZE</a><li>ZERR_NOSOUND
: <a class="el" href="namespaceZE.html#a20a12">ZE</a><li>ZERR_SDL_INIT
: <a class="el" href="namespaceZE.html#a20a2">ZE</a><li>ZERR_SDL_INTERNAL
: <a class="el" href="namespaceZE.html#a20a1">ZE</a><li>ZERR_TTF_INIT
: <a class="el" href="namespaceZE.html#a20a4">ZE</a><li>ZERR_VIDMODE
: <a class="el" href="namespaceZE.html#a20a6">ZE</a><li>ZErrorCode
: <a class="el" href="namespaceZE.html#a20">ZE</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>

17
doc/html/namespaces.html Normal file
View File

@ -0,0 +1,17 @@
<!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>Namespace Index</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZEngine Namespace List</h1>Here is a list of all documented namespaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="namespaceZE.html">ZE</a></td><td class="indexvalue"><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Namespace</td></tr>
</table>
<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>

54
doc/html/physfsrwops_8h-source.html Normal file
View File

@ -0,0 +1,54 @@
<!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>/include/external/physfsrwops.h Source File</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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/include/external/physfsrwops.h</h1><div class="fragment"><pre>00001 <span class="comment">/*</span>
00002 <span class="comment"> * This code provides a glue layer between PhysicsFS and Simple Directmedia</span>
00003 <span class="comment"> * Layer's (SDL) RWops i/o abstraction.</span>
00004 <span class="comment"> *</span>
00005 <span class="comment"> * License: this code is public domain. I make no warranty that it is useful,</span>
00006 <span class="comment"> * correct, harmless, or environmentally safe.</span>
00007 <span class="comment"> *</span>
00008 <span class="comment"> * This particular file may be used however you like, including copying it</span>
00009 <span class="comment"> * verbatim into a closed-source project, exploiting it commercially, and</span>
00010 <span class="comment"> * removing any trace of my name from the source (although I hope you won't</span>
00011 <span class="comment"> * do that). I welcome enhancements and corrections to this file, but I do</span>
00012 <span class="comment"> * not require you to send me patches if you make changes.</span>
00013 <span class="comment"> *</span>
00014 <span class="comment"> * Unless otherwise stated, the rest of PhysicsFS falls under the GNU Lesser</span>
00015 <span class="comment"> * General Public License: http://www.gnu.org/licenses/lgpl.txt</span>
00016 <span class="comment"> *</span>
00017 <span class="comment"> * SDL falls under the LGPL, too. You can get SDL at http://www.libsdl.org/</span>
00018 <span class="comment"> *</span>
00019 <span class="comment"> * This file was written by Ryan C. Gordon. (icculus@clutteredmind.org).</span>
00020 <span class="comment"> */</span>
00021
00022 <span class="preprocessor">#ifndef _INCLUDE_PHYSFSRWOPS_H_</span>
00023 <span class="preprocessor"></span><span class="preprocessor">#define _INCLUDE_PHYSFSRWOPS_H_</span>
00024 <span class="preprocessor"></span>
00025 <span class="preprocessor">#include &lt;physfs.h&gt;</span>
00026 <span class="preprocessor">#include &lt;SDL.h&gt;</span>
00027
00038 SDL_RWops *PHYSFSRWOPS_openRead(<span class="keyword">const</span> <span class="keywordtype">char</span> *fname);
00039
00050 SDL_RWops *PHYSFSRWOPS_openWrite(<span class="keyword">const</span> <span class="keywordtype">char</span> *fname);
00051
00062 SDL_RWops *PHYSFSRWOPS_openAppend(<span class="keyword">const</span> <span class="keywordtype">char</span> *fname);
00063
00074 SDL_RWops *PHYSFSRWOPS_makeRWops(PHYSFS_file *handle);
00075
00076
00077 <span class="preprocessor">#endif </span><span class="comment">/* include-once blocker */</span>
00078
00079 <span class="comment">/* end of physfsrwops.h ... */</span>
00080
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:14:00 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>