SDL_!AddTimer?

SDL_!AddTimer?

NAME SYNOPSIS CALLBACK DESCRIPTION RETURN VALUE EXAMPLES SEE ALSO

NAME

SDL_!AddTimer?- Add a timer which will call a callback after the specified number of milliseconds has elapsed.

SYNOPSIS

#include

SDL_TimerID SDL_!AddTimer?(__Uint32 interval, SDL_!NewTimerCallback? callback, void

• param__);

CALLBACK

/* type definition for the

DESCRIPTION

Adds a callback function to be run after the specified number of milliseconds has elapsed. The callback function is passed the current timer interval and the user supplied parameter from the SDL_!AddTimer? call and returns the next timer interval. If the returned value from the callback 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 SDL_!RemoveTimer? with the timer ID returned from SDL_!AddTimer?.

The timer callback function may run in a different thread than your main program, 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 (see example below). If you use this function, you need to pass SDL_INIT_TIMER to SDL_Init.

RETURN VALUE

Returns an ID value for the added timer or NULL if there was an error.

EXAMPLES

my_timer_id = SDL_!AddTimer?((33/10)*10, my_callbackfunc, my_callback_param);

SEE ALSO

SDL_!RemoveTimer?