Hummingbird Framework
 All Classes Functions Variables Modules Pages
hb::Clock Class Reference

A class for measuring Time intervals. More...

#include <Clock.h>

Public Member Functions

 Clock ()
 Class constructor. More...
 
 ~Clock ()
 Class destructor. More...
 
Time getElapsedTime () const
 Returns the Time elapsed since creation or last reset. More...
 
Time reset ()
 Restarts the Time counter. More...
 

Detailed Description

A class for measuring Time intervals.

Constructor & Destructor Documentation

hb::Clock::Clock ( )

Class constructor.

Initializes a new instance of Clock wich starts measuring the time as it is created.

hb::Clock::~Clock ( )

Class destructor.

Destroys the instance of Clock.

Member Function Documentation

Time hb::Clock::getElapsedTime ( ) const

Returns the Time elapsed since creation or last reset.

Returns
Time since instance creation or last reset().
Time hb::Clock::reset ( )

Restarts the Time counter.

This function also returns the time elapsed up to its reset. This is usefull for getting precise delta times without having time overhead for having to call two methods:

while(game_is_running)
{
hb::Time deltaTime = clk.reset();
... // Game code
}
Returns
Time since instance creation or last reset().

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