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

321 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>JGE++: JGE Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>JGE Class Reference</h1><!-- doxytag: class="JGE" --><code>#include &lt;JGE.h&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for JGE:</div>
<div class="dynsection">
</div>
<p>
<a href="class_j_g_e-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#613d3fb2883577541f9b8a5e6576412a">GetTime</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#51af49f4083b3c29f49f6fb8e61f7a11">GetDelta</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#23a44cbd24aac6f9cae6c6784e3cb9ee">GetFPS</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#8b322821d7b254dce2bdb593ae90923c">GetButtonState</a> (u32 button)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#60c0c0c779afe2a5fa48a6512251a284">GetButtonClick</a> (u32 button)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#e2adce2bb0e0dc8d157af4c29b58bc74">GetAnalogX</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#7b680e87749b994d0437f0a205ab0a23">GetAnalogY</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#1663a6ffb91d936665027e47170592dc">IsDone</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#4c349933b2ed89da82661a7714dbecf4">SetApp</a> (<a class="el" href="class_j_app.html">JApp</a> *app)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#eb2bac497f5be12b63081b252d8d4366">printf</a> (const char *format,...)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_j_g_e.html">JGE</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_g_e.html#35939174437b92423fd98cb5ffcb4341">GetInstance</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Game engine main interface. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="35939174437b92423fd98cb5ffcb4341"></a><!-- doxytag: member="JGE::GetInstance" ref="35939174437b92423fd98cb5ffcb4341" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_j_g_e.html">JGE</a>* JGE::GetInstance </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get <a class="el" href="class_j_g_e.html">JGE</a> instance.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="class_j_g_e.html">JGE</a> instance. </dd></dl>
</div>
</div><p>
<a class="anchor" name="613d3fb2883577541f9b8a5e6576412a"></a><!-- doxytag: member="JGE::GetTime" ref="613d3fb2883577541f9b8a5e6576412a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int JGE::GetTime </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return system timer in milliseconds.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>System time in milliseconds. </dd></dl>
</div>
</div><p>
<a class="anchor" name="51af49f4083b3c29f49f6fb8e61f7a11"></a><!-- doxytag: member="JGE::GetDelta" ref="51af49f4083b3c29f49f6fb8e61f7a11" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JGE::GetDelta </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return elapsed time since last frame update.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Elapsed time in seconds. </dd></dl>
</div>
</div><p>
<a class="anchor" name="23a44cbd24aac6f9cae6c6784e3cb9ee"></a><!-- doxytag: member="JGE::GetFPS" ref="23a44cbd24aac6f9cae6c6784e3cb9ee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JGE::GetFPS </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return frame rate.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This is just 1.0f/GetDelat().</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of frames per second. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b322821d7b254dce2bdb593ae90923c"></a><!-- doxytag: member="JGE::GetButtonState" ref="8b322821d7b254dce2bdb593ae90923c" args="(u32 button)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JGE::GetButtonState </td>
<td>(</td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>button</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check the current state of a button.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>button</em>&nbsp;</td><td>- Button id.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Button state. </dd></dl>
</div>
</div><p>
<a class="anchor" name="60c0c0c779afe2a5fa48a6512251a284"></a><!-- doxytag: member="JGE::GetButtonClick" ref="60c0c0c779afe2a5fa48a6512251a284" args="(u32 button)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JGE::GetButtonClick </td>
<td>(</td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>button</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a button is down the first time.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>button</em>&nbsp;</td><td>- Button id.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Button state. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e2adce2bb0e0dc8d157af4c29b58bc74"></a><!-- doxytag: member="JGE::GetAnalogX" ref="e2adce2bb0e0dc8d157af4c29b58bc74" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 JGE::GetAnalogX </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get x value of the analog pad.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>X value (0 to 255). </dd></dl>
</div>
</div><p>
<a class="anchor" name="7b680e87749b994d0437f0a205ab0a23"></a><!-- doxytag: member="JGE::GetAnalogY" ref="7b680e87749b994d0437f0a205ab0a23" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 JGE::GetAnalogY </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get y value of the analog pad.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Y value (0 to 255). </dd></dl>
</div>
</div><p>
<a class="anchor" name="1663a6ffb91d936665027e47170592dc"></a><!-- doxytag: member="JGE::IsDone" ref="1663a6ffb91d936665027e47170592dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JGE::IsDone </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get if the system is ended or not.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status of the system. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4c349933b2ed89da82661a7714dbecf4"></a><!-- doxytag: member="JGE::SetApp" ref="4c349933b2ed89da82661a7714dbecf4" args="(JApp *app)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JGE::SetApp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_j_app.html">JApp</a> *&nbsp;</td>
<td class="paramname"> <em>app</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the user's core application class.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>app</em>&nbsp;</td><td>- User defined application class. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="eb2bac497f5be12b63081b252d8d4366"></a><!-- doxytag: member="JGE::printf" ref="eb2bac497f5be12b63081b252d8d4366" args="(const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JGE::printf </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"> <em>...</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Print debug message.
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:22 2007 for JGE++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink