From 30f41c02aec763d32e62351452da9ef582bc3472 Mon Sep 17 00:00:00 2001 From: 3gg <3gg@shellblade.net> Date: Fri, 6 Mar 2026 13:30:59 -0800 Subject: Move contrib libraries to contrib repo --- contrib/SDL-3.2.8/include/SDL3/SDL_timer.h | 450 ----------------------------- 1 file changed, 450 deletions(-) delete mode 100644 contrib/SDL-3.2.8/include/SDL3/SDL_timer.h (limited to 'contrib/SDL-3.2.8/include/SDL3/SDL_timer.h') diff --git a/contrib/SDL-3.2.8/include/SDL3/SDL_timer.h b/contrib/SDL-3.2.8/include/SDL3/SDL_timer.h deleted file mode 100644 index cf94881..0000000 --- a/contrib/SDL-3.2.8/include/SDL3/SDL_timer.h +++ /dev/null @@ -1,450 +0,0 @@ -/* - Simple DirectMedia Layer - Copyright (C) 1997-2025 Sam Lantinga - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. -*/ - -#ifndef SDL_timer_h_ -#define SDL_timer_h_ - -/** - * # CategoryTimer - * - * SDL provides time management functionality. It is useful for dealing with - * (usually) small durations of time. - * - * This is not to be confused with _calendar time_ management, which is - * provided by [CategoryTime](CategoryTime). - * - * This category covers measuring time elapsed (SDL_GetTicks(), - * SDL_GetPerformanceCounter()), putting a thread to sleep for a certain - * amount of time (SDL_Delay(), SDL_DelayNS(), SDL_DelayPrecise()), and firing - * a callback function after a certain amount of time has elasped - * (SDL_AddTimer(), etc). - * - * There are also useful macros to convert between time units, like - * SDL_SECONDS_TO_NS() and such. - */ - -#include -#include - -#include -/* Set up for C function definitions, even when using C++ */ -#ifdef __cplusplus -extern "C" { -#endif - -/* SDL time constants */ - -/** - * Number of milliseconds in a second. - * - * This is always 1000. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_MS_PER_SECOND 1000 - -/** - * Number of microseconds in a second. - * - * This is always 1000000. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_US_PER_SECOND 1000000 - -/** - * Number of nanoseconds in a second. - * - * This is always 1000000000. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_NS_PER_SECOND 1000000000LL - -/** - * Number of nanoseconds in a millisecond. - * - * This is always 1000000. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_NS_PER_MS 1000000 - -/** - * Number of nanoseconds in a microsecond. - * - * This is always 1000. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_NS_PER_US 1000 - -/** - * Convert seconds to nanoseconds. - * - * This only converts whole numbers, not fractional seconds. - * - * \param S the number of seconds to convert. - * \returns S, expressed in nanoseconds. - * - * \threadsafety It is safe to call this macro from any thread. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_SECONDS_TO_NS(S) (((Uint64)(S)) * SDL_NS_PER_SECOND) - -/** - * Convert nanoseconds to seconds. - * - * This performs a division, so the results can be dramatically different if - * `NS` is an integer or floating point value. - * - * \param NS the number of nanoseconds to convert. - * \returns NS, expressed in seconds. - * - * \threadsafety It is safe to call this macro from any thread. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_NS_TO_SECONDS(NS) ((NS) / SDL_NS_PER_SECOND) - -/** - * Convert milliseconds to nanoseconds. - * - * This only converts whole numbers, not fractional milliseconds. - * - * \param MS the number of milliseconds to convert. - * \returns MS, expressed in nanoseconds. - * - * \threadsafety It is safe to call this macro from any thread. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_MS_TO_NS(MS) (((Uint64)(MS)) * SDL_NS_PER_MS) - -/** - * Convert nanoseconds to milliseconds. - * - * This performs a division, so the results can be dramatically different if - * `NS` is an integer or floating point value. - * - * \param NS the number of nanoseconds to convert. - * \returns NS, expressed in milliseconds. - * - * \threadsafety It is safe to call this macro from any thread. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_NS_TO_MS(NS) ((NS) / SDL_NS_PER_MS) - -/** - * Convert microseconds to nanoseconds. - * - * This only converts whole numbers, not fractional microseconds. - * - * \param US the number of microseconds to convert. - * \returns US, expressed in nanoseconds. - * - * \threadsafety It is safe to call this macro from any thread. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_US_TO_NS(US) (((Uint64)(US)) * SDL_NS_PER_US) - -/** - * Convert nanoseconds to microseconds. - * - * This performs a division, so the results can be dramatically different if - * `NS` is an integer or floating point value. - * - * \param NS the number of nanoseconds to convert. - * \returns NS, expressed in microseconds. - * - * \threadsafety It is safe to call this macro from any thread. - * - * \since This macro is available since SDL 3.2.0. - */ -#define SDL_NS_TO_US(NS) ((NS) / SDL_NS_PER_US) - -/** - * Get the number of milliseconds since SDL library initialization. - * - * \returns an unsigned 64-bit value representing the number of milliseconds - * since the SDL library initialized. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicks(void); - -/** - * Get the number of nanoseconds since SDL library initialization. - * - * \returns an unsigned 64-bit value representing the number of nanoseconds - * since the SDL library initialized. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicksNS(void); - -/** - * Get the current value of the high resolution counter. - * - * This function is typically used for profiling. - * - * The counter values are only meaningful relative to each other. Differences - * between values can be converted to times by using - * SDL_GetPerformanceFrequency(). - * - * \returns the current counter value. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_GetPerformanceFrequency - */ -extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void); - -/** - * Get the count per second of the high resolution counter. - * - * \returns a platform-specific count per second. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_GetPerformanceCounter - */ -extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void); - -/** - * Wait a specified number of milliseconds before returning. - * - * This function waits a specified number of milliseconds before returning. It - * waits at least the specified time, but possibly longer due to OS - * scheduling. - * - * \param ms the number of milliseconds to delay. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_DelayNS - * \sa SDL_DelayPrecise - */ -extern SDL_DECLSPEC void SDLCALL SDL_Delay(Uint32 ms); - -/** - * Wait a specified number of nanoseconds before returning. - * - * This function waits a specified number of nanoseconds before returning. It - * waits at least the specified time, but possibly longer due to OS - * scheduling. - * - * \param ns the number of nanoseconds to delay. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_Delay - * \sa SDL_DelayPrecise - */ -extern SDL_DECLSPEC void SDLCALL SDL_DelayNS(Uint64 ns); - -/** - * Wait a specified number of nanoseconds before returning. - * - * This function waits a specified number of nanoseconds before returning. It - * will attempt to wait as close to the requested time as possible, busy - * waiting if necessary, but could return later due to OS scheduling. - * - * \param ns the number of nanoseconds to delay. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_Delay - * \sa SDL_DelayNS - */ -extern SDL_DECLSPEC void SDLCALL SDL_DelayPrecise(Uint64 ns); - -/** - * Definition of the timer ID type. - * - * \since This datatype is available since SDL 3.2.0. - */ -typedef Uint32 SDL_TimerID; - -/** - * Function prototype for the millisecond timer callback function. - * - * The callback function is passed the current timer interval and returns the - * next timer interval, in milliseconds. If the returned value is the same as - * the one passed in, the periodic alarm continues, otherwise a new alarm is - * scheduled. If the callback returns 0, the periodic alarm is canceled and - * will be removed. - * - * \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 - * the callback. - * - * \threadsafety SDL may call this callback at any time from a background - * thread; the application is responsible for locking resources - * the callback touches that need to be protected. - * - * \since This datatype is available since SDL 3.2.0. - * - * \sa SDL_AddTimer - */ -typedef Uint32 (SDLCALL *SDL_TimerCallback)(void *userdata, SDL_TimerID timerID, Uint32 interval); - -/** - * Call a callback function at a future time. - * - * The callback function is passed the current timer interval and the user - * supplied parameter from the SDL_AddTimer() call and should return the next - * timer interval. If the value returned from the callback is 0, the timer is - * canceled and will be removed. - * - * 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 - * 1000 (ms), the timer would only wait another 750 ms before its next - * iteration. - * - * Timing may be inexact due to OS scheduling. Be sure to note the current - * time with SDL_GetTicksNS() or SDL_GetPerformanceCounter() in case your - * callback needs to adjust for variances. - * - * \param interval the timer delay, in milliseconds, passed to `callback`. - * \param callback the SDL_TimerCallback function to call when the specified - * `interval` elapses. - * \param userdata a pointer that is passed to `callback`. - * \returns a timer ID or 0 on failure; call SDL_GetError() for more - * information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_AddTimerNS - * \sa SDL_RemoveTimer - */ -extern SDL_DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_TimerCallback callback, void *userdata); - -/** - * Function prototype for the nanosecond timer callback function. - * - * The callback function is passed the current timer interval and returns the - * next timer interval, in nanoseconds. If the returned value is the same as - * the one passed in, the periodic alarm continues, otherwise a new alarm is - * scheduled. If the callback returns 0, the periodic alarm is canceled and - * will be removed. - * - * \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 - * the callback. - * - * \threadsafety SDL may call this callback at any time from a background - * thread; the application is responsible for locking resources - * the callback touches that need to be protected. - * - * \since This datatype is available since SDL 3.2.0. - * - * \sa SDL_AddTimerNS - */ -typedef Uint64 (SDLCALL *SDL_NSTimerCallback)(void *userdata, SDL_TimerID timerID, Uint64 interval); - -/** - * Call a callback function at a future time. - * - * 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 and will be removed. - * - * 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 - * 1000 (ns), the timer would only wait another 750 ns before its next - * iteration. - * - * Timing may be inexact due to OS scheduling. Be sure to note the current - * time with SDL_GetTicksNS() or SDL_GetPerformanceCounter() in case your - * callback needs to adjust for variances. - * - * \param interval the timer delay, in nanoseconds, passed to `callback`. - * \param callback the SDL_TimerCallback function to call when the specified - * `interval` elapses. - * \param userdata a pointer that is passed to `callback`. - * \returns a timer ID or 0 on failure; call SDL_GetError() for more - * information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_AddTimer - * \sa SDL_RemoveTimer - */ -extern SDL_DECLSPEC SDL_TimerID SDLCALL SDL_AddTimerNS(Uint64 interval, SDL_NSTimerCallback callback, void *userdata); - -/** - * Remove a timer created with SDL_AddTimer(). - * - * \param id the ID of the timer to remove. - * \returns true on success or false on failure; call SDL_GetError() for more - * information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_AddTimer - */ -extern SDL_DECLSPEC bool SDLCALL SDL_RemoveTimer(SDL_TimerID id); - - -/* Ends C function definitions when using C++ */ -#ifdef __cplusplus -} -#endif -#include - -#endif /* SDL_timer_h_ */ -- cgit v1.2.3