From 7a5604cf0c54660d5c03ae61e55ca846388769b5 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Tue, 21 Jan 2025 13:12:25 -0500
Subject: [PATCH] Sync SDL3 wiki -> headers.
---
include/SDL3/SDL_assert.h | 44 +--
include/SDL3/SDL_asyncio.h | 22 +-
include/SDL3/SDL_atomic.h | 46 +--
include/SDL3/SDL_audio.h | 156 ++++-----
include/SDL3/SDL_begin_code.h | 26 +-
include/SDL3/SDL_bits.h | 4 +-
include/SDL3/SDL_blendmode.h | 8 +-
include/SDL3/SDL_camera.h | 38 +--
include/SDL3/SDL_clipboard.h | 26 +-
include/SDL3/SDL_cpuinfo.h | 38 +--
include/SDL3/SDL_dialog.h | 14 +-
include/SDL3/SDL_endian.h | 32 +-
include/SDL3/SDL_error.h | 14 +-
include/SDL3/SDL_events.h | 120 +++----
include/SDL3/SDL_filesystem.h | 34 +-
include/SDL3/SDL_gamepad.h | 158 ++++-----
include/SDL3/SDL_gpu.h | 340 ++++++++++----------
include/SDL3/SDL_guid.h | 6 +-
include/SDL3/SDL_haptic.h | 132 ++++----
include/SDL3/SDL_hidapi.h | 50 +--
include/SDL3/SDL_hints.h | 476 +++++++++++++--------------
include/SDL3/SDL_init.h | 34 +-
include/SDL3/SDL_intrin.h | 2 +-
include/SDL3/SDL_iostream.h | 104 +++---
include/SDL3/SDL_joystick.h | 134 ++++----
include/SDL3/SDL_keyboard.h | 54 ++--
include/SDL3/SDL_keycode.h | 4 +-
include/SDL3/SDL_loadso.h | 8 +-
include/SDL3/SDL_locale.h | 4 +-
include/SDL3/SDL_log.h | 42 +--
include/SDL3/SDL_main.h | 24 +-
include/SDL3/SDL_messagebox.h | 16 +-
include/SDL3/SDL_metal.h | 8 +-
include/SDL3/SDL_misc.h | 2 +-
include/SDL3/SDL_mouse.h | 54 ++--
include/SDL3/SDL_mutex.h | 108 +++----
include/SDL3/SDL_pen.h | 10 +-
include/SDL3/SDL_pixels.h | 118 +++----
include/SDL3/SDL_platform.h | 2 +-
include/SDL3/SDL_platform_defines.h | 68 ++--
include/SDL3/SDL_power.h | 4 +-
include/SDL3/SDL_process.h | 22 +-
include/SDL3/SDL_properties.h | 50 +--
include/SDL3/SDL_rect.h | 44 +--
include/SDL3/SDL_render.h | 190 +++++------
include/SDL3/SDL_revision.h | 2 +-
include/SDL3/SDL_scancode.h | 2 +-
include/SDL3/SDL_sensor.h | 36 +--
include/SDL3/SDL_stdinc.h | 480 ++++++++++++++--------------
include/SDL3/SDL_storage.h | 38 +--
include/SDL3/SDL_surface.h | 124 +++----
include/SDL3/SDL_system.h | 78 ++---
include/SDL3/SDL_thread.h | 38 +--
include/SDL3/SDL_time.h | 24 +-
include/SDL3/SDL_timer.h | 48 +--
include/SDL3/SDL_touch.h | 20 +-
include/SDL3/SDL_tray.h | 44 +--
include/SDL3/SDL_version.h | 22 +-
include/SDL3/SDL_video.h | 280 ++++++++--------
include/SDL3/SDL_vulkan.h | 14 +-
60 files changed, 2070 insertions(+), 2070 deletions(-)
diff --git a/include/SDL3/SDL_assert.h b/include/SDL3/SDL_assert.h
index edc69cd7e38c5..09b3b478f0548 100644
--- a/include/SDL3/SDL_assert.h
+++ b/include/SDL3/SDL_assert.h
@@ -89,7 +89,7 @@ extern "C" {
* - 3: Paranoid settings: All SDL assertion macros enabled, including
* SDL_assert_paranoid.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_ASSERT_LEVEL SomeNumberBasedOnVariousFactors
@@ -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_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner
@@ -165,7 +165,7 @@ extern "C" {
*
* If SDL can't figure how the compiler reports this, it will use "???".
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_FUNCTION __FUNCTION__
@@ -180,14 +180,14 @@ extern "C" {
/**
* A macro that reports the current file being compiled.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_FILE __FILE__
/**
* A macro that reports the current line number of the file being compiled.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_LINE __LINE__
@@ -224,7 +224,7 @@ disable assertions.
* do { SomethingOnce(); } while (SDL_NULL_WHILE_LOOP_CONDITION (0));
* ```
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_NULL_WHILE_LOOP_CONDITION (0)
@@ -248,7 +248,7 @@ disable assertions.
*
* \param condition the condition to assert (but not actually run here).
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_disabled_assert(condition) \
do { (void) sizeof ((condition)); } while (SDL_NULL_WHILE_LOOP_CONDITION)
@@ -264,7 +264,7 @@ disable assertions.
* condition, try to break in a debugger, kill the program, or ignore the
* problem).
*
- * \since This enum is available since SDL 3.1.3.
+ * \since This enum is available since SDL 3.2.0.
*/
typedef enum SDL_AssertState
{
@@ -282,7 +282,7 @@ typedef enum SDL_AssertState
* used by the assertion handler, then added to the assertion report. This is
* returned as a linked list from SDL_GetAssertionReport().
*
- * \since This struct is available since SDL 3.1.3.
+ * \since This struct is available since SDL 3.2.0.
*/
typedef struct SDL_AssertData
{
@@ -308,7 +308,7 @@ typedef struct SDL_AssertData
*
* \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 SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *data,
const char *func,
@@ -323,7 +323,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* This isn't for direct use by apps; use SDL_assert or SDL_TriggerBreakpoint
* instead.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AssertBreakpoint() SDL_TriggerBreakpoint()
@@ -355,7 +355,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \param condition the condition to assert.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_enabled_assert(condition) \
do { \
@@ -401,7 +401,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \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_assert(condition) if (assertion_enabled && (condition)) { trigger_assertion; }
@@ -434,7 +434,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \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_assert_release(condition) SDL_disabled_assert(condition)
@@ -463,7 +463,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \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_assert_paranoid(condition) SDL_disabled_assert(condition)
@@ -507,7 +507,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \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_assert_always(condition) SDL_enabled_assert(condition)
@@ -523,7 +523,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* \threadsafety This callback may be called from any thread that triggers an
* assert at any time.
*
- * \since This datatype is available since SDL 3.1.3.
+ * \since This datatype is available since SDL 3.2.0.
*/
typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
const SDL_AssertData *data, void *userdata);
@@ -547,7 +547,7 @@ typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
*
* \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_GetAssertionHandler
*/
@@ -568,7 +568,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetAssertionHandler(
*
* \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_GetAssertionHandler
*/
@@ -593,7 +593,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(
*
* \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_SetAssertionHandler
*/
@@ -627,7 +627,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetAssertionHandler(void **
* SDL_ResetAssertionReport() simultaneously, may render the
* returned pointer invalid.
*
- * \since This function is available since SDL 3.1.3.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_ResetAssertionReport
*/
@@ -645,7 +645,7 @@ extern SDL_DECLSPEC const SDL_AssertData * SDLCALL SDL_GetAssertionReport(void);
* assertion, or simultaneously calling this function may cause
* memory leaks or crashes.
*
- * \since This function is available since SDL 3.1.3.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetAssertionReport
*/
diff --git a/include/SDL3/SDL_asyncio.h b/include/SDL3/SDL_asyncio.h
index 33124e93ff54c..b36cb071bcfb0 100644
--- a/include/SDL3/SDL_asyncio.h
+++ b/include/SDL3/SDL_asyncio.h
@@ -213,7 +213,7 @@ typedef struct SDL_AsyncIOQueue SDL_AsyncIOQueue;
* \returns a pointer to the SDL_AsyncIO structure that is created or NULL on
* failure; call SDL_GetError() for more information.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_CloseAsyncIO
* \sa SDL_ReadAsyncIO
@@ -234,7 +234,7 @@ extern SDL_DECLSPEC SDL_AsyncIO * SDLCALL SDL_AsyncIOFromFile(const char *file,
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio);
@@ -269,7 +269,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio);
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_WriteAsyncIO
* \sa SDL_CreateAsyncIOQueue
@@ -306,7 +306,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadAsyncIO(SDL_AsyncIO *asyncio, void *ptr
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_ReadAsyncIO
* \sa SDL_CreateAsyncIOQueue
@@ -358,7 +358,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteAsyncIO(SDL_AsyncIO *asyncio, void *pt
* \threadsafety It is safe to call this function from any thread, but two
* threads should not attempt to close the same object.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flush, SDL_AsyncIOQueue *queue, void *userdata);
@@ -373,7 +373,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flu
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_DestroyAsyncIOQueue
* \sa SDL_GetAsyncIOResult
@@ -407,7 +407,7 @@ extern SDL_DECLSPEC SDL_AsyncIOQueue * SDLCALL SDL_CreateAsyncIOQueue(void);
* no other thread is waiting on the queue with
* SDL_WaitAsyncIOResult.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue);
@@ -431,7 +431,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_WaitAsyncIOResult
*/
@@ -475,7 +475,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAsyncIOResult(SDL_AsyncIOQueue *queue, S
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_SignalAsyncIOQueue
*/
@@ -499,7 +499,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitAsyncIOResult(SDL_AsyncIOQueue *queue,
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_WaitAsyncIOResult
*/
@@ -531,7 +531,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalAsyncIOQueue(SDL_AsyncIOQueue *queue)
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \since This function is available since SDL 3.1.8.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_LoadFile_IO
*/
diff --git a/include/SDL3/SDL_atomic.h b/include/SDL3/SDL_atomic.h
index 5fd449b0d68e8..03e3fb13441d7 100644
--- a/include/SDL3/SDL_atomic.h
+++ b/include/SDL3/SDL_atomic.h
@@ -92,7 +92,7 @@ typedef int SDL_SpinLock;
*
* \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_LockSpinlock
* \sa SDL_UnlockSpinlock
@@ -109,7 +109,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockSpinlock(SDL_SpinLock *lock);
*
* \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_TryLockSpinlock
* \sa SDL_UnlockSpinlock
@@ -128,7 +128,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockSpinlock(SDL_SpinLock *lock);
*
* \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_LockSpinlock
* \sa SDL_TryLockSpinlock
@@ -152,7 +152,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockSpinlock(SDL_SpinLock *lock);
* time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful!
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_CompilerBarrier() DoCompilerSpecificReadWriteBarrier()
@@ -185,7 +185,7 @@ extern __inline void SDL_CompilerBarrier(void);
* time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful!
*
- * \since This function is available since SDL 3.1.3.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_MemoryBarrierRelease
*/
@@ -205,7 +205,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierReleaseFunction(void);
* time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful!
*
- * \since This function is available since SDL 3.1.3.
+ * \since This function is available since SDL 3.2.0.
*
* \sa SDL_MemoryBarrierAcquire
*/
@@ -245,7 +245,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierAcquireFunction(void);
* time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful!
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*
* \sa SDL_MemoryBarrierAcquire
* \sa SDL_MemoryBarrierReleaseFunction
@@ -268,7 +268,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierAcquireFunction(void);
* time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful!
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*
* \sa SDL_MemoryBarrierRelease
* \sa SDL_MemoryBarrierAcquireFunction
@@ -341,7 +341,7 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
*
* \threadsafety This macro is safe to use 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_CPUPauseInstruction() DoACPUPauseInACompilerAndArchitectureSpecificWay
@@ -385,7 +385,7 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
* This is a struct so people don't accidentally use numeric operations on it
* directly. You have to use SDL atomic functions.
*
- * \since This struct is available since SDL 3.1.3.
+ * \since This struct is available since SDL 3.2.0.
*
* \sa SDL_CompareAndSwapAtomicInt
* \sa SDL_GetAtomicInt
@@ -407,7 +407,7 @@ typedef struct SDL_AtomicInt { int value; } SDL_AtomicInt;
*
* \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_GetAtomicInt
* \sa SDL_SetAtomicInt
@@ -428,7 +428,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CompareAndSwapAtomicInt(SDL_AtomicInt *a, i
*
* \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_GetAtomicInt
*/
@@ -445,7 +445,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetAtomicInt(SDL_AtomicInt *a, int v);
*
* \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_SetAtomicInt
*/
@@ -465,7 +465,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAtomicInt(SDL_AtomicInt *a);
*
* \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_AtomicDecRef
* \sa SDL_AtomicIncRef
@@ -484,7 +484,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
*
* \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.
*
* \sa SDL_AtomicDecRef
*/
@@ -504,7 +504,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
*
* \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.
*
* \sa SDL_AtomicIncRef
*/
@@ -531,7 +531,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
* This is a struct so people don't accidentally use numeric operations on it
* directly. You have to use SDL atomic functions.
*
- * \since This struct is available since SDL 3.1.3.
+ * \since This struct is available since SDL 3.2.0.
*
* \sa SDL_CompareAndSwapAtomicU32
* \sa SDL_GetAtomicU32
@@ -552,7 +552,7 @@ typedef struct SDL_AtomicU32 { Uint32 value; } SDL_AtomicU32;
*
* \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_GetAtomicU32
* \sa SDL_SetAtomicU32
@@ -573,7 +573,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CompareAndSwapAtomicU32(SDL_AtomicU32 *a, U
*
* \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_GetAtomicU32
*/
@@ -590,7 +590,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_SetAtomicU32(SDL_AtomicU32 *a, Uint32 v);
*
* \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_SetAtomicU32
*/
@@ -609,7 +609,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetAtomicU32(SDL_AtomicU32 *a);
*
* \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_CompareAndSwapAtomicInt
* \sa SDL_GetAtomicPointer
@@ -629,7 +629,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CompareAndSwapAtomicPointer(void **a, 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_CompareAndSwapAtomicPointer
* \sa SDL_GetAtomicPointer
@@ -647,7 +647,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_SetAtomicPointer(void **a, void *v);
*
* \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_CompareAndSwapAtomicPointer
* \sa SDL_SetAtomicPointer
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index 71457abbe6976..956938215bea7 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -146,7 +146,7 @@ extern "C" {
*
* Generally one should use SDL_AUDIO_BITSIZE instead of this macro directly.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AUDIO_MASK_BITSIZE (0xFFu)
@@ -155,7 +155,7 @@ extern "C" {
*
* Generally one should use SDL_AUDIO_ISFLOAT instead of this macro directly.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AUDIO_MASK_FLOAT (1u<<8)
@@ -165,7 +165,7 @@ extern "C" {
* Generally one should use SDL_AUDIO_ISBIGENDIAN or SDL_AUDIO_ISLITTLEENDIAN
* instead of this macro directly.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AUDIO_MASK_BIG_ENDIAN (1u<<12)
@@ -174,7 +174,7 @@ extern "C" {
*
* Generally one should use SDL_AUDIO_ISSIGNED instead of this macro directly.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AUDIO_MASK_SIGNED (1u<<15)
@@ -199,7 +199,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_DEFINE_AUDIO_FORMAT(signed, bigendian, flt, size) \
(((Uint16)(signed) << 15) | ((Uint16)(bigendian) << 12) | ((Uint16)(flt) << 8) | ((size) & SDL_AUDIO_MASK_BITSIZE))
@@ -207,7 +207,7 @@ extern "C" {
/**
* Audio format.
*
- * \since This enum is available since SDL 3.1.3.
+ * \since This enum is available since SDL 3.2.0.
*
* \sa SDL_AUDIO_BITSIZE
* \sa SDL_AUDIO_BYTESIZE
@@ -261,7 +261,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_BITSIZE(x) ((x) & SDL_AUDIO_MASK_BITSIZE)
@@ -275,7 +275,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_BYTESIZE(x) (SDL_AUDIO_BITSIZE(x) / 8)
@@ -289,7 +289,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_ISFLOAT(x) ((x) & SDL_AUDIO_MASK_FLOAT)
@@ -303,7 +303,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_ISBIGENDIAN(x) ((x) & SDL_AUDIO_MASK_BIG_ENDIAN)
@@ -317,7 +317,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_ISLITTLEENDIAN(x) (!SDL_AUDIO_ISBIGENDIAN(x))
@@ -331,7 +331,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_ISSIGNED(x) ((x) & SDL_AUDIO_MASK_SIGNED)
@@ -345,7 +345,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_ISINT(x) (!SDL_AUDIO_ISFLOAT(x))
@@ -359,7 +359,7 @@ typedef enum SDL_AudioFormat
*
* \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_AUDIO_ISUNSIGNED(x) (!SDL_AUDIO_ISSIGNED(x))
@@ -369,7 +369,7 @@ typedef enum SDL_AudioFormat
*
* Zero is used to signify an invalid/null device.
*
- * \since This datatype is available since SDL 3.1.3.
+ * \since This datatype is available since SDL 3.2.0.
*/
typedef Uint32 SDL_AudioDeviceID;
@@ -380,7 +380,7 @@ typedef Uint32 SDL_AudioDeviceID;
* to signify the app just wants the system to choose a default device instead
* of the app providing a specific one.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK ((SDL_AudioDeviceID) 0xFFFFFFFFu)
@@ -391,14 +391,14 @@ typedef Uint32 SDL_AudioDeviceID;
* to signify the app just wants the system to choose a default device instead
* of the app providing a specific one.
*
- * \since This macro is available since SDL 3.1.3.
+ * \since This macro is available since SDL 3.2.0.
*/
#define SDL_AUDIO_DEVICE_DEFAULT_RECORDING ((SDL_AudioDeviceID) 0xFFFFFFFEu)
/**
* Format specifier for audio data.
*
- * \since This struct is available since SDL 3.1.3.
+ * \since This struct is available since SDL 3.2.0.
*
* \sa SDL_AudioFormat
*/
@@ -420,7 +420,7 @@ typedef struct SDL_AudioSpec
*
* \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_AUDIO_FRAMESIZE(x) (SDL_AUDIO_BYTESIZE((x).format) * (x).channels)
@@ -444,7 +444,7 @@ typedef struct SDL_AudioSpec
* more of them, bind them to an opened audio device, and feed data to them
* (or for recording, consume data from them).
*
- * \since This struct is available since SDL 3.1.3.
+ * \since This struct is available since SDL 3.2.0.
*
* \sa SDL_CreateAudioStream
*/
@@ -470,7 +470,7 @@ typedef struct SDL_AudioStream SDL_AudioStream;
*
* \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_GetAudioDriver
*/
@@ -494,7 +494,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(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_GetNumAudioDrivers
*/
@@ -512,7 +512,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioDriver(int index);
*
* \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 const char * SDLCALL SDL_GetCurrentAudioDriver(void);
@@ -538,7 +538,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentAudioDriver(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_OpenAudioDevice
* \sa SDL_GetAudioRecordingDevices
@@ -567,7 +567,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID * SDLCALL SDL_GetAudioPlaybackDevices(int
*
* \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_OpenAudioDevice
* \sa SDL_GetAudioPlaybackDevices
@@ -583,7 +583,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID * SDLCALL SDL_GetAudioRecordingDevices(int
*
* \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_GetAudioPlaybackDevices
* \sa SDL_GetAudioRecordingDevices
@@ -621,7 +621,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioDeviceName(SDL_AudioDeviceI
*
* \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 bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devid, SDL_AudioSpec *spec, int *sample_frames);
@@ -642,7 +642,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devi
*
* \threadsafety
(Patch may be truncated, please check the link at the top of this post.)