|
Size: 1148
Comment: update content (old wiki)
|
Size: 1223
Comment: update content - 2/14 changeset 5295
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| Use this function to remove one of the ,,multiple,, timers ^created with [[SDL_AddTimer]](),^ knowing its ID. | Use this function to remove a timer, ^created with [[SDL_AddTimer]](),^ knowing its ID. |
| Line 21: | Line 21: |
| Returns SDL_TRUE on success or SDL_FALSE on failure; call [[SDL_GetError]]() for more information. <<Color2(green,Does !GetError work with this type?)>> | Returns a boolean value indicating success or failure. |
| Line 23: | Line 23: |
| ''-OR-'' | ''-or-'' |
| Line 25: | Line 25: |
| Returns a boolean value indicating success or failure. | Returns SDL_TRUE on success or SDL_FALSE on failure; call [[SDL_GetError]]() for more information. <<Color2(green,Does SDL_!GetError work with this type?)>> |
| Line 40: | Line 40: |
| <<Color2(green,I don't think that math works... 33/10*10 is still 33.)>> |
|
| Line 41: | Line 43: |
| ''You can add useful comments here'' | /!\ It is not safe to remove a timer multiple times. |
DRAFT |
SDL_RemoveTimer
Use this function to remove a timer, created with [[SDL_AddTimer]](), knowing its ID.
green
Contents
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);
green
Remarks
![/!\](/moin_static198/fixedleft/img/alert.png "/!\"){kind=small}
It is not safe to remove a timer multiple times.
