From 1c1706a00ba2eb9ce11d396213a4ea86f76f0f9d Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Wed, 23 Oct 2024 12:19:38 -0400
Subject: [PATCH] fnsince: update `\since` policy for documentation.
Everything in SDL3 up to the ABI lock is reported as available since 3.1.3.
Everything else will be reported as since 3.2.0 (what will be the first
official release).
Also ran a Perl script over the headers to change everything to 3.1.3 that
wasn't an API function, since fnsince.pl can't manage those. If there's a
macro or datatype that has snuck in that needs to be 3.2.0 instead, we'll
have to manually fix it up, but it shouldn't be a big deal in any case.
Reference PR #11304.
---
build-scripts/fnsince.pl | 13 +-
include/SDL3/SDL_assert.h | 30 +-
include/SDL3/SDL_atomic.h | 42 +--
include/SDL3/SDL_audio.h | 140 ++++-----
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 | 10 +-
include/SDL3/SDL_endian.h | 24 +-
include/SDL3/SDL_error.h | 10 +-
include/SDL3/SDL_events.h | 118 +++----
include/SDL3/SDL_filesystem.h | 28 +-
include/SDL3/SDL_gamepad.h | 158 +++++-----
include/SDL3/SDL_gpu.h | 332 +++++++++----------
include/SDL3/SDL_guid.h | 6 +-
include/SDL3/SDL_haptic.h | 128 ++++----
include/SDL3/SDL_hidapi.h | 50 +--
include/SDL3/SDL_hints.h | 472 ++++++++++++++--------------
include/SDL3/SDL_init.h | 20 +-
include/SDL3/SDL_iostream.h | 100 +++---
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 | 68 ++--
include/SDL3/SDL_pen.h | 6 +-
include/SDL3/SDL_pixels.h | 64 ++--
include/SDL3/SDL_platform.h | 2 +-
include/SDL3/SDL_platform_defines.h | 68 ++--
include/SDL3/SDL_power.h | 4 +-
include/SDL3/SDL_process.h | 20 +-
include/SDL3/SDL_properties.h | 50 +--
include/SDL3/SDL_rect.h | 44 +--
include/SDL3/SDL_render.h | 188 +++++------
include/SDL3/SDL_revision.h | 2 +-
include/SDL3/SDL_scancode.h | 2 +-
include/SDL3/SDL_sensor.h | 34 +-
include/SDL3/SDL_stdinc.h | 314 +++++++++---------
include/SDL3/SDL_storage.h | 38 +--
include/SDL3/SDL_surface.h | 124 ++++----
include/SDL3/SDL_system.h | 74 ++---
include/SDL3/SDL_test_compare.h | 2 +-
include/SDL3/SDL_test_font.h | 12 +-
include/SDL3/SDL_thread.h | 38 +--
include/SDL3/SDL_time.h | 24 +-
include/SDL3/SDL_timer.h | 26 +-
include/SDL3/SDL_touch.h | 10 +-
include/SDL3/SDL_version.h | 22 +-
include/SDL3/SDL_video.h | 258 +++++++--------
include/SDL3/SDL_vulkan.h | 14 +-
59 files changed, 1828 insertions(+), 1825 deletions(-)
diff --git a/build-scripts/fnsince.pl b/build-scripts/fnsince.pl
index 1c86f4b068611..20cbb30bb205d 100755
--- a/build-scripts/fnsince.pl
+++ b/build-scripts/fnsince.pl
@@ -65,14 +65,13 @@
$current_release = $releases[-1];
my @current_release_segments = split /\./, $current_release;
-
- # if we're still in the 3.1.x prereleases, bump x by 1, otherwise, bump minor version by 2.
+ # if we're still in the 3.1.x prereleases, call the "next release" 3.2.0 even if we do more prereleases.
if (($current_release_segments[0] == '3') && ($current_release_segments[1] == '1')) {
- @current_release_segments[2] = '' . (int($current_release_segments[2]) + 1);
+ $next_release = '3.2.0';
} else {
@current_release_segments[1] = '' . (int($current_release_segments[1]) + 2);
+ $next_release = join('.', @current_release_segments);
}
- $next_release = join('.', @current_release_segments);
}
#print("\n\nSORTED\n");
@@ -91,7 +90,11 @@
my $tag = $fulltags{$release};
my $blobname = "$tag:src/dynapi/SDL_dynapi_overrides.h";
- $release = '3.0.0' if $release =~ /\A3\.1\.[0123]/; # hack to make everything up to ABI-lock look like 3.0.0.
+ if ($release =~ /\A3\.[01]\.\d+/) { # make everything up to the first SDL3 prerelease look like 3.1.3 (ABI lock version).
+ $release = '3.1.3';
+ }
+
+ else { $release = '3.2.0'; } # !!! FIXME: REMOVE ME WHEN 3.2.0 SHIPS!
open(PIPEFH, '-|', "git show '$blobname'") or die "Failed to read git blob '$blobname': $!\n";
while (<PIPEFH>) {
diff --git a/include/SDL3/SDL_assert.h b/include/SDL3/SDL_assert.h
index ada270010a54f..78a28674cf10d 100644
--- a/include/SDL3/SDL_assert.h
+++ b/include/SDL3/SDL_assert.h
@@ -84,7 +84,7 @@ extern "C" {
* - 3: Paranoid settings: All SDL assertion macros enabled, including
* SDL_assert_paranoid.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_ASSERT_LEVEL SomeNumberBasedOnVariousFactors
@@ -118,7 +118,7 @@ extern "C" {
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner
@@ -198,7 +198,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.0.0.
+ * \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_AssertState
{
@@ -216,7 +216,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.0.0.
+ * \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_AssertData
{
@@ -240,7 +240,7 @@ typedef struct SDL_AssertData
* \param line line number.
* \returns assert state.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *data,
const char *func,
@@ -305,7 +305,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \param condition boolean value to test.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_assert(condition) if (assertion_enabled && (condition)) { trigger_assertion; }
@@ -336,7 +336,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \param condition boolean value to test.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_assert_release(condition) SDL_disabled_assert(condition)
@@ -363,7 +363,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \param condition boolean value to test.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
@@ -405,7 +405,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
*
* \param condition boolean value to test.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_assert_always(condition) SDL_enabled_assert(condition)
@@ -418,7 +418,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* \param userdata what was passed as `userdata` to SDL_SetAssertionHandler().
* \returns an SDL_AssertState value indicating how to handle the failure.
*
- * \since This datatype is available since SDL 3.0.0.
+ * \since This datatype is available since SDL 3.1.3.
*/
typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
const SDL_AssertData *data, void *userdata);
@@ -440,7 +440,7 @@ typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
* fails or NULL for the default handler.
* \param userdata a pointer that is passed to `handler`.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAssertionHandler
*/
@@ -459,7 +459,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetAssertionHandler(
* \returns the default SDL_AssertionHandler that is called when an assert
* triggers.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAssertionHandler
*/
@@ -482,7 +482,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(
* was passed to SDL_SetAssertionHandler().
* \returns the SDL_AssertionHandler that is called when an assert triggers.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetAssertionHandler
*/
@@ -510,7 +510,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetAssertionHandler(void **
* \returns a list of all failed assertions or NULL if the list is empty. This
* memory should not be modified or freed by the application.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_ResetAssertionReport
*/
@@ -524,7 +524,7 @@ extern SDL_DECLSPEC const SDL_AssertData * SDLCALL SDL_GetAssertionReport(void);
* no items. In addition, any previously-triggered assertions will be reset to
* a trigger_count of zero, and their always_ignore state will be false.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAssertionReport
*/
diff --git a/include/SDL3/SDL_atomic.h b/include/SDL3/SDL_atomic.h
index e36436f92030c..45e7b678836a1 100644
--- a/include/SDL3/SDL_atomic.h
+++ b/include/SDL3/SDL_atomic.h
@@ -90,7 +90,7 @@ typedef int SDL_SpinLock;
* \param lock a pointer to a lock variable.
* \returns true if the lock succeeded, false if the lock is already held.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_LockSpinlock
* \sa SDL_UnlockSpinlock
@@ -105,7 +105,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockSpinlock(SDL_SpinLock *lock);
*
* \param lock a pointer to a lock variable.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_TryLockSpinlock
* \sa SDL_UnlockSpinlock
@@ -122,7 +122,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockSpinlock(SDL_SpinLock *lock);
*
* \param lock a pointer to a lock variable.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_LockSpinlock
* \sa SDL_TryLockSpinlock
@@ -146,7 +146,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.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_CompilerBarrier() DoCompilerSpecificReadWriteBarrier()
#elif defined(_MSC_VER) && (_MSC_VER > 1200) && !defined(__clang__)
@@ -189,7 +189,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierReleaseFunction(void);
@@ -202,7 +202,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_MemoryBarrierReleaseFunction
*/
@@ -275,7 +275,7 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
*
* \threadsafety This macro is safe to use from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_CPUPauseInstruction() DoACPUPauseInACompilerAndArchitectureSpecificWay
#elif (defined(__GNUC__) || defined(__clang__)) && (defined(__i386__) || defined(__x86_64__))
@@ -318,7 +318,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.0.0.
+ * \since This struct is available since SDL 3.1.3.
*
* \sa SDL_CompareAndSwapAtomicInt
* \sa SDL_GetAtomicInt
@@ -340,7 +340,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAtomicInt
* \sa SDL_SetAtomicInt
@@ -361,7 +361,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAtomicInt
*/
@@ -378,7 +378,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetAtomicInt
*/
@@ -398,7 +398,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_AtomicDecRef
* \sa SDL_AtomicIncRef
@@ -415,7 +415,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
* \param a a pointer to an SDL_AtomicInt to increment.
* \returns the previous value of the atomic variable.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*
* \sa SDL_AtomicDecRef
*/
@@ -433,7 +433,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
* \returns true if the variable reached zero after decrementing, false
* otherwise.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*
* \sa SDL_AtomicIncRef
*/
@@ -460,7 +460,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.0.0.
+ * \since This struct is available since SDL 3.1.3.
*
* \sa SDL_CompareAndSwapAtomicU32
* \sa SDL_GetAtomicU32
@@ -482,7 +482,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAtomicU32
* \sa SDL_SetAtomicU32
@@ -503,7 +503,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAtomicU32
*/
@@ -520,7 +520,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetAtomicU32
*/
@@ -539,7 +539,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_CompareAndSwapAtomicInt
* \sa SDL_GetAtomicPointer
@@ -559,7 +559,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_CompareAndSwapAtomicPointer
* \sa SDL_GetAtomicPointer
@@ -577,7 +577,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_CompareAndSwapAtomicPointer
* \sa SDL_SetAtomicPointer
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index 09be295fa0d31..882983e141595 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -113,7 +113,7 @@ extern "C" {
/**
* Audio format.
*
- * \since This enum is available since SDL 3.0.0.
+ * \since This enum is available since SDL 3.1.3.
*
* \sa SDL_AUDIO_BITSIZE
* \sa SDL_AUDIO_BYTESIZE
@@ -167,7 +167,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_BITSIZE(x) ((x) & SDL_AUDIO_MASK_BITSIZE)
@@ -181,7 +181,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_BYTESIZE(x) (SDL_AUDIO_BITSIZE(x) / 8)
@@ -195,7 +195,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_ISFLOAT(x) ((x) & SDL_AUDIO_MASK_FLOAT)
@@ -209,7 +209,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_ISBIGENDIAN(x) ((x) & SDL_AUDIO_MASK_BIG_ENDIAN)
@@ -223,7 +223,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_ISLITTLEENDIAN(x) (!SDL_AUDIO_ISBIGENDIAN(x))
@@ -237,7 +237,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_ISSIGNED(x) ((x) & SDL_AUDIO_MASK_SIGNED)
@@ -251,7 +251,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_ISINT(x) (!SDL_AUDIO_ISFLOAT(x))
@@ -265,7 +265,7 @@ typedef enum SDL_AudioFormat
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_ISUNSIGNED(x) (!SDL_AUDIO_ISSIGNED(x))
@@ -275,7 +275,7 @@ typedef enum SDL_AudioFormat
*
* Zero is used to signify an invalid/null device.
*
- * \since This datatype is available since SDL 3.0.0.
+ * \since This datatype is available since SDL 3.1.3.
*/
typedef Uint32 SDL_AudioDeviceID;
@@ -286,7 +286,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.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK ((SDL_AudioDeviceID) 0xFFFFFFFFu)
@@ -297,14 +297,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.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_DEVICE_DEFAULT_RECORDING ((SDL_AudioDeviceID) 0xFFFFFFFEu)
/**
* Format specifier for audio data.
*
- * \since This struct is available since SDL 3.0.0.
+ * \since This struct is available since SDL 3.1.3.
*
* \sa SDL_AudioFormat
*/
@@ -326,7 +326,7 @@ typedef struct SDL_AudioSpec
*
* \threadsafety It is safe to call this macro from any thread.
*
- * \since This macro is available since SDL 3.0.0.
+ * \since This macro is available since SDL 3.1.3.
*/
#define SDL_AUDIO_FRAMESIZE(x) (SDL_AUDIO_BYTESIZE((x).format) * (x).channels)
@@ -350,7 +350,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.0.0.
+ * \since This struct is available since SDL 3.1.3.
*
* \sa SDL_CreateAudioStream
*/
@@ -384,7 +384,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAudioDriver
*/
@@ -408,7 +408,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetNumAudioDrivers
*/
@@ -427,7 +427,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentAudioDriver(void);
@@ -453,7 +453,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_OpenAudioDevice
* \sa SDL_GetAudioRecordingDevices
@@ -482,7 +482,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_OpenAudioDevice
* \sa SDL_GetAudioPlaybackDevices
@@ -498,7 +498,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAudioPlaybackDevices
* \sa SDL_GetAudioRecordingDevices
@@ -537,7 +537,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.0.0.
+ * \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devid, SDL_AudioSpec *spec, int *sample_frames);
@@ -558,7 +558,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devi
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetAudioStreamInputChannelMap
*/
@@ -633,7 +633,7 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioDeviceChannelMap(SDL_AudioDeviceID
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_CloseAudioDevice
* \sa SDL_GetAudioDeviceFormat
@@ -664,7 +664,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(SDL_AudioDevic
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_ResumeAudioDevice
* \sa SDL_AudioDevicePaused
@@ -692,7 +692,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev);
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_AudioDevicePaused
* \sa SDL_PauseAudioDevice
@@ -714,7 +714,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeAudioDevice(SDL_AudioDeviceID dev);
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_PauseAudioDevice
* \sa SDL_ResumeAudioDevice
@@ -738,7 +738,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AudioDevicePaused(SDL_AudioDeviceID dev);
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetAudioDeviceGain
*/
@@ -773,7 +773,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioDeviceGain(SDL_AudioDeviceID devid
* \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAudioDeviceGain
*/
@@ -794,7 +794,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioDeviceGain(SDL_AudioDeviceID devid,
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_OpenAudioDevice
*/
@@ -829,7 +829,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID devid);
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_BindAudioStreams
* \sa SDL_UnbindAudioStream
@@ -850,7 +850,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devid, S
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_BindAudioStreams
* \sa SDL_UnbindAudioStream
@@ -872,7 +872,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BindAudioStream(SDL_AudioDeviceID devid, SD
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_BindAudioStreams
*/
@@ -888,7 +888,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnbindAudioStreams(SDL_AudioStream **stream
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_BindAudioStream
*/
@@ -907,7 +907,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnbindAudioStream(SDL_AudioStream *stream);
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_BindAudioStream
* \sa SDL_BindAudioStreams
@@ -924,7 +924,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_GetAudioStreamDevice(SDL_Audio
*
* \threadsafety It is safe to call this function from any thread.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_PutAudioStreamData
* \sa SDL_GetAudioStreamData
@@ -943,7 +943,7 @@ extern SDL_DECLSPEC SDL_AudioStream * SDLCALL SDL_CreateAudioStream(const SDL_Au
* \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_AudioStream *stream);
@@ -959,7 +959,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_Au
* \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetAudioStreamFormat
*/
@@ -989,7 +989,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioStreamFormat(SDL_AudioStream *strea
* \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running.
*
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetAudioStreamFormat
* \sa SDL_SetAudioStreamFrequencyRatio
@@ -1006,7 +1006,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamFormat(SDL_AudioStream *strea
* \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mut
(Patch may be truncated, please check the link at the top of this post.)