Wiki Page Content

Revision 5 as of 2011-02-25 20:11:16

Clear message

DRAFT

SDL_RemoveTimer

Use this function to remove a timer, created with [[SDL_AddTimer]](), knowing its ID.

green

Syntax

SDL_bool SDL_RemoveTimer(SDL_TimerID t)

Function Parameters

t

the ID of the timer to remove

Return Value

Returns a boolean value indicating success or failure.

-or-

Returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information. green

Code Examples

delay = (33 / 10) * 10;  /* To round it down to the nearest 10 ms */

...

my_timer_id = SDL_AddTimer(delay, my_callbackfunc, my_callback_param);

...

SDL_RemoveTimer(my_timer_id);

Remarks

/!\ It is not safe to remove a timer multiple times.


CategoryAPI, CategoryTimer

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit