game_time.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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 #pragma once
30 
31 #include "../System/cl_platform.h"
32 #include <memory>
33 
34 namespace clan
35 {
38 
39  class GameTime_Impl;
40 
42  class GameTime
43  {
44  public:
49  GameTime(int ticks_per_second = 20, int max_updates_per_second = 0);
50 
52  float get_time_elapsed() const;
53 
55  int get_time_elapsed_ms() const;
56 
58  int get_ticks_elapsed() const;
59 
61  float get_tick_time_elapsed() const;
62 
64  int get_tick_time_elapsed_ms() const;
65 
70  float get_tick_interpolation_time() const;
71 
73  float get_updates_per_second() const;
74 
76  float get_current_time() const;
77 
79  uint64_t get_current_time_microseconds() const;
80 
82  uint64_t get_current_time_ms() const;
83 
87  void update();
88 
90  void reset();
91 
92  private:
93  std::shared_ptr<GameTime_Impl> impl;
94  };
95 
97 }
Definition: clanapp.h:35
void update()
Updates time data for the frame to be rendered.
void reset()
Resets the timer.
float get_tick_interpolation_time() const
Returns the current time between ticks as a normalized number.
int get_tick_time_elapsed_ms() const
Returns the time elapsed per tick in milliseconds.
uint64_t get_current_time_ms() const
Returns the number of milliseconds since this class was reset()
float get_time_elapsed() const
Returns the time elapsed in seconds since last update.
float get_tick_time_elapsed() const
Returns the time elapsed per tick.
float get_current_time() const
Returns the number of seconds since this class was reset()
int get_time_elapsed_ms() const
Returns the time elapsed in seconds since last update in milliseconds.
float get_updates_per_second() const
Returns the number of updates that occurred every second (aka fps, frames per second) ...
uint64_t get_current_time_microseconds() const
Returns the number of microseconds since this class was reset()
GameTime(int ticks_per_second=20, int max_updates_per_second=0)
GameTime constructor.
Tracks time elapsed in various forms useful for games.
Definition: game_time.h:42
int get_ticks_elapsed() const
Returns the number of ticks that elapsed since last update.