Wiki Page Content

Differences between revisions 5 and 6
Revision 5 as of 2011-02-25 20:11:16
Size: 1146
Editor: SheenaSmith
Comment: remove green comment
Revision 6 as of 2011-11-05 18:08:29
Size: 1069
Editor: SheenaSmith
Comment: update content - RV; camelcase
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
#pragma disable-camelcase #pragma camelcase off
Line 21: Line 21:
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. <<Color2(green,Does SDL_!GetError work with this type?)>>
Returns SDL_TRUE if the timer is removed or SDL_FALSE on failure; call [[SDL_GetError]]() for more information. <<Color2(green,Call SDL_GetError here?)>>

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 SDL_TRUE if the timer is removed 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

None: SDL_RemoveTimer (last edited 2017-02-19 20:53:26 by PhilippWiesemann)

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