game_time.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 
31 #pragma once
32 
33 #include "../api_core.h"
34 #include "../System/cl_platform.h"
35 #include <memory>
36 
37 namespace clan
38 {
41 
42 class GameTime_Impl;
43 
45 class CL_API_CORE GameTime
46 {
49 public:
54  GameTime(int ticks_per_second = 20, int max_updates_per_second = 0);
56 
59 public:
61  float get_time_elapsed() const;
62 
64  int get_time_elapsed_ms() const;
65 
67  int get_ticks_elapsed() const;
68 
70  float get_tick_time_elapsed() const;
71 
73  int get_tick_time_elapsed_ms() const;
74 
79  float get_tick_interpolation_time() const;
80 
82  float get_updates_per_second() const;
83 
85  float get_current_time() const;
86 
88  ubyte64 get_current_time_microseconds() const;
89 
91  ubyte64 get_current_time_ms() const;
92 
93 
95 
98 public:
102  void update();
103 
105  void reset();
107 
110 private:
111  std::shared_ptr<GameTime_Impl> impl;
113 };
114 
115 }
116 
unsigned long long ubyte64
Definition: cl_platform.h:66
Tracks time elapsed in various forms useful for games.
Definition: game_time.h:45