mirror of
				https://github.com/libsdl-org/SDL.git
				synced 2025-10-26 12:27:44 +00:00 
			
		
		
		
	Sync SDL3 wiki -> headers.
This commit is contained in:
		@@ -57,7 +57,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * This is always 1000.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_MS_PER_SECOND   1000
 | 
			
		||||
 | 
			
		||||
@@ -66,7 +66,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * This is always 1000000.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_US_PER_SECOND   1000000
 | 
			
		||||
 | 
			
		||||
@@ -75,7 +75,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * This is always 1000000000.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_NS_PER_SECOND   1000000000LL
 | 
			
		||||
 | 
			
		||||
@@ -84,7 +84,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * This is always 1000000.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_NS_PER_MS       1000000
 | 
			
		||||
 | 
			
		||||
@@ -93,7 +93,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * This is always 1000.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_NS_PER_US       1000
 | 
			
		||||
 | 
			
		||||
@@ -107,7 +107,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this macro from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_SECONDS_TO_NS(S)    (((Uint64)(S)) * SDL_NS_PER_SECOND)
 | 
			
		||||
 | 
			
		||||
@@ -122,7 +122,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this macro from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_NS_TO_SECONDS(NS)   ((NS) / SDL_NS_PER_SECOND)
 | 
			
		||||
 | 
			
		||||
@@ -136,7 +136,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this macro from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_MS_TO_NS(MS)        (((Uint64)(MS)) * SDL_NS_PER_MS)
 | 
			
		||||
 | 
			
		||||
@@ -151,7 +151,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this macro from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_NS_TO_MS(NS)        ((NS) / SDL_NS_PER_MS)
 | 
			
		||||
 | 
			
		||||
@@ -165,7 +165,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this macro from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_US_TO_NS(US)        (((Uint64)(US)) * SDL_NS_PER_US)
 | 
			
		||||
 | 
			
		||||
@@ -180,7 +180,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this macro from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This macro is available since SDL 3.1.3.
 | 
			
		||||
 * \since This macro is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
#define SDL_NS_TO_US(NS)        ((NS) / SDL_NS_PER_US)
 | 
			
		||||
 | 
			
		||||
@@ -192,7 +192,7 @@ extern "C" {
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicks(void);
 | 
			
		||||
 | 
			
		||||
@@ -204,7 +204,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicks(void);
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicksNS(void);
 | 
			
		||||
 | 
			
		||||
@@ -221,7 +221,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicksNS(void);
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_GetPerformanceFrequency
 | 
			
		||||
 */
 | 
			
		||||
@@ -234,7 +234,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void);
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_GetPerformanceCounter
 | 
			
		||||
 */
 | 
			
		||||
@@ -251,7 +251,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void);
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_DelayNS
 | 
			
		||||
 * \sa SDL_DelayPrecise
 | 
			
		||||
@@ -269,7 +269,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Delay(Uint32 ms);
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_Delay
 | 
			
		||||
 * \sa SDL_DelayPrecise
 | 
			
		||||
@@ -287,7 +287,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DelayNS(Uint64 ns);
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.6.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_Delay
 | 
			
		||||
 * \sa SDL_DelayNS
 | 
			
		||||
@@ -297,7 +297,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DelayPrecise(Uint64 ns);
 | 
			
		||||
/**
 | 
			
		||||
 * Definition of the timer ID type.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This datatype is available since SDL 3.1.3.
 | 
			
		||||
 * \since This datatype is available since SDL 3.2.0.
 | 
			
		||||
 */
 | 
			
		||||
typedef Uint32 SDL_TimerID;
 | 
			
		||||
 | 
			
		||||
@@ -321,7 +321,7 @@ typedef Uint32 SDL_TimerID;
 | 
			
		||||
 *               thread; the application is responsible for locking resources
 | 
			
		||||
 *               the callback touches that need to be protected.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This datatype is available since SDL 3.1.3.
 | 
			
		||||
 * \since This datatype is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_AddTimer
 | 
			
		||||
 */
 | 
			
		||||
@@ -356,7 +356,7 @@ typedef Uint32 (SDLCALL *SDL_TimerCallback)(void *userdata, SDL_TimerID timerID,
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_AddTimerNS
 | 
			
		||||
 * \sa SDL_RemoveTimer
 | 
			
		||||
@@ -383,7 +383,7 @@ extern SDL_DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_TimerC
 | 
			
		||||
 *               thread; the application is responsible for locking resources
 | 
			
		||||
 *               the callback touches that need to be protected.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This datatype is available since SDL 3.1.3.
 | 
			
		||||
 * \since This datatype is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_AddTimerNS
 | 
			
		||||
 */
 | 
			
		||||
@@ -418,7 +418,7 @@ typedef Uint64 (SDLCALL *SDL_NSTimerCallback)(void *userdata, SDL_TimerID timerI
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_AddTimer
 | 
			
		||||
 * \sa SDL_RemoveTimer
 | 
			
		||||
@@ -434,7 +434,7 @@ extern SDL_DECLSPEC SDL_TimerID SDLCALL SDL_AddTimerNS(Uint64 interval, SDL_NSTi
 | 
			
		||||
 *
 | 
			
		||||
 * \threadsafety It is safe to call this function from any thread.
 | 
			
		||||
 *
 | 
			
		||||
 * \since This function is available since SDL 3.1.3.
 | 
			
		||||
 * \since This function is available since SDL 3.2.0.
 | 
			
		||||
 *
 | 
			
		||||
 * \sa SDL_AddTimer
 | 
			
		||||
 */
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user