Utils::Time Class Reference

Utility class for handling delta time and FPS capping. More...

#include <Time.h>

Static Public Member Functions
static void	updateDeltaTime () noexcept
	Updates the delta time value.
static void	init () noexcept
	Initializes the time tracking system.
static double	deltaTime () noexcept
	Retrieves the time elapsed between the last two frames.
static uint32_t	getTicks () noexcept
	Gets the time in milliseconds since the start of the program.
static void	capFPS ()
	Caps the FPS to the target frame rate.

Static Private Attributes
static double	mDeltaTime = 0.0
	Stores the delta time value in seconds.
static std::chrono::time_point< std::chrono::high_resolution_clock >	mPreviousTime
	Stores the previous frame's timestamp.
static std::chrono::time_point< std::chrono::high_resolution_clock >	mCurrentTime
	Stores the current frame's timestamp.
static std::chrono::time_point< std::chrono::high_resolution_clock >	mStartTime
	Stores the program start timestamp.
static const int	mTargetFPS = 60
	The target frames per second.
static const std::chrono::milliseconds	mFrameDuration
	The expected duration of each frame.

Detailed Description

Utility class for handling delta time and FPS capping.

This class provides static methods to manage delta timing, which measures the time elapsed between frames, and functions for retrieving program ticks.

Member Function Documentation

capFPS()

void Utils::Time::capFPS ( )

static

Caps the FPS to the target frame rate.

This function ensures that the frame rate does not exceed a predefined limit.

deltaTime()

double Utils::Time::deltaTime ( )

staticnoexcept

Retrieves the time elapsed between the last two frames.

Returns

The delta time in milliseconds.

getTicks()

uint32_t Utils::Time::getTicks ( )

staticnoexcept

Gets the time in milliseconds since the start of the program.

Returns

The number of milliseconds since the program began execution.

init()

void Utils::Time::init ( )

staticnoexcept

Initializes the time tracking system.

This method sets the start time and initializes the timing variables. This function should be called only once during initialisation.

updateDeltaTime()

void Utils::Time::updateDeltaTime ( )

staticnoexcept

Updates the delta time value.

This method should be called once at the start of every frame to calculate the time difference between the current and previous frame.

Member Data Documentation

mCurrentTime

std::chrono::time_point< std::chrono::high_resolution_clock > Utils::Time::mCurrentTime

staticprivate

Stores the current frame's timestamp.

mDeltaTime

double Utils::Time::mDeltaTime = 0.0

staticprivate

Stores the delta time value in seconds.

mFrameDuration

const std::chrono::milliseconds Utils::Time::mFrameDuration

staticprivate

Initial value:

=
    std::chrono::milliseconds(1000 / mTargetFPS)

The expected duration of each frame.

mPreviousTime

std::chrono::time_point< std::chrono::high_resolution_clock > Utils::Time::mPreviousTime

staticprivate

Stores the previous frame's timestamp.

mStartTime

std::chrono::time_point< std::chrono::high_resolution_clock > Utils::Time::mStartTime

staticprivate

Stores the program start timestamp.

mTargetFPS

const int Utils::Time::mTargetFPS = 60

staticprivate

The target frames per second.

---

The documentation for this class was generated from the following files:

• /Users/runner/work/Garage/Garage/src/Utils/Time.h
• /Users/runner/work/Garage/Garage/src/Utils/Time.cpp