Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | Related Pages | Examples

fgl::FGTimer Class Reference

#include <fastgl.h>

Inheritance diagram for fgl::FGTimer:

Inheritance graph
[legend]
Collaboration diagram for fgl::FGTimer:

Collaboration graph
[legend]
List of all members.

Detailed Description

Some timing class.
Examples:

timer.cpp.


Public Member Functions

 FGTimer (unsigned int val, TimerCall cb)
 FGTimer (TimerCall cb)

Static Public Member Functions

static int SetTimer (unsigned int val, TimerCall cb)
static unsigned int GetTicks (void)
static void Delay (unsigned int)
static int TimerInit (void)
static void TimerQuit (void)

Static Protected Member Functions

static void StartTicks (void)

Protected Attributes

int state

Friends

void HandleAlarm (int sig)


Member Function Documentation

void fgl::FGTimer::Delay unsigned int  ms  )  [static]
 

Wait a specified number of milliseconds before returning

unsigned int fgl::FGTimer::GetTicks void   )  [static]
 

Get the number of milliseconds since the OpenGUI library initialization. Note that this value wraps if the program runs for more than ~49 days.

int fgl::FGTimer::SetTimer unsigned int  ms,
TimerCall  callback
[static]
 

Set a callback to run after the specified number of milliseconds has elapsed. The callback function is passed the current timer interval and returns the next timer interval. If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled.

To cancel a currently running timer, call SetTimer(0, NULL);

The timer callback function may run in a different thread than your main code, and so shouldn't call any functions from within itself.

The maximum resolution of this timer is 10 ms, which means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms: SetTimer((33/10)*10, flag_update);

Under UNIX, you should not use raise or use SIGALRM and this function in the same program, as it is implemented using setitimer(). You also should not use this function in multi-threaded applications as signals to multi-threaded apps have undefined behavior in some implementations.

Examples:
timer.cpp.


Generated on Wed Feb 9 11:31:39 2005 for OpenGUI by  doxygen 1.4.0