File: FrameTimer.h

package info (click to toggle)
endless-sky 0.10.16-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 414,608 kB
  • sloc: cpp: 73,435; python: 893; xml: 666; sh: 271; makefile: 28
file content (54 lines) | stat: -rw-r--r-- 1,900 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/* FrameTimer.h
Copyright (c) 2014 by Michael Zahniser

Endless Sky is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.

Endless Sky is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
*/

#pragma once

#include <chrono>



// Class to be used for enforcing a certain frame rate. This ensures that the
// frames are not drawn faster than a certain speed, but if the calculations or
// the graphics cannot keep up it will allow things to go slower for a few frames
// without trying to "catch up" by making the subsequent frame faster.
class FrameTimer {
public:
	// Create a timer that is just responsible for measuring the time that
	// elapses until Time() is called.
	FrameTimer();
	// Create a frame timer that will space frames out at exactly the given FPS,
	// _unless_ a frame takes too long by at least the given lag, in which case
	// the next frame happens immediately but no "catch-up" is done.
	explicit FrameTimer(int fps, int maxLagMsec = 5);

	// Wait until the next frame should begin.
	void Wait();
	// Find out how long it has been since this timer was created, in seconds.
	double Time() const;

	// Change the frame rate (for viewing in slow motion).
	void SetFrameRate(int fps);


private:
	// Calculate when the next frame should begin.
	void Step();


private:
	std::chrono::steady_clock::time_point next;
	std::chrono::steady_clock::duration step;
	std::chrono::steady_clock::duration maxLag;
};