1567 lines
63 KiB
HTML
1567 lines
63 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||
|
|
<title>ZE::ZEngine class Reference</title>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
||
|
|
</head><body>
|
||
|
|
<!-- Generated by Doxygen 1.3-rc1 -->
|
||
|
|
<center>
|
||
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
|
||
|
|
<hr><h1>ZE::ZEngine Class Reference</h1><code>#include <<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a>></code>
|
||
|
|
<p>
|
||
|
|
<a href="classZE_1_1ZEngine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
<a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Singleton Class, accessible from anywhere in a ZEngine-based program by nature. Controls core elements of program and does majority of SDL wrapping. Also keeps track of loaded data and helps programs avoid memory leaks and dangling pointers.
|
||
|
|
<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>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a0">SetupDisplay</a> (int width, int height, int bpp, bool fullscreen)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Setup Display for SDL.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a1">SetupSound</a> (int rate, bool stereo)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Initialize Sound for SDL.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a2">CreateWindow</a> (string title, string icon="")</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Create Window with predefined settings.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a3">CloseWindow</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Quit SDL and any Subsystems.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>SDL_Surface * </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a4">GetDisplay</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Allow access to Screen Surface.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a5">UpdateScreen</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Update screen contents.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a6">MapColor</a> (Uint8 r, Uint8 g, Uint8 b, Uint8 a=255)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Create Color in SDL Uint32 Format.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a7">Clear</a> (Uint32 color=0, SDL_Rect *rect=NULL)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Clear screen or portion of screen to a color.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a8">Sleep</a> (Uint32 milliseconds)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Sleep for a certain amount of time.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a9">GetTime</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Global <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> time.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a10">PauseTimer</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Pause <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a11">UnpauseTimer</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Unpause <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>double </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a12">GetFrameTime</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Seconds Per Frame.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a13">IsPaused</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Check Engine Paused State.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a14">IsActive</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Find out if application is active.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a15">RequestQuit</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Request A Quit.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a16">QuitRequested</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Find out if user has requested to quit.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a17">KeyIsPressed</a> (SDLKey key)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Find the state of a key.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a18">HideCursor</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Hide mouse cursor.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a19">ShowCursor</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Show mouse cursor.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a20">GetMouseX</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get X Position of Mouse.</em> <a href="#a20"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a21">GetMouseY</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Y Position of Mouse.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a22">LButtonPressed</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Status of Left Button.</em> <a href="#a22"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a23">RButtonPressed</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Status of Right Button.</em> <a href="#a23"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a24">MouseInRect</a> (SDL_Rect *rect)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Check if mouse is in given rectangle.</em> <a href="#a24"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a25">CheckEvents</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Check for Activation, Window Manager, and Quit Events.</em> <a href="#a25"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a class="el" href="classZE_1_1ImageData.html">ImageData</a> </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a26">LoadImage</a> (string filename)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Load an Image.</em> <a href="#a26"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a27">FreeImage</a> (<a class="el" href="classZE_1_1ImageData.html">ImageData</a> &image)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Free an Image.</em> <a href="#a27"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a class="el" href="classZE_1_1SoundData.html">SoundData</a> </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a28">LoadSound</a> (string filename)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Load a Sound.</em> <a href="#a28"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a29">FreeSound</a> (<a class="el" href="classZE_1_1SoundData.html">SoundData</a> &sound)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Free a Sound.</em> <a href="#a29"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a class="el" href="classZE_1_1MusicData.html">MusicData</a> </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a30">LoadMusic</a> (string filename)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Load a Music File.</em> <a href="#a30"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a31">FreeMusic</a> (<a class="el" href="classZE_1_1MusicData.html">MusicData</a> &music)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Free a Music Sample.</em> <a href="#a31"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a class="el" href="classZE_1_1FontData.html">FontData</a> </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a32">LoadFont</a> (string filename, int size)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Load a Font.</em> <a href="#a32"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a33">FreeFont</a> (<a class="el" href="classZE_1_1FontData.html">FontData</a> &font)</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Free a Font.</em> <a href="#a33"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a34">GetWidth</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Current Display Width.</em> <a href="#a34"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a35">GetHeight</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Current Display Height.</em> <a href="#a35"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a36">GetBPP</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Current Display BPP.</em> <a href="#a36"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#a37">IsFullscreen</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Fullscreen setting.</em> <a href="#a37"></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>ZEngine * </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#d0">GetInstance</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Instance.</em> <a href="#d0"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#d1">ReleaseInstance</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Release Instance.</em> <a href="#d1"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top>string </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#d2">GetVersion</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Get Current Version.</em> <a href="#d2"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td colspan=2><br><h2>Private Methods</h2></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#c0">ZEngine</a> ()</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Constructor for <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>.</em> <a href="#c0"></a><em></em></font><br><br></td></tr>
|
||
|
|
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o0" doxytag="ZE::ZEngine::mWidth"></a>
|
||
|
|
int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o0">mWidth</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Width of Display.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o1" doxytag="ZE::ZEngine::mHeight"></a>
|
||
|
|
int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o1">mHeight</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Height of Display.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o2" doxytag="ZE::ZEngine::mBPP"></a>
|
||
|
|
int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o2">mBPP</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>BPP Setting of Display.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o3" doxytag="ZE::ZEngine::mFullscreen"></a>
|
||
|
|
bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o3">mFullscreen</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Fullscreen setting of Display.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o4" doxytag="ZE::ZEngine::mRate"></a>
|
||
|
|
int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o4">mRate</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Sound Bitrate.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o5" doxytag="ZE::ZEngine::mStereo"></a>
|
||
|
|
bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o5">mStereo</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Stereo setting of Sound Subsystem.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o6" doxytag="ZE::ZEngine::mScreen"></a>
|
||
|
|
SDL_Surface * </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o6">mScreen</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Pointer to Display.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o7" doxytag="ZE::ZEngine::mPaused"></a>
|
||
|
|
bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o7">mPaused</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Keep track of paused state of game.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o8" doxytag="ZE::ZEngine::mUnpauseOnActive"></a>
|
||
|
|
bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o8">mUnpauseOnActive</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Keep track of if <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> should unpause on active event.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o9" doxytag="ZE::ZEngine::mLastPause"></a>
|
||
|
|
Uint32 </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o9">mLastPause</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Keep track of time game was last paused.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o10" doxytag="ZE::ZEngine::mPausedTime"></a>
|
||
|
|
Uint32 </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o10">mPausedTime</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Keep track of total globally paused time.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o11" doxytag="ZE::ZEngine::mLastTime"></a>
|
||
|
|
Uint32 </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o11">mLastTime</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Keep track of last screen update time.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o12" doxytag="ZE::ZEngine::mSecPerFrame"></a>
|
||
|
|
double </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o12">mSecPerFrame</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Seconds per frame.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o13" doxytag="ZE::ZEngine::mActive"></a>
|
||
|
|
bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o13">mActive</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>bool describing Active or Inactive State of Game</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o14" doxytag="ZE::ZEngine::mQuit"></a>
|
||
|
|
bool </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o14">mQuit</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>bool for checking if a Quit event has been detected</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o15" doxytag="ZE::ZEngine::mKeyPressed"></a>
|
||
|
|
Uint8 * </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o15">mKeyPressed</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Pointer to array of Keys.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o16" doxytag="ZE::ZEngine::mMouseX"></a>
|
||
|
|
int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o16">mMouseX</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>X Position of Mouse.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o17" doxytag="ZE::ZEngine::mMouseY"></a>
|
||
|
|
int </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o17">mMouseY</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Y Position of Mouse.</em></font><br><br></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="o18" doxytag="ZE::ZEngine::mMouseB"></a>
|
||
|
|
Uint8 </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#o18">mMouseB</a></td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Mouse Button Information.</em></font><br><br></td></tr>
|
||
|
|
<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr>
|
||
|
|
<tr><td nowrap align=right valign=top><a name="r0" doxytag="ZE::ZEngine::sInstance"></a>
|
||
|
|
ZEngine * </td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html#r0">sInstance</a> = NULL</td></tr>
|
||
|
|
<tr><td> </td><td><font size=-1><em>Static Pointer to Instance of <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> for Singleton.</em></font><br><br></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
|
|
<a name="c0" doxytag="ZE::ZEngine::ZEngine"></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::ZEngine::ZEngine </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap><code> [private]</code></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Initialize <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> values to defaults. (Private so that only one instance may be created.) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<hr><h2>Member Function Documentation</h2>
|
||
|
|
<a name="d0" doxytag="ZE::ZEngine::GetInstance"></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"> ZEngine * ZE::ZEngine::GetInstance </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap><code> [static]</code></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Static function, returns pointer to instance of <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>, creating an instance if none exist. <dl compact><dt><b>Returns:</b></dt><dd>Instance to the <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="d1" doxytag="ZE::ZEngine::ReleaseInstance"></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::ZEngine::ReleaseInstance </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap><code> [static]</code></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Release memory held by instance of engine and closes window. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="d2" doxytag="ZE::ZEngine::GetVersion"></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::ZEngine::GetVersion </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap><code> [static]</code></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get Version Number of <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. (Major.Minor.Extension#) <dl compact><dt><b>Returns:</b></dt><dd>string containing version number </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a0" doxytag="ZE::ZEngine::SetupDisplay"></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::ZEngine::SetupDisplay </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">int </td>
|
||
|
|
<td class="mdname" nowrap> <em>width</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>int </td>
|
||
|
|
<td class="mdname" nowrap> <em>height</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>int </td>
|
||
|
|
<td class="mdname" nowrap> <em>bpp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>bool </td>
|
||
|
|
<td class="mdname" nowrap> <em>fullscreen</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Sets display parameters to specified parameters. (called before CreateDisplay)
|
||
|
|
<p>
|
||
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>width</em> </td><td>Desired width of screen or window. </td></tr>
|
||
|
|
<tr><td valign=top><em>height</em> </td><td>Desired height of screen or window. </td></tr>
|
||
|
|
<tr><td valign=top><em>bpp</em> </td><td>Desired BPP for screen (only works in fullscreen). </td></tr>
|
||
|
|
<tr><td valign=top><em>fullscreen</em> </td><td>A bool for fullscreen setting. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a1" doxytag="ZE::ZEngine::SetupSound"></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::ZEngine::SetupSound </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">int </td>
|
||
|
|
<td class="mdname" nowrap> <em>rate</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>bool </td>
|
||
|
|
<td class="mdname" nowrap> <em>stereo</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Set sound settings to specified parameters. (called before CreateDisplay)
|
||
|
|
<p>
|
||
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>rate</em> </td><td>Desired sound bitrate. </td></tr>
|
||
|
|
<tr><td valign=top><em>stereo</em> </td><td>A bool for stereo setting. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a2" doxytag="ZE::ZEngine::CreateWindow"></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::ZEngine::CreateWindow </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname" nowrap> <em>title</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>string </td>
|
||
|
|
<td class="mdname" nowrap> <em>icon</em> = ""</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
SetupDisplay and SetupSound should be called prior to this to change settings, settings from those do not go into effect until this function is called. Specify no icon file to use default OS icon.
|
||
|
|
<p>
|
||
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>title</em> </td><td>Window Title. </td></tr>
|
||
|
|
<tr><td valign=top><em>icon</em> </td><td>Path to Icon File. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a3" doxytag="ZE::ZEngine::CloseWindow"></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::ZEngine::CloseWindow </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Shut down SDL (and SDL_ttf,SDL_mixer if necessary). </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a4" doxytag="ZE::ZEngine::GetDisplay"></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_Surface * ZE::ZEngine::GetDisplay </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get pointer to screen SDL_Surface, allowing direct screen manipulation using SDL. <dl compact><dt><b>Returns:</b></dt><dd>Pointer to Display Surface. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a5" doxytag="ZE::ZEngine::UpdateScreen"></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::ZEngine::UpdateScreen </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Flip double buffer in SDL if double buffered, otherwise tell video to refresh entire screen. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a6" doxytag="ZE::ZEngine::MapColor"></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::ZEngine::MapColor </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>r</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>g</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>b</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>Uint8 </td>
|
||
|
|
<td class="mdname" nowrap> <em>a</em> = 255</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Turn RGBA values into SDL Uint32 color. (Alpha value will be ignored if not in use)
|
||
|
|
<p>
|
||
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>r</em> </td><td>Red component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>g</em> </td><td>Green component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>b</em> </td><td>Blue component of color (0-255). </td></tr>
|
||
|
|
<tr><td valign=top><em>a</em> </td><td>Alpha (translucency) component of color (0-255). [Default 255] </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Uint32 of color requested. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a7" doxytag="ZE::ZEngine::Clear"></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::ZEngine::Clear </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">Uint32 </td>
|
||
|
|
<td class="mdname" nowrap> <em>color</em> = 0, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>SDL_Rect * </td>
|
||
|
|
<td class="mdname" nowrap> <em>rect</em> = NULL</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Clears a rectangle on screen to a color. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>color</em> </td><td>Color to clear surface to, defaults to black. </td></tr>
|
||
|
|
<tr><td valign=top><em>rect</em> </td><td>Rectangle of screen to clear or NULL for entire surface. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a8" doxytag="ZE::ZEngine::Sleep"></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::ZEngine::Sleep </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">Uint32 </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>milliseconds</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Freeze everything for given number of milliseconds. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>milliseconds</em> </td><td>Number of milliseconds to freeze. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a9" doxytag="ZE::ZEngine::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::ZEngine::GetTime </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get active time since <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> initialization in milliseconds, paused time doesn't count. <dl compact><dt><b>Returns:</b></dt><dd>Number of active milliseconds since initialization. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a10" doxytag="ZE::ZEngine::PauseTimer"></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::ZEngine::PauseTimer </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Pause <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> timer and all <a class="el" href="classZE_1_1ZTimer.html">ZTimer</a> objects that rely on <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a11" doxytag="ZE::ZEngine::UnpauseTimer"></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::ZEngine::UnpauseTimer </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Unpause <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> timer and all <a class="el" href="classZE_1_1ZTimer.html">ZTimer</a> objects that rely on <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a12" doxytag="ZE::ZEngine::GetFrameTime"></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"> double ZE::ZEngine::GetFrameTime </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get double that describes the time passed between screen updates. (used for Framerate Independant Movement) <dl compact><dt><b>Returns:</b></dt><dd>Time between screen updates. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a13" doxytag="ZE::ZEngine::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::ZEngine::IsPaused </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Find out if engine timer is paused. <dl compact><dt><b>Returns:</b></dt><dd>Paused State of engine. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a14" doxytag="ZE::ZEngine::IsActive"></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::ZEngine::IsActive </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Function to find out if application currently has focus. <dl compact><dt><b>Returns:</b></dt><dd>bool telling active/inactive state of application. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a15" doxytag="ZE::ZEngine::RequestQuit"></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::ZEngine::RequestQuit </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Tell the engine that it should behave as if a Quit was requested, does not call any shutdown functions. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a16" doxytag="ZE::ZEngine::QuitRequested"></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::ZEngine::QuitRequested </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Function to find out if user or operating system has requested program cease execution, can be set by Alt-F4, SDL_Quit event or <a class="el" href="classZE_1_1ZEngine.html#a15">ZEngine::RequestQuit()</a>. <dl compact><dt><b>Returns:</b></dt><dd>bool telling if quit has been requested. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a17" doxytag="ZE::ZEngine::KeyIsPressed"></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::ZEngine::KeyIsPressed </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">SDLKey </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>key</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Function returns true/false based on if key is pressed or not. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>key</em> </td><td>code of key to find status of. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>bool state of requested key. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a18" doxytag="ZE::ZEngine::HideCursor"></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::ZEngine::HideCursor </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Hide the system mouse cursor. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a19" doxytag="ZE::ZEngine::ShowCursor"></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::ZEngine::ShowCursor </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Show the system mouse cursor. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a20" doxytag="ZE::ZEngine::GetMouseX"></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::ZEngine::GetMouseX </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Find X Position of Mouse on screen. <dl compact><dt><b>Returns:</b></dt><dd>X Position of Mouse. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a21" doxytag="ZE::ZEngine::GetMouseY"></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::ZEngine::GetMouseY </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Find Y Position of Mouse on screen. <dl compact><dt><b>Returns:</b></dt><dd>Y Position of Mouse. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a22" doxytag="ZE::ZEngine::LButtonPressed"></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::ZEngine::LButtonPressed </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get pressed status of left button of mouse. <dl compact><dt><b>Returns:</b></dt><dd>true if left button is pressed, false otherwise. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a23" doxytag="ZE::ZEngine::RButtonPressed"></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::ZEngine::RButtonPressed </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get pressed status of right button of mouse. <dl compact><dt><b>Returns:</b></dt><dd>true if right button is pressed, false otherwise. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a24" doxytag="ZE::ZEngine::MouseInRect"></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::ZEngine::MouseInRect </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">SDL_Rect * </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>rect</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Return status of mouse in current rectangle (used for buttons) <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>rect</em> </td><td>Rectangle to check if mouse is in. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>true if mouse is in rectangle, false otherwise </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a25" doxytag="ZE::ZEngine::CheckEvents"></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::ZEngine::CheckEvents </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Cycle through event queue, processing events, updating all Event Related variables, should be called once per frame. </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a26" doxytag="ZE::ZEngine::LoadImage"></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="classZE_1_1ImageData.html">ImageData</a> ZE::ZEngine::LoadImage </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Loads an Image to an <a class="el" href="classZE_1_1ImageData.html">ImageData</a> class which keeps vital information on the Image. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>filename</em> </td><td>path to file to load. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classZE_1_1ImageData.html">ImageData</a> class containing filename and pointer to data. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a27" doxytag="ZE::ZEngine::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"> void ZE::ZEngine::FreeImage </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top"><a class="el" href="classZE_1_1ImageData.html">ImageData</a> & </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>image</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Free memory of an Image in an <a class="el" href="classZE_1_1ImageData.html">ImageData</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>image</em> </td><td><a class="el" href="classZE_1_1ImageData.html">ImageData</a> structure of image to free. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a28" doxytag="ZE::ZEngine::LoadSound"></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="classZE_1_1SoundData.html">SoundData</a> ZE::ZEngine::LoadSound </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Loads a Sound to a <a class="el" href="classZE_1_1SoundData.html">SoundData</a> class which keeps vital information on the Sound <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>filename</em> </td><td>path to file to load. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classZE_1_1SoundData.html">SoundData</a> class containing filename and pointer to data. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a29" doxytag="ZE::ZEngine::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"> void ZE::ZEngine::FreeSound </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top"><a class="el" href="classZE_1_1SoundData.html">SoundData</a> & </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>sound</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Free memory of a Sound in a <a class="el" href="classZE_1_1SoundData.html">SoundData</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>sound</em> </td><td><a class="el" href="classZE_1_1SoundData.html">SoundData</a> structure of sound to free. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a30" doxytag="ZE::ZEngine::LoadMusic"></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="classZE_1_1MusicData.html">MusicData</a> ZE::ZEngine::LoadMusic </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Loads a Music Clip to a <a class="el" href="classZE_1_1MusicData.html">MusicData</a> class which keeps vital information on the Music Data <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>filename</em> </td><td>path to file to load. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classZE_1_1MusicData.html">MusicData</a> class containing filename and pointer to data. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a31" doxytag="ZE::ZEngine::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"> void ZE::ZEngine::FreeMusic </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top"><a class="el" href="classZE_1_1MusicData.html">MusicData</a> & </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>music</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Free memory of Music in a <a class="el" href="classZE_1_1MusicData.html">MusicData</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>music</em> </td><td><a class="el" href="classZE_1_1MusicData.html">MusicData</a> structure of music to free. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a32" doxytag="ZE::ZEngine::LoadFont"></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="classZE_1_1FontData.html">FontData</a> ZE::ZEngine::LoadFont </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top">string </td>
|
||
|
|
<td class="mdname" nowrap> <em>filename</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="md" nowrap>int </td>
|
||
|
|
<td class="mdname" nowrap> <em>size</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td class="md">) </td>
|
||
|
|
<td class="md" colspan="2"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Loads a Font to a <a class="el" href="classZE_1_1FontData.html">FontData</a> class which keeps vital information on the Font <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>filename</em> </td><td>path to file to load. </td></tr>
|
||
|
|
<tr><td valign=top><em>size</em> </td><td>point size of font </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classZE_1_1FontData.html">FontData</a> class containing filename and pointer to data. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a33" doxytag="ZE::ZEngine::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"> void ZE::ZEngine::FreeFont </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="md" nowrap valign="top"><a class="el" href="classZE_1_1FontData.html">FontData</a> & </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> <em>font</em> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Free memory of a Font in a <a class="el" href="classZE_1_1FontData.html">FontData</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign=top><em>font</em> </td><td><a class="el" href="classZE_1_1FontData.html">FontData</a> structure of font to free. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a34" doxytag="ZE::ZEngine::GetWidth"></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::ZEngine::GetWidth </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get Width of Window or Fullscreen mode. <dl compact><dt><b>Returns:</b></dt><dd>Width of Display. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a35" doxytag="ZE::ZEngine::GetHeight"></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::ZEngine::GetHeight </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get Height of Window or Fullscreen mode. <dl compact><dt><b>Returns:</b></dt><dd>Height of Display. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a36" doxytag="ZE::ZEngine::GetBPP"></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::ZEngine::GetBPP </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get BPP of Window or Fullscreen mode. <dl compact><dt><b>Returns:</b></dt><dd>BPP of Display. </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<a name="a37" doxytag="ZE::ZEngine::IsFullscreen"></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::ZEngine::IsFullscreen </td>
|
||
|
|
<td class="md" valign="top">( </td>
|
||
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
||
|
|
<td class="md" valign="top">) </td>
|
||
|
|
<td class="md" nowrap></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Get Fullscreen setting of Display. <dl compact><dt><b>Returns:</b></dt><dd>True if Fullscreen, False if Windowed </dd></dl>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<hr>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>/home/James/ZEngine-dev/include/<a class="el" href="ZE__ZEngine_8h-source.html">ZE_ZEngine.h</a><li>/home/James/ZEngine-dev/src/<a class="el" href="ZE__ZEngine_8cpp.html">ZE_ZEngine.cpp</a></ul>
|
||
|
|
<hr><address style="align: right;"><small>Generated on Wed Nov 20 01:18:06 2002 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-rc1 </small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|