1 | /* |
---|
2 | ----------------------------------------------------------------------------- |
---|
3 | This source file is part of OGRE |
---|
4 | (Object-oriented Graphics Rendering Engine) |
---|
5 | For the latest info, see http://www.ogre3d.org/ |
---|
6 | |
---|
7 | Copyright (c) 2000-2013 Torus Knot Software Ltd |
---|
8 | |
---|
9 | Permission is hereby granted, free of charge, to any person obtaining a copy |
---|
10 | of this software and associated documentation files (the "Software"), to deal |
---|
11 | in the Software without restriction, including without limitation the rights |
---|
12 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
---|
13 | copies of the Software, and to permit persons to whom the Software is |
---|
14 | furnished to do so, subject to the following conditions: |
---|
15 | |
---|
16 | The above copyright notice and this permission notice shall be included in |
---|
17 | all copies or substantial portions of the Software. |
---|
18 | |
---|
19 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
20 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
21 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
---|
22 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
---|
23 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
---|
24 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
---|
25 | THE SOFTWARE. |
---|
26 | ----------------------------------------------------------------------------- |
---|
27 | */ |
---|
28 | #ifndef __Win32Timer_H__ |
---|
29 | #define __Win32Timer_H__ |
---|
30 | |
---|
31 | #ifndef WIN32_LEAN_AND_MEAN |
---|
32 | # define WIN32_LEAN_AND_MEAN |
---|
33 | #endif |
---|
34 | #if !defined(NOMINMAX) && defined(_MSC_VER) |
---|
35 | # define NOMINMAX // required to stop windows.h messing up std::min |
---|
36 | #endif |
---|
37 | #include <windows.h> |
---|
38 | |
---|
39 | namespace Ogre |
---|
40 | { |
---|
41 | /** \addtogroup Core |
---|
42 | * @{ |
---|
43 | */ |
---|
44 | /** \addtogroup General |
---|
45 | * @{ |
---|
46 | */ |
---|
47 | |
---|
48 | class _OgreExport Timer : public TimerAlloc |
---|
49 | { |
---|
50 | private: |
---|
51 | clock_t mZeroClock; |
---|
52 | |
---|
53 | DWORD mStartTick; |
---|
54 | LONGLONG mLastTime; |
---|
55 | LARGE_INTEGER mStartTime; |
---|
56 | LARGE_INTEGER mFrequency; |
---|
57 | |
---|
58 | #if OGRE_PLATFORM == OGRE_PLATFORM_WIN32 |
---|
59 | DWORD_PTR mTimerMask; |
---|
60 | #endif |
---|
61 | #if OGRE_PLATFORM == OGRE_PLATFORM_WINRT |
---|
62 | DWORD GetTickCount() { return (DWORD)GetTickCount64(); } |
---|
63 | #endif |
---|
64 | |
---|
65 | public: |
---|
66 | /** Timer constructor. MUST be called on same thread that calls getMilliseconds() */ |
---|
67 | Timer(); |
---|
68 | ~Timer(); |
---|
69 | |
---|
70 | /** Method for setting a specific option of the Timer. These options are usually |
---|
71 | specific for a certain implementation of the Timer class, and may (and probably |
---|
72 | will) not exist across different implementations. reset() must be called after |
---|
73 | all setOption() calls. |
---|
74 | @par |
---|
75 | Current options supported are: |
---|
76 | <ul><li>"QueryAffinityMask" (DWORD): Set the thread affinity mask to be used |
---|
77 | to check the timer. If 'reset' has been called already this mask should |
---|
78 | overlap with the process mask that was in force at that point, and should |
---|
79 | be a power of two (a single core).</li></ul> |
---|
80 | @param |
---|
81 | strKey The name of the option to set |
---|
82 | @param |
---|
83 | pValue A pointer to the value - the size should be calculated by the timer |
---|
84 | based on the key |
---|
85 | @return |
---|
86 | On success, true is returned. |
---|
87 | @par |
---|
88 | On failure, false is returned. |
---|
89 | */ |
---|
90 | bool setOption( const String& strKey, const void* pValue ); |
---|
91 | |
---|
92 | /** Resets timer */ |
---|
93 | void reset(); |
---|
94 | |
---|
95 | /** Returns milliseconds since initialisation or last reset */ |
---|
96 | unsigned long getMilliseconds(); |
---|
97 | |
---|
98 | /** Returns microseconds since initialisation or last reset */ |
---|
99 | unsigned long getMicroseconds(); |
---|
100 | |
---|
101 | /** Returns milliseconds since initialisation or last reset, only CPU time measured */ |
---|
102 | unsigned long getMillisecondsCPU(); |
---|
103 | |
---|
104 | /** Returns microseconds since initialisation or last reset, only CPU time measured */ |
---|
105 | unsigned long getMicrosecondsCPU(); |
---|
106 | }; |
---|
107 | /** @} */ |
---|
108 | /** @} */ |
---|
109 | } |
---|
110 | #endif |
---|