From 290bd8b910a6c0571639387f6f28e6e4dbdbc22d Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Tue, 22 Nov 2022 22:40:14 +0000
Subject: [PATCH] Sync SDL wiki -> header
---
include/SDL.h | 10 +-
include/SDL_assert.h | 10 +-
include/SDL_atomic.h | 22 ++--
include/SDL_audio.h | 76 +++++++-------
include/SDL_blendmode.h | 2 +-
include/SDL_clipboard.h | 12 +--
include/SDL_cpuinfo.h | 46 ++++-----
include/SDL_error.h | 8 +-
include/SDL_events.h | 34 +++----
include/SDL_filesystem.h | 4 +-
include/SDL_gamecontroller.h | 114 ++++++++++-----------
include/SDL_gesture.h | 8 +-
include/SDL_guid.h | 4 +-
include/SDL_haptic.h | 60 +++++------
include/SDL_hidapi.h | 38 +++----
include/SDL_hints.h | 18 ++--
include/SDL_joystick.h | 116 ++++++++++-----------
include/SDL_keyboard.h | 38 +++----
include/SDL_loadso.h | 6 +-
include/SDL_locale.h | 2 +-
include/SDL_log.h | 30 +++---
include/SDL_main.h | 10 +-
include/SDL_messagebox.h | 4 +-
include/SDL_metal.h | 8 +-
include/SDL_misc.h | 2 +-
include/SDL_mouse.h | 34 +++----
include/SDL_mutex.h | 36 +++----
include/SDL_pixels.h | 28 +++---
include/SDL_platform.h | 2 +-
include/SDL_power.h | 2 +-
include/SDL_rect.h | 20 ++--
include/SDL_render.h | 162 ++++++++++++++---------------
include/SDL_rwops.h | 56 +++++------
include/SDL_sensor.h | 32 +++---
include/SDL_shape.h | 8 +-
include/SDL_stdinc.h | 12 +--
include/SDL_surface.h | 76 +++++++-------
include/SDL_system.h | 50 ++++-----
include/SDL_syswm.h | 2 +-
include/SDL_thread.h | 24 ++---
include/SDL_timer.h | 14 +--
include/SDL_touch.h | 12 +--
include/SDL_version.h | 6 +-
include/SDL_video.h | 190 +++++++++++++++++------------------
include/SDL_vulkan.h | 12 +--
45 files changed, 730 insertions(+), 730 deletions(-)
diff --git a/include/SDL.h b/include/SDL.h
index 90e173822f20..946ff158f962 100644
--- a/include/SDL.h
+++ b/include/SDL.h
@@ -134,7 +134,7 @@ extern "C" {
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_InitSubSystem
* \sa SDL_Quit
@@ -152,7 +152,7 @@ extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Init
* \sa SDL_Quit
@@ -175,7 +175,7 @@ extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
*
* \param flags any of the flags used by SDL_Init(); see SDL_Init for details.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_InitSubSystem
* \sa SDL_Quit
@@ -191,7 +191,7 @@ extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
*
* The return value does not include SDL_INIT_NOPARACHUTE.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Init
* \sa SDL_InitSubSystem
@@ -215,7 +215,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
* application is shutdown, but it is not wise to do this from a library or
* other dynamically loaded code.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Init
* \sa SDL_QuitSubSystem
diff --git a/include/SDL_assert.h b/include/SDL_assert.h
index df399b5dd622..15709e69212d 100644
--- a/include/SDL_assert.h
+++ b/include/SDL_assert.h
@@ -219,7 +219,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 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAssertionHandler
*/
@@ -238,7 +238,7 @@ extern DECLSPEC void SDLCALL SDL_SetAssertionHandler(
* \returns the default SDL_AssertionHandler that is called when an assert
* triggers.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAssertionHandler
*/
@@ -261,7 +261,7 @@ extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(void
* was passed to SDL_SetAssertionHandler()
* \returns the SDL_AssertionHandler that is called when an assert triggers.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetAssertionHandler
*/
@@ -289,7 +289,7 @@ extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetAssertionHandler(void **puse
* \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 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_ResetAssertionReport
*/
@@ -303,7 +303,7 @@ extern 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 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAssertionReport
*/
diff --git a/include/SDL_atomic.h b/include/SDL_atomic.h
index 266b53e12ea5..09c8a7c67c76 100644
--- a/include/SDL_atomic.h
+++ b/include/SDL_atomic.h
@@ -98,7 +98,7 @@ typedef int SDL_SpinLock;
* \returns SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already
* held.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicLock
* \sa SDL_AtomicUnlock
@@ -113,7 +113,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTryLock(SDL_SpinLock *lock);
*
* \param lock a pointer to a lock variable
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicTryLock
* \sa SDL_AtomicUnlock
@@ -130,7 +130,7 @@ extern DECLSPEC void SDLCALL SDL_AtomicLock(SDL_SpinLock *lock);
*
* \param lock a pointer to a lock variable
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicLock
* \sa SDL_AtomicTryLock
@@ -178,7 +178,7 @@ extern __inline void SDL_CompilerBarrier(void);
* For more information on these semantics, take a look at the blog post:
* http://preshing.com/20120913/acquire-and-release-semantics
*
- * \since This function is available since SDL 2.0.6.
+ * \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC void SDLCALL SDL_MemoryBarrierReleaseFunction(void);
extern DECLSPEC void SDLCALL SDL_MemoryBarrierAcquireFunction(void);
@@ -269,7 +269,7 @@ typedef struct { int value; } SDL_atomic_t;
* \param newval the new value
* \returns SDL_TRUE if the atomic variable was set, SDL_FALSE otherwise.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicCASPtr
* \sa SDL_AtomicGet
@@ -289,7 +289,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCAS(SDL_atomic_t *a, int oldval, int
* \param v the desired value
* \returns the previous value of the atomic variable.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicGet
*/
@@ -304,7 +304,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicSet(SDL_atomic_t *a, int v);
* \param a a pointer to an SDL_atomic_t variable
* \returns the current value of an atomic variable.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicSet
*/
@@ -322,7 +322,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicGet(SDL_atomic_t *a);
* \param v the desired value to add
* \returns the previous value of the atomic variable.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicDecRef
* \sa SDL_AtomicIncRef
@@ -357,7 +357,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_atomic_t *a, int v);
* \param newval the new pointer value
* \returns SDL_TRUE if the pointer was set, SDL_FALSE otherwise.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicCAS
* \sa SDL_AtomicGetPtr
@@ -375,7 +375,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCASPtr(void **a, void *oldval, void *
* \param v the desired pointer value
* \returns the previous value of the pointer.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicCASPtr
* \sa SDL_AtomicGetPtr
@@ -391,7 +391,7 @@ extern DECLSPEC void* SDLCALL SDL_AtomicSetPtr(void **a, void* v);
* \param a a pointer to a pointer
* \returns the current value of a pointer.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AtomicCASPtr
* \sa SDL_AtomicSetPtr
diff --git a/include/SDL_audio.h b/include/SDL_audio.h
index 3ad8e6c9d899..a5d4ef8bf739 100644
--- a/include/SDL_audio.h
+++ b/include/SDL_audio.h
@@ -269,7 +269,7 @@ typedef struct SDL_AudioCVT
*
* \returns the number of built-in audio drivers.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAudioDriver
*/
@@ -291,7 +291,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
* \returns the name of the audio driver at the requested index, or NULL if an
* invalid index was specified.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetNumAudioDrivers
*/
@@ -318,7 +318,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AudioQuit
*/
@@ -332,7 +332,7 @@ extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
* specific need to specify the audio driver you want to use. You should
* normally use SDL_Quit() or SDL_QuitSubSystem().
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AudioInit
*/
@@ -351,7 +351,7 @@ extern DECLSPEC void SDLCALL SDL_AudioQuit(void);
* \returns the name of the current audio driver or NULL if no driver has been
* initialized.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AudioInit
*/
@@ -397,7 +397,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);
* audio device or failure to set up the audio thread; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_CloseAudio
* \sa SDL_LockAudio
@@ -457,7 +457,7 @@ typedef Uint32 SDL_AudioDeviceID;
* -1 if an explicit list of devices can't be determined. A return
* value of -1 does not necessarily mean an error condition.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAudioDeviceName
* \sa SDL_OpenAudioDevice
@@ -484,7 +484,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDevices(int iscapture);
* \returns the name of the audio device at the requested index, or NULL on
* error.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetNumAudioDevices
* \sa SDL_GetDefaultAudioInfo
@@ -510,7 +510,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName(int index,
* \param spec The SDL_AudioSpec to be initialized by this function.
* \returns 0 on success, nonzero on error
*
- * \since This function is available since SDL 2.0.16.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetNumAudioDevices
* \sa SDL_GetDefaultAudioInfo
@@ -544,7 +544,7 @@ extern DECLSPEC int SDLCALL SDL_GetAudioDeviceSpec(int index,
* query the default output device.
* \returns 0 on success, nonzero on error
*
- * \since This function is available since SDL 2.24.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAudioDeviceName
* \sa SDL_GetAudioDeviceSpec
@@ -657,7 +657,7 @@ extern DECLSPEC int SDLCALL SDL_GetDefaultAudioInfo(char **name,
* For compatibility with SDL 1.2, this will never return 1, since
* SDL reserves that ID for the legacy SDL_OpenAudio() function.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_CloseAudioDevice
* \sa SDL_GetAudioDeviceName
@@ -702,7 +702,7 @@ typedef enum
*
* \returns the SDL_AudioStatus of the audio device opened by SDL_OpenAudio().
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAudioDeviceStatus
*/
@@ -715,7 +715,7 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioStatus(void);
* SDL_OpenAudioDevice()
* \returns the SDL_AudioStatus of the specified audio device.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_PauseAudioDevice
*/
@@ -747,7 +747,7 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioDeviceStatus(SDL_AudioDevice
*
* \param pause_on non-zero to pause, 0 to unpause
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetAudioStatus
* \sa SDL_PauseAudioDevice
@@ -778,7 +778,7 @@ extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
* \param dev a device opened by SDL_OpenAudioDevice()
* \param pause_on non-zero to pause, 0 to unpause
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_LockAudioDevice
*/
@@ -862,7 +862,7 @@ extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev,
* When the application is done with the data returned in
* `audio_buf`, it should call SDL_FreeWAV() to dispose of it.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_FreeWAV
* \sa SDL_LoadWAV
@@ -890,7 +890,7 @@ extern DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW(SDL_RWops * src,
* \param audio_buf a pointer to the buffer created by SDL_LoadWAV() or
* SDL_LoadWAV_RW()
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_LoadWAV
* \sa SDL_LoadWAV_RW
@@ -925,7 +925,7 @@ extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 * audio_buf);
* or a negative error code on failure; call SDL_GetError() for more
* information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_ConvertAudio
*/
@@ -971,7 +971,7 @@ extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT * cvt,
* \returns 0 if the conversion was completed successfully or a negative error
* code on failure; call SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_BuildAudioCVT
*/
@@ -999,7 +999,7 @@ typedef struct _SDL_AudioStream SDL_AudioStream;
* \param dst_rate The sampling rate of the desired audio output
* \returns 0 on success, or -1 on error.
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_AudioStreamPut
* \sa SDL_AudioStreamGet
@@ -1023,7 +1023,7 @@ extern DECLSPEC SDL_AudioStream * SDLCALL SDL_NewAudioStream(const SDL_AudioForm
* \param len The number of bytes to write to the stream
* \returns 0 on success, or -1 on error.
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_NewAudioStream
* \sa SDL_AudioStreamGet
@@ -1042,7 +1042,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamPut(SDL_AudioStream *stream, const vo
* \param len The maximum number of bytes to fill
* \returns the number of bytes read from the stream, or -1 on error
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_NewAudioStream
* \sa SDL_AudioStreamPut
@@ -1060,7 +1060,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamGet(SDL_AudioStream *stream, void *bu
* resample correctly, so this number might be lower than what you expect, or
* even be zero. Add more data or flush the stream if you need the data now.
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_NewAudioStream
* \sa SDL_AudioStreamPut
@@ -1079,7 +1079,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamAvailable(SDL_AudioStream *stream);
* audio gaps in the output. Generally this is intended to signal the end of
* input, so the complete output becomes available.
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_NewAudioStream
* \sa SDL_AudioStreamPut
@@ -1093,7 +1093,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamFlush(SDL_AudioStream *stream);
/**
* Clear any pending data in the stream without converting it
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_NewAudioStream
* \sa SDL_AudioStreamPut
@@ -1107,7 +1107,7 @@ extern DECLSPEC void SDLCALL SDL_AudioStreamClear(SDL_AudioStream *stream);
/**
* Free an audio stream
*
- * \since This function is available since SDL 2.0.7.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_NewAudioStream
* \sa SDL_AudioStreamPut
@@ -1138,7 +1138,7 @@ extern DECLSPEC void SDLCALL SDL_FreeAudioStream(SDL_AudioStream *stream);
* \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
* for full audio volume
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_MixAudioFormat
*/
@@ -1173,7 +1173,7 @@ extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 * dst, const Uint8 * src,
* \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
* for full audio volume
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst,
const Uint8 * src,
@@ -1221,7 +1221,7 @@ extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst,
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.4.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_ClearQueuedAudio
* \sa SDL_GetQueuedAudioSize
@@ -1269,7 +1269,7 @@ extern DECLSPEC int SDLCALL SDL_QueueAudio(SDL_AudioDeviceID dev, const void *da
* \returns the number of bytes dequeued, which could be less than requested;
* call SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.5.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_ClearQueuedAudio
* \sa SDL_GetQueuedAudioSize
@@ -1302,7 +1302,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_DequeueAudio(SDL_AudioDeviceID dev, void *dat
* \param dev the device ID of which we will query queued audio size
* \returns the number of bytes (not samples!) of queued audio.
*
- * \since This function is available since SDL 2.0.4.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_ClearQueuedAudio
* \sa SDL_QueueAudio
@@ -1336,7 +1336,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetQueuedAudioSize(SDL_AudioDeviceID dev);
*
* \param dev the device ID of which to clear the audio queue
*
- * \since This function is available since SDL 2.0.4.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetQueuedAudioSize
* \sa SDL_QueueAudio
@@ -1367,7 +1367,7 @@ extern DECLSPEC void SDLCALL SDL_ClearQueuedAudio(SDL_AudioDeviceID dev);
*
* ...and is only useful if you used the legacy SDL_OpenAudio() function.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_LockAudioDevice
* \sa SDL_UnlockAudio
@@ -1408,7 +1408,7 @@ extern DECLSPEC void SDLCALL SDL_LockAudio(void);
*
* \param dev the ID of the device to be locked
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_UnlockAudioDevice
*/
@@ -1426,7 +1426,7 @@ extern DECLSPEC void SDLCALL SDL_LockAudioDevice(SDL_AudioDeviceID dev);
*
* ...and is only useful if you used the legacy SDL_OpenAudio() function.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_LockAudio
* \sa SDL_UnlockAudioDevice
@@ -1441,7 +1441,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
*
* \param dev the ID of the device to be unlocked
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_LockAudioDevice
*/
@@ -1459,7 +1459,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev);
*
* ...and is only useful if you used the legacy SDL_OpenAudio() function.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_OpenAudio
*/
@@ -1483,7 +1483,7 @@ extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
*
* \param dev an audio device previously opened with SDL_OpenAudioDevice()
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_OpenAudioDevice
*/
diff --git a/include/SDL_blendmode.h b/include/SDL_blendmode.h
index 08c9f9dd6534..0df3d1456758 100644
--- a/include/SDL_blendmode.h
+++ b/include/SDL_blendmode.h
@@ -173,7 +173,7 @@ typedef enum
* \returns an SDL_BlendMode that represents the chosen factors and
* operations.
*
- * \since This function is available since SDL 2.0.6.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetRenderDrawBlendMode
* \sa SDL_GetRenderDrawBlendMode
diff --git a/include/SDL_clipboard.h b/include/SDL_clipboard.h
index 783c7c251a91..29be3b89113b 100644
--- a/include/SDL_clipboard.h
+++ b/include/SDL_clipboard.h
@@ -45,7 +45,7 @@ extern "C" {
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetClipboardText
* \sa SDL_HasClipboardText
@@ -63,7 +63,7 @@ extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text);
* on the returned pointer when done with it (even if there was an
* error).
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_HasClipboardText
* \sa SDL_SetClipboardText
@@ -75,7 +75,7 @@ extern DECLSPEC char * SDLCALL SDL_GetClipboardText(void);
*
* \returns SDL_TRUE if the clipboard has text, or SDL_FALSE if it does not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetClipboardText
* \sa SDL_SetClipboardText
@@ -89,7 +89,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void);
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL 2.26.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetPrimarySelectionText
* \sa SDL_HasPrimarySelectionText
@@ -108,7 +108,7 @@ extern DECLSPEC int SDLCALL SDL_SetPrimarySelectionText(const char *text);
* call SDL_free() on the returned pointer when done with it (even if
* there was an error).
*
- * \since This function is available since SDL 2.26.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_HasPrimarySelectionText
* \sa SDL_SetPrimarySelectionText
@@ -122,7 +122,7 @@ extern DECLSPEC char * SDLCALL SDL_GetPrimarySelectionText(void);
* \returns SDL_TRUE if the primary selection has text, or SDL_FALSE if it
* does not.
*
- * \since This function is available since SDL 2.26.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetPrimarySelectionText
* \sa SDL_SetPrimarySelectionText
diff --git a/include/SDL_cpuinfo.h b/include/SDL_cpuinfo.h
index 1d224420b12f..a810d5e2a52d 100644
--- a/include/SDL_cpuinfo.h
+++ b/include/SDL_cpuinfo.h
@@ -144,7 +144,7 @@ extern "C" {
* technologies such as hyperthreading, the number of logical cores
* may be more than the number of physical cores.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC int SDLCALL SDL_GetCPUCount(void);
@@ -156,7 +156,7 @@ extern DECLSPEC int SDLCALL SDL_GetCPUCount(void);
*
* \returns the L1 cache line size of the CPU, in bytes.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void);
@@ -167,7 +167,7 @@ extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void);
*
* \returns SDL_TRUE if the CPU has the RDTSC instruction or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -190,7 +190,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void);
*
* \returns SDL_TRUE if the CPU has AltiVec features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAVX
@@ -212,7 +212,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void);
*
* \returns SDL_TRUE if the CPU has MMX features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -234,7 +234,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
*
* \returns SDL_TRUE if the CPU has 3DNow! features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_HasAltiVec
* \sa SDL_HasAVX
@@ -256,7 +256,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void);
*
* \returns SDL_TRUE if the CPU has SSE features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -278,7 +278,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
*
* \returns SDL_TRUE if the CPU has SSE2 features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -300,7 +300,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
*
* \returns SDL_TRUE if the CPU has SSE3 features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -322,7 +322,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE3(void);
*
* \returns SDL_TRUE if the CPU has SSE4.1 features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -344,7 +344,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE41(void);
*
* \returns SDL_TRUE if the CPU has SSE4.2 features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.0.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -366,7 +366,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE42(void);
*
* \returns SDL_TRUE if the CPU has AVX features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.2.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -388,7 +388,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX(void);
*
* \returns SDL_TRUE if the CPU has AVX2 features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.4.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_Has3DNow
* \sa SDL_HasAltiVec
@@ -410,7 +410,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX2(void);
*
* \returns SDL_TRUE if the CPU has AVX-512F features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.9.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_HasAVX
*/
@@ -425,7 +425,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX512F(void);
*
* \returns SDL_TRUE if the CPU has ARM SIMD features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.12.
+ * \since This function is available since SDL 3.0.0.
*
* \sa SDL_HasNEON
*/
@@ -438,7 +438,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasARMSIMD(void);
*
* \returns SDL_TRUE if the CPU has ARM NEON features or SDL_FALSE if not.
*
- * \since This function is available since SDL 2.0.6.
+ * \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_HasNEON(void);
@@ -451,7 +451,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasNEON(void);
* \returns SDL_TRUE if the CPU has LOONGARCH LSX features or SDL_F
(Patch may be truncated, please check the link at the top of this post.)