source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1Timer.html @ 657

Revision 657, 14.2 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::Timer class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::Timer Class Reference</h1>Platform-independent <a class="el" href="classOgre_1_1Timer.html">Timer</a> class. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::Timer:
16<p><center><img src="classOgre_1_1Timer.png" usemap="#Ogre::Timer_map" border="0" alt=""></center>
17<map name="Ogre::Timer_map">
18<area href="classOgre_1_1GLXTimer.html" alt="Ogre::GLXTimer" shape="rect" coords="0,56,113,80">
19<area href="classOgre_1_1SDLTimer.html" alt="Ogre::SDLTimer" shape="rect" coords="123,56,236,80">
20<area href="classOgre_1_1Win32Timer.html" alt="Ogre::Win32Timer" shape="rect" coords="246,56,359,80">
21</map>
22<a href="classOgre_1_1Timer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
23<tr><td></td></tr>
24<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera0">Timer</a> ()</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a timer.  <a href="#Ogre_1_1Timera0"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera1">~Timer</a> ()</td></tr>
29
30<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera2">reset</a> ()</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets timer.  <a href="#Ogre_1_1Timera2"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera3">getMilliseconds</a> ()</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns milliseconds since initialisation or last reset.  <a href="#Ogre_1_1Timera3"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timera3">getMillisecondsCPU</a> ()</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns milliseconds since initialisation or last reset, only CPU time measured.  <a href="#Ogre_1_1Win32Timera3"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera5">getMicroseconds</a> ()</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns microseconds since initialisation or last reset.  <a href="#Ogre_1_1Timera5"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timera4">getMicrosecondsCPU</a> ()</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns microseconds since initialisation or last reset, only CPU time measured.  <a href="#Ogre_1_1Win32Timera4"></a><br><br></td></tr>
45<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>clock_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timerp0">zeroClock</a></td></tr>
47
48</table>
49<hr><a name="_details"></a><h2>Detailed Description</h2>
50Platform-independent <a class="el" href="classOgre_1_1Timer.html">Timer</a> class.
51<p>
52<dl compact><dt><b>Remarks:</b></dt><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>. </dd></dl>
53
54<p>
55
56<p>
57Definition 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 &amp; Destructor Documentation</h2>
58<a class="anchor" name="Ogre_1_1Timera0" doxytag="Ogre::Timer::Timer" ></a><p>
59<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
60  <tr>
61    <td class="mdRow">
62      <table cellpadding="0" cellspacing="0" border="0">
63        <tr>
64          <td class="md" nowrap valign="top"> Ogre::Timer::Timer </td>
65          <td class="md" valign="top">(&nbsp;</td>
66          <td class="mdname1" valign="top" nowrap>          </td>
67          <td class="md" valign="top">&nbsp;)&nbsp;</td>
68          <td class="md" nowrap></td>
69        </tr>
70
71      </table>
72    </td>
73  </tr>
74</table>
75<table cellspacing=5 cellpadding=0 border=0>
76  <tr>
77    <td>
78      &nbsp;
79    </td>
80    <td>
81
82<p>
83Creates a timer.
84<p>
85<dl compact><dt><b>Remarks:</b></dt><dd>You must call <a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera2">reset()</a> after creating it; the constructor cannot do it because the call would not be polymorphic.</dd></dl>
86    </td>
87  </tr>
88</table>
89<a class="anchor" name="Ogre_1_1Timera1" doxytag="Ogre::Timer::~Timer" ></a><p>
90<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
91  <tr>
92    <td class="mdRow">
93      <table cellpadding="0" cellspacing="0" border="0">
94        <tr>
95          <td class="md" nowrap valign="top"> virtual Ogre::Timer::~<a class="el" href="classOgre_1_1Timer.html">Timer</a> </td>
96          <td class="md" valign="top">(&nbsp;</td>
97          <td class="mdname1" valign="top" nowrap>          </td>
98          <td class="md" valign="top">&nbsp;)&nbsp;</td>
99          <td class="md" nowrap><code> [virtual]</code></td>
100        </tr>
101
102      </table>
103    </td>
104  </tr>
105</table>
106<table cellspacing=5 cellpadding=0 border=0>
107  <tr>
108    <td>
109      &nbsp;
110    </td>
111    <td>
112
113<p>
114
115<p>
116Definition at line <a class="el" href="OgreTimer_8h-source.html#l00048">48</a> of file <a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a>.    </td>
117  </tr>
118</table>
119<hr><h2>Member Function Documentation</h2>
120<a class="anchor" name="Ogre_1_1Timera5" doxytag="Ogre::Timer::getMicroseconds" ></a><p>
121<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
122  <tr>
123    <td class="mdRow">
124      <table cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Timer::getMicroseconds </td>
127          <td class="md" valign="top">(&nbsp;</td>
128          <td class="mdname1" valign="top" nowrap>          </td>
129          <td class="md" valign="top">&nbsp;)&nbsp;</td>
130          <td class="md" nowrap><code> [virtual]</code></td>
131        </tr>
132
133      </table>
134    </td>
135  </tr>
136</table>
137<table cellspacing=5 cellpadding=0 border=0>
138  <tr>
139    <td>
140      &nbsp;
141    </td>
142    <td>
143
144<p>
145Returns microseconds since initialisation or last reset.
146<p>
147
148<p>
149Reimplemented in <a class="el" href="classOgre_1_1GLXTimer.html#Ogre_1_1GLXTimera2">Ogre::GLXTimer</a>, <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>.    </td>
150  </tr>
151</table>
152<a class="anchor" name="Ogre_1_1Win32Timera4" doxytag="Ogre::Timer::getMicrosecondsCPU" ></a><p>
153<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
154  <tr>
155    <td class="mdRow">
156      <table cellpadding="0" cellspacing="0" border="0">
157        <tr>
158          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Timer::getMicrosecondsCPU </td>
159          <td class="md" valign="top">(&nbsp;</td>
160          <td class="mdname1" valign="top" nowrap>          </td>
161          <td class="md" valign="top">&nbsp;)&nbsp;</td>
162          <td class="md" nowrap><code> [virtual]</code></td>
163        </tr>
164
165      </table>
166    </td>
167  </tr>
168</table>
169<table cellspacing=5 cellpadding=0 border=0>
170  <tr>
171    <td>
172      &nbsp;
173    </td>
174    <td>
175
176<p>
177Returns microseconds since initialisation or last reset, only CPU time measured.
178<p>
179    </td>
180  </tr>
181</table>
182<a class="anchor" name="Ogre_1_1Timera3" doxytag="Ogre::Timer::getMilliseconds" ></a><p>
183<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
184  <tr>
185    <td class="mdRow">
186      <table cellpadding="0" cellspacing="0" border="0">
187        <tr>
188          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Timer::getMilliseconds </td>
189          <td class="md" valign="top">(&nbsp;</td>
190          <td class="mdname1" valign="top" nowrap>          </td>
191          <td class="md" valign="top">&nbsp;)&nbsp;</td>
192          <td class="md" nowrap><code> [virtual]</code></td>
193        </tr>
194
195      </table>
196    </td>
197  </tr>
198</table>
199<table cellspacing=5 cellpadding=0 border=0>
200  <tr>
201    <td>
202      &nbsp;
203    </td>
204    <td>
205
206<p>
207Returns milliseconds since initialisation or last reset.
208<p>
209
210<p>
211Reimplemented in <a class="el" href="classOgre_1_1GLXTimer.html#Ogre_1_1GLXTimera1">Ogre::GLXTimer</a>, <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>.    </td>
212  </tr>
213</table>
214<a class="anchor" name="Ogre_1_1Win32Timera3" doxytag="Ogre::Timer::getMillisecondsCPU" ></a><p>
215<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
216  <tr>
217    <td class="mdRow">
218      <table cellpadding="0" cellspacing="0" border="0">
219        <tr>
220          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Timer::getMillisecondsCPU </td>
221          <td class="md" valign="top">(&nbsp;</td>
222          <td class="mdname1" valign="top" nowrap>          </td>
223          <td class="md" valign="top">&nbsp;)&nbsp;</td>
224          <td class="md" nowrap><code> [virtual]</code></td>
225        </tr>
226
227      </table>
228    </td>
229  </tr>
230</table>
231<table cellspacing=5 cellpadding=0 border=0>
232  <tr>
233    <td>
234      &nbsp;
235    </td>
236    <td>
237
238<p>
239Returns milliseconds since initialisation or last reset, only CPU time measured.
240<p>
241    </td>
242  </tr>
243</table>
244<a class="anchor" name="Ogre_1_1Timera2" doxytag="Ogre::Timer::reset" ></a><p>
245<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
246  <tr>
247    <td class="mdRow">
248      <table cellpadding="0" cellspacing="0" border="0">
249        <tr>
250          <td class="md" nowrap valign="top"> virtual void Ogre::Timer::reset </td>
251          <td class="md" valign="top">(&nbsp;</td>
252          <td class="mdname1" valign="top" nowrap>          </td>
253          <td class="md" valign="top">&nbsp;)&nbsp;</td>
254          <td class="md" nowrap><code> [virtual]</code></td>
255        </tr>
256
257      </table>
258    </td>
259  </tr>
260</table>
261<table cellspacing=5 cellpadding=0 border=0>
262  <tr>
263    <td>
264      &nbsp;
265    </td>
266    <td>
267
268<p>
269Resets timer.
270<p>
271
272<p>
273Reimplemented in <a class="el" href="classOgre_1_1GLXTimer.html#Ogre_1_1GLXTimera0">Ogre::GLXTimer</a>, <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>.    </td>
274  </tr>
275</table>
276<hr><h2>Member Data Documentation</h2>
277<a class="anchor" name="Ogre_1_1Win32Timerp0" doxytag="Ogre::Timer::zeroClock" ></a><p>
278<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
279  <tr>
280    <td class="mdRow">
281      <table cellpadding="0" cellspacing="0" border="0">
282        <tr>
283          <td class="md" nowrap valign="top"> clock_t <a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Win32Timerp0">Ogre::Timer::zeroClock</a><code> [protected]</code>
284      </table>
285    </td>
286  </tr>
287</table>
288<table cellspacing=5 cellpadding=0 border=0>
289  <tr>
290    <td>
291      &nbsp;
292    </td>
293    <td>
294
295<p>
296
297<p>
298Definition 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>.    </td>
299  </tr>
300</table>
301<hr>The documentation for this class was generated from the following file:<ul>
302<li><a class="el" href="OgreTimer_8h-source.html">OgreTimer.h</a></ul>
303<hr>
304<p>
305Copyright &copy; 2000-2005 by The OGRE Team<br />
306<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
307This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
308                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
309                <Work rdf:about="">
310                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
311        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
312                </Work>
313                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
314
315Last modified Sun Feb 12 13:04:50 2006
316</p>
317</body>
318</html>
Note: See TracBrowser for help on using the repository browser.