Commit 227c33b8ecec3afb93ecac26cd8c954e9598f37f

Sam Lantinga 2021-10-13T09:33:57

Add note about SDL_TICKS_PASSED hitting int overflow problems with large timeouts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/include/SDL_timer.h b/include/SDL_timer.h
index 04696dc..b23686b 100644
--- a/include/SDL_timer.h
+++ b/include/SDL_timer.h
@@ -60,6 +60,10 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
  *     // ... do work until timeout has elapsed
  * }
  * ```
+ *
+ * Note that this does not handle tick differences greater
+ * than 2^31 so take care when using the above kind of code
+ * with large timeout delays (tens of days).
  */
 #define SDL_TICKS_PASSED(A, B)  ((Sint32)((B) - (A)) <= 0)