aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/manager/LoopTimerManager.h
diff options
context:
space:
mode:
authorWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-12-07 14:44:46 +0100
committerWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-12-07 14:44:46 +0100
commita06ea7d18008d0859818f7e8fd3e595e7dd05772 (patch)
tree0fb161d3dc87e4403d9443e2f68c5f21867b2a4b /src/crepe/manager/LoopTimerManager.h
parenta73ff31b67faa7e6a922cfb5598f56f80bc01d62 (diff)
changed looptimerManager doxygen
Diffstat (limited to 'src/crepe/manager/LoopTimerManager.h')
-rw-r--r--src/crepe/manager/LoopTimerManager.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/crepe/manager/LoopTimerManager.h b/src/crepe/manager/LoopTimerManager.h
index dba0f66..fee6310 100644
--- a/src/crepe/manager/LoopTimerManager.h
+++ b/src/crepe/manager/LoopTimerManager.h
@@ -1,9 +1,19 @@
#pragma once
#include <chrono>
-#include "../manager/Manager.h"
+
+#include "Manager.h"
+
namespace crepe {
+/**
+ * \brief Manages timing and frame rate for the game loop.
+ *
+ * The LoopTimerManager class is responsible for calculating and managing timing functions
+ * such as delta time, frames per second (FPS), fixed time steps, and time scaling. It ensures
+ * consistent frame updates and supports game loop operations, such as handling fixed updates
+ * for physics and other time-sensitive operations.
+ */
class LoopTimerManager : public Manager {
public:
LoopTimerManager(Mediator & mediator);
@@ -49,6 +59,8 @@ public:
/**
* \brief Set the time scale.
*
+ * time_scale is a value that changes the delta time that can be retrieved using get_delta_time function.
+ *
* \param game_scale The desired time scale (0 = pause, 1 = normal speed, > 1 = speed up).
*/
void set_time_scale(double game_scale);