rendering_engine::AppClock Class Reference

Provides high-resolution timing for frame updates. More...

#include <app_clock.hpp>

Public Member Functions
	AppClock ()
	Constructs a new clock initialized with the current time. More...
	AppClock (AppClock const &)=default
AppClock &	operator= (AppClock const &)=default
	AppClock (AppClock &&)=default
AppClock &	operator= (AppClock &&)=default
	~AppClock ()=default
const std::chrono::steady_clock::time_point &	StartTime () const
	Returns the timestamp when the clock was started. More...
const std::chrono::steady_clock::time_point &	CurrentTime () const
	Returns the most recent recorded time (current frame). More...
const std::chrono::steady_clock::time_point &	LastTime () const
	Returns the time recorded at the previous frame. More...
void	Reset ()
	Resets the clock to the current system time. More...
void	UpdateAppTime (AppTime &appTime)
	Updates the given AppTime instance with elapsed and total durations. More...

Detailed Description

Provides high-resolution timing for frame updates.

AppClock tracks time since the application started and between frames. Each call to UpdateAppTime() updates an AppTime instance with new total and elapsed durations.

Typical usage:

AppClock clock;
AppTime time;
clock.Reset();
 
while (running)
{
    clock.UpdateAppTime(time);
    float delta = time.ElapsedAppTimeMilliseconds();
    // Update logic...
}

See also

rendering_engine::AppTime

Definition at line 49 of file app_clock.hpp.

Constructor & Destructor Documentation

AppClock() [1/3]

rendering_engine::AppClock::AppClock

(

)

Constructs a new clock initialized with the current time.

Definition at line 7 of file app_clock.cpp.

:
mStartTime(),
mCurrentTime(),
mLastTime()
{
    Reset();
}

AppClock() [2/3]

rendering_engine::AppClock::AppClock ( AppClock const &  )

default

AppClock() [3/3]

rendering_engine::AppClock::AppClock ( AppClock &&  )

default

~AppClock()

rendering_engine::AppClock::~AppClock ( )

default

Member Function Documentation

CurrentTime()

const std::chrono::steady_clock::time_point & rendering_engine::AppClock::CurrentTime

(

)

const

Returns the most recent recorded time (current frame).

Definition at line 21 of file app_clock.cpp.

{
    return mCurrentTime;
}

LastTime()

const std::chrono::steady_clock::time_point & rendering_engine::AppClock::LastTime

(

)

const

Returns the time recorded at the previous frame.

Definition at line 26 of file app_clock.cpp.

{
    return mLastTime;
}

operator=() [1/2]

AppClock & rendering_engine::AppClock::operator= ( AppClock &&  )

default

operator=() [2/2]

AppClock & rendering_engine::AppClock::operator= ( AppClock const &  )

default

Reset()

void rendering_engine::AppClock::Reset

(

)

Resets the clock to the current system time.

Definition at line 31 of file app_clock.cpp.

{
    mStartTime = std::chrono::steady_clock::now();
    mCurrentTime = mStartTime;
    mLastTime = mCurrentTime;
}

StartTime()

const std::chrono::steady_clock::time_point & rendering_engine::AppClock::StartTime

(

)

const

Returns the timestamp when the clock was started.

Definition at line 16 of file app_clock.cpp.

{
    return mStartTime;
}

UpdateAppTime()

void rendering_engine::AppClock::UpdateAppTime

(

AppTime &

appTime

)

Updates the given AppTime instance with elapsed and total durations.

Calculates the time difference between the last and current frame, updates internal state, and synchronizes AppTime accordingly.

Parameters

appTime

Reference to the AppTime instance to update.

Definition at line 38 of file app_clock.cpp.

{
    mLastTime = mCurrentTime;
    mCurrentTime = std::chrono::steady_clock::now();
    
    appTime.SetCurrentTime( mCurrentTime );
    appTime.SetTotalAppTime( std::chrono::duration_cast<std::chrono::milliseconds>(mCurrentTime - mStartTime) );
    appTime.SetElapsedAppTime( std::chrono::duration_cast<std::chrono::milliseconds>(mCurrentTime - mLastTime) );
}

---

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

• app_clock.hpp
• app_clock.cpp