From 54fcacae317a3a851416b741df414e38ab38d99a Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Mon, 27 May 2024 14:58:03 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_timer.h | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/include/SDL3/SDL_timer.h b/include/SDL3/SDL_timer.h index 5efecb3482..0a6060279b 100644 --- a/include/SDL3/SDL_timer.h +++ b/include/SDL3/SDL_timer.h @@ -139,7 +139,8 @@ typedef Uint32 SDL_TimerID; * the one passed in, the periodic alarm continues, otherwise a new alarm is * scheduled. If the callback returns 0, the periodic alarm is cancelled. * - * \param userdata an arbitrary pointer provided by the app through SDL_AddTimer, for its own use. + * \param userdata an arbitrary pointer provided by the app through + * SDL_AddTimer, for its own use. * \param timerID the current timer being processed * \param interval the current callback time interval. * \returns the new callback time interval, or 0 to disable further runs of @@ -165,7 +166,8 @@ typedef Uint32 (SDLCALL *SDL_TimerCallback)(void *userdata, SDL_TimerID timerID, * timer interval. If the value returned from the callback is 0, the timer is * canceled. * - * The callback is run on a separate thread, and for short timeouts can potentially be called before this function returns. + * The callback is run on a separate thread, and for short timeouts can + * potentially be called before this function returns. * * Timers take into account the amount of time it took to execute the * callback. For example, if the callback took 250 ms to execute and returned @@ -200,7 +202,8 @@ extern SDL_DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_TimerC * the one passed in, the periodic alarm continues, otherwise a new alarm is * scheduled. If the callback returns 0, the periodic alarm is cancelled. * - * \param userdata an arbitrary pointer provided by the app through SDL_AddTimer, for its own use. + * \param userdata an arbitrary pointer provided by the app through + * SDL_AddTimer, for its own use. * \param timerID the current timer being processed * \param interval the current callback time interval. * \returns the new callback time interval, or 0 to disable further runs of @@ -222,11 +225,12 @@ typedef Uint64 (SDLCALL *SDL_NSTimerCallback)(void *userdata, SDL_TimerID timerI * If you use this function, you must pass `SDL_INIT_TIMER` to SDL_Init(). * * The callback function is passed the current timer interval and the user - * supplied parameter from the SDL_AddTimerNS() call and should return the next - * timer interval. If the value returned from the callback is 0, the timer is - * canceled. + * supplied parameter from the SDL_AddTimerNS() call and should return the + * next timer interval. If the value returned from the callback is 0, the + * timer is canceled. * - * The callback is run on a separate thread, and for short timeouts can potentially be called before this function returns. + * The callback is run on a separate thread, and for short timeouts can + * potentially be called before this function returns. * * Timers take into account the amount of time it took to execute the * callback. For example, if the callback took 250 ns to execute and returned