game_time.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 "../System/cl_platform.h"
34 #include <memory>
35
36 namespace clan
37 {
40
41 class GameTime_Impl;
42
44 class GameTime
45 {
48 public:
53 GameTime(int ticks_per_second = 20, int max_updates_per_second = 0);
55
58 public:
60 float get_time_elapsed() const;
61
63 int get_time_elapsed_ms() const;
64
66 int get_ticks_elapsed() const;
67
69 float get_tick_time_elapsed() const;
70
72 int get_tick_time_elapsed_ms() const;
73
78 float get_tick_interpolation_time() const;
79
81 float get_updates_per_second() const;
82
84 float get_current_time() const;
85
87 uint64_t get_current_time_microseconds() const;
88
90 uint64_t get_current_time_ms() const;
91
92
94
97 public:
101 void update();
102
104 void reset();
106
109 private:
110 std::shared_ptr<GameTime_Impl> impl;
112 };
113
114 }
115
clan::GameTime::get_current_time
float get_current_time() const
Returns the number of seconds since this class was reset()
clan
Definition: clanapp.h:35
clan::GameTime::get_time_elapsed
float get_time_elapsed() const
Returns the time elapsed in seconds since last update.
clan::GameTime::GameTime
GameTime(int ticks_per_second=20, int max_updates_per_second=0)
GameTime constructor.
clan::GameTime::get_tick_time_elapsed
float get_tick_time_elapsed() const
Returns the time elapsed per tick.
clan::GameTime::get_tick_interpolation_time
float get_tick_interpolation_time() const
Returns the current time between ticks as a normalized number.
clan::GameTime::get_current_time_microseconds
uint64_t get_current_time_microseconds() const
Returns the number of microseconds since this class was reset()
clan::GameTime::reset
void reset()
Resets the timer.
clan::GameTime::get_time_elapsed_ms
int get_time_elapsed_ms() const
Returns the time elapsed in seconds since last update in milliseconds.
clan::GameTime::update
void update()
Updates time data for the frame to be rendered.
clan::GameTime::get_updates_per_second
float get_updates_per_second() const
Returns the number of updates that occurred every second (aka fps, frames per second) ...
clan::GameTime::get_tick_time_elapsed_ms
int get_tick_time_elapsed_ms() const
Returns the time elapsed per tick in milliseconds.
clan::GameTime::get_ticks_elapsed
int get_ticks_elapsed() const
Returns the number of ticks that elapsed since last update.
clan::GameTime
Tracks time elapsed in various forms useful for games.
Definition: game_time.h:44
clan::GameTime::get_current_time_ms
uint64_t get_current_time_ms() const
Returns the number of milliseconds since this class was reset()