Timer Library


Data Structures

struct  pgeTimer

Functions

pgeTimerpgeTimerCreate (void)
void pgeTimerUpdate (pgeTimer *timer)
float pgeTimerGetDeltaTime (pgeTimer *timer)
float pgeTimerPeekDeltaTime (pgeTimer *timer)
unsigned long long pgeTimerGetTotalTime (pgeTimer *timer)
void pgeTimerDestroy (pgeTimer *timer)
void pgeTimerPause (pgeTimer *timer)
void pgeTimerUnpause (pgeTimer *timer)

Function Documentation

pgeTimer* pgeTimerCreate ( void   ) 

Create a timer

Returns:
A pointer to a pgeTimer struct.

void pgeTimerDestroy ( pgeTimer timer  ) 

Free a previously created timer

Parameters:
timer - A pointer to a valid pgeTimer struct

float pgeTimerGetDeltaTime ( pgeTimer timer  ) 

Get the delta time of a timer

Parameters:
timer - A pointer to a valid pgeTimer struct
Returns:
The delta time member of the timer

unsigned long long pgeTimerGetTotalTime ( pgeTimer timer  ) 

Get the time of a timer since creation.

Parameters:
timer - A pointer to a valid pgeTimer struct
Returns:
The total time member of the timer

void pgeTimerPause ( pgeTimer timer  ) 

float pgeTimerPeekDeltaTime ( pgeTimer timer  ) 

Peek at delta time of a timer (without updating)

Parameters:
timer - A pointer to a valid pgeTimer struct
Returns:
The delta time member of the timer

void pgeTimerUnpause ( pgeTimer timer  ) 

void pgeTimerUpdate ( pgeTimer timer  ) 

Update a timer

Should be called once at the start of each iteration of your main loop

Parameters:
timer - A pointer to a valid pgeTimer struct


Generated on Mon Sep 22 16:58:14 2008 for Phoenix Game Engine by  doxygen 1.5.5