source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1Win32Timer.html @ 692

Revision 692, 18.3 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::Win32Timer 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::Win32Timer Class Reference</h1><code>#include &lt;<a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>&gt;</code>
11<p>
12<p>Inheritance diagram for Ogre::Win32Timer:
13<p><center><img src="classOgre_1_1Win32Timer.png" usemap="#Ogre::Win32Timer_map" border="0" alt=""></center>
14<map name="Ogre::Win32Timer_map">
15<area href="classOgre_1_1Timer.html" alt="Ogre::Timer" shape="rect" coords="0,0,113,24">
16</map>
17<a href="classOgre_1_1Win32Timer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
18<tr><td></td></tr>
19<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
20<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timera0">reset</a> ()</td></tr>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets timer.  <a href="#Ogre_1_1Win32Timera0"></a><br><br></td></tr>
23<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_1Win32Timer.html#Ogre_1_1Win32Timera1">getMilliseconds</a> ()</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns milliseconds since initialisation or last reset.  <a href="#Ogre_1_1Win32Timera1"></a><br><br></td></tr>
26<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_1Win32Timer.html#Ogre_1_1Win32Timera2">getMicroseconds</a> ()</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns microseconds since initialisation or last reset.  <a href="#Ogre_1_1Win32Timera2"></a><br><br></td></tr>
29<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>
30
31<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>
32<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>
33
34<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>
35<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
36<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>
37
38<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>DWORD&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr0">mStartTick</a></td></tr>
40
41<tr><td class="memItemLeft" nowrap align=right valign=top>LONGLONG&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr1">mLastTime</a></td></tr>
42
43<tr><td class="memItemLeft" nowrap align=right valign=top>LARGE_INTEGER&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr2">mStartTime</a></td></tr>
44
45<tr><td class="memItemLeft" nowrap align=right valign=top>LARGE_INTEGER&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr3">mFrequency</a></td></tr>
46
47<tr><td class="memItemLeft" nowrap align=right valign=top>DWORD&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr4">mProcMask</a></td></tr>
48
49<tr><td class="memItemLeft" nowrap align=right valign=top>DWORD&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr5">mSysMask</a></td></tr>
50
51<tr><td class="memItemLeft" nowrap align=right valign=top>HANDLE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr6">mThread</a></td></tr>
52
53<tr><td class="memItemLeft" nowrap align=right valign=top>DWORD&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr7">mQueryCount</a></td></tr>
54
55</table>
56<hr><h2>Member Function Documentation</h2>
57<a class="anchor" name="Ogre_1_1Win32Timera2" doxytag="Ogre::Win32Timer::getMicroseconds" ></a><p>
58<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
59  <tr>
60    <td class="mdRow">
61      <table cellpadding="0" cellspacing="0" border="0">
62        <tr>
63          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Win32Timer::getMicroseconds </td>
64          <td class="md" valign="top">(&nbsp;</td>
65          <td class="mdname1" valign="top" nowrap>          </td>
66          <td class="md" valign="top">&nbsp;)&nbsp;</td>
67          <td class="md" nowrap><code> [virtual]</code></td>
68        </tr>
69
70      </table>
71    </td>
72  </tr>
73</table>
74<table cellspacing=5 cellpadding=0 border=0>
75  <tr>
76    <td>
77      &nbsp;
78    </td>
79    <td>
80
81<p>
82Returns microseconds since initialisation or last reset.
83<p>
84
85<p>
86Reimplemented from <a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera5">Ogre::Timer</a>.    </td>
87  </tr>
88</table>
89<a class="anchor" name="Ogre_1_1Win32Timera4" doxytag="Ogre::Win32Timer::getMicrosecondsCPU" ></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 unsigned long Ogre::Timer::getMicrosecondsCPU </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, inherited]</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>
114Returns microseconds since initialisation or last reset, only CPU time measured.
115<p>
116    </td>
117  </tr>
118</table>
119<a class="anchor" name="Ogre_1_1Win32Timera1" doxytag="Ogre::Win32Timer::getMilliseconds" ></a><p>
120<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
121  <tr>
122    <td class="mdRow">
123      <table cellpadding="0" cellspacing="0" border="0">
124        <tr>
125          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Win32Timer::getMilliseconds </td>
126          <td class="md" valign="top">(&nbsp;</td>
127          <td class="mdname1" valign="top" nowrap>          </td>
128          <td class="md" valign="top">&nbsp;)&nbsp;</td>
129          <td class="md" nowrap><code> [virtual]</code></td>
130        </tr>
131
132      </table>
133    </td>
134  </tr>
135</table>
136<table cellspacing=5 cellpadding=0 border=0>
137  <tr>
138    <td>
139      &nbsp;
140    </td>
141    <td>
142
143<p>
144Returns milliseconds since initialisation or last reset.
145<p>
146
147<p>
148Reimplemented from <a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera3">Ogre::Timer</a>.    </td>
149  </tr>
150</table>
151<a class="anchor" name="Ogre_1_1Win32Timera3" doxytag="Ogre::Win32Timer::getMillisecondsCPU" ></a><p>
152<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
153  <tr>
154    <td class="mdRow">
155      <table cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::Timer::getMillisecondsCPU </td>
158          <td class="md" valign="top">(&nbsp;</td>
159          <td class="mdname1" valign="top" nowrap>          </td>
160          <td class="md" valign="top">&nbsp;)&nbsp;</td>
161          <td class="md" nowrap><code> [virtual, inherited]</code></td>
162        </tr>
163
164      </table>
165    </td>
166  </tr>
167</table>
168<table cellspacing=5 cellpadding=0 border=0>
169  <tr>
170    <td>
171      &nbsp;
172    </td>
173    <td>
174
175<p>
176Returns milliseconds since initialisation or last reset, only CPU time measured.
177<p>
178    </td>
179  </tr>
180</table>
181<a class="anchor" name="Ogre_1_1Win32Timera0" doxytag="Ogre::Win32Timer::reset" ></a><p>
182<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
183  <tr>
184    <td class="mdRow">
185      <table cellpadding="0" cellspacing="0" border="0">
186        <tr>
187          <td class="md" nowrap valign="top"> virtual void Ogre::Win32Timer::reset </td>
188          <td class="md" valign="top">(&nbsp;</td>
189          <td class="mdname1" valign="top" nowrap>          </td>
190          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191          <td class="md" nowrap><code> [virtual]</code></td>
192        </tr>
193
194      </table>
195    </td>
196  </tr>
197</table>
198<table cellspacing=5 cellpadding=0 border=0>
199  <tr>
200    <td>
201      &nbsp;
202    </td>
203    <td>
204
205<p>
206Resets timer.
207<p>
208
209<p>
210Reimplemented from <a class="el" href="classOgre_1_1Timer.html#Ogre_1_1Timera2">Ogre::Timer</a>.    </td>
211  </tr>
212</table>
213<hr><h2>Member Data Documentation</h2>
214<a class="anchor" name="Ogre_1_1Win32Timerr3" doxytag="Ogre::Win32Timer::mFrequency" ></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"> LARGE_INTEGER <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr3">Ogre::Win32Timer::mFrequency</a><code> [private]</code>
221      </table>
222    </td>
223  </tr>
224</table>
225<table cellspacing=5 cellpadding=0 border=0>
226  <tr>
227    <td>
228      &nbsp;
229    </td>
230    <td>
231
232<p>
233
234<p>
235Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00041">41</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
236  </tr>
237</table>
238<a class="anchor" name="Ogre_1_1Win32Timerr1" doxytag="Ogre::Win32Timer::mLastTime" ></a><p>
239<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
240  <tr>
241    <td class="mdRow">
242      <table cellpadding="0" cellspacing="0" border="0">
243        <tr>
244          <td class="md" nowrap valign="top"> LONGLONG <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr1">Ogre::Win32Timer::mLastTime</a><code> [private]</code>
245      </table>
246    </td>
247  </tr>
248</table>
249<table cellspacing=5 cellpadding=0 border=0>
250  <tr>
251    <td>
252      &nbsp;
253    </td>
254    <td>
255
256<p>
257
258<p>
259Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00039">39</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
260  </tr>
261</table>
262<a class="anchor" name="Ogre_1_1Win32Timerr4" doxytag="Ogre::Win32Timer::mProcMask" ></a><p>
263<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
264  <tr>
265    <td class="mdRow">
266      <table cellpadding="0" cellspacing="0" border="0">
267        <tr>
268          <td class="md" nowrap valign="top"> DWORD <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr4">Ogre::Win32Timer::mProcMask</a><code> [private]</code>
269      </table>
270    </td>
271  </tr>
272</table>
273<table cellspacing=5 cellpadding=0 border=0>
274  <tr>
275    <td>
276      &nbsp;
277    </td>
278    <td>
279
280<p>
281
282<p>
283Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00043">43</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
284  </tr>
285</table>
286<a class="anchor" name="Ogre_1_1Win32Timerr7" doxytag="Ogre::Win32Timer::mQueryCount" ></a><p>
287<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
288  <tr>
289    <td class="mdRow">
290      <table cellpadding="0" cellspacing="0" border="0">
291        <tr>
292          <td class="md" nowrap valign="top"> DWORD <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr7">Ogre::Win32Timer::mQueryCount</a><code> [private]</code>
293      </table>
294    </td>
295  </tr>
296</table>
297<table cellspacing=5 cellpadding=0 border=0>
298  <tr>
299    <td>
300      &nbsp;
301    </td>
302    <td>
303
304<p>
305
306<p>
307Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00048">48</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
308  </tr>
309</table>
310<a class="anchor" name="Ogre_1_1Win32Timerr0" doxytag="Ogre::Win32Timer::mStartTick" ></a><p>
311<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
312  <tr>
313    <td class="mdRow">
314      <table cellpadding="0" cellspacing="0" border="0">
315        <tr>
316          <td class="md" nowrap valign="top"> DWORD <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr0">Ogre::Win32Timer::mStartTick</a><code> [private]</code>
317      </table>
318    </td>
319  </tr>
320</table>
321<table cellspacing=5 cellpadding=0 border=0>
322  <tr>
323    <td>
324      &nbsp;
325    </td>
326    <td>
327
328<p>
329
330<p>
331Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00038">38</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
332  </tr>
333</table>
334<a class="anchor" name="Ogre_1_1Win32Timerr2" doxytag="Ogre::Win32Timer::mStartTime" ></a><p>
335<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
336  <tr>
337    <td class="mdRow">
338      <table cellpadding="0" cellspacing="0" border="0">
339        <tr>
340          <td class="md" nowrap valign="top"> LARGE_INTEGER <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr2">Ogre::Win32Timer::mStartTime</a><code> [private]</code>
341      </table>
342    </td>
343  </tr>
344</table>
345<table cellspacing=5 cellpadding=0 border=0>
346  <tr>
347    <td>
348      &nbsp;
349    </td>
350    <td>
351
352<p>
353
354<p>
355Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00040">40</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
356  </tr>
357</table>
358<a class="anchor" name="Ogre_1_1Win32Timerr5" doxytag="Ogre::Win32Timer::mSysMask" ></a><p>
359<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
360  <tr>
361    <td class="mdRow">
362      <table cellpadding="0" cellspacing="0" border="0">
363        <tr>
364          <td class="md" nowrap valign="top"> DWORD <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr5">Ogre::Win32Timer::mSysMask</a><code> [private]</code>
365      </table>
366    </td>
367  </tr>
368</table>
369<table cellspacing=5 cellpadding=0 border=0>
370  <tr>
371    <td>
372      &nbsp;
373    </td>
374    <td>
375
376<p>
377
378<p>
379Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00044">44</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
380  </tr>
381</table>
382<a class="anchor" name="Ogre_1_1Win32Timerr6" doxytag="Ogre::Win32Timer::mThread" ></a><p>
383<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
384  <tr>
385    <td class="mdRow">
386      <table cellpadding="0" cellspacing="0" border="0">
387        <tr>
388          <td class="md" nowrap valign="top"> HANDLE <a class="el" href="classOgre_1_1Win32Timer.html#Ogre_1_1Win32Timerr6">Ogre::Win32Timer::mThread</a><code> [private]</code>
389      </table>
390    </td>
391  </tr>
392</table>
393<table cellspacing=5 cellpadding=0 border=0>
394  <tr>
395    <td>
396      &nbsp;
397    </td>
398    <td>
399
400<p>
401
402<p>
403Definition at line <a class="el" href="OgreWin32Timer_8h-source.html#l00046">46</a> of file <a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a>.    </td>
404  </tr>
405</table>
406<a class="anchor" name="Ogre_1_1Win32Timerp0" doxytag="Ogre::Win32Timer::zeroClock" ></a><p>
407<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
408  <tr>
409    <td class="mdRow">
410      <table cellpadding="0" cellspacing="0" border="0">
411        <tr>
412          <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, inherited]</code>
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing=5 cellpadding=0 border=0>
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425
426<p>
427Definition 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>
428  </tr>
429</table>
430<hr>The documentation for this class was generated from the following file:<ul>
431<li><a class="el" href="OgreWin32Timer_8h-source.html">OgreWin32Timer.h</a></ul>
432<hr>
433<p>
434Copyright &copy; 2000-2005 by The OGRE Team<br />
435<!--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/>
436This 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/>
437                <!--/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#">
438                <Work rdf:about="">
439                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
440        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
441                </Work>
442                <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> -->
443
444Last modified Sun Mar 12 14:46:29 2006
445</p>
446</body>
447</html>
Note: See TracBrowser for help on using the repository browser.