From 14667cc0a3c484ce40db3d04cd7574e50bf0f95d Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Mon, 27 May 2024 07:56:04 -0700 Subject: [PATCH] Document that the timer callback can potentially be called before the timer returns. --- include/SDL3/SDL_timer.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/SDL3/SDL_timer.h b/include/SDL3/SDL_timer.h index 9bac551a5..5efecb348 100644 --- a/include/SDL3/SDL_timer.h +++ b/include/SDL3/SDL_timer.h @@ -165,7 +165,7 @@ 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. + * 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 @@ -226,7 +226,7 @@ typedef Uint64 (SDLCALL *SDL_NSTimerCallback)(void *userdata, SDL_TimerID timerI * timer interval. If the value returned from the callback is 0, the timer is * canceled. * - * The callback is run on a separate thread. + * 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