<html>
<head>
<title>Ogre::Timer class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<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="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::Timer Class Reference</h1>Platform-independent <a class="el" href="classOgre_1_1Timer.html">Timer</a> class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a>></code>
<p>
Inheritance diagram for Ogre::Timer:<p><center><img src="classOgre_1_1Timer__inherit__graph.png" border="0" usemap="#Ogre_1_1Timer__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1Timer__inherit__map">
<area href="classOgre_1_1SDLTimer.html" shape="rect" coords="7,105,113,87" alt="">
<area href="classOgre_1_1Win32Timer.html" shape="rect" coords="137,105,255,87" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1Timer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera0">Timer</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Creates a timer.</em> <a href="#Ogre_1_1Timera0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera1">reset</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Resets timer.</em> <a href="#Ogre_1_1Timera1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual unsigned long </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera2">getMilliseconds</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Returns milliseconds since initialisation or last reset.</em> <a href="#Ogre_1_1Timera2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual unsigned long </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timera3">getMillisecondsCPU</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Returns milliseconds since initialisation or last reset, only CPU time measured.</em> <a href="#Ogre_1_1Win32Timera3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual unsigned long </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera4">getMicroseconds</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Returns microseconds since initialisation or last reset.</em> <a href="#Ogre_1_1Timera4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual unsigned long </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timera4">getMicrosecondsCPU</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Returns microseconds since initialisation or last reset, only CPU time measured.</em> <a href="#Ogre_1_1Win32Timera4"></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>clock_t </td><td valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timern0">zeroClock</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Platform-independent <a class="el" href="classOgre_1_1Timer.html">Timer</a> class.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
You should never create a <a class="el" href="classOgre_1_1Timer.html">Timer</a> instance manually; instead, use <a class="el" href="classOgre_1_1PlatformManager.html#Ogre_1_1PlatformManagera7">PlatformManager::createTimer</a>. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreTimer_8h-source.html#l00036">36</a> of file <a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Timera0" doxytag="Ogre::Timer::Timer"></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"> Ogre::Timer::Timer </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>
Creates a timer.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
You must call <a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera1">reset</a>() after creating it; the constructor cannot do it because the call would not be polymorphic. </dl>
<p>
Definition at line <a class="el" href="OgreTimer_8cpp-source.html#l00030">30</a> of file <a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1Timera4" doxytag="Ogre::Timer::getMicroseconds"></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"> unsigned long Ogre::Timer::getMicroseconds </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns microseconds since initialisation or last reset.
<p>
<p>
Reimplemented in <a class="el" href="classOgre_1_1SDLTimer.html#Ogre_1_1SDLTimera2">Ogre::SDLTimer</a>, and <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timera2">Ogre::Win32Timer</a>.
<p>
Definition at line <a class="el" href="OgreTimer_8cpp-source.html#l00052">52</a> of file <a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a>.
<p>
References <a class="el" href="OgreTimer_8cpp-source.html#l00057">getMicrosecondsCPU</a>().
<p>
Referenced by <a class="el" href="OgreProfiler_8cpp-source.html#l00273">Ogre::Profiler::beginProfile</a>(), and <a class="el" href="OgreProfiler_8cpp-source.html#l00385">Ogre::Profiler::endProfile</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Win32Timera4" doxytag="Ogre::Timer::getMicrosecondsCPU"></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"> unsigned long Ogre::Timer::getMicrosecondsCPU </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns microseconds since initialisation or last reset, only CPU time measured.
<p>
<p>
Definition at line <a class="el" href="OgreTimer_8cpp-source.html#l00057">57</a> of file <a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a>.
<p>
References <a class="el" href="OgreTimer_8h-source.html#l00039">zeroClock</a>.
<p>
Referenced by <a class="el" href="OgreTimer_8cpp-source.html#l00052">getMicroseconds</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Timera2" doxytag="Ogre::Timer::getMilliseconds"></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"> unsigned long Ogre::Timer::getMilliseconds </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns milliseconds since initialisation or last reset.
<p>
<p>
Reimplemented in <a class="el" href="classOgre_1_1SDLTimer.html#Ogre_1_1SDLTimera1">Ogre::SDLTimer</a>, and <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timera1">Ogre::Win32Timer</a>.
<p>
Definition at line <a class="el" href="OgreTimer_8cpp-source.html#l00041">41</a> of file <a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a>.
<p>
References <a class="el" href="OgreTimer_8cpp-source.html#l00046">getMillisecondsCPU</a>().
<p>
Referenced by <a class="el" href="OgreRoot_8cpp-source.html#l00527">Ogre::Root::_fireFrameEnded</a>(), <a class="el" href="OgreRoot_8cpp-source.html#l00517">Ogre::Root::_fireFrameStarted</a>(), <a class="el" href="OgreRenderTarget_8cpp-source.html#l00223">Ogre::RenderTarget::resetStatistics</a>(), <a class="el" href="OgreRenderTarget_8cpp-source.html#l00238">Ogre::RenderTarget::updateStats</a>(), and <a class="el" href="OgreRenderTarget_8cpp-source.html#l00394">Ogre::RenderTarget::writeContentsToTimestampedFile</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Win32Timera3" doxytag="Ogre::Timer::getMillisecondsCPU"></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"> unsigned long Ogre::Timer::getMillisecondsCPU </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns milliseconds since initialisation or last reset, only CPU time measured.
<p>
<p>
Definition at line <a class="el" href="OgreTimer_8cpp-source.html#l00046">46</a> of file <a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a>.
<p>
References <a class="el" href="OgreTimer_8h-source.html#l00039">zeroClock</a>.
<p>
Referenced by <a class="el" href="OgreTimer_8cpp-source.html#l00041">getMilliseconds</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Timera1" doxytag="Ogre::Timer::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 Ogre::Timer::reset </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Resets timer.
<p>
<p>
Reimplemented in <a class="el" href="classOgre_1_1SDLTimer.html#Ogre_1_1SDLTimera0">Ogre::SDLTimer</a>, and <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timera0">Ogre::Win32Timer</a>.
<p>
Definition at line <a class="el" href="OgreTimer_8cpp-source.html#l00036">36</a> of file <a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a>.
<p>
References <a class="el" href="OgreTimer_8h-source.html#l00039">zeroClock</a>.
<p>
Referenced by <a class="el" href="OgreRoot_8cpp-source.html#l00428">Ogre::Root::initialise</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Win32Timern0" doxytag="Ogre::Timer::zeroClock"></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"> clock_t Ogre::Timer::zeroClock<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreTimer_8h-source.html#l00039">39</a> of file <a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a>.
<p>
Referenced by <a class="el" href="OgreTimer_8cpp-source.html#l00057">getMicrosecondsCPU</a>(), <a class="el" href="OgreTimer_8cpp-source.html#l00046">getMillisecondsCPU</a>(), and <a class="el" href="OgreTimer_8cpp-source.html#l00036">reset</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a><li><a class="el" href="OgreTimer_8cpp-source.html">OgreTimer.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:21:13 2004
</p>
</body>
</html>
