diff --git a/build-scripts/fnsince.pl b/build-scripts/fnsince.pl index 1c86f4b06..20cbb30bb 100755 --- a/build-scripts/fnsince.pl +++ b/build-scripts/fnsince.pl @@ -65,14 +65,13 @@ if (scalar(@releases) > 0) { $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 @@ foreach my $release (@releases) { 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 () { diff --git a/include/SDL3/SDL_assert.h b/include/SDL3/SDL_assert.h index ada270010..78a28674c 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 e36436f92..45e7b6788 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 09be295fa..882983e14 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 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_SetAudioStreamFrequencyRatio */ @@ -1033,7 +1033,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre * \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_GetAudioStreamFrequencyRatio * \sa SDL_SetAudioStreamFormat @@ -1055,7 +1055,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamFrequencyRatio(SDL_AudioStrea * \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_SetAudioStreamGain */ @@ -1080,7 +1080,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamGain(SDL_AudioStream *stream * \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_GetAudioStreamGain */ @@ -1104,7 +1104,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamGain(SDL_AudioStream *stream, * \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_SetAudioStreamInputChannelMap */ @@ -1128,7 +1128,7 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioStreamInputChannelMap(SDL_AudioStr * \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_SetAudioStreamInputChannelMap */ @@ -1179,7 +1179,7 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioStreamOutputChannelMap(SDL_AudioSt * stream's format to have a different number of channels from a * a different thread at the same time, though! * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetAudioStreamInputChannelMap */ @@ -1226,7 +1226,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamInputChannelMap(SDL_AudioStre * stream's format to have a different number of channels from a * a different thread at the same time, though! * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetAudioStreamInputChannelMap */ @@ -1253,7 +1253,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamOutputChannelMap(SDL_AudioStr * stream has a callback set, the caller might need to manage * extra locking. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ClearAudioStream * \sa SDL_FlushAudioStream @@ -1284,7 +1284,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *stream, * stream has a callback set, the caller might need to manage * extra locking. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ClearAudioStream * \sa SDL_GetAudioStreamAvailable @@ -1311,7 +1311,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamData(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_GetAudioStreamData * \sa SDL_PutAudioStreamData @@ -1350,7 +1350,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *str * * \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_ClearAudioStream @@ -1372,7 +1372,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(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_PutAudioStreamData */ @@ -1390,7 +1390,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushAudioStream(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_GetAudioStreamAvailable * \sa SDL_GetAudioStreamData @@ -1417,7 +1417,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearAudioStream(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_ResumeAudioStreamDevice */ @@ -1437,7 +1437,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioStreamDevice(SDL_AudioStream *str * * \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_PauseAudioStreamDevice */ @@ -1465,7 +1465,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeAudioStreamDevice(SDL_AudioStream *st * * \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_UnlockAudioStream */ @@ -1484,7 +1484,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream); * \threadsafety You should only call this from the same thread that * previously called SDL_LockAudioStream. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockAudioStream */ @@ -1525,7 +1525,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UnlockAudioStream(SDL_AudioStream *stream); * is called, so your callback does not need to manage the lock * explicitly. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetAudioStreamGetCallback * \sa SDL_SetAudioStreamPutCallback @@ -1572,7 +1572,7 @@ typedef void (SDLCALL *SDL_AudioStreamCallback)(void *userdata, 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_SetAudioStreamPutCallback */ @@ -1621,7 +1621,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamGetCallback(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_SetAudioStreamGetCallback */ @@ -1643,7 +1643,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamPutCallback(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_CreateAudioStream */ @@ -1705,7 +1705,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAudioStream(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_GetAudioStreamDevice * \sa SDL_ResumeAudioStreamDevice @@ -1743,7 +1743,7 @@ extern SDL_DECLSPEC SDL_AudioStream * SDLCALL SDL_OpenAudioDeviceStream(SDL_Audi * application is responsible for locking resources the callback * touches that need to be protected. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetAudioPostmixCallback */ @@ -1799,7 +1799,7 @@ typedef void (SDLCALL *SDL_AudioPostmixCallback)(void *userdata, const 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. */ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID devid, SDL_AudioPostmixCallback callback, void *userdata); @@ -1877,7 +1877,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID d * * \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_free * \sa SDL_LoadWAV @@ -1913,7 +1913,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LoadWAV_IO(SDL_IOStream *src, bool closeio, * * \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_free * \sa SDL_LoadWAV_IO @@ -1952,7 +1952,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LoadWAV(const char *path, SDL_AudioSpec *sp * * \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_MixAudio(Uint8 *dst, const Uint8 *src, SDL_AudioFormat format, Uint32 len, float volume); @@ -1982,7 +1982,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, SDL_ * * \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_ConvertAudioSamples(const SDL_AudioSpec *src_spec, const Uint8 *src_data, int src_len, const SDL_AudioSpec *dst_spec, Uint8 **dst_data, int *dst_len); @@ -1995,7 +1995,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertAudioSamples(const SDL_AudioSpec *sr * * \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_GetAudioFormatName(SDL_AudioFormat format); @@ -2011,7 +2011,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioFormatName(SDL_AudioFormat * * \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 int SDLCALL SDL_GetSilenceValueForFormat(SDL_AudioFormat format); diff --git a/include/SDL3/SDL_bits.h b/include/SDL3/SDL_bits.h index fe2dd81db..cabf92d17 100644 --- a/include/SDL3/SDL_bits.h +++ b/include/SDL3/SDL_bits.h @@ -65,7 +65,7 @@ extern __inline int _SDL_bsr_watcom(Uint32); * * \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. */ SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x) { @@ -132,7 +132,7 @@ SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x) * * \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. */ SDL_FORCE_INLINE bool SDL_HasExactlyOneBitSet32(Uint32 x) { diff --git a/include/SDL3/SDL_blendmode.h b/include/SDL3/SDL_blendmode.h index 76aa19732..be89a48b9 100644 --- a/include/SDL3/SDL_blendmode.h +++ b/include/SDL3/SDL_blendmode.h @@ -45,7 +45,7 @@ extern "C" { * * Additional values may be obtained from SDL_ComposeCustomBlendMode. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_ComposeCustomBlendMode */ @@ -64,7 +64,7 @@ typedef Uint32 SDL_BlendMode; * The blend operation used when combining source and destination pixel * components. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_BlendOperation { @@ -83,7 +83,7 @@ typedef enum SDL_BlendOperation * operation. The comma-separated factors listed above are always applied in * the component order red, green, blue, and alpha. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_BlendFactor { @@ -177,7 +177,7 @@ typedef enum SDL_BlendFactor * \returns an SDL_BlendMode that represents the chosen factors and * operations. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderDrawBlendMode * \sa SDL_GetRenderDrawBlendMode diff --git a/include/SDL3/SDL_camera.h b/include/SDL3/SDL_camera.h index ec2c36ad4..4ea75908a 100644 --- a/include/SDL3/SDL_camera.h +++ b/include/SDL3/SDL_camera.h @@ -53,7 +53,7 @@ extern "C" { * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GetCameras */ @@ -62,7 +62,7 @@ typedef Uint32 SDL_CameraID; /** * The opaque structure used to identify an opened SDL camera. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Camera SDL_Camera; @@ -72,7 +72,7 @@ typedef struct SDL_Camera SDL_Camera; * Cameras often support multiple formats; each one will be encapsulated in * this struct. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetCameraSupportedFormats * \sa SDL_GetCameraFormat @@ -90,7 +90,7 @@ typedef struct SDL_CameraSpec /** * The position of camera in relation to system device. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_GetCameraPosition */ @@ -119,7 +119,7 @@ typedef enum SDL_CameraPosition * * \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_GetCameraDriver */ @@ -143,7 +143,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumCameraDrivers(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_GetNumCameraDrivers */ @@ -161,7 +161,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCameraDriver(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_GetCurrentCameraDriver(void); @@ -176,7 +176,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentCameraDriver(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_OpenCamera */ @@ -214,7 +214,7 @@ extern SDL_DECLSPEC SDL_CameraID * SDLCALL SDL_GetCameras(int *count); * * \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_GetCameras * \sa SDL_OpenCamera @@ -230,7 +230,7 @@ extern SDL_DECLSPEC SDL_CameraSpec ** SDLCALL SDL_GetCameraSupportedFormats(SDL_ * * \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_GetCameras */ @@ -249,7 +249,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCameraName(SDL_CameraID instance * * \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_GetCameras */ @@ -295,7 +295,7 @@ extern SDL_DECLSPEC SDL_CameraPosition SDLCALL SDL_GetCameraPosition(SDL_CameraI * * \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_GetCameras * \sa SDL_GetCameraFormat @@ -328,7 +328,7 @@ extern SDL_DECLSPEC SDL_Camera * SDLCALL SDL_OpenCamera(SDL_CameraID instance_id * * \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_OpenCamera * \sa SDL_CloseCamera @@ -344,7 +344,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetCameraPermissionState(SDL_Camera *camera) * * \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_OpenCamera */ @@ -359,7 +359,7 @@ extern SDL_DECLSPEC SDL_CameraID SDLCALL SDL_GetCameraID(SDL_Camera *camera); * * \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 SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera *camera); @@ -383,7 +383,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera * * \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_OpenCamera */ @@ -426,7 +426,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetCameraFormat(SDL_Camera *camera, SDL_Cam * * \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_ReleaseCameraFrame */ @@ -454,7 +454,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_AcquireCameraFrame(SDL_Camera *cam * * \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_AcquireCameraFrame */ @@ -469,7 +469,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseCameraFrame(SDL_Camera *camera, SDL_ * \threadsafety It is safe to call this function from any thread, but no * thread may reference `device` once this function is called. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenCameraWithSpec * \sa SDL_OpenCamera diff --git a/include/SDL3/SDL_clipboard.h b/include/SDL3/SDL_clipboard.h index a59de5b77..1c0359a69 100644 --- a/include/SDL3/SDL_clipboard.h +++ b/include/SDL3/SDL_clipboard.h @@ -49,7 +49,7 @@ extern "C" { * \returns true on success or false 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. * * \sa SDL_GetClipboardText * \sa SDL_HasClipboardText @@ -66,7 +66,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardText(const char *text); * SDL_GetError() for more information. This should be freed with * SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasClipboardText * \sa SDL_SetClipboardText @@ -78,7 +78,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetClipboardText(void); * * \returns true if the clipboard has text, or false if it does not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetClipboardText * \sa SDL_SetClipboardText @@ -92,7 +92,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardText(void); * \returns true on success or false 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. * * \sa SDL_GetPrimarySelectionText * \sa SDL_HasPrimarySelectionText @@ -109,7 +109,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPrimarySelectionText(const char *text); * failure; call SDL_GetError() for more information. This should be * freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasPrimarySelectionText * \sa SDL_SetPrimarySelectionText @@ -122,7 +122,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetPrimarySelectionText(void); * * \returns true if the primary selection has text, or false if it does not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPrimarySelectionText * \sa SDL_SetPrimarySelectionText @@ -147,7 +147,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasPrimarySelectionText(void); * breakage in receiving applications. The returned data will not be * freed so it needs to be retained and dealt with internally. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetClipboardData */ @@ -159,7 +159,7 @@ typedef const void *(SDLCALL *SDL_ClipboardDataCallback)(void *userdata, const c * * \param userdata a pointer to provided user data. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetClipboardData */ @@ -187,7 +187,7 @@ typedef void (SDLCALL *SDL_ClipboardCleanupCallback)(void *userdata); * \returns true on success or false 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. * * \sa SDL_ClearClipboardData * \sa SDL_GetClipboardData @@ -201,7 +201,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardData(SDL_ClipboardDataCallback * \returns true on success or false 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. * * \sa SDL_SetClipboardData */ @@ -219,7 +219,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearClipboardData(void); * for more information. This should be freed with SDL_free() when it * is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasClipboardData * \sa SDL_SetClipboardData @@ -233,7 +233,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetClipboardData(const char *mime_type, s * \returns true if there exists data in clipboard for the provided mime type, * false if it does not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetClipboardData * \sa SDL_GetClipboardData @@ -249,7 +249,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardData(const char *mime_type); * failure; call SDL_GetError() for more information. This should be * freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetClipboardData */ diff --git a/include/SDL3/SDL_cpuinfo.h b/include/SDL3/SDL_cpuinfo.h index cf77705fd..8d47d92d3 100644 --- a/include/SDL3/SDL_cpuinfo.h +++ b/include/SDL3/SDL_cpuinfo.h @@ -49,7 +49,7 @@ extern "C" { * processors have a 128 byte cache line. We use the larger value to be * generally safe. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_CACHELINE_SIZE 128 @@ -62,7 +62,7 @@ extern "C" { * * \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 int SDLCALL SDL_GetNumLogicalCPUCores(void); @@ -76,7 +76,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumLogicalCPUCores(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. */ extern SDL_DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void); @@ -90,7 +90,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(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. */ extern SDL_DECLSPEC bool SDLCALL SDL_HasAltiVec(void); @@ -103,7 +103,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAltiVec(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. */ extern SDL_DECLSPEC bool SDLCALL SDL_HasMMX(void); @@ -116,7 +116,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasMMX(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_HasSSE2 * \sa SDL_HasSSE3 @@ -134,7 +134,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE(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_HasSSE * \sa SDL_HasSSE3 @@ -152,7 +152,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE2(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_HasSSE * \sa SDL_HasSSE2 @@ -170,7 +170,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE3(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_HasSSE * \sa SDL_HasSSE2 @@ -188,7 +188,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE41(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_HasSSE * \sa SDL_HasSSE2 @@ -206,7 +206,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE42(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_HasAVX2 * \sa SDL_HasAVX512F @@ -222,7 +222,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAVX(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_HasAVX * \sa SDL_HasAVX512F @@ -238,7 +238,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAVX2(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_HasAVX * \sa SDL_HasAVX2 @@ -256,7 +256,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAVX512F(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_HasNEON */ @@ -271,7 +271,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasARMSIMD(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. */ extern SDL_DECLSPEC bool SDLCALL SDL_HasNEON(void); @@ -285,7 +285,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasNEON(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. */ extern SDL_DECLSPEC bool SDLCALL SDL_HasLSX(void); @@ -299,7 +299,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasLSX(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. */ extern SDL_DECLSPEC bool SDLCALL SDL_HasLASX(void); @@ -310,7 +310,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasLASX(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. */ extern SDL_DECLSPEC int SDLCALL SDL_GetSystemRAM(void); @@ -331,7 +331,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetSystemRAM(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_aligned_alloc * \sa SDL_aligned_free diff --git a/include/SDL3/SDL_dialog.h b/include/SDL3/SDL_dialog.h index a2e328396..5fe628298 100644 --- a/include/SDL3/SDL_dialog.h +++ b/include/SDL3/SDL_dialog.h @@ -49,7 +49,7 @@ extern "C" { * hyphens, underscores and periods. Alternatively, the whole string can be a * single asterisk ("*"), which serves as an "All files" filter. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_DialogFileCallback * \sa SDL_ShowOpenFileDialog @@ -87,7 +87,7 @@ typedef struct SDL_DialogFileFilter * \param filelist the file(s) chosen by the user. * \param filter index of the selected filter. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_DialogFileFilter * \sa SDL_ShowOpenFileDialog @@ -144,7 +144,7 @@ typedef void (SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * cons * \param allow_many if non-zero, the user will be allowed to select multiple * entries. Not all platforms support this option. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_DialogFileCallback * \sa SDL_DialogFileFilter @@ -199,7 +199,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowOpenFileDialog(SDL_DialogFileCallback c * \param default_location the default folder or file to start the dialog at, * may be NULL. Not all platforms support this option. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_DialogFileCallback * \sa SDL_DialogFileFilter @@ -248,7 +248,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback c * \param allow_many if non-zero, the user will be allowed to select multiple * entries. Not all platforms support this option. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_DialogFileCallback * \sa SDL_ShowOpenFileDialog diff --git a/include/SDL3/SDL_endian.h b/include/SDL3/SDL_endian.h index cb3d7f34e..5a91ae6af 100644 --- a/include/SDL3/SDL_endian.h +++ b/include/SDL3/SDL_endian.h @@ -309,7 +309,7 @@ SDL_FORCE_INLINE Uint64 SDL_Swap64(Uint64 x) * * \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. */ SDL_FORCE_INLINE float SDL_SwapFloat(float x) { @@ -348,7 +348,7 @@ SDL_FORCE_INLINE float SDL_SwapFloat(float x) * * \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. */ SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x) { return x_but_byteswapped; } @@ -369,7 +369,7 @@ SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x) { return x_but_byteswapped; } * * \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. */ SDL_FORCE_INLINE Uint32 SDL_Swap32(Uint32 x) { return x_but_byteswapped; } @@ -390,7 +390,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap32(Uint32 x) { return x_but_byteswapped; } * * \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. */ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } @@ -404,7 +404,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in littleendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_Swap16LE(x) SwapOnlyIfNecessary(x) @@ -418,7 +418,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in littleendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_Swap32LE(x) SwapOnlyIfNecessary(x) @@ -432,7 +432,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in littleendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_Swap64LE(x) SwapOnlyIfNecessary(x) @@ -446,7 +446,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in littleendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_SwapFloatLE(x) SwapOnlyIfNecessary(x) @@ -460,7 +460,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in bigendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_Swap16BE(x) SwapOnlyIfNecessary(x) @@ -474,7 +474,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in bigendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_Swap32BE(x) SwapOnlyIfNecessary(x) @@ -488,7 +488,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in bigendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_Swap64BE(x) SwapOnlyIfNecessary(x) @@ -502,7 +502,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } * \param x the value to swap, in bigendian byte order. * \returns `x` in native byte order. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_SwapFloatBE(x) SwapOnlyIfNecessary(x) diff --git a/include/SDL3/SDL_error.h b/include/SDL3/SDL_error.h index 0cc9c0eac..0e0532d19 100644 --- a/include/SDL3/SDL_error.h +++ b/include/SDL3/SDL_error.h @@ -80,7 +80,7 @@ extern "C" { * * \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_ClearError * \sa SDL_GetError @@ -99,7 +99,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetError(SDL_PRINTF_FORMAT_STRING const cha * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.1.4. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ClearError * \sa SDL_GetError @@ -116,7 +116,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetErrorV(SDL_PRINTF_FORMAT_STRING const ch * * \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_OutOfMemory(void); @@ -150,7 +150,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_OutOfMemory(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_ClearError * \sa SDL_SetError @@ -164,7 +164,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetError(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_GetError * \sa SDL_SetError diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h index 779cc2fae..8987134fb 100644 --- a/include/SDL3/SDL_events.h +++ b/include/SDL3/SDL_events.h @@ -55,7 +55,7 @@ extern "C" { /** * The types of events that can be delivered. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_EventType { @@ -257,7 +257,7 @@ typedef enum SDL_EventType /** * Fields shared by every event * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_CommonEvent { @@ -269,7 +269,7 @@ typedef struct SDL_CommonEvent /** * Display state change event data (event.display.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_DisplayEvent { @@ -284,7 +284,7 @@ typedef struct SDL_DisplayEvent /** * Window state change event data (event.window.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_WindowEvent { @@ -299,7 +299,7 @@ typedef struct SDL_WindowEvent /** * Keyboard device event structure (event.kdevice.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_KeyboardDeviceEvent { @@ -318,7 +318,7 @@ typedef struct SDL_KeyboardDeviceEvent * event scancode and modifiers directly from the keyboard layout, bypassing * SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode(). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetKeyFromScancode * \sa SDL_HINT_KEYCODE_OPTIONS @@ -345,7 +345,7 @@ typedef struct SDL_KeyboardEvent * will be inserted into the editing text. The length is the number of UTF-8 * characters that will be replaced by new typing. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_TextEditingEvent { @@ -361,7 +361,7 @@ typedef struct SDL_TextEditingEvent /** * Keyboard IME candidates event structure (event.edit_candidates.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_TextEditingCandidatesEvent { @@ -384,7 +384,7 @@ typedef struct SDL_TextEditingCandidatesEvent * This event will never be delivered unless text input is enabled by calling * SDL_StartTextInput(). Text input is disabled by default! * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_StartTextInput * \sa SDL_StopTextInput @@ -401,7 +401,7 @@ typedef struct SDL_TextInputEvent /** * Mouse device event structure (event.mdevice.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MouseDeviceEvent { @@ -414,7 +414,7 @@ typedef struct SDL_MouseDeviceEvent /** * Mouse motion event structure (event.motion.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MouseMotionEvent { @@ -433,7 +433,7 @@ typedef struct SDL_MouseMotionEvent /** * Mouse button event structure (event.button.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MouseButtonEvent { @@ -453,7 +453,7 @@ typedef struct SDL_MouseButtonEvent /** * Mouse wheel event structure (event.wheel.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MouseWheelEvent { @@ -472,7 +472,7 @@ typedef struct SDL_MouseWheelEvent /** * Joystick axis motion event structure (event.jaxis.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_JoyAxisEvent { @@ -491,7 +491,7 @@ typedef struct SDL_JoyAxisEvent /** * Joystick trackball motion event structure (event.jball.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_JoyBallEvent { @@ -510,7 +510,7 @@ typedef struct SDL_JoyBallEvent /** * Joystick hat position change event structure (event.jhat.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_JoyHatEvent { @@ -533,7 +533,7 @@ typedef struct SDL_JoyHatEvent /** * Joystick button event structure (event.jbutton.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_JoyButtonEvent { @@ -553,7 +553,7 @@ typedef struct SDL_JoyButtonEvent * SDL will send JOYSTICK_ADDED events for devices that are already plugged in * during SDL_Init. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GamepadDeviceEvent */ @@ -568,7 +568,7 @@ typedef struct SDL_JoyDeviceEvent /** * Joystick battery level change event structure (event.jbattery.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_JoyBatteryEvent { @@ -583,7 +583,7 @@ typedef struct SDL_JoyBatteryEvent /** * Gamepad axis motion event structure (event.gaxis.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_GamepadAxisEvent { @@ -603,7 +603,7 @@ typedef struct SDL_GamepadAxisEvent /** * Gamepad button event structure (event.gbutton.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_GamepadButtonEvent { @@ -628,7 +628,7 @@ typedef struct SDL_GamepadButtonEvent * in during SDL_Init() and are recognized as gamepads. It will also send * events for joysticks that get gamepad mappings at runtime. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_JoyDeviceEvent */ @@ -643,7 +643,7 @@ typedef struct SDL_GamepadDeviceEvent /** * Gamepad touchpad event structure (event.gtouchpad.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_GamepadTouchpadEvent { @@ -661,7 +661,7 @@ typedef struct SDL_GamepadTouchpadEvent /** * Gamepad sensor event structure (event.gsensor.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_GamepadSensorEvent { @@ -677,7 +677,7 @@ typedef struct SDL_GamepadSensorEvent /** * Audio device event structure (event.adevice.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_AudioDeviceEvent { @@ -694,7 +694,7 @@ typedef struct SDL_AudioDeviceEvent /** * Camera device event structure (event.cdevice.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_CameraDeviceEvent { @@ -721,7 +721,7 @@ typedef struct SDL_CameraDeviceEvent * report a touch outside of the window, which will also be outside of the * range. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_TouchFingerEvent { @@ -751,7 +751,7 @@ typedef struct SDL_TouchFingerEvent * is there." The pen touching and lifting off from the tablet while not * leaving the area are handled by SDL_EVENT_PEN_DOWN and SDL_EVENT_PEN_UP. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_PenProximityEvent { @@ -771,7 +771,7 @@ typedef struct SDL_PenProximityEvent * `pen_state & SDL_PEN_INPUT_DOWN` to decide if a pen is "drawing" when * dealing with pen motion. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_PenMotionEvent { @@ -791,7 +791,7 @@ typedef struct SDL_PenMotionEvent * These events come when a pen touches a surface (a tablet, etc), or lifts * off from one. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_PenTouchEvent { @@ -813,7 +813,7 @@ typedef struct SDL_PenTouchEvent * This is for buttons on the pen itself that the user might click. The pen * itself pressing down to draw triggers a SDL_EVENT_PEN_DOWN event instead. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_PenButtonEvent { @@ -835,7 +835,7 @@ typedef struct SDL_PenButtonEvent * You might get some of these events even if the pen isn't touching the * tablet. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_PenAxisEvent { @@ -855,7 +855,7 @@ typedef struct SDL_PenAxisEvent * An event used to drop text or request a file open by the system * (event.drop.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_DropEvent { @@ -873,7 +873,7 @@ typedef struct SDL_DropEvent * An event triggered when the clipboard contents have changed * (event.clipboard.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_ClipboardEvent { @@ -888,7 +888,7 @@ typedef struct SDL_ClipboardEvent /** * Sensor event structure (event.sensor.*) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_SensorEvent { @@ -903,7 +903,7 @@ typedef struct SDL_SensorEvent /** * The "quit requested" event * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_QuitEvent { @@ -921,7 +921,7 @@ typedef struct SDL_QuitEvent * the programmer; the only requirement is that '''type''' is a value obtained * from SDL_RegisterEvents(). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_UserEvent { @@ -938,7 +938,7 @@ typedef struct SDL_UserEvent /** * The structure for all events in SDL. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef union SDL_Event { @@ -1019,7 +1019,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_Event, sizeof(SDL_Event) == sizeof(((SDL_Event *)NUL * polling or waiting for events (e.g. you are filtering them), then you must * call SDL_PumpEvents() to force an event queue update. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PollEvent * \sa SDL_WaitEvent @@ -1031,7 +1031,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PumpEvents(void); /** * The type of action to request from SDL_PeepEvents(). * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_EventAction { @@ -1076,7 +1076,7 @@ typedef enum SDL_EventAction * \returns the number of events actually stored or -1 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. * * \sa SDL_PollEvent * \sa SDL_PumpEvents @@ -1095,7 +1095,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event *events, int numevents, * \returns true if events matching `type` are present, or false if events * matching `type` are not present. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasEvents */ @@ -1114,7 +1114,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasEvent(Uint32 type); * \returns true if events with type >= `minType` and <= `maxType` are * present, or false if not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasEvents */ @@ -1140,7 +1140,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType); * * \param type the type of event to be cleared; see SDL_EventType for details. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_FlushEvents */ @@ -1165,7 +1165,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type); * \param maxType the high end of event type to be cleared, inclusive; see * SDL_EventType for details. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_FlushEvent */ @@ -1207,7 +1207,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType) * the queue, or NULL. * \returns true if this got an event or false if there are none available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PushEvent * \sa SDL_WaitEvent @@ -1229,7 +1229,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PollEvent(SDL_Event *event); * \returns true on success or false if there was an error while waiting for * events; 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. * * \sa SDL_PollEvent * \sa SDL_PushEvent @@ -1257,7 +1257,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEvent(SDL_Event *event); * \returns true if this got an event or false if the timeout elapsed without * any events available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PollEvent * \sa SDL_PushEvent @@ -1291,7 +1291,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEventTimeout(SDL_Event *event, Sint32 t * call SDL_GetError() for more information. A common reason for * error is the event queue being full. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PeepEvents * \sa SDL_PollEvent @@ -1313,7 +1313,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PushEvent(SDL_Event *event); * application is responsible for locking resources the callback * touches that need to be protected. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetEventFilter * \sa SDL_AddEventWatch @@ -1358,7 +1358,7 @@ typedef bool (SDLCALL *SDL_EventFilter)(void *userdata, SDL_Event *event); * the application is responsible for locking resources the * callback touches that need to be protected. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddEventWatch * \sa SDL_SetEventEnabled @@ -1379,7 +1379,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter, void * be stored here. * \returns true on success or false if there is no event filter set. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetEventFilter */ @@ -1410,7 +1410,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetEventFilter(SDL_EventFilter *filter, voi * * \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_RemoveEventWatch * \sa SDL_SetEventFilter @@ -1426,7 +1426,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddEventWatch(SDL_EventFilter filter, void * \param filter the function originally passed to SDL_AddEventWatch(). * \param userdata the pointer originally passed to SDL_AddEventWatch(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddEventWatch */ @@ -1443,7 +1443,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveEventWatch(SDL_EventFilter filter, vo * \param filter the SDL_EventFilter function to call when an event happens. * \param userdata a pointer that is passed to `filter`. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetEventFilter * \sa SDL_SetEventFilter @@ -1456,7 +1456,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter, void * * \param type the type of event; see SDL_EventType for details. * \param enabled whether to process the event or not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_EventEnabled */ @@ -1468,7 +1468,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetEventEnabled(Uint32 type, bool enabled); * \param type the type of event; see SDL_EventType for details. * \returns true if the event is being processed, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetEventEnabled */ @@ -1482,7 +1482,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EventEnabled(Uint32 type); * \returns the beginning event number, or 0 if numevents is invalid or if * there are not enough user-defined events left. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PushEvent */ @@ -1494,7 +1494,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents); * \param event an event containing a `windowID`. * \returns the associated window on success or NULL if there is none. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PollEvent * \sa SDL_WaitEvent diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h index e35ca5cac..51789f9fd 100644 --- a/include/SDL3/SDL_filesystem.h +++ b/include/SDL3/SDL_filesystem.h @@ -73,7 +73,7 @@ extern "C" { * doesn't implement this functionality, 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. * * \sa SDL_GetPrefPath */ @@ -128,7 +128,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetBasePath(void); * etc.). This should be freed with SDL_free() when it is no longer * needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetBasePath */ @@ -159,7 +159,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetPrefPath(const char *org, const char * * * Note that on macOS/iOS, the Videos folder is called "Movies". * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_GetUserFolder */ @@ -212,7 +212,7 @@ typedef enum SDL_Folder * \returns either a null-terminated C string containing the full path to the * folder, or NULL if an error happened. * - * \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_GetUserFolder(SDL_Folder folder); @@ -239,7 +239,7 @@ typedef struct SDL_PathInfo /** * Flags for path matching * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GlobDirectory * \sa SDL_GlobStorageDirectory @@ -260,14 +260,14 @@ typedef Uint32 SDL_GlobFlags; * \returns true on success or false 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 bool SDLCALL SDL_CreateDirectory(const char *path); /** * Possible results from an enumeration callback. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_EnumerateDirectoryCallback */ @@ -295,7 +295,7 @@ typedef enum SDL_EnumerationResult * \param fname the next entry in the enumeration. * \returns how the enumeration should proceed. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_EnumerateDirectory */ @@ -318,7 +318,7 @@ typedef SDL_EnumerationResult (SDLCALL *SDL_EnumerateDirectoryCallback)(void *us * \returns true on success or false 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 bool SDLCALL SDL_EnumerateDirectory(const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata); @@ -332,7 +332,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateDirectory(const char *path, SDL_En * \returns true on success or false 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 bool SDLCALL SDL_RemovePath(const char *path); @@ -355,7 +355,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RemovePath(const char *path); * \returns true on success or false 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 bool SDLCALL SDL_RenamePath(const char *oldpath, const char *newpath); @@ -395,7 +395,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenamePath(const char *oldpath, const char * \returns true on success or false 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 bool SDLCALL SDL_CopyFile(const char *oldpath, const char *newpath); @@ -408,7 +408,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CopyFile(const char *oldpath, const char *n * \returns true on success or false if the file doesn't exist, or another * 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 bool SDLCALL SDL_GetPathInfo(const char *path, SDL_PathInfo *info); @@ -441,7 +441,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetPathInfo(const char *path, SDL_PathInfo * * \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 char ** SDLCALL SDL_GlobDirectory(const char *path, const char *pattern, SDL_GlobFlags flags, int *count); diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h index c4c8ac7f9..900a80923 100644 --- a/include/SDL3/SDL_gamepad.h +++ b/include/SDL3/SDL_gamepad.h @@ -74,7 +74,7 @@ extern "C" { /** * The structure used to identify an SDL gamepad * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Gamepad SDL_Gamepad; @@ -124,7 +124,7 @@ typedef enum SDL_GamepadType * You can query the labels for the face buttons using * SDL_GetGamepadButtonLabel() * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GamepadButton { @@ -167,7 +167,7 @@ typedef enum SDL_GamepadButton * For a complete set, you should look at the button and gamepad type and have * a set of symbols that work well with your art style. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GamepadButtonLabel { @@ -194,7 +194,7 @@ typedef enum SDL_GamepadButtonLabel * pressed) when reported by SDL_GetGamepadAxis(). Note that this is not the * same range that will be reported by the lower-level SDL_GetJoystickAxis(). * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GamepadAxis { @@ -216,7 +216,7 @@ typedef enum SDL_GamepadAxis * gamepad. This enum is used as part of SDL_GamepadBinding to specify those * mappings. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GamepadBindingType { @@ -237,7 +237,7 @@ typedef enum SDL_GamepadBindingType * more with a simple text string. Those strings are parsed into a collection * of these structs to make it easier to operate on the data. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetGamepadBindings */ @@ -310,7 +310,7 @@ typedef struct SDL_GamepadBinding * * \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_AddGamepadMappingsFromFile * \sa SDL_AddGamepadMappingsFromIO @@ -350,7 +350,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMapping(const char *mapping); * * \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_AddGamepadMapping * \sa SDL_AddGamepadMappingsFromFile @@ -384,7 +384,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, * * \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_AddGamepadMapping * \sa SDL_AddGamepadMappingsFromIO @@ -404,7 +404,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromFile(const char *file) * \returns true on success or false 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 bool SDLCALL SDL_ReloadGamepadMappings(void); @@ -418,7 +418,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReloadGamepadMappings(void); * single allocation that should be freed with SDL_free() when it is * no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC char ** SDLCALL SDL_GetGamepadMappings(int *count); @@ -430,7 +430,7 @@ extern SDL_DECLSPEC char ** SDLCALL SDL_GetGamepadMappings(int *count); * information. This should be freed with SDL_free() when it is no * longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickGUIDForID * \sa SDL_GetJoystickGUID @@ -447,7 +447,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMappingForGUID(SDL_GUID guid); * available; call SDL_GetError() for more information. This should * be freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddGamepadMapping * \sa SDL_GetGamepadMappingForID @@ -467,7 +467,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMapping(SDL_Gamepad *gamepad); * \returns true on success or false 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. * * \sa SDL_AddGamepadMapping * \sa SDL_GetGamepadMapping @@ -479,7 +479,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadMapping(SDL_JoystickID instance_i * * \returns true if a gamepad is connected, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepads */ @@ -494,7 +494,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasGamepad(void); * call SDL_GetError() for more information. This should be freed * with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasGamepad * \sa SDL_OpenGamepad @@ -508,7 +508,7 @@ extern SDL_DECLSPEC SDL_JoystickID * SDLCALL SDL_GetGamepads(int *count); * \returns true if the given joystick is supported by the gamepad interface, * false if it isn't or it's an invalid index. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoysticks * \sa SDL_OpenGamepad @@ -524,7 +524,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsGamepad(SDL_JoystickID instance_id); * \returns the name of the selected gamepad. If no name can be found, this * function returns NULL; 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. * * \sa SDL_GetGamepadName * \sa SDL_GetGamepads @@ -540,7 +540,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadNameForID(SDL_JoystickID * \returns the path of the selected gamepad. If no path can be found, this * function returns NULL; 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. * * \sa SDL_GetGamepadPath * \sa SDL_GetGamepads @@ -555,7 +555,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadPathForID(SDL_JoystickID * \param instance_id the joystick instance ID. * \returns the player index of a gamepad, or -1 if it's not available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadPlayerIndex * \sa SDL_GetGamepads @@ -571,7 +571,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndexForID(SDL_JoystickID in * \returns the GUID of the selected gamepad. If called on an invalid index, * this function returns a zero GUID. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GUIDToString * \sa SDL_GetGamepads @@ -588,7 +588,7 @@ extern SDL_DECLSPEC SDL_GUID SDLCALL SDL_GetGamepadGUIDForID(SDL_JoystickID inst * \returns the USB vendor ID of the selected gamepad. If called on an invalid * index, this function returns zero. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadVendor * \sa SDL_GetGamepads @@ -605,7 +605,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadVendorForID(SDL_JoystickID inst * \returns the USB product ID of the selected gamepad. If called on an * invalid index, this function returns zero. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadProduct * \sa SDL_GetGamepads @@ -622,7 +622,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductForID(SDL_JoystickID ins * \returns the product version of the selected gamepad. If called on an * invalid index, this function returns zero. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadProductVersion * \sa SDL_GetGamepads @@ -637,7 +637,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductVersionForID(SDL_Joystic * \param instance_id the joystick instance ID. * \returns the gamepad type. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadType * \sa SDL_GetGamepads @@ -653,7 +653,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadTypeForID(SDL_Joystick * \param instance_id the joystick instance ID. * \returns the gamepad type. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadTypeForID * \sa SDL_GetGamepads @@ -670,7 +670,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadTypeForID(SDL_Joys * \returns the mapping string. Returns NULL if no mapping is available. This * should be freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepads * \sa SDL_GetGamepadMapping @@ -684,7 +684,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMappingForID(SDL_JoystickID ins * \returns a gamepad identifier or NULL if an error occurred; 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. * * \sa SDL_CloseGamepad * \sa SDL_IsGamepad @@ -699,7 +699,7 @@ extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_OpenGamepad(SDL_JoystickID instanc * \returns an SDL_Gamepad on success or NULL on failure or if it hasn't been * opened yet; 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_Gamepad * SDLCALL SDL_GetGamepadFromID(SDL_JoystickID instance_id); @@ -709,7 +709,7 @@ extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_GetGamepadFromID(SDL_JoystickID in * \param player_index the player index, which different from the instance ID. * \returns the SDL_Gamepad associated with a player index. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadPlayerIndex * \sa SDL_SetGamepadPlayerIndex @@ -739,7 +739,7 @@ extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_GetGamepadFromPlayerIndex(int play * \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_GetGamepadProperties(SDL_Gamepad *gamepad); @@ -757,7 +757,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGamepadProperties(SDL_Gamepa * \returns the instance ID of the specified gamepad 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_JoystickID SDLCALL SDL_GetGamepadID(SDL_Gamepad *gamepad); @@ -769,7 +769,7 @@ extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetGamepadID(SDL_Gamepad *gamepad * \returns the implementation dependent name for the gamepad, or NULL if * there is no name or the identifier passed is invalid. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadNameForID */ @@ -783,7 +783,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadName(SDL_Gamepad *gamepad * \returns the implementation dependent path for the gamepad, or NULL if * there is no path or the identifier passed is invalid. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadPathForID */ @@ -796,7 +796,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadPath(SDL_Gamepad *gamepad * \returns the gamepad type, or SDL_GAMEPAD_TYPE_UNKNOWN if it's not * available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadTypeForID */ @@ -809,7 +809,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadType(SDL_Gamepad *game * \returns the gamepad type, or SDL_GAMEPAD_TYPE_UNKNOWN if it's not * available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRealGamepadTypeForID */ @@ -823,7 +823,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadType(SDL_Gamepad * * \param gamepad the gamepad object to query. * \returns the player index for gamepad, or -1 if it's not available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetGamepadPlayerIndex */ @@ -838,7 +838,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad); * \returns true on success or false 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. * * \sa SDL_GetGamepadPlayerIndex */ @@ -852,7 +852,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadPlayerIndex(SDL_Gamepad *gamepad, * \param gamepad the gamepad object to query. * \returns the USB vendor ID, or zero if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadVendorForID */ @@ -866,7 +866,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadVendor(SDL_Gamepad *gamepad); * \param gamepad the gamepad object to query. * \returns the USB product ID, or zero if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadProductForID */ @@ -880,7 +880,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProduct(SDL_Gamepad *gamepad); * \param gamepad the gamepad object to query. * \returns the USB product version, or zero if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadProductVersionForID */ @@ -894,7 +894,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductVersion(SDL_Gamepad *gam * \param gamepad the gamepad object to query. * \returns the gamepad firmware version, or zero if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadFirmwareVersion(SDL_Gamepad *gamepad); @@ -906,7 +906,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadFirmwareVersion(SDL_Gamepad *ga * \param gamepad the gamepad object to query. * \returns the serial number, or NULL if unavailable. * - * \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_GetGamepadSerial(SDL_Gamepad *gamepad); @@ -919,7 +919,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadSerial(SDL_Gamepad *gamep * \param gamepad the gamepad object to query. * \returns the gamepad handle, or 0 if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepad); @@ -931,7 +931,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepa * `SDL_JOYSTICK_CONNECTION_INVALID` 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_JoystickConnectionState SDLCALL SDL_GetGamepadConnectionState(SDL_Gamepad *gamepad); @@ -951,7 +951,7 @@ extern SDL_DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnection * battery. * \returns the current battery 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_PowerState SDLCALL SDL_GetGamepadPowerInfo(SDL_Gamepad *gamepad, int *percent); @@ -963,7 +963,7 @@ extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetGamepadPowerInfo(SDL_Gamepad * * \returns true if the gamepad has been opened and is currently connected, or * false if not. * - * \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_GamepadConnected(SDL_Gamepad *gamepad); @@ -983,7 +983,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadConnected(SDL_Gamepad *gamepad); * \returns an SDL_Joystick object, or NULL 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_Joystick * SDLCALL SDL_GetGamepadJoystick(SDL_Gamepad *gamepad); @@ -995,7 +995,7 @@ extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetGamepadJoystick(SDL_Gamepad *g * * \param enabled whether to process gamepad events or not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GamepadEventsEnabled * \sa SDL_UpdateGamepads @@ -1010,7 +1010,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGamepadEventsEnabled(bool enabled); * * \returns true if gamepad events are being processed, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetGamepadEventsEnabled */ @@ -1026,7 +1026,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadEventsEnabled(void); * single allocation that should be freed with SDL_free() when it is * no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_GamepadBinding ** SDLCALL SDL_GetGamepadBindings(SDL_Gamepad *gamepad, int *count); @@ -1037,7 +1037,7 @@ extern SDL_DECLSPEC SDL_GamepadBinding ** SDLCALL SDL_GetGamepadBindings(SDL_Gam * enabled. Under such circumstances, it will not be necessary to call this * function. * - * \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_UpdateGamepads(void); @@ -1053,7 +1053,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UpdateGamepads(void); * \returns the SDL_GamepadType enum corresponding to the input string, or * `SDL_GAMEPAD_TYPE_UNKNOWN` if no match was found. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadStringForType */ @@ -1067,7 +1067,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadTypeFromString(const c * specified. The string returned is of the format used by * SDL_Gamepad mapping strings. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadTypeFromString */ @@ -1089,7 +1089,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadStringForType(SDL_Gamepad * \returns the SDL_GamepadAxis enum corresponding to the input string, or * `SDL_GAMEPAD_AXIS_INVALID` if no match was found. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadStringForAxis */ @@ -1103,7 +1103,7 @@ extern SDL_DECLSPEC SDL_GamepadAxis SDLCALL SDL_GetGamepadAxisFromString(const c * specified. The string returned is of the format used by * SDL_Gamepad mapping strings. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadAxisFromString */ @@ -1119,7 +1119,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadStringForAxis(SDL_Gamepad * \param axis an axis enum value (an SDL_GamepadAxis value). * \returns true if the gamepad has this axis, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GamepadHasButton * \sa SDL_GetGamepadAxis @@ -1143,7 +1143,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadHasAxis(SDL_Gamepad *gamepad, SDL_Ga * \returns axis state (including 0) on success or 0 (also) 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. * * \sa SDL_GamepadHasAxis * \sa SDL_GetGamepadButton @@ -1162,7 +1162,7 @@ extern SDL_DECLSPEC Sint16 SDLCALL SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_ * \returns the SDL_GamepadButton enum corresponding to the input string, or * `SDL_GAMEPAD_BUTTON_INVALID` if no match was found. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadStringForButton */ @@ -1176,7 +1176,7 @@ extern SDL_DECLSPEC SDL_GamepadButton SDLCALL SDL_GetGamepadButtonFromString(con * specified. The string returned is of the format used by * SDL_Gamepad mapping strings. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadButtonFromString */ @@ -1192,7 +1192,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadStringForButton(SDL_Gamep * \param button a button enum value (an SDL_GamepadButton value). * \returns true if the gamepad has this button, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GamepadHasAxis */ @@ -1205,7 +1205,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadHasButton(SDL_Gamepad *gamepad, SDL_ * \param button a button index (one of the SDL_GamepadButton values). * \returns true if the button is pressed, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GamepadHasButton * \sa SDL_GetGamepadAxis @@ -1219,7 +1219,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadButton(SDL_Gamepad *gamepad, SDL_ * \param button a button index (one of the SDL_GamepadButton values). * \returns the SDL_GamepadButtonLabel enum corresponding to the button label. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadButtonLabel */ @@ -1232,7 +1232,7 @@ extern SDL_DECLSPEC SDL_GamepadButtonLabel SDLCALL SDL_GetGamepadButtonLabelForT * \param button a button index (one of the SDL_GamepadButton values). * \returns the SDL_GamepadButtonLabel enum corresponding to the button label. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadButtonLabelForType */ @@ -1244,7 +1244,7 @@ extern SDL_DECLSPEC SDL_GamepadButtonLabel SDLCALL SDL_GetGamepadButtonLabel(SDL * \param gamepad a gamepad. * \returns number of touchpads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetNumGamepadTouchpadFingers */ @@ -1258,7 +1258,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpads(SDL_Gamepad *gamepad) * \param touchpad a touchpad. * \returns number of supported simultaneous fingers. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadTouchpadFinger * \sa SDL_GetNumGamepadTouchpads @@ -1281,7 +1281,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpadFingers(SDL_Gamepad *ga * \returns true on success or false 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. * * \sa SDL_GetNumGamepadTouchpadFingers */ @@ -1294,7 +1294,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadTouchpadFinger(SDL_Gamepad *gamep * \param type the type of sensor to query. * \returns true if the sensor exists, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadSensorData * \sa SDL_GetGamepadSensorDataRate @@ -1311,7 +1311,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadHasSensor(SDL_Gamepad *gamepad, SDL_ * \returns true on success or false 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. * * \sa SDL_GamepadHasSensor * \sa SDL_GamepadSensorEnabled @@ -1325,7 +1325,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadSensorEnabled(SDL_Gamepad *gamepa * \param type the type of sensor to query. * \returns true if the sensor is enabled, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetGamepadSensorEnabled */ @@ -1338,7 +1338,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadSensorEnabled(SDL_Gamepad *gamepad, * \param type the type of sensor to query. * \returns the data rate, or 0.0f if the data rate is not available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC float SDLCALL SDL_GetGamepadSensorDataRate(SDL_Gamepad *gamepad, SDL_SensorType type); @@ -1355,7 +1355,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetGamepadSensorDataRate(SDL_Gamepad *game * \returns true on success or false 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 bool SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamepad, SDL_SensorType type, float *data, int num_values); @@ -1377,7 +1377,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamepad, * \returns true on success or false 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 bool SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms); @@ -1403,7 +1403,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 * \returns true on success or false 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. * * \sa SDL_RumbleGamepad */ @@ -1425,7 +1425,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RumbleGamepadTriggers(SDL_Gamepad *gamepad, * \returns true on success or false 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 bool SDLCALL SDL_SetGamepadLED(SDL_Gamepad *gamepad, Uint8 red, Uint8 green, Uint8 blue); @@ -1438,7 +1438,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadLED(SDL_Gamepad *gamepad, Uint8 r * \returns true on success or false 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 bool SDLCALL SDL_SendGamepadEffect(SDL_Gamepad *gamepad, const void *data, int size); @@ -1448,7 +1448,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SendGamepadEffect(SDL_Gamepad *gamepad, con * \param gamepad a gamepad identifier previously returned by * SDL_OpenGamepad(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenGamepad */ @@ -1462,7 +1462,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseGamepad(SDL_Gamepad *gamepad); * \param button a button on the gamepad. * \returns the sfSymbolsName or NULL if the name can't be found. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadAppleSFSymbolsNameForAxis */ @@ -1475,7 +1475,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadAppleSFSymbolsNameForButt * \param axis an axis on the gamepad. * \returns the sfSymbolsName or NULL if the name can't be found. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGamepadAppleSFSymbolsNameForButton */ diff --git a/include/SDL3/SDL_gpu.h b/include/SDL3/SDL_gpu.h index 99a3c5ffd..b1c63fe17 100644 --- a/include/SDL3/SDL_gpu.h +++ b/include/SDL3/SDL_gpu.h @@ -170,7 +170,7 @@ extern "C" { /** * An opaque handle representing the SDL_GPU context. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 */ typedef struct SDL_GPUDevice SDL_GPUDevice; @@ -180,7 +180,7 @@ typedef struct SDL_GPUDevice SDL_GPUDevice; * Used for vertices, indices, indirect draw commands, and general compute * data. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUBuffer * \sa SDL_SetGPUBufferName @@ -204,7 +204,7 @@ typedef struct SDL_GPUBuffer SDL_GPUBuffer; * * Used for transferring data to and from the device. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUTransferBuffer * \sa SDL_MapGPUTransferBuffer @@ -220,7 +220,7 @@ typedef struct SDL_GPUTransferBuffer SDL_GPUTransferBuffer; /** * An opaque handle representing a texture. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUTexture * \sa SDL_SetGPUTextureName @@ -241,7 +241,7 @@ typedef struct SDL_GPUTexture SDL_GPUTexture; /** * An opaque handle representing a sampler. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUSampler * \sa SDL_BindGPUVertexSamplers @@ -253,7 +253,7 @@ typedef struct SDL_GPUSampler SDL_GPUSampler; /** * An opaque handle representing a compiled shader object. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUShader * \sa SDL_CreateGPUGraphicsPipeline @@ -266,7 +266,7 @@ typedef struct SDL_GPUShader SDL_GPUShader; * * Used during compute passes. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUComputePipeline * \sa SDL_BindGPUComputePipeline @@ -279,7 +279,7 @@ typedef struct SDL_GPUComputePipeline SDL_GPUComputePipeline; * * Used during render passes. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline * \sa SDL_BindGPUGraphicsPipeline @@ -304,7 +304,7 @@ typedef struct SDL_GPUGraphicsPipeline SDL_GPUGraphicsPipeline; * In multi-threading scenarios, you should only access a command buffer on * the thread you acquired it from. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_AcquireGPUCommandBuffer * \sa SDL_SubmitGPUCommandBuffer @@ -318,7 +318,7 @@ typedef struct SDL_GPUCommandBuffer SDL_GPUCommandBuffer; * This handle is transient and should not be held or referenced after * SDL_EndGPURenderPass is called. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPURenderPass * \sa SDL_EndGPURenderPass @@ -331,7 +331,7 @@ typedef struct SDL_GPURenderPass SDL_GPURenderPass; * This handle is transient and should not be held or referenced after * SDL_EndGPUComputePass is called. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPUComputePass * \sa SDL_EndGPUComputePass @@ -344,7 +344,7 @@ typedef struct SDL_GPUComputePass SDL_GPUComputePass; * This handle is transient and should not be held or referenced after * SDL_EndGPUCopyPass is called. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPUCopyPass * \sa SDL_EndGPUCopyPass @@ -354,7 +354,7 @@ typedef struct SDL_GPUCopyPass SDL_GPUCopyPass; /** * An opaque handle representing a fence. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_SubmitGPUCommandBufferAndAcquireFence * \sa SDL_QueryGPUFence @@ -366,7 +366,7 @@ typedef struct SDL_GPUFence SDL_GPUFence; /** * Specifies the primitive topology of a graphics pipeline. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -383,7 +383,7 @@ typedef enum SDL_GPUPrimitiveType * Specifies how the contents of a texture attached to a render pass are * treated at the beginning of the render pass. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_BeginGPURenderPass */ @@ -398,7 +398,7 @@ typedef enum SDL_GPULoadOp * Specifies how the contents of a texture attached to a render pass are * treated at the end of the render pass. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_BeginGPURenderPass */ @@ -413,7 +413,7 @@ typedef enum SDL_GPUStoreOp /** * Specifies the size of elements in an index buffer. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -504,7 +504,7 @@ typedef enum SDL_GPUIndexElementSize * Unless D16_UNORM is sufficient for your purposes, always check which of * D24/D32 is supported before creating a depth-stencil texture! * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUTexture * \sa SDL_GPUTextureSupportsFormat @@ -650,7 +650,7 @@ typedef enum SDL_GPUTextureFormat * within a compute pass. Note that SIMULTANEOUS usage is only supported by a * limited number of texture formats. * - * \since This datatype is available since SDL 3.0.0 + * \since This datatype is available since SDL 3.1.3 * * \sa SDL_CreateGPUTexture */ @@ -667,7 +667,7 @@ typedef Uint32 SDL_GPUTextureUsageFlags; /** * Specifies the type of a texture. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUTexture */ @@ -686,7 +686,7 @@ typedef enum SDL_GPUTextureType * Used in multisampling. Note that this value only applies when the texture * is used as a render target. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUTexture * \sa SDL_GPUTextureSupportsSampleCount @@ -705,7 +705,7 @@ typedef enum SDL_GPUSampleCount * * Can be passed in as the layer field in texture-related structs. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 */ typedef enum SDL_GPUCubeMapFace { @@ -726,7 +726,7 @@ typedef enum SDL_GPUCubeMapFace * Unlike textures, READ | WRITE can be used for simultaneous read-write * usage. The same data synchronization concerns as textures apply. * - * \since This datatype is available since SDL 3.0.0 + * \since This datatype is available since SDL 3.1.3 * * \sa SDL_CreateGPUBuffer */ @@ -745,7 +745,7 @@ typedef Uint32 SDL_GPUBufferUsageFlags; * Note that mapping and copying FROM an upload transfer buffer or TO a * download transfer buffer is undefined behavior. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUTransferBuffer */ @@ -758,7 +758,7 @@ typedef enum SDL_GPUTransferBufferUsage /** * Specifies which stage a shader program corresponds to. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUShader */ @@ -773,7 +773,7 @@ typedef enum SDL_GPUShaderStage * * Each format corresponds to a specific backend that accepts it. * - * \since This datatype is available since SDL 3.0.0 + * \since This datatype is available since SDL 3.1.3 * * \sa SDL_CreateGPUShader */ @@ -790,7 +790,7 @@ typedef Uint32 SDL_GPUShaderFormat; /** * Specifies the format of a vertex attribute. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -856,7 +856,7 @@ typedef enum SDL_GPUVertexElementFormat /** * Specifies the rate at which vertex attributes are pulled from buffers. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -869,7 +869,7 @@ typedef enum SDL_GPUVertexInputRate /** * Specifies the fill mode of the graphics pipeline. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -882,7 +882,7 @@ typedef enum SDL_GPUFillMode /** * Specifies the facing direction in which triangle faces will be culled. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -897,7 +897,7 @@ typedef enum SDL_GPUCullMode * Specifies the vertex winding that will cause a triangle to be determined to * be front-facing. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -910,7 +910,7 @@ typedef enum SDL_GPUFrontFace /** * Specifies a comparison operator for depth, stencil and sampler operations. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -931,7 +931,7 @@ typedef enum SDL_GPUCompareOp * Specifies what happens to a stored stencil value if stencil tests fail or * pass. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -955,7 +955,7 @@ typedef enum SDL_GPUStencilOp * The source color is the value written by the fragment shader. The * destination color is the value currently existing in the texture. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -976,7 +976,7 @@ typedef enum SDL_GPUBlendOp * The source color is the value written by the fragment shader. The * destination color is the value currently existing in the texture. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -1001,7 +1001,7 @@ typedef enum SDL_GPUBlendFactor /** * Specifies which color components are written in a graphics pipeline. * - * \since This datatype is available since SDL 3.0.0 + * \since This datatype is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -1015,7 +1015,7 @@ typedef Uint8 SDL_GPUColorComponentFlags; /** * Specifies a filter operation used by a sampler. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUSampler */ @@ -1028,7 +1028,7 @@ typedef enum SDL_GPUFilter /** * Specifies a mipmap mode used by a sampler. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUSampler */ @@ -1042,7 +1042,7 @@ typedef enum SDL_GPUSamplerMipmapMode * Specifies behavior of texture sampling when the coordinates exceed the 0-1 * range. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_CreateGPUSampler */ @@ -1078,7 +1078,7 @@ typedef enum SDL_GPUSamplerAddressMode * this mode, AcquireGPUSwapchainTexture will return NULL if too many frames * are in flight. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_SetGPUSwapchainParameters * \sa SDL_WindowSupportsGPUPresentMode @@ -1110,7 +1110,7 @@ typedef enum SDL_GPUPresentMode * - HDR10_ST2048: A2R10G10B10 or A2B10G10R10 swapchain. Pixel values are in * PQ ST2048 encoding. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 * * \sa SDL_SetGPUSwapchainParameters * \sa SDL_WindowSupportsGPUSwapchainComposition @@ -1129,7 +1129,7 @@ typedef enum SDL_GPUSwapchainComposition /** * A structure specifying a viewport. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_SetGPUViewport */ @@ -1147,7 +1147,7 @@ typedef struct SDL_GPUViewport * A structure specifying parameters related to transferring data to or from a * texture. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_UploadToGPUTexture * \sa SDL_DownloadFromGPUTexture @@ -1165,7 +1165,7 @@ typedef struct SDL_GPUTextureTransferInfo * * Used when transferring buffer data to or from a transfer buffer. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_UploadToGPUBuffer * \sa SDL_DownloadFromGPUBuffer @@ -1181,7 +1181,7 @@ typedef struct SDL_GPUTransferBufferLocation * * Used when copying data from one texture to another. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CopyGPUTextureToTexture */ @@ -1200,7 +1200,7 @@ typedef struct SDL_GPUTextureLocation * * Used when transferring data to or from a texture. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_UploadToGPUTexture * \sa SDL_DownloadFromGPUTexture @@ -1221,7 +1221,7 @@ typedef struct SDL_GPUTextureRegion /** * A structure specifying a region of a texture used in the blit operation. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BlitGPUTexture */ @@ -1241,7 +1241,7 @@ typedef struct SDL_GPUBlitRegion * * Used when copying data between buffers. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CopyGPUBufferToBuffer */ @@ -1256,7 +1256,7 @@ typedef struct SDL_GPUBufferLocation * * Used when transferring data to or from buffers. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_UploadToGPUBuffer * \sa SDL_DownloadFromGPUBuffer @@ -1276,7 +1276,7 @@ typedef struct SDL_GPUBufferRegion * example, SV_VertexID). If your shader depends on these variables, the * correlating draw call parameter MUST be 0. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_DrawGPUPrimitivesIndirect */ @@ -1296,7 +1296,7 @@ typedef struct SDL_GPUIndirectDrawCommand * example, SV_VertexID). If your shader depends on these variables, the * correlating draw call parameter MUST be 0. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_DrawGPUIndexedPrimitivesIndirect */ @@ -1312,7 +1312,7 @@ typedef struct SDL_GPUIndexedIndirectDrawCommand /** * A structure specifying the parameters of an indexed dispatch command. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_DispatchGPUComputeIndirect */ @@ -1328,7 +1328,7 @@ typedef struct SDL_GPUIndirectDispatchCommand /** * A structure specifying the parameters of a sampler. * - * \since This function is available since SDL 3.0.0 + * \since This function is available since SDL 3.1.3 * * \sa SDL_CreateGPUSampler */ @@ -1366,7 +1366,7 @@ typedef struct SDL_GPUSamplerCreateInfo * SDL_GPUVertexAttribute. For example, if an attribute has a buffer_slot of * 0, then that attribute belongs to the vertex buffer bound at slot 0. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUVertexAttribute * \sa SDL_GPUVertexInputState @@ -1385,7 +1385,7 @@ typedef struct SDL_GPUVertexBufferDescription * All vertex attribute locations provided to an SDL_GPUVertexInputState must * be unique. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUVertexBufferDescription * \sa SDL_GPUVertexInputState @@ -1402,7 +1402,7 @@ typedef struct SDL_GPUVertexAttribute * A structure specifying the parameters of a graphics pipeline vertex input * state. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUGraphicsPipelineCreateInfo */ @@ -1417,7 +1417,7 @@ typedef struct SDL_GPUVertexInputState /** * A structure specifying the stencil operation state of a graphics pipeline. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUDepthStencilState */ @@ -1432,7 +1432,7 @@ typedef struct SDL_GPUStencilOpState /** * A structure specifying the blend state of a color target. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUColorTargetDescription */ @@ -1455,7 +1455,7 @@ typedef struct SDL_GPUColorTargetBlendState /** * A structure specifying code and metadata for creating a shader object. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUShader */ @@ -1481,7 +1481,7 @@ typedef struct SDL_GPUShaderCreateInfo * that certain usage combinations are invalid, for example SAMPLER and * GRAPHICS_STORAGE. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUTexture */ @@ -1512,7 +1512,7 @@ typedef struct SDL_GPUTextureCreateInfo * Usage flags can be bitwise OR'd together for combinations of usages. Note * that certain combinations are invalid, for example VERTEX and INDEX. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUBuffer */ @@ -1527,7 +1527,7 @@ typedef struct SDL_GPUBufferCreateInfo /** * A structure specifying the parameters of a transfer buffer. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUTransferBuffer */ @@ -1550,7 +1550,7 @@ typedef struct SDL_GPUTransferBufferCreateInfo * consider enabling depth clip and then manually clamping depth in your * fragment shaders on Metal and Vulkan. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUGraphicsPipelineCreateInfo */ @@ -1572,7 +1572,7 @@ typedef struct SDL_GPURasterizerState * A structure specifying the parameters of the graphics pipeline multisample * state. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUGraphicsPipelineCreateInfo */ @@ -1590,7 +1590,7 @@ typedef struct SDL_GPUMultisampleState * A structure specifying the parameters of the graphics pipeline depth * stencil state. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUGraphicsPipelineCreateInfo */ @@ -1613,7 +1613,7 @@ typedef struct SDL_GPUDepthStencilState * A structure specifying the parameters of color targets used in a graphics * pipeline. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUGraphicsPipelineTargetInfo */ @@ -1627,7 +1627,7 @@ typedef struct SDL_GPUColorTargetDescription * A structure specifying the descriptions of render targets used in a * graphics pipeline. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_GPUGraphicsPipelineCreateInfo */ @@ -1645,7 +1645,7 @@ typedef struct SDL_GPUGraphicsPipelineTargetInfo /** * A structure specifying the parameters of a graphics pipeline state. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUGraphicsPipeline */ @@ -1666,7 +1666,7 @@ typedef struct SDL_GPUGraphicsPipelineCreateInfo /** * A structure specifying the parameters of a compute pipeline state. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_CreateGPUComputePipeline */ @@ -1720,7 +1720,7 @@ typedef struct SDL_GPUComputePipelineCreateInfo * stores the multisample texture's contents. Not recommended as it requires * significant memory bandwidth. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPURenderPass */ @@ -1781,7 +1781,7 @@ typedef struct SDL_GPUColorTargetInfo * * Note that depth/stencil targets do not support multisample resolves. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPURenderPass */ @@ -1802,7 +1802,7 @@ typedef struct SDL_GPUDepthStencilTargetInfo /** * A structure containing parameters for a blit command. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BlitGPUTexture */ @@ -1824,7 +1824,7 @@ typedef struct SDL_GPUBlitInfo { /** * A structure specifying parameters in a buffer binding call. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BindGPUVertexBuffers * \sa SDL_BindGPUIndexBuffers @@ -1838,7 +1838,7 @@ typedef struct SDL_GPUBufferBinding /** * A structure specifying parameters in a sampler binding call. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BindGPUVertexSamplers * \sa SDL_BindGPUFragmentSamplers @@ -1853,7 +1853,7 @@ typedef struct SDL_GPUTextureSamplerBinding * A structure specifying parameters related to binding buffers in a compute * pass. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPUComputePass */ @@ -1870,7 +1870,7 @@ typedef struct SDL_GPUStorageBufferReadWriteBinding * A structure specifying parameters related to binding textures in a compute * pass. * - * \since This struct is available since SDL 3.0.0 + * \since This struct is available since SDL 3.1.3 * * \sa SDL_BeginGPUComputePass */ @@ -1898,7 +1898,7 @@ typedef struct SDL_GPUStorageTextureReadWriteBinding * driver. * \returns true if supported, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateGPUDevice */ @@ -1912,7 +1912,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GPUSupportsShaderFormats( * \param props the properties to use. * \returns true if supported, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateGPUDeviceWithProperties */ @@ -1930,7 +1930,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GPUSupportsProperties( * \returns a GPU context on success or NULL 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. * * \sa SDL_GetGPUShaderFormats * \sa SDL_GetGPUDeviceDriver @@ -1978,7 +1978,7 @@ extern SDL_DECLSPEC SDL_GPUDevice *SDLCALL SDL_CreateGPUDevice( * \returns a GPU context on success or NULL 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. * * \sa SDL_GetGPUShaderFormats * \sa SDL_GetGPUDeviceDriver @@ -2004,7 +2004,7 @@ extern SDL_DECLSPEC SDL_GPUDevice *SDLCALL SDL_CreateGPUDeviceWithProperties( * * \param device a GPU Context to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateGPUDevice */ @@ -2015,7 +2015,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyGPUDevice(SDL_GPUDevice *device); * * \returns the number of built in GPU drivers. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGPUDriver */ @@ -2034,7 +2034,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumGPUDrivers(void); * \param index the index of a GPU driver. * \returns the name of the GPU driver with the given **index**. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetNumGPUDrivers */ @@ -2046,7 +2046,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGPUDriver(int index); * \param device a GPU context to query. * \returns the name of the device's driver, or NULL on error. * - * \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_GetGPUDeviceDriver(SDL_GPUDevice *device); @@ -2057,7 +2057,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGPUDeviceDriver(SDL_GPUDevice *d * \returns a bitflag indicating which shader formats the driver is able to * consume. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUDevice *device); @@ -2105,7 +2105,7 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD * \returns a compute pipeline object on success, or NULL 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. * * \sa SDL_BindGPUComputePipeline * \sa SDL_ReleaseGPUComputePipeline @@ -2123,7 +2123,7 @@ extern SDL_DECLSPEC SDL_GPUComputePipeline *SDLCALL SDL_CreateGPUComputePipeline * \returns a graphics pipeline object on success, or NULL 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. * * \sa SDL_CreateGPUShader * \sa SDL_BindGPUGraphicsPipeline @@ -2142,7 +2142,7 @@ extern SDL_DECLSPEC SDL_GPUGraphicsPipeline *SDLCALL SDL_CreateGPUGraphicsPipeli * \returns a sampler object on success, or NULL 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. * * \sa SDL_BindGPUVertexSamplers * \sa SDL_BindGPUFragmentSamplers @@ -2212,7 +2212,7 @@ extern SDL_DECLSPEC SDL_GPUSampler *SDLCALL SDL_CreateGPUSampler( * \returns a shader object on success, or NULL 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. * * \sa SDL_CreateGPUGraphicsPipeline * \sa SDL_ReleaseGPUShader @@ -2239,7 +2239,7 @@ extern SDL_DECLSPEC SDL_GPUShader *SDLCALL SDL_CreateGPUShader( * \returns a texture object on success, or NULL 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. * * \sa SDL_UploadToGPUTexture * \sa SDL_DownloadFromGPUTexture @@ -2270,7 +2270,7 @@ extern SDL_DECLSPEC SDL_GPUTexture *SDLCALL SDL_CreateGPUTexture( * \returns a buffer object on success, or NULL 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. * * \sa SDL_SetGPUBufferName * \sa SDL_UploadToGPUBuffer @@ -2300,7 +2300,7 @@ extern SDL_DECLSPEC SDL_GPUBuffer *SDLCALL SDL_CreateGPUBuffer( * \returns a transfer buffer on success, or NULL 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. * * \sa SDL_UploadToGPUBuffer * \sa SDL_DownloadFromGPUBuffer @@ -2323,7 +2323,7 @@ extern SDL_DECLSPEC SDL_GPUTransferBuffer *SDLCALL SDL_CreateGPUTransferBuffer( * \param buffer a buffer to attach the name to. * \param text a UTF-8 string constant to mark as the name of the buffer. * - * \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_SetGPUBufferName( SDL_GPUDevice *device, @@ -2339,7 +2339,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUBufferName( * \param texture a texture to attach the name to. * \param text a UTF-8 string constant to mark as the name of the texture. * - * \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_SetGPUTextureName( SDL_GPUDevice *device, @@ -2354,7 +2354,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUTextureName( * \param command_buffer a command buffer. * \param text a UTF-8 string constant to insert as the label. * - * \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_InsertGPUDebugLabel( SDL_GPUCommandBuffer *command_buffer, @@ -2377,7 +2377,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_InsertGPUDebugLabel( * \param command_buffer a command buffer. * \param name a UTF-8 string constant that names the group. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PopGPUDebugGroup */ @@ -2390,7 +2390,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PushGPUDebugGroup( * * \param command_buffer a command buffer. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PushGPUDebugGroup */ @@ -2407,7 +2407,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PopGPUDebugGroup( * \param device a GPU context. * \param texture a texture to be destroyed. * - * \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_ReleaseGPUTexture( SDL_GPUDevice *device, @@ -2421,7 +2421,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUTexture( * \param device a GPU context. * \param sampler a sampler to be destroyed. * - * \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_ReleaseGPUSampler( SDL_GPUDevice *device, @@ -2435,7 +2435,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUSampler( * \param device a GPU context. * \param buffer a buffer to be destroyed. * - * \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_ReleaseGPUBuffer( SDL_GPUDevice *device, @@ -2449,7 +2449,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUBuffer( * \param device a GPU context. * \param transfer_buffer a transfer buffer to be destroyed. * - * \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_ReleaseGPUTransferBuffer( SDL_GPUDevice *device, @@ -2463,7 +2463,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUTransferBuffer( * \param device a GPU context. * \param compute_pipeline a compute pipeline to be destroyed. * - * \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_ReleaseGPUComputePipeline( SDL_GPUDevice *device, @@ -2477,7 +2477,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUComputePipeline( * \param device a GPU context. * \param shader a shader to be destroyed. * - * \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_ReleaseGPUShader( SDL_GPUDevice *device, @@ -2491,7 +2491,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUShader( * \param device a GPU context. * \param graphics_pipeline a graphics pipeline to be destroyed. * - * \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_ReleaseGPUGraphicsPipeline( SDL_GPUDevice *device, @@ -2509,7 +2509,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUGraphicsPipeline( * \returns a command buffer, or NULL 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. * * \sa SDL_SubmitGPUCommandBuffer * \sa SDL_SubmitGPUCommandBufferAndAcquireFence @@ -2547,7 +2547,7 @@ extern SDL_DECLSPEC SDL_GPUCommandBuffer *SDLCALL SDL_AcquireGPUCommandBuffer( * \param data client data to write. * \param length the length of the data to write. * - * \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_PushGPUVertexUniformData( SDL_GPUCommandBuffer *command_buffer, @@ -2565,7 +2565,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PushGPUVertexUniformData( * \param data client data to write. * \param length the length of the data to write. * - * \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_PushGPUFragmentUniformData( SDL_GPUCommandBuffer *command_buffer, @@ -2583,7 +2583,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PushGPUFragmentUniformData( * \param data client data to write. * \param length the length of the data to write. * - * \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_PushGPUComputeUniformData( SDL_GPUCommandBuffer *command_buffer, @@ -2653,7 +2653,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PushGPUComputeUniformData( * NULL. * \returns a render pass handle. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_EndGPURenderPass */ @@ -2671,7 +2671,7 @@ extern SDL_DECLSPEC SDL_GPURenderPass *SDLCALL SDL_BeginGPURenderPass( * \param render_pass a render pass handle. * \param graphics_pipeline the graphics pipeline to bind. * - * \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_BindGPUGraphicsPipeline( SDL_GPURenderPass *render_pass, @@ -2683,7 +2683,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUGraphicsPipeline( * \param render_pass a render pass handle. * \param viewport the viewport to set. * - * \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_SetGPUViewport( SDL_GPURenderPass *render_pass, @@ -2695,7 +2695,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUViewport( * \param render_pass a render pass handle. * \param scissor the scissor area to set. * - * \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_SetGPUScissor( SDL_GPURenderPass *render_pass, @@ -2707,7 +2707,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUScissor( * \param render_pass a render pass handle. * \param blend_constants the blend constant color. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GPU_BLENDFACTOR_CONSTANT_COLOR * \sa SDL_GPU_BLENDFACTOR_ONE_MINUS_CONSTANT_COLOR @@ -2722,7 +2722,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUBlendConstants( * \param render_pass a render pass handle. * \param reference the stencil reference value to set. * - * \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_SetGPUStencilReference( SDL_GPURenderPass *render_pass, @@ -2738,7 +2738,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUStencilReference( * buffers and offset values. * \param num_bindings the number of bindings in the bindings array. * - * \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_BindGPUVertexBuffers( SDL_GPURenderPass *render_pass, @@ -2755,7 +2755,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUVertexBuffers( * \param index_element_size whether the index values in the buffer are 16- or * 32-bit. * - * \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_BindGPUIndexBuffer( SDL_GPURenderPass *render_pass, @@ -2774,7 +2774,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUIndexBuffer( * \param num_bindings the number of texture-sampler pairs to bind from the * array. * - * \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_BindGPUVertexSamplers( SDL_GPURenderPass *render_pass, @@ -2793,7 +2793,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUVertexSamplers( * \param storage_textures an array of storage textures. * \param num_bindings the number of storage texture to bind from the array. * - * \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_BindGPUVertexStorageTextures( SDL_GPURenderPass *render_pass, @@ -2812,7 +2812,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUVertexStorageTextures( * \param storage_buffers an array of buffers. * \param num_bindings the number of buffers to bind from the array. * - * \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_BindGPUVertexStorageBuffers( SDL_GPURenderPass *render_pass, @@ -2832,7 +2832,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUVertexStorageBuffers( * \param num_bindings the number of texture-sampler pairs to bind from the * array. * - * \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_BindGPUFragmentSamplers( SDL_GPURenderPass *render_pass, @@ -2851,7 +2851,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUFragmentSamplers( * \param storage_textures an array of storage textures. * \param num_bindings the number of storage textures to bind from the array. * - * \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_BindGPUFragmentStorageTextures( SDL_GPURenderPass *render_pass, @@ -2870,7 +2870,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUFragmentStorageTextures( * \param storage_buffers an array of storage buffers. * \param num_bindings the number of storage buffers to bind from the array. * - * \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_BindGPUFragmentStorageBuffers( SDL_GPURenderPass *render_pass, @@ -2899,7 +2899,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUFragmentStorageBuffers( * vertex buffer. * \param first_instance the ID of the first instance to draw. * - * \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_DrawGPUIndexedPrimitives( SDL_GPURenderPass *render_pass, @@ -2925,7 +2925,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DrawGPUIndexedPrimitives( * \param first_vertex the index of the first vertex to draw. * \param first_instance the ID of the first instance to draw. * - * \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_DrawGPUPrimitives( SDL_GPURenderPass *render_pass, @@ -2948,7 +2948,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DrawGPUPrimitives( * \param draw_count the number of draw parameter sets that should be read * from the draw buffer. * - * \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_DrawGPUPrimitivesIndirect( SDL_GPURenderPass *render_pass, @@ -2970,7 +2970,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DrawGPUPrimitivesIndirect( * \param draw_count the number of draw parameter sets that should be read * from the draw buffer. * - * \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_DrawGPUIndexedPrimitivesIndirect( SDL_GPURenderPass *render_pass, @@ -2986,7 +2986,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DrawGPUIndexedPrimitivesIndirect( * * \param render_pass a render pass handle. * - * \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_EndGPURenderPass( SDL_GPURenderPass *render_pass); @@ -3026,7 +3026,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_EndGPURenderPass( * from the array. * \returns a compute pass handle. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_EndGPUComputePass */ @@ -3043,7 +3043,7 @@ extern SDL_DECLSPEC SDL_GPUComputePass *SDLCALL SDL_BeginGPUComputePass( * \param compute_pass a compute pass handle. * \param compute_pipeline a compute pipeline to bind. * - * \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_BindGPUComputePipeline( SDL_GPUComputePass *compute_pass, @@ -3061,7 +3061,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUComputePipeline( * \param num_bindings the number of texture-sampler bindings to bind from the * array. * - * \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_BindGPUComputeSamplers( SDL_GPUComputePass *compute_pass, @@ -3080,7 +3080,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUComputeSamplers( * \param storage_textures an array of storage textures. * \param num_bindings the number of storage textures to bind from the array. * - * \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_BindGPUComputeStorageTextures( SDL_GPUComputePass *compute_pass, @@ -3099,7 +3099,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUComputeStorageTextures( * \param storage_buffers an array of storage buffer binding structs. * \param num_bindings the number of storage buffers to bind from the array. * - * \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_BindGPUComputeStorageBuffers( SDL_GPUComputePass *compute_pass, @@ -3125,7 +3125,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUComputeStorageBuffers( * \param groupcount_z number of local workgroups to dispatch in the Z * dimension. * - * \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_DispatchGPUCompute( SDL_GPUComputePass *compute_pass, @@ -3149,7 +3149,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DispatchGPUCompute( * \param buffer a buffer containing dispatch parameters. * \param offset the offset to start reading from the dispatch buffer. * - * \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_DispatchGPUComputeIndirect( SDL_GPUComputePass *compute_pass, @@ -3164,7 +3164,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DispatchGPUComputeIndirect( * * \param compute_pass a compute pass handle. * - * \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_EndGPUComputePass( SDL_GPUComputePass *compute_pass); @@ -3182,7 +3182,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_EndGPUComputePass( * \returns the address of the mapped transfer buffer memory, or NULL 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 void *SDLCALL SDL_MapGPUTransferBuffer( SDL_GPUDevice *device, @@ -3195,7 +3195,7 @@ extern SDL_DECLSPEC void *SDLCALL SDL_MapGPUTransferBuffer( * \param device a GPU context. * \param transfer_buffer a previously mapped transfer buffer. * - * \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_UnmapGPUTransferBuffer( SDL_GPUDevice *device, @@ -3213,7 +3213,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnmapGPUTransferBuffer( * \param command_buffer a command buffer. * \returns a copy pass handle. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_GPUCopyPass *SDLCALL SDL_BeginGPUCopyPass( SDL_GPUCommandBuffer *command_buffer); @@ -3233,7 +3233,7 @@ extern SDL_DECLSPEC SDL_GPUCopyPass *SDLCALL SDL_BeginGPUCopyPass( * \param cycle if true, cycles the texture if the texture is bound, otherwise * overwrites the data. * - * \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_UploadToGPUTexture( SDL_GPUCopyPass *copy_pass, @@ -3255,7 +3255,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UploadToGPUTexture( * \param cycle if true, cycles the buffer if it is already bound, otherwise * overwrites the data. * - * \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_UploadToGPUBuffer( SDL_GPUCopyPass *copy_pass, @@ -3278,7 +3278,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UploadToGPUBuffer( * \param cycle if true, cycles the destination texture if the destination * texture is bound, otherwise overwrites the data. * - * \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_CopyGPUTextureToTexture( SDL_GPUCopyPass *copy_pass, @@ -3304,7 +3304,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CopyGPUTextureToTexture( * \param cycle if true, cycles the destination buffer if it is already bound, * otherwise overwrites the data. * - * \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_CopyGPUBufferToBuffer( SDL_GPUCopyPass *copy_pass, @@ -3324,7 +3324,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CopyGPUBufferToBuffer( * \param destination the destination transfer buffer with image layout * information. * - * \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_DownloadFromGPUTexture( SDL_GPUCopyPass *copy_pass, @@ -3341,7 +3341,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DownloadFromGPUTexture( * \param source the source buffer with offset and size. * \param destination the destination transfer buffer with offset. * - * \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_DownloadFromGPUBuffer( SDL_GPUCopyPass *copy_pass, @@ -3353,7 +3353,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DownloadFromGPUBuffer( * * \param copy_pass a copy pass handle. * - * \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_EndGPUCopyPass( SDL_GPUCopyPass *copy_pass); @@ -3366,7 +3366,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_EndGPUCopyPass( * \param command_buffer a command_buffer. * \param texture a texture with more than 1 mip level. * - * \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_GenerateMipmapsForGPUTexture( SDL_GPUCommandBuffer *command_buffer, @@ -3380,7 +3380,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GenerateMipmapsForGPUTexture( * \param command_buffer a command buffer. * \param info the blit info struct containing the blit parameters. * - * \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_BlitGPUTexture( SDL_GPUCommandBuffer *command_buffer, @@ -3398,7 +3398,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BlitGPUTexture( * \param swapchain_composition the swapchain composition to check. * \returns true if supported, false if unsupported. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ClaimWindowForGPUDevice */ @@ -3417,7 +3417,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WindowSupportsGPUSwapchainComposition( * \param present_mode the presentation mode to check. * \returns true if supported, false if unsupported. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ClaimWindowForGPUDevice */ @@ -3443,7 +3443,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WindowSupportsGPUPresentMode( * \returns true on success, or false 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. * * \sa SDL_AcquireGPUSwapchainTexture * \sa SDL_ReleaseWindowFromGPUDevice @@ -3460,7 +3460,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClaimWindowForGPUDevice( * \param device a GPU context. * \param window an SDL_Window that has been claimed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ClaimWindowForGPUDevice */ @@ -3486,7 +3486,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseWindowFromGPUDevice( * \returns true if successful, false on error; 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. * * \sa SDL_WindowSupportsGPUPresentMode * \sa SDL_WindowSupportsGPUSwapchainComposition @@ -3506,7 +3506,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGPUSwapchainParameters( * \param window an SDL_Window that has been claimed. * \returns the texture format of the swapchain. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_GPUTextureFormat SDLCALL SDL_GetGPUSwapchainTextureFormat( SDL_GPUDevice *device, @@ -3537,7 +3537,7 @@ extern SDL_DECLSPEC SDL_GPUTextureFormat SDLCALL SDL_GetGPUSwapchainTextureForma * \returns true on success, false on error; 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. * * \sa SDL_ClaimWindowForGPUDevice * \sa SDL_SubmitGPUCommandBuffer @@ -3565,7 +3565,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AcquireGPUSwapchainTexture( * \returns true on success, false 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. * * \sa SDL_AcquireGPUCommandBuffer * \sa SDL_AcquireGPUSwapchainTexture @@ -3590,7 +3590,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SubmitGPUCommandBuffer( * \returns a fence associated with the command buffer, or NULL 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. * * \sa SDL_AcquireGPUCommandBuffer * \sa SDL_AcquireGPUSwapchainTexture @@ -3607,7 +3607,7 @@ extern SDL_DECLSPEC SDL_GPUFence *SDLCALL SDL_SubmitGPUCommandBufferAndAcquireFe * \returns true on success, false 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. * * \sa SDL_WaitForGPUFences */ @@ -3625,7 +3625,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitForGPUIdle( * \returns true on success, false 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. * * \sa SDL_SubmitGPUCommandBufferAndAcquireFence * \sa SDL_WaitForGPUIdle @@ -3643,7 +3643,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitForGPUFences( * \param fence a fence. * \returns true if the fence is signaled, false if it is not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SubmitGPUCommandBufferAndAcquireFence */ @@ -3657,7 +3657,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_QueryGPUFence( * \param device a GPU context. * \param fence a fence. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SubmitGPUCommandBufferAndAcquireFence */ @@ -3673,7 +3673,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseGPUFence( * \param format the texture format you want to know the texel size of. * \returns the texel block size of the texture format. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_UploadToGPUTexture */ @@ -3690,7 +3690,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GPUTextureFormatTexelBlockSize( * \param usage a bitmask of all usage scenarios to check. * \returns whether the texture format is supported for this type and usage. * - * \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_GPUTextureSupportsFormat( SDL_GPUDevice *device, @@ -3706,7 +3706,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GPUTextureSupportsFormat( * \param sample_count the sample count to check. * \returns a hardware-specific version of min(preferred, possible). * - * \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_GPUTextureSupportsSampleCount( SDL_GPUDevice *device, @@ -3722,7 +3722,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GPUTextureSupportsSampleCount( * \param depth_or_layer_count depth for 3D textures or layer count otherwise. * \returns the size of a texture with this format and dimensions. * - * \since This function is available since SDL 3.1.4. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint32 SDLCALL SDL_CalculateGPUTextureFormatSize( SDL_GPUTextureFormat format, @@ -3741,7 +3741,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_CalculateGPUTextureFormatSize( * * \param device a GPU context. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddEventWatch */ @@ -3756,7 +3756,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GDKSuspendGPU(SDL_GPUDevice *device); * * \param device a GPU context. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddEventWatch */ diff --git a/include/SDL3/SDL_guid.h b/include/SDL3/SDL_guid.h index d45a3c365..7806d835c 100644 --- a/include/SDL3/SDL_guid.h +++ b/include/SDL3/SDL_guid.h @@ -54,7 +54,7 @@ extern "C" { * GUIDs may be platform-dependent (i.e., the same device may report different * GUIDs on different operating systems). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_GUID { Uint8 data[16]; @@ -69,7 +69,7 @@ typedef struct SDL_GUID { * \param pszGUID buffer in which to write the ASCII string. * \param cbGUID the size of pszGUID, should be at least 33 bytes. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_StringToGUID */ @@ -85,7 +85,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GUIDToString(SDL_GUID guid, char *pszGUID, * \param pchGUID string containing an ASCII representation of a GUID. * \returns a SDL_GUID structure. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GUIDToString */ diff --git a/include/SDL3/SDL_haptic.h b/include/SDL3/SDL_haptic.h index 58b5b1c99..c123cd90c 100644 --- a/include/SDL3/SDL_haptic.h +++ b/include/SDL3/SDL_haptic.h @@ -141,7 +141,7 @@ extern "C" { /** * The haptic structure used to identify an SDL haptic. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_OpenHaptic * \sa SDL_OpenHapticFromJoystick @@ -167,7 +167,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Constant haptic effect. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticCondition */ @@ -178,7 +178,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Periodic haptic effect that simulates sine waves. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticPeriodic */ @@ -189,7 +189,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Periodic haptic effect that simulates square waves. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticPeriodic */ @@ -200,7 +200,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Periodic haptic effect that simulates triangular waves. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticPeriodic */ @@ -211,7 +211,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Periodic haptic effect that simulates saw tooth up waves. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticPeriodic */ @@ -222,7 +222,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Periodic haptic effect that simulates saw tooth down waves. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticPeriodic */ @@ -233,7 +233,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Ramp haptic effect. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticRamp */ @@ -245,7 +245,7 @@ typedef struct SDL_Haptic SDL_Haptic; * Condition haptic effect that simulates a spring. Effect is based on the * axes position. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticCondition */ @@ -257,7 +257,7 @@ typedef struct SDL_Haptic SDL_Haptic; * Condition haptic effect that simulates dampening. Effect is based on the * axes velocity. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticCondition */ @@ -269,7 +269,7 @@ typedef struct SDL_Haptic SDL_Haptic; * Condition haptic effect that simulates inertia. Effect is based on the axes * acceleration. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticCondition */ @@ -281,7 +281,7 @@ typedef struct SDL_Haptic SDL_Haptic; * Condition haptic effect that simulates friction. Effect is based on the * axes movement. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticCondition */ @@ -292,7 +292,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Haptic effect for direct control over high/low frequency motors. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticLeftRight */ @@ -301,7 +301,7 @@ typedef struct SDL_Haptic SDL_Haptic; /** * Reserved for future use * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_HAPTIC_RESERVED1 (1u<<12) #define SDL_HAPTIC_RESERVED2 (1u<<13) @@ -312,7 +312,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * User defined custom haptic effect. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_HAPTIC_CUSTOM (1u<<15) @@ -325,7 +325,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Device supports setting the global gain. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_SetHapticGain */ @@ -336,7 +336,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Device supports setting autocenter. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_SetHapticAutocenter */ @@ -347,7 +347,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Device supports querying effect status. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_GetHapticEffectStatus */ @@ -358,7 +358,7 @@ typedef struct SDL_Haptic SDL_Haptic; * * Devices supports being paused. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PauseHaptic * \sa SDL_ResumeHaptic @@ -374,7 +374,7 @@ typedef struct SDL_Haptic SDL_Haptic; /** * Uses polar coordinates for the direction. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticDirection */ @@ -383,7 +383,7 @@ typedef struct SDL_Haptic SDL_Haptic; /** * Uses cartesian coordinates for the direction. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticDirection */ @@ -392,7 +392,7 @@ typedef struct SDL_Haptic SDL_Haptic; /** * Uses spherical coordinates for the direction. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticDirection */ @@ -404,7 +404,7 @@ typedef struct SDL_Haptic SDL_Haptic; * This provides better compatibility across platforms and devices as SDL will * guess the correct axis. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_HapticDirection */ @@ -421,7 +421,7 @@ typedef struct SDL_Haptic SDL_Haptic; /** * Used to play a device an infinite number of times. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_RunHapticEffect */ @@ -522,7 +522,7 @@ typedef struct SDL_Haptic SDL_Haptic; * direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters. * ``` * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HAPTIC_POLAR * \sa SDL_HAPTIC_CARTESIAN @@ -546,7 +546,7 @@ typedef struct SDL_HapticDirection * A constant effect applies a constant force in the specified direction to * the joystick. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HAPTIC_CONSTANT * \sa SDL_HapticEffect @@ -628,7 +628,7 @@ typedef struct SDL_HapticConstant * \| \| \| \| \| \| \| * ``` * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HAPTIC_SINE * \sa SDL_HAPTIC_SQUARE @@ -684,7 +684,7 @@ typedef struct SDL_HapticPeriodic * SDL_HapticDirection diagram for which side is positive and which is * negative. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HapticDirection * \sa SDL_HAPTIC_SPRING @@ -727,7 +727,7 @@ typedef struct SDL_HapticCondition * effects get added to the ramp effect making the effect become quadratic * instead of linear. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HAPTIC_RAMP * \sa SDL_HapticEffect @@ -766,7 +766,7 @@ typedef struct SDL_HapticRamp * motors, commonly found in modern game controllers. The small (right) motor * is high frequency, and the large (left) motor is low frequency. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HAPTIC_LEFTRIGHT * \sa SDL_HapticEffect @@ -796,7 +796,7 @@ typedef struct SDL_HapticLeftRight * If channels is one, the effect is rotated using the defined direction. * Otherwise it uses the samples in data for the different axes. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HAPTIC_CUSTOM * \sa SDL_HapticEffect @@ -891,7 +891,7 @@ typedef struct SDL_HapticCustom * Note either the attack_level or the fade_level may be above the actual * effect level. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_HapticConstant * \sa SDL_HapticPeriodic @@ -920,7 +920,7 @@ typedef union SDL_HapticEffect * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_HapticID; @@ -936,7 +936,7 @@ typedef Uint32 SDL_HapticID; * failure; call SDL_GetError() for more information. This should be * freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenHaptic */ @@ -952,7 +952,7 @@ extern SDL_DECLSPEC SDL_HapticID * SDLCALL SDL_GetHaptics(int *count); * this function returns NULL; 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. * * \sa SDL_GetHapticName * \sa SDL_OpenHaptic @@ -973,7 +973,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetHapticNameForID(SDL_HapticID ins * \returns the device identifier or NULL 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. * * \sa SDL_CloseHaptic * \sa SDL_GetHaptics @@ -992,7 +992,7 @@ extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHaptic(SDL_HapticID instance_id * \returns an SDL_Haptic on success or NULL on failure or if it hasn't been * opened yet; 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_Haptic * SDLCALL SDL_GetHapticFromID(SDL_HapticID instance_id); @@ -1003,7 +1003,7 @@ extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_GetHapticFromID(SDL_HapticID instan * \returns the instance ID of the specified haptic device 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_HapticID SDLCALL SDL_GetHapticID(SDL_Haptic *haptic); @@ -1015,7 +1015,7 @@ extern SDL_DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticID(SDL_Haptic *haptic); * this function returns NULL; 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. * * \sa SDL_GetHapticNameForID */ @@ -1026,7 +1026,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetHapticName(SDL_Haptic *haptic); * * \returns true if the mouse is haptic or false if it isn't. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenHapticFromMouse */ @@ -1038,7 +1038,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsMouseHaptic(void); * \returns the haptic device identifier or NULL 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. * * \sa SDL_CloseHaptic * \sa SDL_IsMouseHaptic @@ -1051,7 +1051,7 @@ extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHapticFromMouse(void); * \param joystick the SDL_Joystick to test for haptic capabilities. * \returns true if the joystick is haptic or false if it isn't. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenHapticFromJoystick */ @@ -1072,7 +1072,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsJoystickHaptic(SDL_Joystick *joystick); * \returns a valid haptic device identifier on success or NULL 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. * * \sa SDL_CloseHaptic * \sa SDL_IsJoystickHaptic @@ -1084,7 +1084,7 @@ extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHapticFromJoystick(SDL_Joystick * * \param haptic the SDL_Haptic device to close. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenHaptic */ @@ -1101,7 +1101,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseHaptic(SDL_Haptic *haptic); * \returns the number of effects the haptic device can store or a negative * error code 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. * * \sa SDL_GetMaxHapticEffectsPlaying * \sa SDL_GetHapticFeatures @@ -1117,7 +1117,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetMaxHapticEffects(SDL_Haptic *haptic); * \returns the number of effects the haptic device can play at the same time * or -1 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. * * \sa SDL_GetMaxHapticEffects * \sa SDL_GetHapticFeatures @@ -1131,7 +1131,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetMaxHapticEffectsPlaying(SDL_Haptic *hapti * \returns a list of supported haptic features in bitwise manner (OR'd), 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. * * \sa SDL_HapticEffectSupported * \sa SDL_GetMaxHapticEffects @@ -1148,7 +1148,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetHapticFeatures(SDL_Haptic *haptic); * \returns the number of axes on success or -1 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 int SDLCALL SDL_GetNumHapticAxes(SDL_Haptic *haptic); @@ -1159,7 +1159,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumHapticAxes(SDL_Haptic *haptic); * \param effect the desired effect to query. * \returns true if the effect is supported or false if it isn't. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateHapticEffect * \sa SDL_GetHapticFeatures @@ -1175,7 +1175,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HapticEffectSupported(SDL_Haptic *haptic, c * \returns the ID of the effect on success or -1 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. * * \sa SDL_DestroyHapticEffect * \sa SDL_RunHapticEffect @@ -1198,7 +1198,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_CreateHapticEffect(SDL_Haptic *haptic, const * \returns true on success or false 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. * * \sa SDL_CreateHapticEffect * \sa SDL_RunHapticEffect @@ -1221,7 +1221,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateHapticEffect(SDL_Haptic *haptic, int * \returns true on success or false 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. * * \sa SDL_GetHapticEffectStatus * \sa SDL_StopHapticEffect @@ -1237,7 +1237,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RunHapticEffect(SDL_Haptic *haptic, int eff * \returns true on success or false 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. * * \sa SDL_RunHapticEffect * \sa SDL_StopHapticEffects @@ -1253,7 +1253,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StopHapticEffect(SDL_Haptic *haptic, int ef * \param haptic the SDL_Haptic device to destroy the effect on. * \param effect the ID of the haptic effect to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateHapticEffect */ @@ -1269,7 +1269,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyHapticEffect(SDL_Haptic *haptic, int * \returns true if it is playing, false if it isn't playing or haptic status * isn't supported. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetHapticFeatures */ @@ -1291,7 +1291,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetHapticEffectStatus(SDL_Haptic *haptic, i * \returns true on success or false 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. * * \sa SDL_GetHapticFeatures */ @@ -1310,7 +1310,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetHapticGain(SDL_Haptic *haptic, int gain) * \returns true on success or false 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. * * \sa SDL_GetHapticFeatures */ @@ -1329,7 +1329,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetHapticAutocenter(SDL_Haptic *haptic, int * \returns true on success or false 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. * * \sa SDL_ResumeHaptic */ @@ -1344,7 +1344,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseHaptic(SDL_Haptic *haptic); * \returns true on success or false 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. * * \sa SDL_PauseHaptic */ @@ -1357,7 +1357,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeHaptic(SDL_Haptic *haptic); * \returns true on success or false 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. * * \sa SDL_RunHapticEffect * \sa SDL_StopHapticEffects @@ -1370,7 +1370,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StopHapticEffects(SDL_Haptic *haptic); * \param haptic haptic device to check for rumble support. * \returns true if the effect is supported or false if it isn't. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_InitHapticRumble */ @@ -1383,7 +1383,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *haptic); * \returns true on success or false 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. * * \sa SDL_PlayHapticRumble * \sa SDL_StopHapticRumble @@ -1400,7 +1400,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_InitHapticRumble(SDL_Haptic *haptic); * \returns true on success or false 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. * * \sa SDL_InitHapticRumble * \sa SDL_StopHapticRumble @@ -1414,7 +1414,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PlayHapticRumble(SDL_Haptic *haptic, float * \returns true on success or false 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. * * \sa SDL_PlayHapticRumble */ diff --git a/include/SDL3/SDL_hidapi.h b/include/SDL3/SDL_hidapi.h index 730fdee42..86d78f7c4 100644 --- a/include/SDL3/SDL_hidapi.h +++ b/include/SDL3/SDL_hidapi.h @@ -65,14 +65,14 @@ extern "C" { /** * An opaque handle representing an open HID device. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_hid_device SDL_hid_device; /** * HID underlying bus types. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_hid_bus_type { /** Unknown bus type */ @@ -107,7 +107,7 @@ typedef enum SDL_hid_bus_type { /** * Information about a connected HID device * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_hid_device_info { @@ -169,7 +169,7 @@ typedef struct SDL_hid_device_info * \returns 0 on success or a negative error code 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. * * \sa SDL_hid_exit */ @@ -184,7 +184,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_init(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 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_hid_init */ @@ -205,7 +205,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_exit(void); * \returns a change counter that is incremented with each potential device * change, or 0 if device change detection isn't available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_hid_enumerate */ @@ -233,7 +233,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_hid_device_change_count(void); * in the case of failure. Free this linked list by calling * SDL_hid_free_enumeration(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_hid_device_change_count */ @@ -247,7 +247,7 @@ extern SDL_DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_enumerate(unsigned sho * \param devs pointer to a list of struct_device returned from * SDL_hid_enumerate(). * - * \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_hid_free_enumeration(SDL_hid_device_info *devs); @@ -265,7 +265,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_hid_free_enumeration(SDL_hid_device_info *d * \returns a pointer to a SDL_hid_device object on success or NULL 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_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number); @@ -279,7 +279,7 @@ extern SDL_DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_ * \returns a pointer to a SDL_hid_device object on success or NULL 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_hid_device * SDLCALL SDL_hid_open_path(const char *path); @@ -306,7 +306,7 @@ extern SDL_DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path) * \returns the actual number of bytes written and -1 on 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 int SDLCALL SDL_hid_write(SDL_hid_device *dev, const unsigned char *data, size_t length); @@ -327,7 +327,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_write(SDL_hid_device *dev, const unsigne * SDL_GetError() for more information. If no packet was available to * be read within the timeout period, this function returns 0. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_hid_read_timeout(SDL_hid_device *dev, unsigned char *data, size_t length, int milliseconds); @@ -348,7 +348,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_read_timeout(SDL_hid_device *dev, unsign * be read and the handle is in non-blocking mode, this function * returns 0. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_hid_read(SDL_hid_device *dev, unsigned char *data, size_t length); @@ -367,7 +367,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_read(SDL_hid_device *dev, unsigned char * \returns 0 on success or a negative error code 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 int SDLCALL SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock); @@ -392,7 +392,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_set_nonblocking(SDL_hid_device *dev, int * \returns the actual number of bytes written and -1 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 int SDLCALL SDL_hid_send_feature_report(SDL_hid_device *dev, const unsigned char *data, size_t length); @@ -415,7 +415,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_send_feature_report(SDL_hid_device *dev, * still in the first byte), or -1 on 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 int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, unsigned char *data, size_t length); @@ -438,7 +438,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, * still in the first byte), or -1 on 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 int SDLCALL SDL_hid_get_input_report(SDL_hid_device *dev, unsigned char *data, size_t length); @@ -449,7 +449,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_input_report(SDL_hid_device *dev, un * \returns 0 on success or a negative error code 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 int SDLCALL SDL_hid_close(SDL_hid_device *dev); @@ -462,7 +462,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_close(SDL_hid_device *dev); * \returns 0 on success or a negative error code 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 int SDLCALL SDL_hid_get_manufacturer_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); @@ -475,7 +475,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_manufacturer_string(SDL_hid_device * * \returns 0 on success or a negative error code 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 int SDLCALL SDL_hid_get_product_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); @@ -488,7 +488,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_product_string(SDL_hid_device *dev, * \returns 0 on success or a negative error code 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 int SDLCALL SDL_hid_get_serial_number_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); @@ -502,7 +502,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_serial_number_string(SDL_hid_device * \returns 0 on success or a negative error code 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 int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int string_index, wchar_t *string, size_t maxlen); @@ -514,7 +514,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, * on failure; call SDL_GetError() for more information. This struct * is valid until the device is closed with SDL_hid_close(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_get_device_info(SDL_hid_device *dev); @@ -530,7 +530,7 @@ extern SDL_DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_get_device_info(SDL_hi * \returns the number of bytes actually copied or -1 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 int SDLCALL SDL_hid_get_report_descriptor(SDL_hid_device *dev, unsigned char *buf, size_t buf_size); @@ -539,7 +539,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_hid_get_report_descriptor(SDL_hid_device *de * * \param active true to start the scan, false to stop the scan. * - * \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_hid_ble_scan(bool active); diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h index e5f969b95..c6797931f 100644 --- a/include/SDL3/SDL_hints.h +++ b/include/SDL3/SDL_hints.h @@ -61,7 +61,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED "SDL_ALLOW_ALT_TAB_WHILE_GRABBED" @@ -81,7 +81,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ANDROID_ALLOW_RECREATE_ACTIVITY "SDL_ANDROID_ALLOW_RECREATE_ACTIVITY" @@ -96,7 +96,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ANDROID_BLOCK_ON_PAUSE "SDL_ANDROID_BLOCK_ON_PAUSE" @@ -119,7 +119,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ANDROID_TRAP_BACK_BUTTON "SDL_ANDROID_TRAP_BACK_BUTTON" @@ -135,7 +135,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_APP_ID "SDL_APP_ID" @@ -153,7 +153,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_APP_NAME "SDL_APP_NAME" @@ -176,7 +176,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS "SDL_APPLE_TV_CONTROLLER_UI_EVENTS" @@ -191,7 +191,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION "SDL_APPLE_TV_REMOTE_ALLOW_ROTATION" @@ -205,7 +205,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_ALSA_DEFAULT_DEVICE "SDL_AUDIO_ALSA_DEFAULT_DEVICE" @@ -223,7 +223,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_CATEGORY "SDL_AUDIO_CATEGORY" @@ -236,7 +236,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_CHANNELS "SDL_AUDIO_CHANNELS" @@ -259,7 +259,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DEVICE_APP_ICON_NAME "SDL_AUDIO_DEVICE_APP_ICON_NAME" @@ -281,7 +281,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DEVICE_SAMPLE_FRAMES "SDL_AUDIO_DEVICE_SAMPLE_FRAMES" @@ -308,7 +308,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DEVICE_STREAM_NAME "SDL_AUDIO_DEVICE_STREAM_NAME" @@ -334,7 +334,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DEVICE_STREAM_ROLE "SDL_AUDIO_DEVICE_STREAM_ROLE" @@ -345,7 +345,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DISK_INPUT_FILE "SDL_AUDIO_DISK_INPUT_FILE" @@ -356,7 +356,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DISK_OUTPUT_FILE "SDL_AUDIO_DISK_OUTPUT_FILE" @@ -369,7 +369,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DISK_TIMESCALE "SDL_AUDIO_DISK_TIMESCALE" @@ -383,7 +383,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DRIVER "SDL_AUDIO_DRIVER" @@ -396,7 +396,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_DUMMY_TIMESCALE "SDL_AUDIO_DUMMY_TIMESCALE" @@ -423,7 +423,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_FORMAT "SDL_AUDIO_FORMAT" @@ -436,7 +436,7 @@ extern "C" { * * This hint should be set before an audio device is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_FREQUENCY "SDL_AUDIO_FREQUENCY" @@ -459,7 +459,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUDIO_INCLUDE_MONITORS "SDL_AUDIO_INCLUDE_MONITORS" @@ -474,7 +474,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUTO_UPDATE_JOYSTICKS "SDL_AUTO_UPDATE_JOYSTICKS" @@ -489,7 +489,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_AUTO_UPDATE_SENSORS "SDL_AUTO_UPDATE_SENSORS" @@ -512,7 +512,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_BMP_SAVE_LEGACY_FORMAT "SDL_BMP_SAVE_LEGACY_FORMAT" @@ -528,7 +528,7 @@ extern "C" { * best camera backend on your behalf. This hint needs to be set before * SDL_Init() is called to be useful. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_CAMERA_DRIVER "SDL_CAMERA_DRIVER" @@ -561,7 +561,7 @@ extern "C" { * * The items can be prefixed by '+'/'-' to add/remove features. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_CPU_FEATURE_MASK "SDL_CPU_FEATURE_MASK" @@ -575,7 +575,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_DIRECTINPUT "SDL_JOYSTICK_DIRECTINPUT" @@ -604,7 +604,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_FILE_DIALOG_DRIVER "SDL_FILE_DIALOG_DRIVER" @@ -622,7 +622,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_DISPLAY_USABLE_BOUNDS "SDL_DISPLAY_USABLE_BOUNDS" @@ -643,7 +643,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_EMSCRIPTEN_ASYNCIFY "SDL_EMSCRIPTEN_ASYNCIFY" @@ -656,7 +656,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_EMSCRIPTEN_CANVAS_SELECTOR "SDL_EMSCRIPTEN_CANVAS_SELECTOR" @@ -676,7 +676,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT "SDL_EMSCRIPTEN_KEYBOARD_ELEMENT" @@ -693,7 +693,7 @@ extern "C" { * * This hint must be set before SDL_StartTextInput() is called * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ENABLE_SCREEN_KEYBOARD "SDL_ENABLE_SCREEN_KEYBOARD" @@ -710,7 +710,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_EVDEV_DEVICES "SDL_EVDEV_DEVICES" @@ -734,7 +734,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_EVENT_LOGGING "SDL_EVENT_LOGGING" @@ -754,7 +754,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_FORCE_RAISEWINDOW "SDL_FORCE_RAISEWINDOW" @@ -775,7 +775,7 @@ extern "C" { * * This hint should be set before calling SDL_GetWindowSurface() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_FRAMEBUFFER_ACCELERATION "SDL_FRAMEBUFFER_ACCELERATION" @@ -790,7 +790,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG" @@ -806,7 +806,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GAMECONTROLLERCONFIG_FILE "SDL_GAMECONTROLLERCONFIG_FILE" @@ -830,7 +830,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GAMECONTROLLERTYPE "SDL_GAMECONTROLLERTYPE" @@ -848,7 +848,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES "SDL_GAMECONTROLLER_IGNORE_DEVICES" @@ -866,7 +866,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT "SDL_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT" @@ -889,7 +889,7 @@ extern "C" { * * This hint should be set before a gamepad is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GAMECONTROLLER_SENSOR_FUSION "SDL_GAMECONTROLLER_SENSOR_FUSION" @@ -901,7 +901,7 @@ extern "C" { * * This hint should be set before calling SDL_StartTextInput() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GDK_TEXTINPUT_DEFAULT_TEXT "SDL_GDK_TEXTINPUT_DEFAULT_TEXT" @@ -913,7 +913,7 @@ extern "C" { * * This hint should be set before calling SDL_StartTextInput() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GDK_TEXTINPUT_DESCRIPTION "SDL_GDK_TEXTINPUT_DESCRIPTION" @@ -928,7 +928,7 @@ extern "C" { * * This hint should be set before calling SDL_StartTextInput() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GDK_TEXTINPUT_MAX_LENGTH "SDL_GDK_TEXTINPUT_MAX_LENGTH" @@ -944,7 +944,7 @@ extern "C" { * * This hint should be set before calling SDL_StartTextInput() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GDK_TEXTINPUT_SCOPE "SDL_GDK_TEXTINPUT_SCOPE" @@ -955,7 +955,7 @@ extern "C" { * * This hint should be set before calling SDL_StartTextInput() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GDK_TEXTINPUT_TITLE "SDL_GDK_TEXTINPUT_TITLE" @@ -973,7 +973,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_HIDAPI_LIBUSB "SDL_HIDAPI_LIBUSB" @@ -991,7 +991,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_HIDAPI_LIBUSB_WHITELIST "SDL_HIDAPI_LIBUSB_WHITELIST" @@ -1005,7 +1005,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_HIDAPI_UDEV "SDL_HIDAPI_UDEV" @@ -1019,7 +1019,7 @@ extern "C" { * * This hint should be set before SDL_GPUSelectBackend() is called. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_GPU_DRIVER "SDL_GPU_DRIVER" @@ -1038,7 +1038,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS "SDL_HIDAPI_ENUMERATE_ONLY_CONTROLLERS" @@ -1055,7 +1055,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_HIDAPI_IGNORE_DEVICES "SDL_HIDAPI_IGNORE_DEVICES" @@ -1078,7 +1078,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_IME_IMPLEMENTED_UI "SDL_IME_IMPLEMENTED_UI" @@ -1097,7 +1097,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_IOS_HIDE_HOME_INDICATOR "SDL_IOS_HIDE_HOME_INDICATOR" @@ -1114,7 +1114,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS" @@ -1131,7 +1131,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_ARCADESTICK_DEVICES "SDL_JOYSTICK_ARCADESTICK_DEVICES" @@ -1152,7 +1152,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_ARCADESTICK_DEVICES_EXCLUDED "SDL_JOYSTICK_ARCADESTICK_DEVICES_EXCLUDED" @@ -1170,7 +1170,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_BLACKLIST_DEVICES "SDL_JOYSTICK_BLACKLIST_DEVICES" @@ -1191,7 +1191,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_BLACKLIST_DEVICES_EXCLUDED "SDL_JOYSTICK_BLACKLIST_DEVICES_EXCLUDED" @@ -1201,7 +1201,7 @@ extern "C" { * * This variable is currently only used by the Linux joystick driver. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_DEVICE "SDL_JOYSTICK_DEVICE" @@ -1218,7 +1218,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_FLIGHTSTICK_DEVICES "SDL_JOYSTICK_FLIGHTSTICK_DEVICES" @@ -1239,7 +1239,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_FLIGHTSTICK_DEVICES_EXCLUDED "SDL_JOYSTICK_FLIGHTSTICK_DEVICES_EXCLUDED" @@ -1256,7 +1256,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_GAMEINPUT "SDL_JOYSTICK_GAMEINPUT" @@ -1274,7 +1274,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_GAMECUBE_DEVICES "SDL_JOYSTICK_GAMECUBE_DEVICES" @@ -1295,7 +1295,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_GAMECUBE_DEVICES_EXCLUDED "SDL_JOYSTICK_GAMECUBE_DEVICES_EXCLUDED" @@ -1312,7 +1312,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI "SDL_JOYSTICK_HIDAPI" @@ -1329,7 +1329,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_COMBINE_JOY_CONS "SDL_JOYSTICK_HIDAPI_COMBINE_JOY_CONS" @@ -1346,7 +1346,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE "SDL_JOYSTICK_HIDAPI_GAMECUBE" @@ -1367,7 +1367,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE_RUMBLE_BRAKE "SDL_JOYSTICK_HIDAPI_GAMECUBE_RUMBLE_BRAKE" @@ -1384,7 +1384,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_JOY_CONS "SDL_JOYSTICK_HIDAPI_JOY_CONS" @@ -1403,7 +1403,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_JOYCON_HOME_LED "SDL_JOYSTICK_HIDAPI_JOYCON_HOME_LED" @@ -1420,7 +1420,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_LUNA "SDL_JOYSTICK_HIDAPI_LUNA" @@ -1437,7 +1437,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_NINTENDO_CLASSIC "SDL_JOYSTICK_HIDAPI_NINTENDO_CLASSIC" @@ -1459,7 +1459,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS3 "SDL_JOYSTICK_HIDAPI_PS3" @@ -1476,7 +1476,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER "SDL_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER" @@ -1493,7 +1493,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS4 "SDL_JOYSTICK_HIDAPI_PS4" @@ -1508,7 +1508,7 @@ extern "C" { * This hint can be set anytime, but only takes effect when extended input * reports are enabled. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS4_REPORT_INTERVAL "SDL_JOYSTICK_HIDAPI_PS4_REPORT_INTERVAL" @@ -1534,7 +1534,7 @@ extern "C" { * * This hint can be enabled anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS4_RUMBLE "SDL_JOYSTICK_HIDAPI_PS4_RUMBLE" @@ -1551,7 +1551,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS5 "SDL_JOYSTICK_HIDAPI_PS5" @@ -1564,7 +1564,7 @@ extern "C" { * - "0": player LEDs are not enabled. * - "1": player LEDs are enabled. (default) * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS5_PLAYER_LED "SDL_JOYSTICK_HIDAPI_PS5_PLAYER_LED" @@ -1589,7 +1589,7 @@ extern "C" { * * This hint can be enabled anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS5_RUMBLE "SDL_JOYSTICK_HIDAPI_PS5_RUMBLE" @@ -1606,7 +1606,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_SHIELD "SDL_JOYSTICK_HIDAPI_SHIELD" @@ -1621,7 +1621,7 @@ extern "C" { * * The default is the value of SDL_HINT_JOYSTICK_HIDAPI. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_STADIA "SDL_JOYSTICK_HIDAPI_STADIA" @@ -1638,7 +1638,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_STEAM "SDL_JOYSTICK_HIDAPI_STEAM" @@ -1655,7 +1655,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_STEAMDECK "SDL_JOYSTICK_HIDAPI_STEAMDECK" @@ -1683,7 +1683,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_SWITCH "SDL_JOYSTICK_HIDAPI_SWITCH" @@ -1702,7 +1702,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED "SDL_JOYSTICK_HIDAPI_SWITCH_HOME_LED" @@ -1717,7 +1717,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED "SDL_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED" @@ -1733,7 +1733,7 @@ extern "C" { * * This hint should be set before opening a Joy-Con controller. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS "SDL_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS" @@ -1751,7 +1751,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_WII "SDL_JOYSTICK_HIDAPI_WII" @@ -1766,7 +1766,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_WII_PLAYER_LED "SDL_JOYSTICK_HIDAPI_WII_PLAYER_LED" @@ -1784,7 +1784,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_XBOX "SDL_JOYSTICK_HIDAPI_XBOX" @@ -1801,7 +1801,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360 "SDL_JOYSTICK_HIDAPI_XBOX_360" @@ -1816,7 +1816,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED "SDL_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED" @@ -1833,7 +1833,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS "SDL_JOYSTICK_HIDAPI_XBOX_360_WIRELESS" @@ -1850,7 +1850,7 @@ extern "C" { * * This hint should be set before enumerating controllers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE "SDL_JOYSTICK_HIDAPI_XBOX_ONE" @@ -1869,7 +1869,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED "SDL_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED" @@ -1884,7 +1884,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_IOKIT "SDL_JOYSTICK_IOKIT" @@ -1899,7 +1899,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_LINUX_CLASSIC "SDL_JOYSTICK_LINUX_CLASSIC" @@ -1914,7 +1914,7 @@ extern "C" { * * This hint should be set before a controller is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_LINUX_DEADZONES "SDL_JOYSTICK_LINUX_DEADZONES" @@ -1932,7 +1932,7 @@ extern "C" { * * This hint should be set before a controller is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_LINUX_DIGITAL_HATS "SDL_JOYSTICK_LINUX_DIGITAL_HATS" @@ -1948,7 +1948,7 @@ extern "C" { * * This hint should be set before a controller is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_LINUX_HAT_DEADZONES "SDL_JOYSTICK_LINUX_HAT_DEADZONES" @@ -1963,7 +1963,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_MFI "SDL_JOYSTICK_MFI" @@ -1978,7 +1978,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_RAWINPUT "SDL_JOYSTICK_RAWINPUT" @@ -1995,7 +1995,7 @@ extern "C" { * * This hint should be set before a gamepad is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_RAWINPUT_CORRELATE_XINPUT "SDL_JOYSTICK_RAWINPUT_CORRELATE_XINPUT" @@ -2010,7 +2010,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_ROG_CHAKRAM "SDL_JOYSTICK_ROG_CHAKRAM" @@ -2025,7 +2025,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_THREAD "SDL_JOYSTICK_THREAD" @@ -2042,7 +2042,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_THROTTLE_DEVICES "SDL_JOYSTICK_THROTTLE_DEVICES" @@ -2063,7 +2063,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_THROTTLE_DEVICES_EXCLUDED "SDL_JOYSTICK_THROTTLE_DEVICES_EXCLUDED" @@ -2078,7 +2078,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_WGI "SDL_JOYSTICK_WGI" @@ -2095,7 +2095,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_WHEEL_DEVICES "SDL_JOYSTICK_WHEEL_DEVICES" @@ -2116,7 +2116,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_WHEEL_DEVICES_EXCLUDED "SDL_JOYSTICK_WHEEL_DEVICES_EXCLUDED" @@ -2134,7 +2134,7 @@ extern "C" { * * This hint should be set before a controller is opened. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_JOYSTICK_ZERO_CENTERED_DEVICES "SDL_JOYSTICK_ZERO_CENTERED_DEVICES" @@ -2168,7 +2168,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_KEYCODE_OPTIONS "SDL_KEYCODE_OPTIONS" @@ -2182,7 +2182,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_KMSDRM_DEVICE_INDEX "SDL_KMSDRM_DEVICE_INDEX" @@ -2210,7 +2210,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_KMSDRM_REQUIRE_DRM_MASTER "SDL_KMSDRM_REQUIRE_DRM_MASTER" @@ -2236,7 +2236,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_LOGGING "SDL_LOGGING" @@ -2252,7 +2252,7 @@ extern "C" { * * This hint needs to be set before SDL_Init(). * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MAC_BACKGROUND_APP "SDL_MAC_BACKGROUND_APP" @@ -2268,7 +2268,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK" @@ -2291,7 +2291,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MAC_OPENGL_ASYNC_DISPATCH "SDL_MAC_OPENGL_ASYNC_DISPATCH" @@ -2306,7 +2306,7 @@ extern "C" { * * This hint needs to be set before SDL_Init(). * - * \since This hint is available since SDL 3.1.6. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MAC_SCROLL_MOMENTUM "SDL_MAC_SCROLL_MOMENTUM" @@ -2324,7 +2324,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MAIN_CALLBACK_RATE "SDL_MAIN_CALLBACK_RATE" @@ -2343,7 +2343,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_AUTO_CAPTURE "SDL_MOUSE_AUTO_CAPTURE" @@ -2352,7 +2352,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS "SDL_MOUSE_DOUBLE_CLICK_RADIUS" @@ -2361,7 +2361,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_DOUBLE_CLICK_TIME "SDL_MOUSE_DOUBLE_CLICK_TIME" @@ -2393,7 +2393,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_EMULATE_WARP_WITH_RELATIVE "SDL_MOUSE_EMULATE_WARP_WITH_RELATIVE" @@ -2407,7 +2407,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH "SDL_MOUSE_FOCUS_CLICKTHROUGH" @@ -2417,7 +2417,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_NORMAL_SPEED_SCALE "SDL_MOUSE_NORMAL_SPEED_SCALE" @@ -2438,7 +2438,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_MODE_CENTER "SDL_MOUSE_RELATIVE_MODE_CENTER" @@ -2453,7 +2453,7 @@ extern "C" { * * This hint can be set anytime relative mode is not currently enabled. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_MODE_WARP "SDL_MOUSE_RELATIVE_MODE_WARP" @@ -2463,7 +2463,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE "SDL_MOUSE_RELATIVE_SPEED_SCALE" @@ -2482,7 +2482,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_SYSTEM_SCALE "SDL_MOUSE_RELATIVE_SYSTEM_SCALE" @@ -2501,7 +2501,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_WARP_MOTION "SDL_MOUSE_RELATIVE_WARP_MOTION" @@ -2519,7 +2519,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_CURSOR_VISIBLE "SDL_MOUSE_RELATIVE_CURSOR_VISIBLE" @@ -2536,7 +2536,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_RELATIVE_CLIP_INTERVAL "SDL_MOUSE_RELATIVE_CLIP_INTERVAL" @@ -2553,7 +2553,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MOUSE_TOUCH_EVENTS "SDL_MOUSE_TOUCH_EVENTS" @@ -2571,7 +2571,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_MUTE_CONSOLE_KEYBOARD "SDL_MUTE_CONSOLE_KEYBOARD" @@ -2586,7 +2586,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_NO_SIGNAL_HANDLERS "SDL_NO_SIGNAL_HANDLERS" @@ -2596,7 +2596,7 @@ extern "C" { * This hint should be set before creating an OpenGL window or creating an * OpenGL context. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_OPENGL_LIBRARY "SDL_OPENGL_LIBRARY" @@ -2630,7 +2630,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_OPENGL_ES_DRIVER "SDL_OPENGL_ES_DRIVER" @@ -2659,7 +2659,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ORIENTATIONS "SDL_ORIENTATIONS" @@ -2679,7 +2679,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_POLL_SENTINEL "SDL_POLL_SENTINEL" @@ -2697,7 +2697,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_PREFERRED_LOCALES "SDL_PREFERRED_LOCALES" @@ -2716,7 +2716,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_QUIT_ON_LAST_WINDOW_CLOSE "SDL_QUIT_ON_LAST_WINDOW_CLOSE" @@ -2731,7 +2731,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE" @@ -2747,7 +2747,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_DIRECT3D11_DEBUG "SDL_RENDER_DIRECT3D11_DEBUG" @@ -2761,7 +2761,7 @@ extern "C" { * * By default, SDL does not use Vulkan Validation Layers. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_VULKAN_DEBUG "SDL_RENDER_VULKAN_DEBUG" @@ -2775,7 +2775,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_GPU_DEBUG "SDL_RENDER_GPU_DEBUG" @@ -2790,7 +2790,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_GPU_LOW_POWER "SDL_RENDER_GPU_LOW_POWER" @@ -2818,7 +2818,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_DRIVER "SDL_RENDER_DRIVER" @@ -2836,7 +2836,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_LINE_METHOD "SDL_RENDER_LINE_METHOD" @@ -2851,7 +2851,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_METAL_PREFER_LOW_POWER_DEVICE "SDL_RENDER_METAL_PREFER_LOW_POWER_DEVICE" @@ -2868,7 +2868,7 @@ extern "C" { * * This hint should be set before creating a renderer. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RENDER_VSYNC "SDL_RENDER_VSYNC" @@ -2885,7 +2885,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RETURN_KEY_HIDES_IME "SDL_RETURN_KEY_HIDES_IME" @@ -2902,7 +2902,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. * * \sa SDL_HINT_ROG_GAMEPAD_MICE_EXCLUDED */ @@ -2924,7 +2924,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ROG_GAMEPAD_MICE_EXCLUDED "SDL_ROG_GAMEPAD_MICE_EXCLUDED" @@ -2936,7 +2936,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_RPI_VIDEO_LAYER "SDL_RPI_VIDEO_LAYER" @@ -2958,7 +2958,7 @@ extern "C" { * * This hint should be set before calling SDL_DisableScreenSaver() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_SCREENSAVER_INHIBIT_ACTIVITY_NAME "SDL_SCREENSAVER_INHIBIT_ACTIVITY_NAME" @@ -2977,7 +2977,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_SHUTDOWN_DBUS_ON_QUIT "SDL_SHUTDOWN_DBUS_ON_QUIT" @@ -2991,7 +2991,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_STORAGE_TITLE_DRIVER "SDL_STORAGE_TITLE_DRIVER" @@ -3005,7 +3005,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_STORAGE_USER_DRIVER "SDL_STORAGE_USER_DRIVER" @@ -3034,7 +3034,7 @@ extern "C" { * * This hint should be set before calling SDL_SetCurrentThreadPriority() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL "SDL_THREAD_FORCE_REALTIME_TIME_CRITICAL" @@ -3057,7 +3057,7 @@ extern "C" { * * This hint should be set before calling SDL_SetCurrentThreadPriority() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_THREAD_PRIORITY_POLICY "SDL_THREAD_PRIORITY_POLICY" @@ -3077,7 +3077,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION" @@ -3092,7 +3092,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_TOUCH_MOUSE_EVENTS "SDL_TOUCH_MOUSE_EVENTS" @@ -3113,7 +3113,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_TRACKPAD_IS_TOUCH_ONLY "SDL_TRACKPAD_IS_TOUCH_ONLY" @@ -3128,7 +3128,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_TV_REMOTE_AS_JOYSTICK "SDL_TV_REMOTE_AS_JOYSTICK" @@ -3142,7 +3142,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_ALLOW_SCREENSAVER "SDL_VIDEO_ALLOW_SCREENSAVER" @@ -3167,7 +3167,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.1.6. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_DISPLAY_PRIORITY "SDL_VIDEO_DISPLAY_PRIORITY" @@ -3190,7 +3190,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_DOUBLE_BUFFER "SDL_VIDEO_DOUBLE_BUFFER" @@ -3204,7 +3204,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_DRIVER "SDL_VIDEO_DRIVER" @@ -3217,7 +3217,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_DUMMY_SAVE_FRAMES "SDL_VIDEO_DUMMY_SAVE_FRAMES" @@ -3231,7 +3231,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_EGL_ALLOW_GETDISPLAY_FALLBACK "SDL_VIDEO_EGL_ALLOW_GETDISPLAY_FALLBACK" @@ -3247,7 +3247,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_FORCE_EGL "SDL_VIDEO_FORCE_EGL" @@ -3265,7 +3265,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES "SDL_VIDEO_MAC_FULLSCREEN_SPACES" @@ -3281,7 +3281,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS" @@ -3298,7 +3298,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_OFFSCREEN_SAVE_FRAMES "SDL_VIDEO_OFFSCREEN_SAVE_FRAMES" @@ -3324,7 +3324,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS "SDL_VIDEO_SYNC_WINDOW_OPERATIONS" @@ -3342,7 +3342,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_WAYLAND_ALLOW_LIBDECOR "SDL_VIDEO_WAYLAND_ALLOW_LIBDECOR" @@ -3362,7 +3362,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_WAYLAND_MODE_EMULATION "SDL_VIDEO_WAYLAND_MODE_EMULATION" @@ -3384,7 +3384,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_WAYLAND_MODE_SCALING "SDL_VIDEO_WAYLAND_MODE_SCALING" @@ -3404,7 +3404,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_WAYLAND_PREFER_LIBDECOR "SDL_VIDEO_WAYLAND_PREFER_LIBDECOR" @@ -3441,7 +3441,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_WAYLAND_SCALE_TO_DISPLAY "SDL_VIDEO_WAYLAND_SCALE_TO_DISPLAY" @@ -3463,7 +3463,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_WIN_D3DCOMPILER "SDL_VIDEO_WIN_D3DCOMPILER" @@ -3478,7 +3478,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR "SDL_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR" @@ -3497,7 +3497,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_NET_WM_PING "SDL_VIDEO_X11_NET_WM_PING" @@ -3511,7 +3511,7 @@ extern "C" { * * This hint should be set before initializing the video subsystem. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_NODIRECTCOLOR "SDL_VIDEO_X11_NODIRECTCOLOR" @@ -3522,7 +3522,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_SCALING_FACTOR "SDL_VIDEO_X11_SCALING_FACTOR" @@ -3531,7 +3531,7 @@ extern "C" { * * This hint should be set before initializing the video subsystem. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_VISUALID "SDL_VIDEO_X11_VISUALID" @@ -3540,7 +3540,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_WINDOW_VISUALID "SDL_VIDEO_X11_WINDOW_VISUALID" @@ -3554,7 +3554,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VIDEO_X11_XRANDR "SDL_VIDEO_X11_XRANDR" @@ -3569,7 +3569,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_ENABLE_BACK_TOUCH "SDL_VITA_ENABLE_BACK_TOUCH" @@ -3584,7 +3584,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_ENABLE_FRONT_TOUCH "SDL_VITA_ENABLE_FRONT_TOUCH" @@ -3595,7 +3595,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_MODULE_PATH "SDL_VITA_MODULE_PATH" @@ -3608,7 +3608,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_PVR_INIT "SDL_VITA_PVR_INIT" @@ -3623,7 +3623,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_RESOLUTION "SDL_VITA_RESOLUTION" @@ -3638,7 +3638,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_PVR_OPENGL "SDL_VITA_PVR_OPENGL" @@ -3654,7 +3654,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VITA_TOUCH_MOUSE_DEVICE "SDL_VITA_TOUCH_MOUSE_DEVICE" @@ -3665,7 +3665,7 @@ extern "C" { * * This hint should be set before calling SDL_Vulkan_CreateSurface() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VULKAN_DISPLAY "SDL_VULKAN_DISPLAY" @@ -3675,7 +3675,7 @@ extern "C" { * This hint should be set before creating a Vulkan window or calling * SDL_Vulkan_LoadLibrary(). * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_VULKAN_LIBRARY "SDL_VULKAN_LIBRARY" @@ -3707,7 +3707,7 @@ extern "C" { * * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WAVE_FACT_CHUNK "SDL_WAVE_FACT_CHUNK" @@ -3719,7 +3719,7 @@ extern "C" { * * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WAVE_CHUNK_LIMIT "SDL_WAVE_CHUNK_LIMIT" @@ -3747,7 +3747,7 @@ extern "C" { * * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WAVE_RIFF_CHUNK_SIZE "SDL_WAVE_RIFF_CHUNK_SIZE" @@ -3767,7 +3767,7 @@ extern "C" { * * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO() * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WAVE_TRUNCATION "SDL_WAVE_TRUNCATION" @@ -3784,7 +3784,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED "SDL_WINDOW_ACTIVATE_WHEN_RAISED" @@ -3801,7 +3801,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOW_ACTIVATE_WHEN_SHOWN "SDL_WINDOW_ACTIVATE_WHEN_SHOWN" @@ -3819,7 +3819,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOW_ALLOW_TOPMOST "SDL_WINDOW_ALLOW_TOPMOST" @@ -3835,7 +3835,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN "SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN" @@ -3851,7 +3851,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_CLOSE_ON_ALT_F4 "SDL_WINDOWS_CLOSE_ON_ALT_F4" @@ -3880,7 +3880,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_ENABLE_MENU_MNEMONICS "SDL_WINDOWS_ENABLE_MENU_MNEMONICS" @@ -3895,7 +3895,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP "SDL_WINDOWS_ENABLE_MESSAGELOOP" @@ -3911,7 +3911,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_GAMEINPUT "SDL_WINDOWS_GAMEINPUT" @@ -3925,7 +3925,7 @@ extern "C" { * * This hint can be set anytime. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_RAW_KEYBOARD "SDL_WINDOWS_RAW_KEYBOARD" @@ -3946,7 +3946,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_FORCE_SEMAPHORE_KERNEL "SDL_WINDOWS_FORCE_SEMAPHORE_KERNEL" @@ -3956,7 +3956,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_INTRESOURCE_ICON "SDL_WINDOWS_INTRESOURCE_ICON" #define SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL "SDL_WINDOWS_INTRESOURCE_ICON_SMALL" @@ -3983,7 +3983,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_USE_D3D9EX "SDL_WINDOWS_USE_D3D9EX" @@ -4000,7 +4000,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_WINDOWS_ERASE_BACKGROUND_MODE "SDL_WINDOWS_ERASE_BACKGROUND_MODE" @@ -4021,7 +4021,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_X11_FORCE_OVERRIDE_REDIRECT "SDL_X11_FORCE_OVERRIDE_REDIRECT" @@ -4038,7 +4038,7 @@ extern "C" { * * This hint should be set before creating a window. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_X11_WINDOW_TYPE "SDL_X11_WINDOW_TYPE" @@ -4049,7 +4049,7 @@ extern "C" { * * This hint should be set before initializing the video subsystem. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_X11_XCB_LIBRARY "SDL_X11_XCB_LIBRARY" @@ -4064,7 +4064,7 @@ extern "C" { * * This hint should be set before SDL is initialized. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED" @@ -4088,7 +4088,7 @@ extern "C" { * This hint should be set before an assertion failure is triggered and can be * changed at any time. * - * \since This hint is available since SDL 3.0.0. + * \since This hint is available since SDL 3.1.3. */ #define SDL_HINT_ASSERT "SDL_ASSERT" @@ -4096,7 +4096,7 @@ extern "C" { /** * An enumeration of hint priorities. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_HintPriority { @@ -4120,7 +4120,7 @@ typedef enum SDL_HintPriority * * \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_GetHint * \sa SDL_ResetHint @@ -4142,7 +4142,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetHintWithPriority(const char *name, const * * \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_GetHint * \sa SDL_ResetHint @@ -4163,7 +4163,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetHint(const char *name, const char *value * * \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_SetHint * \sa SDL_ResetHints @@ -4179,7 +4179,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResetHint(const char *name); * * \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_ResetHint */ @@ -4198,7 +4198,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ResetHints(void); * callback instead is always thread-safe, as SDL holds a lock * on the thread subsystem during the callback. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetHint * \sa SDL_SetHintWithPriority @@ -4215,7 +4215,7 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetHint(const char *name); * * \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_GetHint * \sa SDL_SetHint @@ -4237,7 +4237,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetHintBoolean(const char *name, bool defau * hint value. SDL holds a lock on the hint subsystem when * calling this callback. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_AddHintCallback */ @@ -4258,7 +4258,7 @@ typedef void(SDLCALL *SDL_HintCallback)(void *userdata, const char *name, const * * \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_RemoveHintCallback */ @@ -4274,7 +4274,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddHintCallback(const char *name, SDL_HintC * * \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_AddHintCallback */ diff --git a/include/SDL3/SDL_init.h b/include/SDL3/SDL_init.h index 645dad51f..3f7f45d1d 100644 --- a/include/SDL3/SDL_init.h +++ b/include/SDL3/SDL_init.h @@ -67,7 +67,7 @@ extern "C" { * These are the flags which may be passed to SDL_Init(). You should specify * the subsystems which you will be using in your application. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_Init * \sa SDL_Quit @@ -104,7 +104,7 @@ typedef Uint32 SDL_InitFlags; * [Main callbacks in SDL3](https://wiki.libsdl.org/SDL3/README/main-functions#main-callbacks-in-sdl3) * for complete details. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_AppResult { @@ -164,7 +164,7 @@ typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate, SDL_AppResult result); * \returns true on success or false 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. * * \sa SDL_SetAppMetadata * \sa SDL_SetAppMetadataProperty @@ -184,7 +184,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Init(SDL_InitFlags flags); * \returns true on success or false 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. * * \sa SDL_Init * \sa SDL_Quit @@ -200,7 +200,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_InitSubSystem(SDL_InitFlags flags); * * \param flags any of the flags used by SDL_Init(); see SDL_Init for details. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_InitSubSystem * \sa SDL_Quit @@ -214,7 +214,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_QuitSubSystem(SDL_InitFlags flags); * \returns a mask of all initialized subsystems if `flags` is 0, otherwise it * returns the initialization status of the specified subsystems. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Init * \sa SDL_InitSubSystem @@ -232,7 +232,7 @@ extern SDL_DECLSPEC SDL_InitFlags SDLCALL SDL_WasInit(SDL_InitFlags 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 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Init * \sa SDL_QuitSubSystem @@ -271,7 +271,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Quit(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_SetAppMetadataProperty */ @@ -333,7 +333,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAppMetadata(const char *appname, const c * * \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_GetAppMetadataProperty * \sa SDL_SetAppMetadata @@ -364,7 +364,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAppMetadataProperty(const char *name, co * freed if you call SDL_SetAppMetadataProperty() to set that * property from another thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetAppMetadata * \sa SDL_SetAppMetadataProperty diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index 3c4ffd5b3..76fdf0ad2 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -48,7 +48,7 @@ extern "C" { /** * SDL_IOStream status, set by a read or write operation. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_IOStatus { @@ -66,7 +66,7 @@ typedef enum SDL_IOStatus * These map to the same "whence" concept that `fseek` or `lseek` use in the * standard C runtime. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_IOWhence { @@ -85,7 +85,7 @@ typedef enum SDL_IOWhence * * This structure should be initialized using SDL_INIT_INTERFACE() * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_INIT_INTERFACE */ @@ -177,7 +177,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_IOStreamInterface_SIZE, * SDL_OpenIO() to provide their own stream implementation behind this * struct's abstract interface. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_IOStream SDL_IOStream; @@ -260,7 +260,7 @@ typedef struct SDL_IOStream SDL_IOStream; * \returns a pointer to the SDL_IOStream structure that is created or NULL 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. * * \sa SDL_CloseIO * \sa SDL_FlushIO @@ -303,7 +303,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromFile(const char *file, cons * \returns a pointer to a new SDL_IOStream structure or NULL 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. * * \sa SDL_IOFromConstMem * \sa SDL_CloseIO @@ -347,7 +347,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromMem(void *mem, size_t size) * \returns a pointer to a new SDL_IOStream structure or NULL 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. * * \sa SDL_IOFromMem * \sa SDL_CloseIO @@ -375,7 +375,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromConstMem(const void *mem, s * \returns a pointer to a new SDL_IOStream structure or NULL 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. * * \sa SDL_CloseIO * \sa SDL_ReadIO @@ -408,7 +408,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromDynamicMem(void); * \returns a pointer to the allocated memory on success or NULL 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. * * \sa SDL_CloseIO * \sa SDL_INIT_INTERFACE @@ -442,7 +442,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_OpenIO(const SDL_IOStreamInterfac * \returns true on success or false 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. * * \sa SDL_OpenIO */ @@ -455,7 +455,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseIO(SDL_IOStream *context); * \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_GetIOProperties(SDL_IOStream *context); @@ -476,7 +476,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetIOProperties(SDL_IOStream *c * \threadsafety This function should not be called at the same time that * another thread is operating on the same SDL_IOStream. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context); @@ -488,7 +488,7 @@ extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context); * negative error code 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 Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context); @@ -513,7 +513,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context); * \returns the final offset in the data stream after the seek or -1 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. * * \sa SDL_TellIO */ @@ -531,7 +531,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_SeekIO(SDL_IOStream *context, Sint64 offs * \returns the current offset in the stream, or -1 if the information can not * be determined. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SeekIO */ @@ -552,7 +552,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context); * \returns the number of bytes read, or 0 on end of file or other 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. * * \sa SDL_WriteIO * \sa SDL_GetIOStatus @@ -579,7 +579,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_ReadIO(SDL_IOStream *context, void *ptr, * \returns the number of bytes written, which will be less than `size` 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. * * \sa SDL_IOprintf * \sa SDL_ReadIO @@ -601,7 +601,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_WriteIO(SDL_IOStream *context, const void * \returns the number of bytes written 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. * * \sa SDL_IOvprintf * \sa SDL_WriteIO @@ -619,7 +619,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_IOprintf(SDL_IOStream *context, SDL_PRINT * \returns the number of bytes written 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. * * \sa SDL_IOprintf * \sa SDL_WriteIO @@ -637,7 +637,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRIN * \returns true on success or false 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. * * \sa SDL_OpenIO * \sa SDL_WriteIO @@ -661,7 +661,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushIO(SDL_IOStream *context); * \returns the data or NULL 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. * * \sa SDL_LoadFile */ @@ -681,7 +681,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *da * \returns the data or NULL 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. * * \sa SDL_LoadFile_IO */ @@ -702,7 +702,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile(const char *file, size_t *datasi * \returns true on success or false 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 bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value); @@ -714,7 +714,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value); * \returns true on success or false 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 bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value); @@ -730,7 +730,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value); * \returns true on successful write or false 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 bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value); @@ -746,7 +746,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value); @@ -762,7 +762,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value); @@ -778,7 +778,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value); @@ -794,7 +794,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value); @@ -810,7 +810,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value); @@ -826,7 +826,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value); @@ -842,7 +842,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value); @@ -858,7 +858,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value); @@ -874,7 +874,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value); @@ -890,7 +890,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value); @@ -906,7 +906,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *value); /* @} *//* Read endian functions */ @@ -926,7 +926,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value); @@ -938,7 +938,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value); * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value); @@ -955,7 +955,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value); * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 value); @@ -972,7 +972,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 value); @@ -988,7 +988,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 value); @@ -1004,7 +1004,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 value); @@ -1021,7 +1021,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 value); @@ -1038,7 +1038,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 value); @@ -1054,7 +1054,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 value); @@ -1070,7 +1070,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 value); @@ -1087,7 +1087,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 value); @@ -1104,7 +1104,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 value); @@ -1120,7 +1120,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 value); @@ -1136,7 +1136,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 value) * \returns true on successful write or false 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 bool SDLCALL SDL_WriteS64BE(SDL_IOStream *dst, Sint64 value); diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h index 520e6eb07..44770972c 100644 --- a/include/SDL3/SDL_joystick.h +++ b/include/SDL3/SDL_joystick.h @@ -81,7 +81,7 @@ extern SDL_Mutex *SDL_joystick_lock; * * This is opaque data. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Joystick SDL_Joystick; @@ -93,7 +93,7 @@ typedef struct SDL_Joystick SDL_Joystick; * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_JoystickID; @@ -107,7 +107,7 @@ typedef Uint32 SDL_JoystickID; * This is by no means a complete list of everything that can be plugged into * a computer. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_JoystickType { @@ -130,7 +130,7 @@ typedef enum SDL_JoystickType * This is used by SDL_GetJoystickConnectionState to report how a device is * connected to the system. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_JoystickConnectionState { @@ -143,7 +143,7 @@ typedef enum SDL_JoystickConnectionState /** * The largest value an SDL_Joystick's axis can report. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_JOYSTICK_AXIS_MIN */ @@ -154,7 +154,7 @@ typedef enum SDL_JoystickConnectionState * * This is a negative number! * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_JOYSTICK_AXIS_MAX */ @@ -170,14 +170,14 @@ typedef enum SDL_JoystickConnectionState * joysticks while processing to guarantee that the joystick list won't change * and joystick and gamepad events will not be delivered. * - * \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_LockJoysticks(void) SDL_ACQUIRE(SDL_joystick_lock); /** * Unlocking for atomic access to the joystick API. * - * \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_UnlockJoysticks(void) SDL_RELEASE(SDL_joystick_lock); @@ -186,7 +186,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockJoysticks(void) SDL_RELEASE(SDL_joyst * * \returns true if a joystick is connected, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoysticks */ @@ -201,7 +201,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasJoystick(void); * call SDL_GetError() for more information. This should be freed * with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasJoystick * \sa SDL_OpenJoystick @@ -217,7 +217,7 @@ extern SDL_DECLSPEC SDL_JoystickID * SDLCALL SDL_GetJoysticks(int *count); * \returns the name of the selected joystick. If no name can be found, this * function returns NULL; 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. * * \sa SDL_GetJoystickName * \sa SDL_GetJoysticks @@ -233,7 +233,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickNameForID(SDL_JoystickID * \returns the path of the selected joystick. If no path can be found, this * function returns NULL; 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. * * \sa SDL_GetJoystickPath * \sa SDL_GetJoysticks @@ -248,7 +248,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickPathForID(SDL_JoystickID * \param instance_id the joystick instance ID. * \returns the player index of a joystick, or -1 if it's not available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickPlayerIndex * \sa SDL_GetJoysticks @@ -264,7 +264,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetJoystickPlayerIndexForID(SDL_JoystickID i * \returns the GUID of the selected joystick. If called with an invalid * instance_id, this function returns a zero GUID. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickGUID * \sa SDL_GUIDToString @@ -281,7 +281,7 @@ extern SDL_DECLSPEC SDL_GUID SDLCALL SDL_GetJoystickGUIDForID(SDL_JoystickID ins * \returns the USB vendor ID of the selected joystick. If called with an * invalid instance_id, this function returns 0. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickVendor * \sa SDL_GetJoysticks @@ -298,7 +298,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickVendorForID(SDL_JoystickID ins * \returns the USB product ID of the selected joystick. If called with an * invalid instance_id, this function returns 0. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickProduct * \sa SDL_GetJoysticks @@ -315,7 +315,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickProductForID(SDL_JoystickID in * \returns the product version of the selected joystick. If called with an * invalid instance_id, this function returns 0. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickProductVersion * \sa SDL_GetJoysticks @@ -332,7 +332,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickProductVersionForID(SDL_Joysti * invalid instance_id, this function returns * `SDL_JOYSTICK_TYPE_UNKNOWN`. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickType * \sa SDL_GetJoysticks @@ -349,7 +349,7 @@ extern SDL_DECLSPEC SDL_JoystickType SDLCALL SDL_GetJoystickTypeForID(SDL_Joysti * \returns a joystick identifier or NULL 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. * * \sa SDL_CloseJoystick */ @@ -362,7 +362,7 @@ extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_OpenJoystick(SDL_JoystickID insta * \returns an SDL_Joystick on success or NULL on failure or if it hasn't been * opened yet; 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_Joystick * SDLCALL SDL_GetJoystickFromID(SDL_JoystickID instance_id); @@ -373,7 +373,7 @@ extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetJoystickFromID(SDL_JoystickID * \returns an SDL_Joystick on success or NULL 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. * * \sa SDL_GetJoystickPlayerIndex * \sa SDL_SetJoystickPlayerIndex @@ -383,7 +383,7 @@ extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetJoystickFromPlayerIndex(int pl /** * The structure that describes a virtual joystick touchpad. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_VirtualJoystickDesc */ @@ -396,7 +396,7 @@ typedef struct SDL_VirtualJoystickTouchpadDesc /** * The structure that describes a virtual joystick sensor. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_VirtualJoystickDesc */ @@ -412,7 +412,7 @@ typedef struct SDL_VirtualJoystickSensorDesc * This structure should be initialized using SDL_INIT_INTERFACE(). All * elements of this structure are optional. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_AttachVirtualJoystick * \sa SDL_INIT_INTERFACE @@ -469,7 +469,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_VirtualJoystickDesc_SIZE, * \returns the joystick instance ID, 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. * * \sa SDL_DetachVirtualJoystick */ @@ -483,7 +483,7 @@ extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_AttachVirtualJoystick(const SDL_V * \returns true on success or false 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. * * \sa SDL_AttachVirtualJoystick */ @@ -495,7 +495,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DetachVirtualJoystick(SDL_JoystickID instan * \param instance_id the joystick instance ID. * \returns true if the joystick is virtual, false otherwise. * - * \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_IsJoystickVirtual(SDL_JoystickID instance_id); @@ -518,7 +518,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsJoystickVirtual(SDL_JoystickID instance_i * \returns true on success or false 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 bool SDLCALL SDL_SetJoystickVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value); @@ -538,7 +538,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualAxis(SDL_Joystick *joysti * \returns true on success or false 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 bool SDLCALL SDL_SetJoystickVirtualBall(SDL_Joystick *joystick, int ball, Sint16 xrel, Sint16 yrel); @@ -557,7 +557,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualBall(SDL_Joystick *joysti * \returns true on success or false 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 bool SDLCALL SDL_SetJoystickVirtualButton(SDL_Joystick *joystick, int button, bool down); @@ -576,7 +576,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualButton(SDL_Joystick *joys * \returns true on success or false 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 bool SDLCALL SDL_SetJoystickVirtualHat(SDL_Joystick *joystick, int hat, Uint8 value); @@ -602,7 +602,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualHat(SDL_Joystick *joystic * \returns true on success or false 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 bool SDLCALL SDL_SetJoystickVirtualTouchpad(SDL_Joystick *joystick, int touchpad, int finger, bool down, float x, float y, float pressure); @@ -624,7 +624,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualTouchpad(SDL_Joystick *jo * \returns true on success or false 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 bool SDLCALL SDL_SendJoystickVirtualSensorData(SDL_Joystick *joystick, SDL_SensorType type, Uint64 sensor_timestamp, const float *data, int num_values); @@ -648,7 +648,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SendJoystickVirtualSensorData(SDL_Joystick * \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_GetJoystickProperties(SDL_Joystick *joystick); @@ -665,7 +665,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetJoystickProperties(SDL_Joyst * \returns the name of the selected joystick. If no name can be found, this * function returns NULL; 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. * * \sa SDL_GetJoystickNameForID */ @@ -678,7 +678,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickName(SDL_Joystick *joyst * \returns the path of the selected joystick. If no path can be found, this * function returns NULL; 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. * * \sa SDL_GetJoystickPathForID */ @@ -693,7 +693,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickPath(SDL_Joystick *joyst * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick(). * \returns the player index, or -1 if it's not available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetJoystickPlayerIndex */ @@ -708,7 +708,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetJoystickPlayerIndex(SDL_Joystick *joystic * \returns true on success or false 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. * * \sa SDL_GetJoystickPlayerIndex */ @@ -724,7 +724,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickPlayerIndex(SDL_Joystick *joysti * this function returns a zero GUID; 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. * * \sa SDL_GetJoystickGUIDForID * \sa SDL_GUIDToString @@ -739,7 +739,7 @@ extern SDL_DECLSPEC SDL_GUID SDLCALL SDL_GetJoystickGUID(SDL_Joystick *joystick) * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick(). * \returns the USB vendor ID of the selected joystick, or 0 if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickVendorForID */ @@ -753,7 +753,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickVendor(SDL_Joystick *joystick) * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick(). * \returns the USB product ID of the selected joystick, or 0 if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickProductForID */ @@ -767,7 +767,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickProduct(SDL_Joystick *joystick * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick(). * \returns the product version of the selected joystick, or 0 if unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickProductVersionForID */ @@ -782,7 +782,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickProductVersion(SDL_Joystick *j * \returns the firmware version of the selected joystick, or 0 if * unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickFirmwareVersion(SDL_Joystick *joystick); @@ -795,7 +795,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickFirmwareVersion(SDL_Joystick * * \returns the serial number of the selected joystick, or NULL if * unavailable. * - * \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_GetJoystickSerial(SDL_Joystick *joystick); @@ -805,7 +805,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickSerial(SDL_Joystick *joy * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick(). * \returns the SDL_JoystickType of the selected joystick. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickTypeForID */ @@ -824,7 +824,7 @@ extern SDL_DECLSPEC SDL_JoystickType SDLCALL SDL_GetJoystickType(SDL_Joystick *j * \param crc16 a pointer filled in with a CRC used to distinguish different * products with the same VID/PID, or 0 if not available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetJoystickGUIDForID */ @@ -837,7 +837,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetJoystickGUIDInfo(SDL_GUID guid, Uint16 * * \returns true if the joystick has been opened, false if it has not; 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 bool SDLCALL SDL_JoystickConnected(SDL_Joystick *joystick); @@ -848,7 +848,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_JoystickConnected(SDL_Joystick *joystick); * \returns the instance ID of the specified joystick 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_JoystickID SDLCALL SDL_GetJoystickID(SDL_Joystick *joystick); @@ -863,7 +863,7 @@ extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetJoystickID(SDL_Joystick *joyst * \returns the number of axis controls/number of axes on success or -1 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. * * \sa SDL_GetJoystickAxis * \sa SDL_GetNumJoystickBalls @@ -884,7 +884,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickAxes(SDL_Joystick *joystick); * \returns the number of trackballs on success or -1 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. * * \sa SDL_GetJoystickBall * \sa SDL_GetNumJoystickAxes @@ -900,7 +900,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickBalls(SDL_Joystick *joystick); * \returns the number of POV hats on success or -1 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. * * \sa SDL_GetJoystickHat * \sa SDL_GetNumJoystickAxes @@ -916,7 +916,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickHats(SDL_Joystick *joystick); * \returns the number of buttons on success or -1 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. * * \sa SDL_GetJoystickButton * \sa SDL_GetNumJoystickAxes @@ -934,7 +934,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickButtons(SDL_Joystick *joystick * * \param enabled whether to process joystick events or not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_JoystickEventsEnabled * \sa SDL_UpdateJoysticks @@ -950,7 +950,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetJoystickEventsEnabled(bool enabled); * * \returns true if joystick events are being processed, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetJoystickEventsEnabled */ @@ -962,7 +962,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_JoystickEventsEnabled(void); * This is called automatically by the event loop if any joystick events are * enabled. * - * \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_UpdateJoysticks(void); @@ -984,7 +984,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UpdateJoysticks(void); * \returns a 16-bit signed integer representing the current position of the * axis 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. * * \sa SDL_GetNumJoystickAxes */ @@ -1002,7 +1002,7 @@ extern SDL_DECLSPEC Sint16 SDLCALL SDL_GetJoystickAxis(SDL_Joystick *joystick, i * \param state upon return, the initial value is supplied here. * \returns true if this axis has any initial value, or false if not. * - * \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_GetJoystickAxisInitialState(SDL_Joystick *joystick, int axis, Sint16 *state); @@ -1021,7 +1021,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetJoystickAxisInitialState(SDL_Joystick *j * \returns true on success or false 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. * * \sa SDL_GetNumJoystickBalls */ @@ -1036,7 +1036,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetJoystickBall(SDL_Joystick *joystick, int * \param hat the hat index to get the state from; indices start at index 0. * \returns the current hat position. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetNumJoystickHats */ @@ -1060,7 +1060,7 @@ extern SDL_DECLSPEC Uint8 SDLCALL SDL_GetJoystickHat(SDL_Joystick *joystick, int * index 0. * \returns true if the button is pressed, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetNumJoystickButtons */ @@ -1083,7 +1083,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetJoystickButton(SDL_Joystick *joystick, i * \param duration_ms the duration of the rumble effect, in milliseconds. * \returns true, or false if rumble isn't supported on this joystick. * - * \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_RumbleJoystick(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms); @@ -1110,7 +1110,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RumbleJoystick(SDL_Joystick *joystick, Uint * \returns true on success or false 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. * * \sa SDL_RumbleJoystick */ @@ -1132,7 +1132,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RumbleJoystickTriggers(SDL_Joystick *joysti * \returns true on success or false 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 bool SDLCALL SDL_SetJoystickLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue); @@ -1145,7 +1145,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickLED(SDL_Joystick *joystick, Uint * \returns true on success or false 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 bool SDLCALL SDL_SendJoystickEffect(SDL_Joystick *joystick, const void *data, int size); @@ -1154,7 +1154,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SendJoystickEffect(SDL_Joystick *joystick, * * \param joystick the joystick device to close. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenJoystick */ @@ -1168,7 +1168,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseJoystick(SDL_Joystick *joystick); * `SDL_JOYSTICK_CONNECTION_INVALID` 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_JoystickConnectionState SDLCALL SDL_GetJoystickConnectionState(SDL_Joystick *joystick); @@ -1189,7 +1189,7 @@ extern SDL_DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetJoystickConnectio * \returns the current battery state or `SDL_POWERSTATE_ERROR` 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_PowerState SDLCALL SDL_GetJoystickPowerInfo(SDL_Joystick *joystick, int *percent); diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h index 95a78cb5d..4432dd1f3 100644 --- a/include/SDL3/SDL_keyboard.h +++ b/include/SDL3/SDL_keyboard.h @@ -50,7 +50,7 @@ extern "C" { * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_KeyboardID; @@ -61,7 +61,7 @@ typedef Uint32 SDL_KeyboardID; * * \returns true if a keyboard is connected, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyboards */ @@ -81,7 +81,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasKeyboard(void); * call SDL_GetError() for more information. This should be freed * with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyboardNameForID * \sa SDL_HasKeyboard @@ -97,7 +97,7 @@ extern SDL_DECLSPEC SDL_KeyboardID * SDLCALL SDL_GetKeyboards(int *count); * \returns the name of the selected keyboard or NULL 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. * * \sa SDL_GetKeyboards */ @@ -108,7 +108,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetKeyboardNameForID(SDL_KeyboardID * * \returns the window with keyboard focus. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void); @@ -136,7 +136,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void); * \param numkeys if non-NULL, receives the length of the returned array. * \returns a pointer to an array of key states. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_PumpEvents * \sa SDL_ResetKeyboard @@ -148,7 +148,7 @@ extern SDL_DECLSPEC const bool * SDLCALL SDL_GetKeyboardState(int *numkeys); * * This function will generate key up events for all pressed keys. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyboardState */ @@ -160,7 +160,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ResetKeyboard(void); * \returns an OR'd combination of the modifier keys for the keyboard. See * SDL_Keymod for details. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyboardState * \sa SDL_SetModState @@ -180,7 +180,7 @@ extern SDL_DECLSPEC SDL_Keymod SDLCALL SDL_GetModState(void); * * \param modstate the desired SDL_Keymod for the keyboard. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetModState */ @@ -201,7 +201,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate); * \param key_event true if the keycode will be used in key events. * \returns the SDL_Keycode that corresponds to the given SDL_Scancode. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyName * \sa SDL_GetScancodeFromKey @@ -220,7 +220,7 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scan * scancode generates this key, may be NULL. * \returns the SDL_Scancode that corresponds to the given SDL_Keycode. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyFromScancode * \sa SDL_GetScancodeName @@ -237,7 +237,7 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key, * \returns true on success or false 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. * * \sa SDL_GetScancodeName */ @@ -259,7 +259,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetScancodeName(SDL_Scancode scancode, cons * \returns a pointer to the name for the scancode. If the scancode doesn't * have a name this function returns an empty string (""). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetScancodeFromKey * \sa SDL_GetScancodeFromName @@ -274,7 +274,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetScancodeName(SDL_Scancode scanco * \returns the SDL_Scancode, or `SDL_SCANCODE_UNKNOWN` if the name wasn't * recognized; 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. * * \sa SDL_GetKeyFromName * \sa SDL_GetScancodeFromKey @@ -290,7 +290,7 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *nam * \param key the desired SDL_Keycode to query. * \returns a UTF-8 encoded string of the key name. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetKeyFromName * \sa SDL_GetKeyFromScancode @@ -305,7 +305,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetKeyName(SDL_Keycode key); * \returns key code, or `SDLK_UNKNOWN` if the name wasn't recognized; 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. * * \sa SDL_GetKeyFromScancode * \sa SDL_GetKeyName @@ -330,7 +330,7 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name); * \returns true on success or false 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. * * \sa SDL_SetTextInputArea * \sa SDL_StartTextInputWithProperties @@ -346,7 +346,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StartTextInput(SDL_Window *window); * value is valid on every platform, but where a value isn't supported, a * reasonable fallback will be used. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_StartTextInputWithProperties */ @@ -371,7 +371,7 @@ typedef enum SDL_TextInputType * every platform, but where a value isn't supported, a reasonable fallback * will be used. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_StartTextInputWithProperties */ @@ -424,7 +424,7 @@ typedef enum SDL_Capitalization * \returns true on success or false 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. * * \sa SDL_SetTextInputArea * \sa SDL_StartTextInput @@ -445,7 +445,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StartTextInputWithProperties(SDL_Window *wi * \param window the window to check. * \returns true if text input events are enabled else false. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_StartTextInput */ @@ -461,7 +461,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TextInputActive(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_StartTextInput */ @@ -474,7 +474,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StopTextInput(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_StartTextInput * \sa SDL_StopTextInput @@ -495,7 +495,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearComposition(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_GetTextInputArea * \sa SDL_StartTextInput @@ -515,7 +515,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextInputArea(SDL_Window *window, const * \returns true on success or false 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. * * \sa SDL_SetTextInputArea */ @@ -527,7 +527,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextInputArea(SDL_Window *window, SDL_Re * \returns true if the platform has some screen keyboard support or false if * not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_StartTextInput * \sa SDL_ScreenKeyboardShown @@ -540,7 +540,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasScreenKeyboardSupport(void); * \param window the window for which screen keyboard should be queried. * \returns true if screen keyboard is shown or false if not. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasScreenKeyboardSupport */ diff --git a/include/SDL3/SDL_keycode.h b/include/SDL3/SDL_keycode.h index f4770279a..77968bd09 100644 --- a/include/SDL3/SDL_keycode.h +++ b/include/SDL3/SDL_keycode.h @@ -42,7 +42,7 @@ * A special exception is the number keys at the top of the keyboard which map * to SDLK_0...SDLK_9 on AZERTY layouts. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_Keycode; @@ -301,7 +301,7 @@ typedef Uint32 SDL_Keycode; /** * Valid key modifiers (possibly OR'd together). * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint16 SDL_Keymod; diff --git a/include/SDL3/SDL_loadso.h b/include/SDL3/SDL_loadso.h index 2d49c75fe..53c496711 100644 --- a/include/SDL3/SDL_loadso.h +++ b/include/SDL3/SDL_loadso.h @@ -63,7 +63,7 @@ extern "C" { /** * An opaque datatype that represents a loaded shared object. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_LoadObject * \sa SDL_LoadFunction @@ -80,7 +80,7 @@ typedef struct SDL_SharedObject SDL_SharedObject; * * \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_LoadFunction * \sa SDL_UnloadObject @@ -109,7 +109,7 @@ extern SDL_DECLSPEC SDL_SharedObject * SDLCALL SDL_LoadObject(const char *sofile * * \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_LoadObject */ @@ -125,7 +125,7 @@ extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_LoadFunction(SDL_SharedObjec * * \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_LoadObject */ diff --git a/include/SDL3/SDL_locale.h b/include/SDL3/SDL_locale.h index 85d77500c..3042bd858 100644 --- a/include/SDL3/SDL_locale.h +++ b/include/SDL3/SDL_locale.h @@ -47,7 +47,7 @@ extern "C" { * would be "en"), and the country, if not NULL, will be an ISO-3166 country * code (so Canada would be "CA"). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPreferredLocales */ @@ -96,7 +96,7 @@ typedef struct SDL_Locale * allocation that should be freed with SDL_free() when it is no * longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Locale ** SDLCALL SDL_GetPreferredLocales(int *count); diff --git a/include/SDL3/SDL_log.h b/include/SDL3/SDL_log.h index b5db82cd5..49be64dc9 100644 --- a/include/SDL3/SDL_log.h +++ b/include/SDL3/SDL_log.h @@ -76,7 +76,7 @@ extern "C" { * level, the assert category is enabled at the WARN level, test is enabled at * the VERBOSE level and all other categories are enabled at the ERROR level. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_LogCategory { @@ -116,7 +116,7 @@ typedef enum SDL_LogCategory /** * The predefined log priorities * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_LogPriority { @@ -139,7 +139,7 @@ typedef enum SDL_LogPriority * * \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_ResetLogPriorities * \sa SDL_SetLogPriority @@ -154,7 +154,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetLogPriorities(SDL_LogPriority priority); * * \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_GetLogPriority * \sa SDL_ResetLogPriorities @@ -170,7 +170,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetLogPriority(int category, SDL_LogPriorit * * \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_SetLogPriority */ @@ -183,7 +183,7 @@ extern SDL_DECLSPEC SDL_LogPriority SDLCALL SDL_GetLogPriority(int category); * * \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_SetLogPriorities * \sa SDL_SetLogPriority @@ -205,7 +205,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ResetLogPriorities(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_SetLogPriorities * \sa SDL_SetLogPriority @@ -221,7 +221,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetLogPriorityPrefix(SDL_LogPriority priori * * \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_LogCritical * \sa SDL_LogDebug @@ -245,7 +245,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fm * * \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_Log * \sa SDL_LogCritical @@ -270,7 +270,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogTrace(int category, SDL_PRINTF_FORMAT_ST * * \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_Log * \sa SDL_LogCritical @@ -293,7 +293,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_ * * \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_Log * \sa SDL_LogCritical @@ -317,7 +317,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogDebug(int category, SDL_PRINTF_FORMAT_ST * * \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_Log * \sa SDL_LogCritical @@ -341,7 +341,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogInfo(int category, SDL_PRINTF_FORMAT_STR * * \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_Log * \sa SDL_LogCritical @@ -365,7 +365,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STR * * \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_Log * \sa SDL_LogCritical @@ -389,7 +389,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogError(int category, SDL_PRINTF_FORMAT_ST * * \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_Log * \sa SDL_LogDebug @@ -414,7 +414,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogCritical(int category, SDL_PRINTF_FORMAT * * \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_Log * \sa SDL_LogCritical @@ -440,7 +440,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogMessage(int category, * * \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_Log * \sa SDL_LogCritical @@ -469,7 +469,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogMessageV(int category, * \param priority the priority of the message. * \param message the message being output. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_LogPriority priority, const char *message); @@ -480,7 +480,7 @@ typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_ * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.1.4. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetLogOutputFunction * \sa SDL_GetLogOutputFunction @@ -497,7 +497,7 @@ extern SDL_DECLSPEC SDL_LogOutputFunction SDLCALL SDL_GetDefaultLogOutputFunctio * * \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_GetDefaultLogOutputFunction * \sa SDL_SetLogOutputFunction @@ -512,7 +512,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetLogOutputFunction(SDL_LogOutputFunction * * \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_GetDefaultLogOutputFunction * \sa SDL_GetLogOutputFunction diff --git a/include/SDL3/SDL_main.h b/include/SDL3/SDL_main.h index b3455ce3d..f15d14f74 100644 --- a/include/SDL3/SDL_main.h +++ b/include/SDL3/SDL_main.h @@ -252,7 +252,7 @@ extern "C" { * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to * terminate with success, SDL_APP_CONTINUE to continue. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AppIterate * \sa SDL_AppEvent @@ -304,7 +304,7 @@ extern SDLMAIN_DECLSPEC SDL_AppResult SDLCALL SDL_AppInit(void **appstate, int a * \threadsafety This function may get called concurrently with SDL_AppEvent() * for events not pushed on the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AppInit * \sa SDL_AppEvent @@ -353,7 +353,7 @@ extern SDLMAIN_DECLSPEC SDL_AppResult SDLCALL SDL_AppIterate(void *appstate); * SDL_AppIterate() or SDL_AppQuit() for events not pushed from * the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AppInit * \sa SDL_AppIterate @@ -392,7 +392,7 @@ extern SDLMAIN_DECLSPEC SDL_AppResult SDLCALL SDL_AppEvent(void *appstate, SDL_E * \threadsafety SDL_AppEvent() may get called concurrently with this function * if other threads that push events are still active. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AppInit */ @@ -410,7 +410,7 @@ extern SDLMAIN_DECLSPEC void SDLCALL SDL_AppQuit(void *appstate, SDL_AppResult r * program completion, and small non-zero values are considered * errors. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]); @@ -443,7 +443,7 @@ typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]); * * \threadsafety This is the program entry point. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDLMAIN_DECLSPEC int SDLCALL SDL_main(int argc, char *argv[]); @@ -456,7 +456,7 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_main(int argc, char *argv[]); * will not be changed it is necessary to define SDL_MAIN_HANDLED before * including SDL.h. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Init */ @@ -488,7 +488,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetMainReady(void); * \threadsafety Generally this is called once, near startup, from the * process's initial thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_RunApp(int argc, char *argv[], SDL_main_func mainFunction, void *reserved); @@ -515,7 +515,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_RunApp(int argc, char *argv[], SDL_main_func * \threadsafety It is not safe to call this anywhere except as the only * function call in SDL_main. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_EnterAppMainCallbacks(int argc, char *argv[], SDL_AppInit_func appinit, SDL_AppIterate_func appiter, SDL_AppEvent_func appevent, SDL_AppQuit_func appquit); @@ -544,7 +544,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_EnterAppMainCallbacks(int argc, char *argv[] * \returns true on success or false 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 bool SDLCALL SDL_RegisterApp(const char *name, Uint32 style, void *hInst); @@ -561,7 +561,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RegisterApp(const char *name, Uint32 style, * deregistered when the registration counter in SDL_RegisterApp decrements to * zero through calls to this function. * - * \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_UnregisterApp(void); @@ -572,7 +572,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnregisterApp(void); /** * Callback from the application to let the suspend continue. * - * \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_GDKSuspendComplete(void); diff --git a/include/SDL3/SDL_messagebox.h b/include/SDL3/SDL_messagebox.h index bec3ac06e..5161ef71f 100644 --- a/include/SDL3/SDL_messagebox.h +++ b/include/SDL3/SDL_messagebox.h @@ -43,7 +43,7 @@ extern "C" { * * If supported will display warning icon, etc. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_MessageBoxFlags; @@ -56,7 +56,7 @@ typedef Uint32 SDL_MessageBoxFlags; /** * SDL_MessageBoxButtonData flags. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_MessageBoxButtonFlags; @@ -66,7 +66,7 @@ typedef Uint32 SDL_MessageBoxButtonFlags; /** * Individual button data. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MessageBoxButtonData { @@ -78,7 +78,7 @@ typedef struct SDL_MessageBoxButtonData /** * RGB value used in a message box color scheme * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MessageBoxColor { @@ -102,7 +102,7 @@ typedef enum SDL_MessageBoxColorType /** * A set of colors to use for message box dialogs * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MessageBoxColorScheme { @@ -112,7 +112,7 @@ typedef struct SDL_MessageBoxColorScheme /** * MessageBox structure containing title, text, window, etc. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_MessageBoxData { @@ -157,7 +157,7 @@ typedef struct SDL_MessageBoxData * \returns true on success or false 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. * * \sa SDL_ShowSimpleMessageBox */ @@ -199,7 +199,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *me * \returns true on success or false 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. * * \sa SDL_ShowMessageBox */ diff --git a/include/SDL3/SDL_metal.h b/include/SDL3/SDL_metal.h index 7c9aece7a..ff7f2a0eb 100644 --- a/include/SDL3/SDL_metal.h +++ b/include/SDL3/SDL_metal.h @@ -39,7 +39,7 @@ extern "C" { /** * A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS). * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef void *SDL_MetalView; @@ -61,7 +61,7 @@ typedef void *SDL_MetalView; * \param window the window. * \returns handle NSView or UIView. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Metal_DestroyView * \sa SDL_Metal_GetLayer @@ -76,7 +76,7 @@ extern SDL_DECLSPEC SDL_MetalView SDLCALL SDL_Metal_CreateView(SDL_Window *windo * * \param view the SDL_MetalView object. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Metal_CreateView */ @@ -88,7 +88,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view); * \param view the SDL_MetalView object. * \returns a pointer. * - * \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_Metal_GetLayer(SDL_MetalView view); diff --git a/include/SDL3/SDL_misc.h b/include/SDL3/SDL_misc.h index 2d5aa153e..45d26f4d1 100644 --- a/include/SDL3/SDL_misc.h +++ b/include/SDL3/SDL_misc.h @@ -65,7 +65,7 @@ extern "C" { * \returns true on success or false 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 bool SDLCALL SDL_OpenURL(const char *url); diff --git a/include/SDL3/SDL_mouse.h b/include/SDL3/SDL_mouse.h index 44060091f..16c07100f 100644 --- a/include/SDL3/SDL_mouse.h +++ b/include/SDL3/SDL_mouse.h @@ -47,7 +47,7 @@ extern "C" { * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_MouseID; @@ -56,14 +56,14 @@ typedef Uint32 SDL_MouseID; * * This is opaque data. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Cursor SDL_Cursor; /** * Cursor types for SDL_CreateSystemCursor(). * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_SystemCursor { @@ -93,7 +93,7 @@ typedef enum SDL_SystemCursor /** * Scroll direction types for the Scroll event * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_MouseWheelDirection { @@ -110,7 +110,7 @@ typedef enum SDL_MouseWheelDirection * - Button 4: Side mouse button 1 * - Button 5: Side mouse button 2 * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GetMouseState * \sa SDL_GetGlobalMouseState @@ -139,7 +139,7 @@ typedef Uint32 SDL_MouseButtonFlags; * * \returns true if a mouse is connected, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetMice */ @@ -159,7 +159,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasMouse(void); * call SDL_GetError() for more information. This should be freed * with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetMouseNameForID * \sa SDL_HasMouse @@ -175,7 +175,7 @@ extern SDL_DECLSPEC SDL_MouseID * SDLCALL SDL_GetMice(int *count); * \returns the name of the selected mouse, or NULL 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. * * \sa SDL_GetMice */ @@ -186,7 +186,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetMouseNameForID(SDL_MouseID insta * * \returns the window with mouse focus. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void); @@ -205,7 +205,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void); * focus window. * \returns a 32-bit button bitmask of the current button state. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetGlobalMouseState * \sa SDL_GetRelativeMouseState @@ -235,7 +235,7 @@ extern SDL_DECLSPEC SDL_MouseButtonFlags SDLCALL SDL_GetMouseState(float *x, flo * \returns the current button state as a bitmask which can be tested using * the SDL_BUTTON_MASK(X) macros. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CaptureMouse * \sa SDL_GetMouseState @@ -255,7 +255,7 @@ extern SDL_DECLSPEC SDL_MouseButtonFlags SDLCALL SDL_GetGlobalMouseState(float * * \param y a pointer filled with the last recorded y coordinate of the mouse. * \returns a 32-bit button bitmask of the relative button state. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetMouseState */ @@ -276,7 +276,7 @@ extern SDL_DECLSPEC SDL_MouseButtonFlags SDLCALL SDL_GetRelativeMouseState(float * \param x the x coordinate within the window. * \param y the y coordinate within the window. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_WarpMouseGlobal */ @@ -299,7 +299,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window, * \returns true on success or false 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. * * \sa SDL_WarpMouseInWindow */ @@ -320,7 +320,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WarpMouseGlobal(float x, float y); * \returns true on success or false 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. * * \sa SDL_GetWindowRelativeMouseMode */ @@ -332,7 +332,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowRelativeMouseMode(SDL_Window *wind * \param window the window to query. * \returns true if relative mode is enabled for a window or false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowRelativeMouseMode */ @@ -378,7 +378,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowRelativeMouseMode(SDL_Window *wind * \returns true on success or false 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. * * \sa SDL_GetGlobalMouseState */ @@ -419,7 +419,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CaptureMouse(bool enabled); * \returns a new cursor with the specified parameters on success or NULL 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. * * \sa SDL_CreateColorCursor * \sa SDL_CreateSystemCursor @@ -450,7 +450,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor(const Uint8 * data, * \returns the new cursor on success or NULL 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. * * \sa SDL_CreateCursor * \sa SDL_CreateSystemCursor @@ -468,7 +468,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateColorCursor(SDL_Surface *surf * \returns a cursor on success or NULL 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. * * \sa SDL_DestroyCursor */ @@ -486,7 +486,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor * \returns true on success or false 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. * * \sa SDL_GetCursor */ @@ -500,7 +500,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCursor(SDL_Cursor *cursor); * * \returns the active cursor or NULL if there is no mouse. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetCursor */ @@ -515,7 +515,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_GetCursor(void); * \returns the default cursor on success or NULL on failuree; 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_Cursor * SDLCALL SDL_GetDefaultCursor(void); @@ -527,7 +527,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_GetDefaultCursor(void); * * \param cursor the cursor to free. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateColorCursor * \sa SDL_CreateCursor @@ -541,7 +541,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyCursor(SDL_Cursor *cursor); * \returns true on success or false 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. * * \sa SDL_CursorVisible * \sa SDL_HideCursor @@ -554,7 +554,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowCursor(void); * \returns true on success or false 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. * * \sa SDL_CursorVisible * \sa SDL_ShowCursor @@ -567,7 +567,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HideCursor(void); * \returns `true` if the cursor is being shown, or `false` if the cursor is * hidden. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HideCursor * \sa SDL_ShowCursor diff --git a/include/SDL3/SDL_mutex.h b/include/SDL3/SDL_mutex.h index 03cb80cfb..b3fddeebd 100644 --- a/include/SDL3/SDL_mutex.h +++ b/include/SDL3/SDL_mutex.h @@ -132,7 +132,7 @@ extern "C" { * * https://en.wikipedia.org/wiki/Mutex * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Mutex SDL_Mutex; @@ -149,7 +149,7 @@ typedef struct SDL_Mutex SDL_Mutex; * \returns the initialized and unlocked mutex or NULL 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. * * \sa SDL_DestroyMutex * \sa SDL_LockMutex @@ -175,7 +175,7 @@ extern SDL_DECLSPEC SDL_Mutex * SDLCALL SDL_CreateMutex(void); * * \param mutex the mutex to lock. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_TryLockMutex * \sa SDL_UnlockMutex @@ -196,7 +196,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockMutex(SDL_Mutex *mutex) SDL_ACQUIRE(mut * \param mutex the mutex to try to lock. * \returns true on success, false if the mutex would block. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockMutex * \sa SDL_UnlockMutex @@ -215,7 +215,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockMutex(SDL_Mutex *mutex) SDL_TRY_ACQU * * \param mutex the mutex to unlock. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockMutex * \sa SDL_TryLockMutex @@ -233,7 +233,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockMutex(SDL_Mutex *mutex) SDL_RELEASE(m * * \param mutex the mutex to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateMutex */ @@ -263,7 +263,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_Mutex *mutex); * about how threads are scheduled and when they can be recursively locked. * These are documented in the other rwlock functions. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_RWLock SDL_RWLock; @@ -298,7 +298,7 @@ typedef struct SDL_RWLock SDL_RWLock; * \returns the initialized and unlocked read/write lock or NULL 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. * * \sa SDL_DestroyRWLock * \sa SDL_LockRWLockForReading @@ -338,7 +338,7 @@ extern SDL_DECLSPEC SDL_RWLock * SDLCALL SDL_CreateRWLock(void); * * \param rwlock the read/write lock to lock. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockRWLockForWriting * \sa SDL_TryLockRWLockForReading @@ -369,7 +369,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockRWLockForReading(SDL_RWLock *rwlock) SD * * \param rwlock the read/write lock to lock. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockRWLockForReading * \sa SDL_TryLockRWLockForWriting @@ -394,7 +394,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockRWLockForWriting(SDL_RWLock *rwlock) SD * \param rwlock the rwlock to try to lock. * \returns true on success, false if the lock would block. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockRWLockForReading * \sa SDL_TryLockRWLockForWriting @@ -424,7 +424,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockRWLockForReading(SDL_RWLock *rwlock) * \param rwlock the rwlock to try to lock. * \returns true on success, false if the lock would block. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockRWLockForWriting * \sa SDL_TryLockRWLockForReading @@ -448,7 +448,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockRWLockForWriting(SDL_RWLock *rwlock) * * \param rwlock the rwlock to unlock. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockRWLockForReading * \sa SDL_LockRWLockForWriting @@ -468,7 +468,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockRWLock(SDL_RWLock *rwlock) SDL_RELEAS * * \param rwlock the rwlock to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateRWLock */ @@ -494,7 +494,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyRWLock(SDL_RWLock *rwlock); * * https://en.wikipedia.org/wiki/Semaphore_(programming) * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Semaphore SDL_Semaphore; @@ -511,7 +511,7 @@ typedef struct SDL_Semaphore SDL_Semaphore; * \returns a new semaphore or NULL 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. * * \sa SDL_DestroySemaphore * \sa SDL_SignalSemaphore @@ -530,7 +530,7 @@ extern SDL_DECLSPEC SDL_Semaphore * SDLCALL SDL_CreateSemaphore(Uint32 initial_v * * \param sem the semaphore to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateSemaphore */ @@ -548,7 +548,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_Semaphore *sem); * * \param sem the semaphore wait on. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SignalSemaphore * \sa SDL_TryWaitSemaphore @@ -567,7 +567,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitSemaphore(SDL_Semaphore *sem); * \param sem the semaphore to wait on. * \returns true if the wait succeeds, false if the wait would block. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SignalSemaphore * \sa SDL_WaitSemaphore @@ -587,7 +587,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryWaitSemaphore(SDL_Semaphore *sem); * indefinitely. * \returns true if the wait succeeds or false if the wait times out. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SignalSemaphore * \sa SDL_TryWaitSemaphore @@ -600,7 +600,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Si * * \param sem the semaphore to increment. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_TryWaitSemaphore * \sa SDL_WaitSemaphore @@ -614,7 +614,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalSemaphore(SDL_Semaphore *sem); * \param sem the semaphore to query. * \returns the current value of the semaphore. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetSemaphoreValue(SDL_Semaphore *sem); @@ -637,7 +637,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetSemaphoreValue(SDL_Semaphore *sem); * * https://en.wikipedia.org/wiki/Condition_variable * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Condition SDL_Condition; @@ -647,7 +647,7 @@ typedef struct SDL_Condition SDL_Condition; * \returns a new condition variable or NULL 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. * * \sa SDL_BroadcastCondition * \sa SDL_SignalCondition @@ -662,7 +662,7 @@ extern SDL_DECLSPEC SDL_Condition * SDLCALL SDL_CreateCondition(void); * * \param cond the condition variable to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateCondition */ @@ -675,7 +675,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyCondition(SDL_Condition *cond); * * \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_BroadcastCondition * \sa SDL_WaitCondition @@ -690,7 +690,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalCondition(SDL_Condition *cond); * * \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_SignalCondition * \sa SDL_WaitCondition @@ -718,7 +718,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BroadcastCondition(SDL_Condition *cond); * * \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_BroadcastCondition * \sa SDL_SignalCondition @@ -748,7 +748,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitCondition(SDL_Condition *cond, SDL_Mute * * \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_BroadcastCondition * \sa SDL_SignalCondition @@ -767,7 +767,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitConditionTimeout(SDL_Condition *cond, /** * The current status of an SDL_InitState structure. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_InitStatus { @@ -831,7 +831,7 @@ typedef enum SDL_InitStatus * should use other mechanisms to protect those, if that's a concern for your * code. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_InitState { @@ -856,7 +856,7 @@ typedef struct SDL_InitState * * \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_SetInitialized * \sa SDL_ShouldQuit @@ -877,7 +877,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShouldInit(SDL_InitState *state); * * \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_SetInitialized * \sa SDL_ShouldInit @@ -896,7 +896,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShouldQuit(SDL_InitState *state); * * \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_ShouldInit * \sa SDL_ShouldQuit diff --git a/include/SDL3/SDL_pen.h b/include/SDL3/SDL_pen.h index 77c7bed9a..6f0eef50f 100644 --- a/include/SDL3/SDL_pen.h +++ b/include/SDL3/SDL_pen.h @@ -55,7 +55,7 @@ extern "C" { * consistent as long as SDL can recognize a tool to be the same pen; but if a * pen physically leaves the area and returns, it might get a new ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_PenID; @@ -63,7 +63,7 @@ typedef Uint32 SDL_PenID; /** * Pen input flags, as reported by various pen events' `pen_state` field. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_PenInputFlags; @@ -88,7 +88,7 @@ typedef Uint32 SDL_PenInputFlags; * * `SDL_sinf(xtilt * SDL_PI_F / 180.0)`. * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 */ typedef enum SDL_PenAxis { diff --git a/include/SDL3/SDL_pixels.h b/include/SDL3/SDL_pixels.h index 820e29957..42957797b 100644 --- a/include/SDL3/SDL_pixels.h +++ b/include/SDL3/SDL_pixels.h @@ -41,7 +41,7 @@ extern "C" { /** * A fully opaque 8-bit alpha value. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_ALPHA_TRANSPARENT */ @@ -50,7 +50,7 @@ extern "C" { /** * A fully opaque floating point alpha value. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_ALPHA_TRANSPARENT_FLOAT */ @@ -59,7 +59,7 @@ extern "C" { /** * A fully transparent 8-bit alpha value. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_ALPHA_OPAQUE */ @@ -68,7 +68,7 @@ extern "C" { /** * A fully transparent floating point alpha value. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_ALPHA_OPAQUE_FLOAT */ @@ -77,7 +77,7 @@ extern "C" { /** * Pixel type. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_PixelType { @@ -100,7 +100,7 @@ typedef enum SDL_PixelType /** * Bitmap pixel order, high bit -> low bit. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_BitmapOrder { @@ -112,7 +112,7 @@ typedef enum SDL_BitmapOrder /** * Packed component order, high bit -> low bit. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_PackedOrder { @@ -130,7 +130,7 @@ typedef enum SDL_PackedOrder /** * Array component order, low byte -> high byte. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ArrayOrder { @@ -146,7 +146,7 @@ typedef enum SDL_ArrayOrder /** * Packed component layout. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_PackedLayout { @@ -259,7 +259,7 @@ typedef enum SDL_PackedLayout * an alias for ABGR8888 on little-endian CPUs like x86, or an alias for * RGBA8888 on big-endian CPUs. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_PixelFormat { @@ -441,7 +441,7 @@ typedef enum SDL_PixelFormat /** * Colorspace color type. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ColorType { @@ -454,7 +454,7 @@ typedef enum SDL_ColorType * Colorspace color range, as described by * https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ColorRange { @@ -467,7 +467,7 @@ typedef enum SDL_ColorRange * Colorspace color primaries, as described by * https://www.itu.int/rec/T-REC-H.273-201612-S/en * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ColorPrimaries { @@ -492,7 +492,7 @@ typedef enum SDL_ColorPrimaries * * These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_TransferCharacteristics { @@ -522,7 +522,7 @@ typedef enum SDL_TransferCharacteristics * * These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_MatrixCoefficients { @@ -546,7 +546,7 @@ typedef enum SDL_MatrixCoefficients /** * Colorspace chroma sample location. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ChromaLocation { @@ -582,7 +582,7 @@ typedef enum SDL_ChromaLocation * function, etc.), this is not an exhaustive list, but rather a * representative sample of the kinds of colorspaces supported in SDL. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_ColorPrimaries * \sa SDL_ColorRange @@ -689,7 +689,7 @@ typedef enum SDL_Colorspace * (SDL_PIXELFORMAT_ABGR8888 on little-endian systems and * SDL_PIXELFORMAT_RGBA8888 on big-endian systems). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Color { @@ -703,7 +703,7 @@ typedef struct SDL_Color * The bits of this structure can be directly reinterpreted as a float-packed * color which uses the SDL_PIXELFORMAT_RGBA128_FLOAT format * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_FColor { @@ -716,7 +716,7 @@ typedef struct SDL_FColor /** * A set of indexed colors representing a palette. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_SetPaletteColors */ @@ -731,7 +731,7 @@ typedef struct SDL_Palette /** * Details about the format of a pixel. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_PixelFormatDetails { @@ -762,7 +762,7 @@ typedef struct SDL_PixelFormatDetails * * \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_GetPixelFormatName(SDL_PixelFormat format); @@ -780,7 +780,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat * * \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_GetPixelFormatForMasks */ @@ -802,7 +802,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetMasksForPixelFormat(SDL_PixelFormat form * * \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_GetMasksForPixelFormat */ @@ -821,7 +821,7 @@ extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetPixelFormatForMasks(int bpp, * * \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 SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDetails(SDL_PixelFormat format); @@ -837,7 +837,7 @@ extern SDL_DECLSPEC const SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDet * * \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_DestroyPalette * \sa SDL_SetPaletteColors @@ -858,7 +858,7 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreatePalette(int ncolors); * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified or destroyed in another 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_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors); @@ -870,7 +870,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPaletteColors(SDL_Palette *palette, cons * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified or destroyed in another thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreatePalette */ @@ -905,7 +905,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyPalette(SDL_Palette *palette); * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPixelFormatDetails * \sa SDL_GetRGB @@ -944,7 +944,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormatDetails *form * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPixelFormatDetails * \sa SDL_GetRGBA @@ -972,7 +972,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormatDetails *for * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPixelFormatDetails * \sa SDL_GetRGBA @@ -1004,7 +1004,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, const SDL_PixelFormatD * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPixelFormatDetails * \sa SDL_GetRGB diff --git a/include/SDL3/SDL_platform.h b/include/SDL3/SDL_platform.h index bfdfa3a41..9f4689d6f 100644 --- a/include/SDL3/SDL_platform.h +++ b/include/SDL3/SDL_platform.h @@ -51,7 +51,7 @@ extern "C" { * \returns the name of the platform. If the correct platform name is not * available, returns a string beginning with the text "Unknown". * - * \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_GetPlatform(void); diff --git a/include/SDL3/SDL_platform_defines.h b/include/SDL3/SDL_platform_defines.h index 4f878e3b2..89ce02d45 100644 --- a/include/SDL3/SDL_platform_defines.h +++ b/include/SDL3/SDL_platform_defines.h @@ -33,7 +33,7 @@ /** * A preprocessor macro that is only defined if compiling for AIX. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_AIX 1 #endif @@ -43,7 +43,7 @@ /** * A preprocessor macro that is only defined if compiling for Haiku OS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_HAIKU 1 #endif @@ -53,7 +53,7 @@ /** * A preprocessor macro that is only defined if compiling for BSDi * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_BSDI 1 #endif @@ -63,7 +63,7 @@ /** * A preprocessor macro that is only defined if compiling for FreeBSD. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_FREEBSD 1 #endif @@ -73,7 +73,7 @@ /** * A preprocessor macro that is only defined if compiling for HP-UX. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_HPUX 1 #endif @@ -83,7 +83,7 @@ /** * A preprocessor macro that is only defined if compiling for IRIX. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_IRIX 1 #endif @@ -96,7 +96,7 @@ * Note that Android, although ostensibly a Linux-based system, will not * define this. It defines SDL_PLATFORM_ANDROID instead. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_LINUX 1 #endif @@ -106,7 +106,7 @@ /** * A preprocessor macro that is only defined if compiling for Android. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_ANDROID 1 #undef SDL_PLATFORM_LINUX @@ -117,7 +117,7 @@ /** * A preprocessor macro that is only defined if compiling for Nokia N-Gage. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_NGAGE 1 #endif @@ -131,7 +131,7 @@ * Other platforms, like Linux, might define this in addition to their primary * define. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_UNIX 1 #endif @@ -143,7 +143,7 @@ * * iOS, macOS, etc will additionally define a more specific platform macro. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PLATFORM_MACOS * \sa SDL_PLATFORM_IOS @@ -190,7 +190,7 @@ /** * A preprocessor macro that is only defined if compiling for tvOS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PLATFORM_APPLE */ @@ -202,7 +202,7 @@ /** * A preprocessor macro that is only defined if compiling for VisionOS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PLATFORM_APPLE */ @@ -214,7 +214,7 @@ /** * A preprocessor macro that is only defined if compiling for iOS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PLATFORM_APPLE */ @@ -225,7 +225,7 @@ /** * A preprocessor macro that is only defined if compiling for macOS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PLATFORM_APPLE */ @@ -242,7 +242,7 @@ /** * A preprocessor macro that is only defined if compiling for Emscripten. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_EMSCRIPTEN 1 #endif @@ -252,7 +252,7 @@ /** * A preprocessor macro that is only defined if compiling for NetBSD. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_NETBSD 1 #endif @@ -262,7 +262,7 @@ /** * A preprocessor macro that is only defined if compiling for OpenBSD. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_OPENBSD 1 #endif @@ -272,7 +272,7 @@ /** * A preprocessor macro that is only defined if compiling for OS/2. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_OS2 1 #endif @@ -282,7 +282,7 @@ /** * A preprocessor macro that is only defined if compiling for Tru64 (OSF/1). * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_OSF 1 #endif @@ -292,7 +292,7 @@ /** * A preprocessor macro that is only defined if compiling for QNX Neutrino. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_QNXNTO 1 #endif @@ -302,7 +302,7 @@ /** * A preprocessor macro that is only defined if compiling for RISC OS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_RISCOS 1 #endif @@ -312,7 +312,7 @@ /** * A preprocessor macro that is only defined if compiling for SunOS/Solaris. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_SOLARIS 1 #endif @@ -322,7 +322,7 @@ /** * A preprocessor macro that is only defined if compiling for Cygwin. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_CYGWIN 1 #endif @@ -335,7 +335,7 @@ * This also covers several other platforms, like Microsoft GDK, Xbox, WinRT, * etc. Each will have their own more-specific platform macros, too. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_PLATFORM_WIN32 * \sa SDL_PLATFORM_XBOXONE @@ -382,7 +382,7 @@ * A preprocessor macro that is only defined if compiling for Microsoft GDK * for Windows. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_WINGDK 1 @@ -391,7 +391,7 @@ /** * A preprocessor macro that is only defined if compiling for Xbox One. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_XBOXONE 1 @@ -400,7 +400,7 @@ /** * A preprocessor macro that is only defined if compiling for Xbox Series. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_XBOXSERIES 1 @@ -413,7 +413,7 @@ * convention, its system layer tends to still be referred to as "the Win32 * API." * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_WIN32 1 @@ -428,7 +428,7 @@ * A preprocessor macro that is only defined if compiling for Microsoft GDK on * any platform. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_GDK 1 #endif @@ -438,7 +438,7 @@ /** * A preprocessor macro that is only defined if compiling for Sony PSP. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_PSP 1 #endif @@ -449,7 +449,7 @@ * A preprocessor macro that is only defined if compiling for Sony PlayStation * 2. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_PS2 1 #endif @@ -459,7 +459,7 @@ /** * A preprocessor macro that is only defined if compiling for Sony Vita. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_VITA 1 #endif @@ -469,7 +469,7 @@ /** * A preprocessor macro that is only defined if compiling for Nintendo 3DS. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_PLATFORM_3DS 1 diff --git a/include/SDL3/SDL_power.h b/include/SDL3/SDL_power.h index 1fdef78ee..5265eaf9b 100644 --- a/include/SDL3/SDL_power.h +++ b/include/SDL3/SDL_power.h @@ -42,7 +42,7 @@ extern "C" { * * These are results returned by SDL_GetPowerInfo(). * - * \since This enum is available since SDL 3.0.0 + * \since This enum is available since SDL 3.1.3 */ typedef enum SDL_PowerState { @@ -80,7 +80,7 @@ typedef enum SDL_PowerState * \returns the current battery state or `SDL_POWERSTATE_ERROR` 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_PowerState SDLCALL SDL_GetPowerInfo(int *seconds, int *percent); diff --git a/include/SDL3/SDL_process.h b/include/SDL3/SDL_process.h index 1dfac1917..32042a3e8 100644 --- a/include/SDL3/SDL_process.h +++ b/include/SDL3/SDL_process.h @@ -85,7 +85,7 @@ typedef struct SDL_Process SDL_Process; * * \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_CreateProcessWithProperties * \sa SDL_GetProcessProperties @@ -132,7 +132,7 @@ extern SDL_DECLSPEC SDL_Process *SDLCALL SDL_CreateProcess(const char * const *a * `SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER` set. This is true for streams * representing files and process I/O. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_CreateProcessWithProperties * \sa SDL_GetProcessProperties @@ -197,7 +197,7 @@ typedef enum SDL_ProcessIO * * \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_CreateProcess * \sa SDL_GetProcessProperties @@ -245,7 +245,7 @@ extern SDL_DECLSPEC SDL_Process *SDLCALL SDL_CreateProcessWithProperties(SDL_Pro * * \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_CreateProcess * \sa SDL_CreateProcessWithProperties @@ -281,7 +281,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetProcessProperties(SDL_Proces * * \threadsafety This function is not thread safe. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProcess * \sa SDL_CreateProcessWithProperties @@ -307,7 +307,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_ReadProcess(SDL_Process *process, size_t * * \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_CreateProcess * \sa SDL_CreateProcessWithProperties @@ -331,7 +331,7 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_GetProcessInput(SDL_Process *proce * * \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_CreateProcess * \sa SDL_CreateProcessWithProperties @@ -353,7 +353,7 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_GetProcessOutput(SDL_Process *proc * * \threadsafety This function is not thread safe. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProcess * \sa SDL_CreateProcessWithProperties @@ -380,7 +380,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_KillProcess(SDL_Process *process, bool forc * * \threadsafety This function is not thread safe. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProcess * \sa SDL_CreateProcessWithProperties @@ -400,7 +400,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitProcess(SDL_Process *process, bool bloc * * \threadsafety This function is not thread safe. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProcess * \sa SDL_CreateProcessWithProperties diff --git a/include/SDL3/SDL_properties.h b/include/SDL3/SDL_properties.h index e48466ed7..45852407e 100644 --- a/include/SDL3/SDL_properties.h +++ b/include/SDL3/SDL_properties.h @@ -61,14 +61,14 @@ extern "C" { /** * SDL properties ID * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_PropertiesID; /** * SDL property type * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_PropertyType { @@ -86,7 +86,7 @@ typedef enum SDL_PropertyType * \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_GetGlobalProperties(void); @@ -100,7 +100,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGlobalProperties(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_DestroyProperties */ @@ -121,7 +121,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_CreateProperties(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. */ extern SDL_DECLSPEC bool SDLCALL SDL_CopyProperties(SDL_PropertiesID src, SDL_PropertiesID dst); @@ -143,7 +143,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CopyProperties(SDL_PropertiesID src, SDL_Pr * * \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_UnlockProperties */ @@ -156,7 +156,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockProperties(SDL_PropertiesID props); * * \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_LockProperties */ @@ -180,7 +180,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockProperties(SDL_PropertiesID props); * \threadsafety This callback may fire without any locks held; if this is a * concern, the app should provide its own locking. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetPointerPropertyWithCleanup */ @@ -209,7 +209,7 @@ typedef void (SDLCALL *SDL_CleanupPropertyCallback)(void *userdata, void *value) * * \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_GetPointerProperty * \sa SDL_SetPointerProperty @@ -228,7 +228,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPointerPropertyWithCleanup(SDL_Propertie * * \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_GetPointerProperty * \sa SDL_HasProperty @@ -254,7 +254,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPointerProperty(SDL_PropertiesID props, * * \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_GetStringProperty */ @@ -271,7 +271,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetStringProperty(SDL_PropertiesID props, c * * \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_GetNumberProperty */ @@ -288,7 +288,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetNumberProperty(SDL_PropertiesID props, c * * \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_GetFloatProperty */ @@ -305,7 +305,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetFloatProperty(SDL_PropertiesID props, co * * \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_GetBooleanProperty */ @@ -320,7 +320,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetBooleanProperty(SDL_PropertiesID props, * * \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_GetPropertyType */ @@ -336,7 +336,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasProperty(SDL_PropertiesID props, const c * * \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_HasProperty */ @@ -363,7 +363,7 @@ extern SDL_DECLSPEC SDL_PropertyType SDLCALL SDL_GetPropertyType(SDL_PropertiesI * If you need to avoid this, use SDL_LockProperties() and * SDL_UnlockProperties(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetBooleanProperty * \sa SDL_GetFloatProperty @@ -391,7 +391,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetPointerProperty(SDL_PropertiesID props * If you need to avoid this, use SDL_LockProperties() and * SDL_UnlockProperties(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPropertyType * \sa SDL_HasProperty @@ -413,7 +413,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetStringProperty(SDL_PropertiesID * * \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_GetPropertyType * \sa SDL_HasProperty @@ -435,7 +435,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetNumberProperty(SDL_PropertiesID props, * * \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_GetPropertyType * \sa SDL_HasProperty @@ -457,7 +457,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetFloatProperty(SDL_PropertiesID props, c * * \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_GetPropertyType * \sa SDL_HasProperty @@ -475,7 +475,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetBooleanProperty(SDL_PropertiesID props, * * \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_ClearProperty(SDL_PropertiesID props, const char *name); @@ -492,7 +492,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const * \threadsafety SDL_EnumerateProperties holds a lock on `props` during this * callback. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_EnumerateProperties */ @@ -512,7 +512,7 @@ typedef void (SDLCALL *SDL_EnumeratePropertiesCallback)(void *userdata, SDL_Prop * * \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_EnumerateProperties(SDL_PropertiesID props, SDL_EnumeratePropertiesCallback callback, void *userdata); @@ -528,7 +528,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateProperties(SDL_PropertiesID props, * locked or other threads might be setting or getting values * from these properties. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProperties */ diff --git a/include/SDL3/SDL_rect.h b/include/SDL3/SDL_rect.h index d0f0bbcba..e4d3b84de 100644 --- a/include/SDL3/SDL_rect.h +++ b/include/SDL3/SDL_rect.h @@ -41,7 +41,7 @@ extern "C" { /** * The structure that defines a point (using integers). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetRectEnclosingPoints * \sa SDL_PointInRect @@ -55,7 +55,7 @@ typedef struct SDL_Point /** * The structure that defines a point (using floating point values). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetRectEnclosingPointsFloat * \sa SDL_PointInRectFloat @@ -70,7 +70,7 @@ typedef struct SDL_FPoint /** * A rectangle, with the origin at the upper left (using integers). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_RectEmpty * \sa SDL_RectsEqual @@ -91,7 +91,7 @@ typedef struct SDL_Rect * A rectangle, with the origin at the upper left (using floating point * values). * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_RectEmptyFloat * \sa SDL_RectsEqualFloat @@ -121,7 +121,7 @@ typedef struct SDL_FRect * * \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. */ SDL_FORCE_INLINE void SDL_RectToFRect(const SDL_Rect *rect, SDL_FRect *frect) { @@ -150,7 +150,7 @@ SDL_FORCE_INLINE void SDL_RectToFRect(const SDL_Rect *rect, SDL_FRect *frect) * * \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. */ SDL_FORCE_INLINE bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r) { @@ -174,7 +174,7 @@ SDL_FORCE_INLINE bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r) * * \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. */ SDL_FORCE_INLINE bool SDL_RectEmpty(const SDL_Rect *r) { @@ -198,7 +198,7 @@ SDL_FORCE_INLINE bool SDL_RectEmpty(const SDL_Rect *r) * * \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. */ SDL_FORCE_INLINE bool SDL_RectsEqual(const SDL_Rect *a, const SDL_Rect *b) { @@ -217,7 +217,7 @@ SDL_FORCE_INLINE bool SDL_RectsEqual(const SDL_Rect *a, const SDL_Rect *b) * * \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_GetRectIntersection */ @@ -234,7 +234,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasRectIntersection(const SDL_Rect *A, cons * rectangles `A` and `B`. * \returns true if there is an intersection, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasRectIntersection */ @@ -250,7 +250,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectIntersection(const SDL_Rect *A, cons * \returns true on success or false 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 bool SDLCALL SDL_GetRectUnion(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result); @@ -269,7 +269,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectUnion(const SDL_Rect *A, const SDL_R * \returns true if any points were enclosed or false if all the points were * outside of the clipping rectangle. * - * \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_GetRectEnclosingPoints(const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result); @@ -289,7 +289,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectEnclosingPoints(const SDL_Point *poi * \param Y2 a pointer to the ending Y-coordinate of the line. * \returns true if there is an intersection, false otherwise. * - * \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_GetRectAndLineIntersection(const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2); @@ -315,7 +315,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectAndLineIntersection(const SDL_Rect * * * \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. */ SDL_FORCE_INLINE bool SDL_PointInRectFloat(const SDL_FPoint *p, const SDL_FRect *r) { @@ -339,7 +339,7 @@ SDL_FORCE_INLINE bool SDL_PointInRectFloat(const SDL_FPoint *p, const SDL_FRect * * \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. */ SDL_FORCE_INLINE bool SDL_RectEmptyFloat(const SDL_FRect *r) { @@ -367,7 +367,7 @@ SDL_FORCE_INLINE bool SDL_RectEmptyFloat(const SDL_FRect *r) * * \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_RectsEqualFloat */ @@ -402,7 +402,7 @@ SDL_FORCE_INLINE bool SDL_RectsEqualEpsilon(const SDL_FRect *a, const SDL_FRect * * \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_RectsEqualEpsilon */ @@ -420,7 +420,7 @@ SDL_FORCE_INLINE bool SDL_RectsEqualFloat(const SDL_FRect *a, const SDL_FRect *b * \param B an SDL_FRect structure representing the second rectangle. * \returns true if there is an intersection, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRectIntersection */ @@ -437,7 +437,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasRectIntersectionFloat(const SDL_FRect *A * rectangles `A` and `B`. * \returns true if there is an intersection, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_HasRectIntersectionFloat */ @@ -453,7 +453,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectIntersectionFloat(const SDL_FRect *A * \returns true on success or false 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 bool SDLCALL SDL_GetRectUnionFloat(const SDL_FRect *A, const SDL_FRect *B, SDL_FRect *result); @@ -473,7 +473,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectUnionFloat(const SDL_FRect *A, const * \returns true if any points were enclosed or false if all the points were * outside of the clipping rectangle. * - * \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_GetRectEnclosingPointsFloat(const SDL_FPoint *points, int count, const SDL_FRect *clip, SDL_FRect *result); @@ -494,7 +494,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRectEnclosingPointsFloat(const SDL_FPoin * \param Y2 a pointer to the ending Y-coordinate of the line. * \returns true if there is an intersection, false otherwise. * - * \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_GetRectAndLineIntersectionFloat(const SDL_FRect *rect, float *X1, float *Y1, float *X2, float *Y2); diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h index 1bb53c319..e51b08a11 100644 --- a/include/SDL3/SDL_render.h +++ b/include/SDL3/SDL_render.h @@ -69,14 +69,14 @@ extern "C" { /** * The name of the software renderer. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_SOFTWARE_RENDERER "software" /** * Vertex structure. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Vertex { @@ -88,7 +88,7 @@ typedef struct SDL_Vertex /** * The access pattern allowed for a texture. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_TextureAccess { @@ -100,7 +100,7 @@ typedef enum SDL_TextureAccess /** * How the logical size is mapped to the output. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_RendererLogicalPresentation { @@ -114,7 +114,7 @@ typedef enum SDL_RendererLogicalPresentation /** * A structure representing rendering state * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Renderer SDL_Renderer; @@ -123,7 +123,7 @@ typedef struct SDL_Renderer SDL_Renderer; /** * An efficient driver-specific representation of pixel data * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_CreateTexture * \sa SDL_CreateTextureFromSurface @@ -157,7 +157,7 @@ typedef struct SDL_Texture SDL_Texture; * * \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_CreateRenderer * \sa SDL_GetRenderDriver @@ -182,7 +182,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(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_GetNumRenderDrivers */ @@ -203,7 +203,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetRenderDriver(int index); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateRenderer * \sa SDL_CreateWindow @@ -231,7 +231,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateWindowAndRenderer(const char *title, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateRendererWithProperties * \sa SDL_CreateSoftwareRenderer @@ -285,7 +285,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProperties * \sa SDL_CreateRenderer @@ -322,7 +322,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRendererWithProperties(SDL_ * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_DestroyRenderer */ @@ -337,7 +337,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surfac * * \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 SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window *window); @@ -350,7 +350,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window *window); * * \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 SDL_Window * SDLCALL SDL_GetRenderWindow(SDL_Renderer *renderer); @@ -363,7 +363,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetRenderWindow(SDL_Renderer *rende * * \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_CreateRenderer * \sa SDL_CreateRendererWithProperties @@ -447,7 +447,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetRendererName(SDL_Renderer *rende * * \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 SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Renderer *renderer); @@ -489,7 +489,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Rende * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetCurrentRenderOutputSize */ @@ -511,7 +511,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderOutputSize */ @@ -533,7 +533,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetCurrentRenderOutputSize(SDL_Renderer *re * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateTextureFromSurface * \sa SDL_CreateTextureWithProperties @@ -563,7 +563,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer *render * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateTexture * \sa SDL_CreateTextureWithProperties @@ -673,7 +673,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Rende * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateProperties * \sa SDL_CreateTexture @@ -803,7 +803,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureWithProperties(SDL_Re * * \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 SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Texture *texture); @@ -843,7 +843,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Textur * * \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 SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Texture *texture); @@ -860,7 +860,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Textur * * \threadsafety You may only call this function from the main 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_GetTextureSize(SDL_Texture *texture, float *w, float *h); @@ -885,7 +885,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureSize(SDL_Texture *texture, float * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureColorMod * \sa SDL_SetTextureAlphaMod @@ -915,7 +915,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureColorMod(SDL_Texture *texture, Ui * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureColorModFloat * \sa SDL_SetTextureAlphaModFloat @@ -936,7 +936,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureColorModFloat(SDL_Texture *textur * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureAlphaMod * \sa SDL_GetTextureColorModFloat @@ -956,7 +956,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureColorMod(SDL_Texture *texture, Ui * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureAlphaModFloat * \sa SDL_GetTextureColorMod @@ -982,7 +982,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureColorModFloat(SDL_Texture *textur * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureAlphaMod * \sa SDL_SetTextureAlphaModFloat @@ -1008,7 +1008,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureAlphaMod(SDL_Texture *texture, Ui * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureAlphaModFloat * \sa SDL_SetTextureAlphaMod @@ -1026,7 +1026,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureAlphaModFloat(SDL_Texture *textur * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureAlphaModFloat * \sa SDL_GetTextureColorMod @@ -1044,7 +1044,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureAlphaMod(SDL_Texture *texture, Ui * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureAlphaMod * \sa SDL_GetTextureColorModFloat @@ -1065,7 +1065,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *textur * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureBlendMode */ @@ -1081,7 +1081,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetTextureBlendMode */ @@ -1101,7 +1101,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureBlendMode(SDL_Texture *texture, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetTextureScaleMode */ @@ -1117,7 +1117,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureScaleMode(SDL_Texture *texture, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetTextureScaleMode */ @@ -1148,7 +1148,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureScaleMode(SDL_Texture *texture, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockTexture * \sa SDL_UnlockTexture @@ -1182,7 +1182,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_UpdateNVTexture * \sa SDL_UpdateTexture @@ -1214,7 +1214,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_UpdateTexture * \sa SDL_UpdateYUVTexture @@ -1249,7 +1249,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockTextureToSurface * \sa SDL_UnlockTexture @@ -1287,7 +1287,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockTexture(SDL_Texture *texture, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockTexture * \sa SDL_UnlockTexture @@ -1309,7 +1309,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockTextureToSurface(SDL_Texture *texture, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockTexture */ @@ -1331,7 +1331,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture *texture); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderTarget */ @@ -1348,7 +1348,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer, SDL * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderTarget */ @@ -1387,7 +1387,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *rend * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_ConvertEventToRenderCoordinates * \sa SDL_GetRenderLogicalPresentation @@ -1410,7 +1410,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderLogicalPresentation(SDL_Renderer * * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderLogicalPresentation */ @@ -1432,7 +1432,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer * * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderLogicalPresentation */ @@ -1458,7 +1458,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderLogicalPresentationRect(SDL_Render * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderLogicalPresentation * \sa SDL_SetRenderScale @@ -1487,7 +1487,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Renderer *r * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderLogicalPresentation * \sa SDL_SetRenderScale @@ -1517,7 +1517,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderCoordinatesToWindow(SDL_Renderer *ren * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderCoordinatesFromWindow */ @@ -1540,7 +1540,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertEventToRenderCoordinates(SDL_Rendere * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderViewport * \sa SDL_RenderViewportSet @@ -1557,7 +1557,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderViewport(SDL_Renderer *renderer, c * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderViewportSet * \sa SDL_SetRenderViewport @@ -1577,7 +1577,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderViewport(SDL_Renderer *renderer, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderViewport * \sa SDL_SetRenderViewport @@ -1602,7 +1602,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderViewportSet(SDL_Renderer *renderer); * * \threadsafety You may only call this function from the main 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_GetRenderSafeArea(SDL_Renderer *renderer, SDL_Rect *rect); @@ -1617,7 +1617,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderSafeArea(SDL_Renderer *renderer, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderClipRect * \sa SDL_RenderClipEnabled @@ -1635,7 +1635,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderClipRect(SDL_Renderer *renderer, c * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderClipEnabled * \sa SDL_SetRenderClipRect @@ -1651,7 +1651,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderClipRect(SDL_Renderer *renderer, S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderClipRect * \sa SDL_SetRenderClipRect @@ -1677,7 +1677,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderClipEnabled(SDL_Renderer *renderer); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderScale */ @@ -1694,7 +1694,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderScale(SDL_Renderer *renderer, floa * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderScale */ @@ -1718,7 +1718,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderScale(SDL_Renderer *renderer, floa * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderDrawColor * \sa SDL_SetRenderDrawColorFloat @@ -1743,7 +1743,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderDrawColorFloat * \sa SDL_SetRenderDrawColor @@ -1767,7 +1767,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawColorFloat(SDL_Renderer *rende * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderDrawColorFloat * \sa SDL_SetRenderDrawColor @@ -1791,7 +1791,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderDrawColor(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderDrawColorFloat * \sa SDL_GetRenderDrawColor @@ -1816,7 +1816,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderDrawColorFloat(SDL_Renderer *rende * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderColorScale */ @@ -1832,7 +1832,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderColorScale(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderColorScale */ @@ -1850,7 +1850,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderColorScale(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderDrawBlendMode */ @@ -1866,7 +1866,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *render * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderDrawBlendMode */ @@ -1886,7 +1886,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer *render * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderDrawColor */ @@ -1903,7 +1903,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderClear(SDL_Renderer *renderer); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderPoints */ @@ -1920,7 +1920,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, float x * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderPoint */ @@ -1939,7 +1939,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, const * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderLines */ @@ -1957,7 +1957,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderLine(SDL_Renderer *renderer, float x1 * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderLine */ @@ -1974,7 +1974,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderLines(SDL_Renderer *renderer, const S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderRects */ @@ -1992,7 +1992,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderRect(SDL_Renderer *renderer, const SD * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderRect */ @@ -2010,7 +2010,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderRects(SDL_Renderer *renderer, const S * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderFillRects */ @@ -2028,7 +2028,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, cons * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderFillRect */ @@ -2049,7 +2049,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, con * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderTextureRotated * \sa SDL_RenderTextureTiled @@ -2078,7 +2078,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, SDL_T * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderTexture */ @@ -2108,7 +2108,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderTexture */ @@ -2142,7 +2142,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTextureTiled(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderTexture */ @@ -2166,7 +2166,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTexture9Grid(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderGeometryRaw */ @@ -2198,7 +2198,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_RenderGeometry */ @@ -2227,7 +2227,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer, * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *renderer, const SDL_Rect *rect); @@ -2264,7 +2264,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *ren * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateRenderer * \sa SDL_RenderClear @@ -2291,7 +2291,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderPresent(SDL_Renderer *renderer); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateTexture * \sa SDL_CreateTextureFromSurface @@ -2308,7 +2308,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture *texture); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateRenderer */ @@ -2343,7 +2343,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer *renderer); * * \threadsafety You may only call this function from the main 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_FlushRenderer(SDL_Renderer *renderer); @@ -2359,7 +2359,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer); * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderMetalCommandEncoder */ @@ -2382,7 +2382,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalLayer(SDL_Renderer *rendere * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderMetalLayer */ @@ -2415,7 +2415,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalCommandEncoder(SDL_Renderer * \threadsafety It is **NOT** safe to call this function from two threads at * once. * - * \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_AddVulkanRenderSemaphores(SDL_Renderer *renderer, Uint32 wait_stage_mask, Sint64 wait_semaphore, Sint64 signal_semaphore); @@ -2438,7 +2438,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *ren * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRenderVSync */ @@ -2458,7 +2458,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, int * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetRenderVSync */ @@ -2469,7 +2469,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderVSync(SDL_Renderer *renderer, int * * The font is monospaced and square, so this applies to all characters. * - * \since This macro is available since SDL 3.1.6. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_RenderDebugText */ @@ -2509,7 +2509,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderVSync(SDL_Renderer *renderer, int * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.1.4. + * \since This function is available since SDL 3.1.3. * * \sa SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE */ diff --git a/include/SDL3/SDL_revision.h b/include/SDL3/SDL_revision.h index f78e5d9d0..d75cfc8ea 100644 --- a/include/SDL3/SDL_revision.h +++ b/include/SDL3/SDL_revision.h @@ -44,7 +44,7 @@ * clue in debugging forensics and not something the app will parse in any * way. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_REVISION "Some arbitrary string decided at SDL build time" #elif defined(SDL_VENDOR_INFO) diff --git a/include/SDL3/SDL_scancode.h b/include/SDL3/SDL_scancode.h index 16fb2a828..deda12fe1 100644 --- a/include/SDL3/SDL_scancode.h +++ b/include/SDL3/SDL_scancode.h @@ -42,7 +42,7 @@ * The values in this enumeration are based on the USB usage page standard: * https://usb.org/sites/default/files/hut1_5.pdf * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_Scancode { diff --git a/include/SDL3/SDL_sensor.h b/include/SDL3/SDL_sensor.h index 2ad2fc029..138629130 100644 --- a/include/SDL3/SDL_sensor.h +++ b/include/SDL3/SDL_sensor.h @@ -52,7 +52,7 @@ typedef struct SDL_Sensor SDL_Sensor; * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_SensorID; @@ -64,7 +64,7 @@ typedef Uint32 SDL_SensorID; * rest will have an value of SDL_STANDARD_GRAVITY away from the center of the * earth, which is a positive Y value. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_STANDARD_GRAVITY 9.80665f @@ -118,7 +118,7 @@ typedef Uint32 SDL_SensorID; * * The gyroscope axis data is not changed when the device is rotated. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_GetCurrentDisplayOrientation */ @@ -146,7 +146,7 @@ typedef enum SDL_SensorType * call SDL_GetError() for more information. This should be freed * with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_SensorID * SDLCALL SDL_GetSensors(int *count); @@ -158,7 +158,7 @@ extern SDL_DECLSPEC SDL_SensorID * SDLCALL SDL_GetSensors(int *count); * \param instance_id the sensor instance ID. * \returns the sensor name, or NULL if `instance_id` is not valid. * - * \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_GetSensorNameForID(SDL_SensorID instance_id); @@ -171,7 +171,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorNameForID(SDL_SensorID ins * \returns the SDL_SensorType, or `SDL_SENSOR_INVALID` if `instance_id` is * not valid. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorTypeForID(SDL_SensorID instance_id); @@ -184,7 +184,7 @@ extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorTypeForID(SDL_SensorID i * \returns the sensor platform dependent type, or -1 if `instance_id` is not * valid. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableTypeForID(SDL_SensorID instance_id); @@ -195,7 +195,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableTypeForID(SDL_SensorID i * \returns an SDL_Sensor object or NULL 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_Sensor * SDLCALL SDL_OpenSensor(SDL_SensorID instance_id); @@ -206,7 +206,7 @@ extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_OpenSensor(SDL_SensorID instance_id * \returns an SDL_Sensor object or NULL 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_Sensor * SDLCALL SDL_GetSensorFromID(SDL_SensorID instance_id); @@ -217,7 +217,7 @@ extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_GetSensorFromID(SDL_SensorID instan * \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_GetSensorProperties(SDL_Sensor *sensor); @@ -228,7 +228,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSensorProperties(SDL_Sensor * \returns the sensor name or NULL 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 const char * SDLCALL SDL_GetSensorName(SDL_Sensor *sensor); @@ -239,7 +239,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorName(SDL_Sensor *sensor); * \returns the SDL_SensorType type, or `SDL_SENSOR_INVALID` if `sensor` is * NULL. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorType(SDL_Sensor *sensor); @@ -249,7 +249,7 @@ extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorType(SDL_Sensor *sensor) * \param sensor the SDL_Sensor object to inspect. * \returns the sensor platform dependent type, or -1 if `sensor` is NULL. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableType(SDL_Sensor *sensor); @@ -260,7 +260,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableType(SDL_Sensor *sensor) * \returns the sensor instance ID, 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_SensorID SDLCALL SDL_GetSensorID(SDL_Sensor *sensor); @@ -275,7 +275,7 @@ extern SDL_DECLSPEC SDL_SensorID SDLCALL SDL_GetSensorID(SDL_Sensor *sensor); * \returns true on success or false 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 bool SDLCALL SDL_GetSensorData(SDL_Sensor *sensor, float *data, int num_values); @@ -284,7 +284,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSensorData(SDL_Sensor *sensor, float *da * * \param sensor the SDL_Sensor object to close. * - * \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_CloseSensor(SDL_Sensor *sensor); @@ -297,7 +297,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseSensor(SDL_Sensor *sensor); * This needs to be called from the thread that initialized the sensor * subsystem. * - * \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_UpdateSensors(void); diff --git a/include/SDL3/SDL_stdinc.h b/include/SDL3/SDL_stdinc.h index 1b64d8cb3..e1ab42e18 100644 --- a/include/SDL3/SDL_stdinc.h +++ b/include/SDL3/SDL_stdinc.h @@ -131,7 +131,7 @@ void *alloca(size_t); * inside of `sizeof`, so there are no side-effects here, as expressions do * not actually run any code in these cases. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0])) @@ -144,7 +144,7 @@ void *alloca(size_t); * #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")` * ``` * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_STRINGIFY_ARG(arg) #arg @@ -173,7 +173,7 @@ void *alloca(size_t); * * \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. * * \sa SDL_static_cast * \sa SDL_const_cast @@ -195,7 +195,7 @@ void *alloca(size_t); * * \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. * * \sa SDL_reinterpret_cast * \sa SDL_const_cast @@ -217,7 +217,7 @@ void *alloca(size_t); * * \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. * * \sa SDL_reinterpret_cast * \sa SDL_static_cast @@ -248,7 +248,7 @@ void *alloca(size_t); * * \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_FOURCC(A, B, C, D) \ ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \ @@ -265,7 +265,7 @@ void *alloca(size_t); * 0xFFFFFFFF is overflowing a 32-bit value. Use `SDL_SINT64_C(0xFFFFFFFF1)` * instead of `0xFFFFFFFF1` by itself. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_UINT64_C */ @@ -278,7 +278,7 @@ void *alloca(size_t); * 0xFFFFFFFF is overflowing a 32-bit value. Use `SDL_UINT64_C(0xFFFFFFFF1)` * instead of `0xFFFFFFFF1` by itself. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_SINT64_C */ @@ -306,7 +306,7 @@ void *alloca(size_t); /** * A signed 8-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ typedef int8_t Sint8; #define SDL_MAX_SINT8 ((Sint8)0x7F) /* 127 */ @@ -315,7 +315,7 @@ typedef int8_t Sint8; /** * An unsigned 8-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ typedef uint8_t Uint8; #define SDL_MAX_UINT8 ((Uint8)0xFF) /* 255 */ @@ -324,7 +324,7 @@ typedef uint8_t Uint8; /** * A signed 16-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ typedef int16_t Sint16; #define SDL_MAX_SINT16 ((Sint16)0x7FFF) /* 32767 */ @@ -333,7 +333,7 @@ typedef int16_t Sint16; /** * An unsigned 16-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ typedef uint16_t Uint16; #define SDL_MAX_UINT16 ((Uint16)0xFFFF) /* 65535 */ @@ -342,7 +342,7 @@ typedef uint16_t Uint16; /** * A signed 32-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ typedef int32_t Sint32; #define SDL_MAX_SINT32 ((Sint32)0x7FFFFFFF) /* 2147483647 */ @@ -351,7 +351,7 @@ typedef int32_t Sint32; /** * An unsigned 32-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ typedef uint32_t Uint32; #define SDL_MAX_UINT32 ((Uint32)0xFFFFFFFFu) /* 4294967295 */ @@ -360,7 +360,7 @@ typedef uint32_t Uint32; /** * A signed 64-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_SINT64_C */ @@ -371,7 +371,7 @@ typedef int64_t Sint64; /** * An unsigned 64-bit integer type. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_UINT64_C */ @@ -387,7 +387,7 @@ typedef uint64_t Uint64; * and SDL_SECONDS_TO_NS(), and between Windows FILETIME values with * SDL_TimeToWindows() and SDL_TimeFromWindows(). * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_MAX_SINT64 * \sa SDL_MIN_SINT64 @@ -413,7 +413,7 @@ typedef Sint64 SDL_Time; * Equals by default to platform-defined `FLT_EPSILON`, or * `1.1920928955078125e-07F` if that's not available. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_FLT_EPSILON 1.1920928955078125e-07F /* 0x0.000002p0 */ #endif @@ -652,7 +652,7 @@ extern "C" { * * \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. * * \sa SDL_IOStreamInterface * \sa SDL_StorageInterface @@ -689,7 +689,7 @@ extern "C" { * * \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_free * \sa SDL_calloc @@ -711,7 +711,7 @@ extern SDL_DECLSPEC SDL_MALLOC void * SDLCALL SDL_malloc(size_t size); * * \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_free * \sa SDL_malloc @@ -746,7 +746,7 @@ extern SDL_DECLSPEC SDL_MALLOC SDL_ALLOC_SIZE2(1, 2) void * SDLCALL SDL_calloc(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_free * \sa SDL_malloc @@ -766,7 +766,7 @@ extern SDL_DECLSPEC SDL_ALLOC_SIZE(2) void * SDLCALL SDL_realloc(void *mem, size * * \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_malloc * \sa SDL_calloc @@ -784,7 +784,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_free(void *mem); * * \threadsafety It should be safe to call this callback from any thread. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_malloc * \sa SDL_GetOriginalMemoryFunctions @@ -805,7 +805,7 @@ typedef void *(SDLCALL *SDL_malloc_func)(size_t size); * * \threadsafety It should be safe to call this callback from any thread. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_calloc * \sa SDL_GetOriginalMemoryFunctions @@ -826,7 +826,7 @@ typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size); * * \threadsafety It should be safe to call this callback from any thread. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_realloc * \sa SDL_GetOriginalMemoryFunctions @@ -844,7 +844,7 @@ typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size); * * \threadsafety It should be safe to call this callback from any thread. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_free * \sa SDL_GetOriginalMemoryFunctions @@ -868,7 +868,7 @@ typedef void (SDLCALL *SDL_free_func)(void *mem); * * \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 void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func *malloc_func, SDL_calloc_func *calloc_func, @@ -887,7 +887,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func * unlikely event of a background thread calling * SDL_SetMemoryFunctions simultaneously. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetMemoryFunctions * \sa SDL_GetOriginalMemoryFunctions @@ -918,7 +918,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_ * should not replace the memory functions once any allocations * are made! * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetMemoryFunctions * \sa SDL_GetOriginalMemoryFunctions @@ -946,7 +946,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_f * * \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_aligned_free */ @@ -964,7 +964,7 @@ extern SDL_DECLSPEC SDL_MALLOC void * SDLCALL SDL_aligned_alloc(size_t alignment * * \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_aligned_alloc */ @@ -977,14 +977,14 @@ extern SDL_DECLSPEC void SDLCALL SDL_aligned_free(void *mem); * * \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 int SDLCALL SDL_GetNumAllocations(void); /** * A thread-safe set of environment variables * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetEnvironment * \sa SDL_CreateEnvironment @@ -1010,7 +1010,7 @@ typedef struct SDL_Environment SDL_Environment; * * \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_GetEnvironmentVariable * \sa SDL_GetEnvironmentVariables @@ -1031,7 +1031,7 @@ extern SDL_DECLSPEC SDL_Environment * SDLCALL SDL_GetEnvironment(void); * from any thread, otherwise it is safe if no other threads are * calling setenv() or unsetenv() * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetEnvironmentVariable * \sa SDL_GetEnvironmentVariables @@ -1051,7 +1051,7 @@ extern SDL_DECLSPEC SDL_Environment * SDLCALL SDL_CreateEnvironment(bool populat * * \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_GetEnvironment * \sa SDL_CreateEnvironment @@ -1072,7 +1072,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetEnvironmentVariable(SDL_Environm * * \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_GetEnvironment * \sa SDL_CreateEnvironment @@ -1096,7 +1096,7 @@ extern SDL_DECLSPEC char ** SDLCALL SDL_GetEnvironmentVariables(SDL_Environment * * \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_GetEnvironment * \sa SDL_CreateEnvironment @@ -1116,7 +1116,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetEnvironmentVariable(SDL_Environment *env * * \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_GetEnvironment * \sa SDL_CreateEnvironment @@ -1135,7 +1135,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UnsetEnvironmentVariable(SDL_Environment *e * \threadsafety It is safe to call this function from any thread, as long as * the environment is no longer in use. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateEnvironment */ @@ -1152,7 +1152,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyEnvironment(SDL_Environment *env); * * \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_getenv(const char *name); @@ -1169,7 +1169,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_getenv(const char *name); * \threadsafety This function is not thread safe, consider using SDL_getenv() * instead. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_getenv */ @@ -1187,7 +1187,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_getenv_unsafe(const char *name); * \threadsafety This function is not thread safe, consider using * SDL_SetEnvironmentVariable() instead. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetEnvironmentVariable */ @@ -1202,7 +1202,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_setenv_unsafe(const char *name, const char * * \threadsafety This function is not thread safe, consider using * SDL_UnsetEnvironmentVariable() instead. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_UnsetEnvironmentVariable */ @@ -1217,7 +1217,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_unsetenv_unsafe(const char *name); * before `a`, 0 if they are equal. If two elements are equal, their * order in the sorted array is undefined. * - * \since This callback is available since SDL 3.0.0. + * \since This callback is available since SDL 3.1.3. * * \sa SDL_bsearch * \sa SDL_qsort @@ -1263,7 +1263,7 @@ typedef int (SDLCALL *SDL_CompareCallback)(const void *a, const void *b); * * \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_bsearch * \sa SDL_qsort_r @@ -1313,7 +1313,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size * * \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_bsearch_r * \sa SDL_qsort @@ -1330,7 +1330,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_bsearch(const void *key, const void *base * before `a`, 0 if they are equal. If two elements are equal, their * order in the sorted array is undefined. * - * \since This callback is available since SDL 3.0.0. + * \since This callback is available since SDL 3.1.3. * * \sa SDL_qsort_r * \sa SDL_bsearch_r @@ -1383,7 +1383,7 @@ typedef int (SDLCALL *SDL_CompareCallback_r)(void *userdata, const void *a, cons * * \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_bsearch_r * \sa SDL_qsort @@ -1441,7 +1441,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_qsort_r(void *base, size_t nmemb, size_t si * * \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_bsearch * \sa SDL_qsort_r @@ -1466,7 +1466,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_abs(int x); * * \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 int SDLCALL SDL_isalpha(int x); @@ -1481,7 +1481,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isalpha(int x); * * \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 int SDLCALL SDL_isalnum(int x); @@ -1496,7 +1496,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isalnum(int x); * * \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 int SDLCALL SDL_isblank(int x); @@ -1511,7 +1511,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isblank(int x); * * \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 int SDLCALL SDL_iscntrl(int x); @@ -1526,7 +1526,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_iscntrl(int x); * * \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 int SDLCALL SDL_isdigit(int x); @@ -1541,7 +1541,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isdigit(int x); * * \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 int SDLCALL SDL_isxdigit(int x); @@ -1556,7 +1556,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isxdigit(int x); * * \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_isgraph * \sa SDL_isalnum @@ -1581,7 +1581,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_ispunct(int x); * * \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 int SDLCALL SDL_isspace(int x); @@ -1596,7 +1596,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isspace(int x); * * \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 int SDLCALL SDL_isupper(int x); @@ -1611,7 +1611,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isupper(int x); * * \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 int SDLCALL SDL_islower(int x); @@ -1630,7 +1630,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_islower(int x); * * \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 int SDLCALL SDL_isprint(int x); @@ -1649,7 +1649,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isprint(int x); * * \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_isprint */ @@ -1669,7 +1669,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isgraph(int x); * * \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 int SDLCALL SDL_toupper(int x); @@ -1687,7 +1687,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_toupper(int x); * * \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 int SDLCALL SDL_tolower(int x); @@ -1709,7 +1709,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_murmur3_32(const void *data, size_t len, * * \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_memmove */ @@ -1740,7 +1740,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, 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_memcpy */ @@ -1795,7 +1795,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_wcsnlen(const wchar_t *wstr, size_t maxle * * \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_wcslcat */ @@ -1824,7 +1824,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *ds * * \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_wcslcpy */ @@ -1849,7 +1849,7 @@ extern SDL_DECLSPEC wchar_t * SDLCALL SDL_wcsnstr(const wchar_t *haystack, const * * \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 int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2); @@ -1880,7 +1880,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *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. */ extern SDL_DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen); @@ -1910,7 +1910,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t * * * \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 int SDLCALL SDL_wcscasecmp(const wchar_t *str1, const wchar_t *str2); @@ -1952,7 +1952,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_wcscasecmp(const wchar_t *str1, const wchar_ * * \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 int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen); @@ -1977,7 +1977,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar * * \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_strtol */ @@ -2008,7 +2008,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_strnlen(const char *str, size_t maxlen); * * \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_strlcat * \sa SDL_utf8strlcpy @@ -2037,7 +2037,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, * * \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_strlcpy */ @@ -2065,7 +2065,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char * * \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_strlcpy */ @@ -2090,7 +2090,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_strrev(char *str); * * \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_strlwr */ @@ -2111,7 +2111,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_strupr(char *str); * * \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_strupr */ @@ -2144,7 +2144,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_ulltoa(unsigned long long value, char *st * * \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_atof * \sa SDL_strtol @@ -2167,7 +2167,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_atoi(const char *str); * * \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_atoi * \sa SDL_strtol @@ -2199,7 +2199,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_atof(const char *str); * * \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_atoi * \sa SDL_atof @@ -2233,7 +2233,7 @@ extern SDL_DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int ba * * \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_atoi * \sa SDL_atof @@ -2266,7 +2266,7 @@ extern SDL_DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **en * * \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_atoi * \sa SDL_atof @@ -2300,7 +2300,7 @@ extern SDL_DECLSPEC long long SDLCALL SDL_strtoll(const char *str, char **endp, * * \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_atoi * \sa SDL_atof @@ -2330,7 +2330,7 @@ extern SDL_DECLSPEC unsigned long long SDLCALL SDL_strtoull(const char *str, cha * * \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_atoi * \sa SDL_atof @@ -2357,7 +2357,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp); * * \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 int SDLCALL SDL_strcmp(const char *str1, const char *str2); @@ -2387,7 +2387,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2); * * \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 int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen); @@ -2415,7 +2415,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, * * \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 int SDLCALL SDL_strcasecmp(const char *str1, const char *str2); @@ -2455,7 +2455,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str * * \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 int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t maxlen); @@ -2473,7 +2473,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *st * * \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 char * SDLCALL SDL_strpbrk(const char *str, const char *breakset); @@ -2485,7 +2485,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_strpbrk(const char *str, const char *brea * * This tends to render as something like a question mark in most places. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. * * \sa SDL_StepBackUTF8 * \sa SDL_StepUTF8 @@ -2533,7 +2533,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_strpbrk(const char *str, const char *brea * * \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 Uint32 SDLCALL SDL_StepUTF8(const char **pstr, size_t *pslen); @@ -2564,7 +2564,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_StepUTF8(const char **pstr, size_t *pslen * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.1.4. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint32 SDLCALL SDL_StepBackUTF8(const char *start, const char **pstr); @@ -2593,7 +2593,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_StepBackUTF8(const char *start, const cha * * \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 char * SDLCALL SDL_UCS4ToUTF8(Uint32 codepoint, char *dst); @@ -2619,7 +2619,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_vasprintf(char **strp, SDL_PRINTF_FORMAT_STR * \threadsafety This should be called on the same thread that calls * SDL_rand*() * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_rand * \sa SDL_rand_bits @@ -2654,7 +2654,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_srand(Uint64 seed); * * \threadsafety All calls should be made from a single thread * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_srand * \sa SDL_randf @@ -2677,7 +2677,7 @@ extern SDL_DECLSPEC Sint32 SDLCALL SDL_rand(Sint32 n); * * \threadsafety All calls should be made from a single thread * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_srand * \sa SDL_rand @@ -2699,7 +2699,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_randf(void); * * \threadsafety All calls should be made from a single thread * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_rand * \sa SDL_randf @@ -2734,7 +2734,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits(void); * \threadsafety This function is thread-safe, as long as the state pointer * isn't shared between threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_rand * \sa SDL_rand_bits_r @@ -2761,7 +2761,7 @@ extern SDL_DECLSPEC Sint32 SDLCALL SDL_rand_r(Uint64 *state, Sint32 n); * \threadsafety This function is thread-safe, as long as the state pointer * isn't shared between threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_rand_bits_r * \sa SDL_rand_r @@ -2787,7 +2787,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_randf_r(Uint64 *state); * \threadsafety This function is thread-safe, as long as the state pointer * isn't shared between threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_rand_r * \sa SDL_randf_r @@ -2824,7 +2824,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits_r(Uint64 *state); * * \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_acosf * \sa SDL_asin @@ -2854,7 +2854,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_acos(double x); * * \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_acos * \sa SDL_asinf @@ -2884,7 +2884,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_acosf(float x); * * \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_asinf * \sa SDL_acos @@ -2914,7 +2914,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_asin(double x); * * \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_asin * \sa SDL_acosf @@ -2946,7 +2946,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_asinf(float x); * * \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_atanf * \sa SDL_atan2 @@ -2978,7 +2978,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_atan(double x); * * \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_atan * \sa SDL_atan2f @@ -3014,7 +3014,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_atanf(float x); * * \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_atan2f * \sa SDL_atan @@ -3050,7 +3050,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_atan2(double y, double x); * * \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_atan2f * \sa SDL_atan @@ -3076,7 +3076,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_atan2f(float y, float x); * * \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_ceilf * \sa SDL_floor @@ -3104,7 +3104,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_ceil(double x); * * \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_ceil * \sa SDL_floorf @@ -3133,7 +3133,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_ceilf(float x); * * \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_copysignf * \sa SDL_fabs @@ -3159,7 +3159,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_copysign(double x, double y); * * \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_copysignf * \sa SDL_fabsf @@ -3186,7 +3186,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_copysignf(float x, float y); * * \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_cosf * \sa SDL_acos @@ -3214,7 +3214,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_cos(double x); * * \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_cos * \sa SDL_acosf @@ -3247,7 +3247,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_cosf(float x); * * \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_expf * \sa SDL_log @@ -3279,7 +3279,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_exp(double x); * * \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_exp * \sa SDL_logf @@ -3301,7 +3301,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_expf(float x); * * \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_fabsf */ @@ -3322,7 +3322,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_fabs(double x); * * \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_fabs */ @@ -3346,7 +3346,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_fabsf(float x); * * \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_floorf * \sa SDL_ceil @@ -3374,7 +3374,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_floor(double x); * * \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_floor * \sa SDL_ceilf @@ -3402,7 +3402,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_floorf(float x); * * \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_truncf * \sa SDL_fmod @@ -3431,7 +3431,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_trunc(double x); * * \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_trunc * \sa SDL_fmodf @@ -3460,7 +3460,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_truncf(float x); * * \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_fmodf * \sa SDL_modf @@ -3490,7 +3490,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_fmod(double x, double y); * * \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_fmod * \sa SDL_truncf @@ -3510,7 +3510,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_fmodf(float x, float y); * * \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_isinff */ @@ -3524,7 +3524,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isinf(double x); * * \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_isinf */ @@ -3538,7 +3538,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isinff(float x); * * \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_isnanf */ @@ -3552,7 +3552,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isnan(double x); * * \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_isnan */ @@ -3580,7 +3580,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_isnanf(float x); * * \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_logf * \sa SDL_log10 @@ -3610,7 +3610,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_log(double x); * * \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_log * \sa SDL_expf @@ -3639,7 +3639,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_logf(float x); * * \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_log10f * \sa SDL_log @@ -3669,7 +3669,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_log10(double x); * * \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_log10 * \sa SDL_logf @@ -3689,7 +3689,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_log10f(float x); * * \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_modff * \sa SDL_trunc @@ -3709,7 +3709,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_modf(double x, double *y); * * \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_modf * \sa SDL_truncf @@ -3741,7 +3741,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_modff(float x, float *y); * * \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_powf * \sa SDL_exp @@ -3773,7 +3773,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_pow(double x, double y); * * \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_pow * \sa SDL_expf @@ -3800,7 +3800,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_powf(float x, float y); * * \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_roundf * \sa SDL_lround @@ -3829,7 +3829,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_round(double x); * * \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_round * \sa SDL_lroundf @@ -3858,7 +3858,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_roundf(float x); * * \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_lroundf * \sa SDL_round @@ -3887,7 +3887,7 @@ extern SDL_DECLSPEC long SDLCALL SDL_lround(double x); * * \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_lround * \sa SDL_roundf @@ -3915,7 +3915,7 @@ extern SDL_DECLSPEC long SDLCALL SDL_lroundf(float x); * * \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_scalbnf * \sa SDL_pow @@ -3940,7 +3940,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_scalbn(double x, int n); * * \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_scalbn * \sa SDL_powf @@ -3967,7 +3967,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_scalbnf(float x, int n); * * \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_sinf * \sa SDL_asin @@ -3995,7 +3995,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_sin(double x); * * \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_sin * \sa SDL_asinf @@ -4023,7 +4023,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_sinf(float x); * * \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_sqrtf */ @@ -4049,7 +4049,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_sqrt(double x); * * \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_sqrt */ @@ -4075,7 +4075,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_sqrtf(float x); * * \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_tanf * \sa SDL_sin @@ -4105,7 +4105,7 @@ extern SDL_DECLSPEC double SDLCALL SDL_tan(double x); * * \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_tan * \sa SDL_sinf @@ -4132,7 +4132,7 @@ typedef struct SDL_iconv_data_t *SDL_iconv_t; * \returns a handle that must be freed with SDL_iconv_close, or * SDL_ICONV_ERROR on failure. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_iconv * \sa SDL_iconv_close @@ -4147,7 +4147,7 @@ extern SDL_DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode, * \param cd The character set conversion handle. * \returns 0 on success, or -1 on failure. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_iconv * \sa SDL_iconv_open @@ -4184,7 +4184,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd); * the location where to store the next output byte. - outbytesleft * will be set to the number of bytes left in the output buffer. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_iconv_open * \sa SDL_iconv_close @@ -4213,7 +4213,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, * \param inbytesleft the size of the input string _in bytes_. * \returns a new string, converted to the new encoding, or NULL on error. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_iconv_open * \sa SDL_iconv_close @@ -4316,7 +4316,7 @@ char *strdup(const char *str); * * \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. */ SDL_FORCE_INLINE bool SDL_size_mul_check_overflow(size_t a, size_t b, size_t *ret) { @@ -4355,7 +4355,7 @@ SDL_FORCE_INLINE bool SDL_size_mul_check_overflow_builtin(size_t a, size_t b, si * * \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. */ SDL_FORCE_INLINE bool SDL_size_add_check_overflow(size_t a, size_t b, size_t *ret) { @@ -4394,7 +4394,7 @@ SDL_FORCE_INLINE bool SDL_size_add_check_overflow_builtin(size_t a, size_t b, si * perhaps to work around a compiler or existing code, you can define * `SDL_FUNCTION_POINTER_IS_VOID_POINTER` before including any SDL headers. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef void (*SDL_FunctionPointer)(void); #elif defined(SDL_FUNCTION_POINTER_IS_VOID_POINTER) diff --git a/include/SDL3/SDL_storage.h b/include/SDL3/SDL_storage.h index 9edbcf8e4..a0b4e4966 100644 --- a/include/SDL3/SDL_storage.h +++ b/include/SDL3/SDL_storage.h @@ -54,7 +54,7 @@ extern "C" { * * This structure should be initialized using SDL_INIT_INTERFACE() * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_INIT_INTERFACE */ @@ -114,7 +114,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_StorageInterface_SIZE, * functions like SDL_OpenTitleStorage or SDL_OpenUserStorage, etc, or create * an object with a custom implementation using SDL_OpenStorage. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_Storage SDL_Storage; @@ -126,7 +126,7 @@ typedef struct SDL_Storage SDL_Storage; * \returns a title storage container on success or NULL 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. * * \sa SDL_CloseStorage * \sa SDL_GetStorageFileSize @@ -149,7 +149,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenTitleStorage(const char *overr * \returns a user storage container on success or NULL 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. * * \sa SDL_CloseStorage * \sa SDL_GetStorageFileSize @@ -173,7 +173,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenUserStorage(const char *org, c * \returns a filesystem storage container on success or NULL 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. * * \sa SDL_CloseStorage * \sa SDL_GetStorageFileSize @@ -202,7 +202,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenFileStorage(const char *path); * \returns a storage container on success or NULL 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. * * \sa SDL_CloseStorage * \sa SDL_GetStorageFileSize @@ -223,7 +223,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenStorage(const SDL_StorageInter * returns an error, the container data will be freed; the error is * only for informational purposes. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_OpenFileStorage * \sa SDL_OpenStorage @@ -242,7 +242,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseStorage(SDL_Storage *storage); * \param storage a storage container to query. * \returns true if the container is ready, false otherwise. * - * \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_StorageReady(SDL_Storage *storage); @@ -255,7 +255,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StorageReady(SDL_Storage *storage); * \returns true if the file could be queried or false 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. * * \sa SDL_ReadStorageFile * \sa SDL_StorageReady @@ -273,7 +273,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetStorageFileSize(SDL_Storage *storage, co * \returns true if the file was read or false 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. * * \sa SDL_GetStorageFileSize * \sa SDL_StorageReady @@ -291,7 +291,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadStorageFile(SDL_Storage *storage, const * \returns true if the file was written or false 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. * * \sa SDL_GetStorageSpaceRemaining * \sa SDL_ReadStorageFile @@ -307,7 +307,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteStorageFile(SDL_Storage *storage, cons * \returns true on success or false 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. * * \sa SDL_StorageReady */ @@ -331,7 +331,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage * \returns true on success or false 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. * * \sa SDL_StorageReady */ @@ -345,7 +345,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateStorageDirectory(SDL_Storage *stor * \returns true on success or false 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. * * \sa SDL_StorageReady */ @@ -360,7 +360,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RemoveStoragePath(SDL_Storage *storage, con * \returns true on success or false 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. * * \sa SDL_StorageReady */ @@ -375,7 +375,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenameStoragePath(SDL_Storage *storage, con * \returns true on success or false 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. * * \sa SDL_StorageReady */ @@ -391,7 +391,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CopyStorageFile(SDL_Storage *storage, const * \returns true on success or false if the file doesn't exist, or another * 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. * * \sa SDL_StorageReady */ @@ -403,7 +403,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetStoragePathInfo(SDL_Storage *storage, co * \param storage a storage container to query. * \returns the amount of remaining space, in bytes. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_StorageReady * \sa SDL_WriteStorageFile @@ -443,7 +443,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetStorageSpaceRemaining(SDL_Storage *sto * \threadsafety It is safe to call this function from any thread, assuming * the `storage` object is thread-safe. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC char ** SDLCALL SDL_GlobStorageDirectory(SDL_Storage *storage, const char *path, const char *pattern, SDL_GlobFlags flags, int *count); diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h index f50c5fc1e..bdea07916 100644 --- a/include/SDL3/SDL_surface.h +++ b/include/SDL3/SDL_surface.h @@ -59,7 +59,7 @@ extern "C" { * * These are generally considered read-only. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_SurfaceFlags; @@ -71,14 +71,14 @@ typedef Uint32 SDL_SurfaceFlags; /** * Evaluates to true if the surface needs to be locked before access. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_MUSTLOCK(S) ((((S)->flags & SDL_SURFACE_LOCK_NEEDED)) == SDL_SURFACE_LOCK_NEEDED) /** * The scaling mode. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ScaleMode { @@ -89,7 +89,7 @@ typedef enum SDL_ScaleMode /** * The flip mode. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_FlipMode { @@ -115,7 +115,7 @@ typedef enum SDL_FlipMode * remaining bytes to reach the pitch are used as padding to reach a desired * alignment, and have undefined contents. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_CreateSurface * \sa SDL_DestroySurface @@ -148,7 +148,7 @@ typedef struct SDL_Surface SDL_Surface; * \returns the new SDL_Surface structure that is created or NULL 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. * * \sa SDL_CreateSurfaceFrom * \sa SDL_DestroySurface @@ -176,7 +176,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_CreateSurface(int width, int heigh * \returns the new SDL_Surface structure that is created or NULL 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. * * \sa SDL_CreateSurface * \sa SDL_DestroySurface @@ -190,7 +190,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_CreateSurfaceFrom(int width, int h * * \param surface the SDL_Surface to free. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateStackSurface * \sa SDL_CreateSurface @@ -222,7 +222,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroySurface(SDL_Surface *surface); * \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_GetSurfaceProperties(SDL_Surface *surface); @@ -242,7 +242,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surfac * \returns true on success or false 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. * * \sa SDL_GetSurfaceColorspace */ @@ -259,7 +259,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorspace(SDL_Surface *surface, * \returns the colorspace used by the surface, or SDL_COLORSPACE_UNKNOWN if * the surface is NULL. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetSurfaceColorspace */ @@ -287,7 +287,7 @@ extern SDL_DECLSPEC SDL_Colorspace SDLCALL SDL_GetSurfaceColorspace(SDL_Surface * the surface didn't have an index format); 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. * * \sa SDL_SetPaletteColors */ @@ -303,7 +303,7 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreateSurfacePalette(SDL_Surface * * \returns true on success or false 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. * * \sa SDL_CreatePalette * \sa SDL_GetSurfacePalette @@ -317,7 +317,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfacePalette(SDL_Surface *surface, SDL * \returns a pointer to the palette used by the surface, or NULL if there is * no palette used. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetSurfacePalette */ @@ -340,7 +340,7 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_GetSurfacePalette(SDL_Surface *sur * \returns true on success or false 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. * * \sa SDL_RemoveSurfaceAlternateImages * \sa SDL_GetSurfaceImages @@ -354,7 +354,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddSurfaceAlternateImage(SDL_Surface *surfa * \param surface the SDL_Surface structure to query. * \returns true if alternate versions are available or true otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddSurfaceAlternateImage * \sa SDL_RemoveSurfaceAlternateImages @@ -379,7 +379,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasAlternateImages(SDL_Surface *surf * failure; call SDL_GetError() for more information. This should be * freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddSurfaceAlternateImage * \sa SDL_RemoveSurfaceAlternateImages @@ -395,7 +395,7 @@ extern SDL_DECLSPEC SDL_Surface ** SDLCALL SDL_GetSurfaceImages(SDL_Surface *sur * * \param surface the SDL_Surface structure to update. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddSurfaceAlternateImage * \sa SDL_GetSurfaceImages @@ -419,7 +419,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveSurfaceAlternateImages(SDL_Surface *s * \returns true on success or false 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. * * \sa SDL_MUSTLOCK * \sa SDL_UnlockSurface @@ -431,7 +431,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockSurface(SDL_Surface *surface); * * \param surface the SDL_Surface structure to be unlocked. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_LockSurface */ @@ -449,7 +449,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface *surface); * \returns a pointer to a new SDL_Surface structure or NULL 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. * * \sa SDL_DestroySurface * \sa SDL_LoadBMP @@ -467,7 +467,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP_IO(SDL_IOStream *src, bool * \returns a pointer to a new SDL_Surface structure or NULL 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. * * \sa SDL_DestroySurface * \sa SDL_LoadBMP_IO @@ -491,7 +491,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP(const char *file); * \returns true on success or false 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. * * \sa SDL_LoadBMP_IO * \sa SDL_SaveBMP @@ -512,7 +512,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStre * \returns true on success or false 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. * * \sa SDL_LoadBMP * \sa SDL_SaveBMP_IO @@ -530,7 +530,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveBMP(SDL_Surface *surface, const char *f * \returns true on success or false 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. * * \sa SDL_BlitSurface * \sa SDL_LockSurface @@ -546,7 +546,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceRLE(SDL_Surface *surface, bool en * \param surface the SDL_Surface structure to query. * \returns true if the surface is RLE enabled, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetSurfaceRLE */ @@ -568,7 +568,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasRLE(SDL_Surface *surface); * \returns true on success or false 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. * * \sa SDL_GetSurfaceColorKey * \sa SDL_SetSurfaceRLE @@ -584,7 +584,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorKey(SDL_Surface *surface, bo * \param surface the SDL_Surface structure to query. * \returns true if the surface has a color key, false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetSurfaceColorKey * \sa SDL_GetSurfaceColorKey @@ -604,7 +604,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasColorKey(SDL_Surface *surface); * \returns true on success or false 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. * * \sa SDL_SetSurfaceColorKey * \sa SDL_SurfaceHasColorKey @@ -627,7 +627,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceColorKey(SDL_Surface *surface, Ui * \returns true on success or false 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. * * \sa SDL_GetSurfaceColorMod * \sa SDL_SetSurfaceAlphaMod @@ -645,7 +645,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorMod(SDL_Surface *surface, Ui * \returns true on success or false 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. * * \sa SDL_GetSurfaceAlphaMod * \sa SDL_SetSurfaceColorMod @@ -665,7 +665,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceColorMod(SDL_Surface *surface, Ui * \returns true on success or false 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. * * \sa SDL_GetSurfaceAlphaMod * \sa SDL_SetSurfaceColorMod @@ -680,7 +680,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface *surface, Ui * \returns true on success or false 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. * * \sa SDL_GetSurfaceColorMod * \sa SDL_SetSurfaceAlphaMod @@ -699,7 +699,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface *surface, Ui * \returns true on success or false 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. * * \sa SDL_GetSurfaceBlendMode */ @@ -713,7 +713,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface *surface, S * \returns true on success or false 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. * * \sa SDL_SetSurfaceBlendMode */ @@ -734,7 +734,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface *surface, S * \returns true if the rectangle intersects the surface, otherwise false and * blits will be completely clipped. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetSurfaceClipRect */ @@ -753,7 +753,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceClipRect(SDL_Surface *surface, co * \returns true on success or false 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. * * \sa SDL_SetSurfaceClipRect */ @@ -767,7 +767,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceClipRect(SDL_Surface *surface, SD * \returns true on success or false 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 bool SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipMode flip); @@ -783,7 +783,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipM * \returns a copy of the surface or NULL 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. * * \sa SDL_DestroySurface */ @@ -802,7 +802,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_DuplicateSurface(SDL_Surface *surf * \returns a copy of the surface or NULL 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. * * \sa SDL_DestroySurface */ @@ -827,7 +827,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ScaleSurface(SDL_Surface *surface, * \returns the new SDL_Surface structure that is created or NULL 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. * * \sa SDL_ConvertSurfaceAndColorspace * \sa SDL_DestroySurface @@ -853,7 +853,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurface(SDL_Surface *surfac * \returns the new SDL_Surface structure that is created or NULL 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. * * \sa SDL_ConvertSurface * \sa SDL_ConvertSurface @@ -875,7 +875,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurfaceAndColorspace(SDL_Su * \returns false on success or false 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. * * \sa SDL_ConvertPixelsAndColorspace */ @@ -904,7 +904,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertPixels(int width, int height, SDL_Pi * \returns false on success or false 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. * * \sa SDL_ConvertPixels */ @@ -928,7 +928,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertPixelsAndColorspace(int width, int h * \returns true on success or false 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 bool SDLCALL SDL_PremultiplyAlpha(int width, int height, SDL_PixelFormat src_format, const void *src, int src_pitch, SDL_PixelFormat dst_format, void *dst, int dst_pitch, bool linear); @@ -943,7 +943,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplyAlpha(int width, int height, SDL * \returns true on success or false 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 bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surface, bool linear); @@ -963,7 +963,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surfac * \returns true on success or false 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 bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, float r, float g, float b, float a); @@ -986,7 +986,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, float r, * \returns true on success or false 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. * * \sa SDL_FillSurfaceRects */ @@ -1011,7 +1011,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FillSurfaceRect(SDL_Surface *dst, const SDL * \returns true on success or false 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. * * \sa SDL_FillSurfaceRect */ @@ -1086,7 +1086,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FillSurfaceRects(SDL_Surface *dst, const SD * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurfaceScaled */ @@ -1111,7 +1111,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurface(SDL_Surface *src, const SDL_Rec * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurface */ @@ -1136,7 +1136,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceUnchecked(SDL_Surface *src, cons * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurface */ @@ -1162,7 +1162,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceScaled(SDL_Surface *src, const S * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurfaceScaled */ @@ -1188,7 +1188,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceUncheckedScaled(SDL_Surface *src * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurface */ @@ -1218,7 +1218,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceTiled(SDL_Surface *src, const SD * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurface */ @@ -1255,7 +1255,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceTiledWithScale(SDL_Surface *src, * threads at once. It is safe to use the same source surface * from multiple threads. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_BlitSurface */ @@ -1285,7 +1285,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurface9Grid(SDL_Surface *src, const SD * \param b the blue component of the pixel in the range 0-255. * \returns a pixel value. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_MapSurfaceRGBA */ @@ -1316,7 +1316,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapSurfaceRGB(SDL_Surface *surface, Uint8 * \param a the alpha component of the pixel in the range 0-255. * \returns a pixel value. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_MapSurfaceRGB */ @@ -1345,7 +1345,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapSurfaceRGBA(SDL_Surface *surface, Uint * \returns true on success or false 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 bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a); @@ -1369,7 +1369,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int * \returns true on success or false 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 bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface, int x, int y, float *r, float *g, float *b, float *a); @@ -1392,7 +1392,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface, * \returns true on success or false 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 bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 r, Uint8 g, Uint8 b, Uint8 a); @@ -1412,7 +1412,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, int * \returns true on success or false 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 bool SDLCALL SDL_WriteSurfacePixelFloat(SDL_Surface *surface, int x, int y, float r, float g, float b, float a); diff --git a/include/SDL3/SDL_system.h b/include/SDL3/SDL_system.h index 93b6e98f5..191d32dd3 100644 --- a/include/SDL3/SDL_system.h +++ b/include/SDL3/SDL_system.h @@ -64,7 +64,7 @@ typedef struct tagMSG MSG; * \threadsafety This may only be called (by SDL) from the thread handling the * Windows event loop. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetWindowsMessageHook * \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP @@ -80,7 +80,7 @@ typedef bool (SDLCALL *SDL_WindowsMessageHook)(void *userdata, MSG *msg); * \param callback the SDL_WindowsMessageHook function to call. * \param userdata a pointer to pass to every iteration of `callback`. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_WindowsMessageHook * \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP @@ -101,7 +101,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHoo * \returns the D3D9 adapter index on success or -1 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 int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displayID); @@ -118,7 +118,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displ * \returns true on success or false 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 bool SDLCALL SDL_GetDXGIOutputInfo(SDL_DisplayID displayID, int *adapterIndex, int *outputIndex); @@ -141,7 +141,7 @@ typedef bool (SDLCALL *SDL_X11EventHook)(void *userdata, XEvent *xevent); * \param callback the SDL_X11EventHook function to call. * \param userdata a pointer to pass to every iteration of `callback`. * - * \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_SetX11EventHook(SDL_X11EventHook callback, void *userdata); @@ -158,7 +158,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetX11EventHook(SDL_X11EventHook callback, * \returns true on success or false 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 bool SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, int priority); @@ -174,7 +174,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, int * \returns true on success or false 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 bool SDLCALL SDL_SetLinuxThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy); @@ -197,7 +197,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriorityAndPolicy(Sint64 thre * \param userdata what was passed as `callbackParam` to * SDL_SetiOSAnimationCallback as `callbackParam`. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetiOSAnimationCallback */ @@ -236,7 +236,7 @@ typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata); * \returns true on success or false 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. * * \sa SDL_SetiOSEventPump */ @@ -249,7 +249,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetiOSAnimationCallback(SDL_Window *window, * * \param enabled true to enable the event pump, false to disable it. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetiOSAnimationCallback */ @@ -279,7 +279,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetiOSEventPump(bool enabled); * * \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_GetAndroidActivity */ @@ -304,7 +304,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetAndroidJNIEnv(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_GetAndroidJNIEnv */ @@ -342,7 +342,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetAndroidActivity(void); * * \returns the Android API level. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void); @@ -351,7 +351,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void); * * \returns true if this is a Chromebook, false otherwise. * - * \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_IsChromebook(void); @@ -360,7 +360,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsChromebook(void); * * \returns true if this is a DeX docking station, false otherwise. * - * \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_IsDeXMode(void); @@ -369,7 +369,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsDeXMode(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. */ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void); @@ -377,7 +377,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void); * See the official Android developer guide for more information: * http://developer.android.com/guide/topics/data/data-storage.html * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_ANDROID_EXTERNAL_STORAGE_READ 0x01 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE 0x02 @@ -398,7 +398,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void); * \returns the path used for internal storage or NULL 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. * * \sa SDL_GetAndroidExternalStoragePath * \sa SDL_GetAndroidCachePath @@ -416,7 +416,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidInternalStoragePath(void) * \returns the current state of external storage, or 0 if external storage is * currently unavailable. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetAndroidExternalStoragePath */ @@ -438,7 +438,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetAndroidExternalStorageState(void); * \returns the path used for external storage for this application on success * or NULL 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. * * \sa SDL_GetAndroidExternalStorageState * \sa SDL_GetAndroidInternalStoragePath @@ -461,7 +461,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidExternalStoragePath(void) * \returns the path used for caches for this application on success or NULL * 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. * * \sa SDL_GetAndroidInternalStoragePath * \sa SDL_GetAndroidExternalStoragePath @@ -503,7 +503,7 @@ typedef void (SDLCALL *SDL_RequestAndroidPermissionCallback)(void *userdata, con * * \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_RequestAndroidPermission(const char *permission, SDL_RequestAndroidPermissionCallback cb, void *userdata); @@ -531,7 +531,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RequestAndroidPermission(const char *permis * * \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_ShowAndroidToast(const char *message, int duration, int gravity, int xoffset, int yoffset); @@ -547,7 +547,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowAndroidToast(const char *message, int d * * \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_SendAndroidMessage(Uint32 command, int param); @@ -560,7 +560,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SendAndroidMessage(Uint32 command, int para * * \returns true if the device is a tablet, false otherwise. * - * \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_IsTablet(void); @@ -571,14 +571,14 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsTablet(void); * * \returns true if the device is a TV, false otherwise. * - * \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_IsTV(void); /** * Application sandbox environment. * - * \since This enum is available since SDL 3.1.6. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_Sandbox { @@ -595,7 +595,7 @@ typedef enum SDL_Sandbox * \returns the application sandbox environment or SDL_SANDBOX_NONE if the * application is not running in a sandbox environment. * - * \since This function is available since SDL 3.1.4. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Sandbox SDLCALL SDL_GetSandbox(void); @@ -615,7 +615,7 @@ extern SDL_DECLSPEC SDL_Sandbox SDLCALL SDL_GetSandbox(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillTerminate(void); @@ -632,7 +632,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillTerminate(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidReceiveMemoryWarning(void); @@ -649,7 +649,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidReceiveMemoryWarning(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterBackground(void); @@ -666,7 +666,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterBackground(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterBackground(void); @@ -683,7 +683,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterBackground(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterForeground(void); @@ -700,7 +700,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterForeground(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterForeground(void); @@ -719,7 +719,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterForeground(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. */ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidChangeStatusBarOrientation(void); #endif @@ -743,7 +743,7 @@ typedef struct XUser *XUserHandle; * \returns true on success or false 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 bool SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle *outTaskQueue); @@ -758,7 +758,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle *outTaskQu * \returns true if success or false 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 bool SDLCALL SDL_GetGDKDefaultUser(XUserHandle *outUserHandle); diff --git a/include/SDL3/SDL_test_compare.h b/include/SDL3/SDL_test_compare.h index a7e18e3c7..24bc9ee6e 100644 --- a/include/SDL3/SDL_test_compare.h +++ b/include/SDL3/SDL_test_compare.h @@ -65,7 +65,7 @@ int SDLCALL SDLTest_CompareSurfaces(SDL_Surface *surface, SDL_Surface *reference * * \returns 0 if the left and right memory block are equal, non-zero if they are non-equal. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ int SDLCALL SDLTest_CompareMemory(const void *actual, size_t size_actual, const void *reference, size_t size_reference); diff --git a/include/SDL3/SDL_test_font.h b/include/SDL3/SDL_test_font.h index 99308abbf..9d7b346eb 100644 --- a/include/SDL3/SDL_test_font.h +++ b/include/SDL3/SDL_test_font.h @@ -93,7 +93,7 @@ typedef struct SDLTest_TextWindow * * \returns the new window, or NULL on failure. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ SDLTest_TextWindow * SDLCALL SDLTest_TextWindowCreate(float x, float y, float w, float h); @@ -105,7 +105,7 @@ SDLTest_TextWindow * SDLCALL SDLTest_TextWindowCreate(float x, float y, float w, * \param textwin The text output window * \param renderer The renderer to use for display * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ void SDLCALL SDLTest_TextWindowDisplay(SDLTest_TextWindow *textwin, SDL_Renderer *renderer); @@ -120,7 +120,7 @@ void SDLCALL SDLTest_TextWindowDisplay(SDLTest_TextWindow *textwin, SDL_Renderer * \param fmt A printf() style format string * \param ... additional parameters matching % tokens in the `fmt` string, if any * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ void SDLCALL SDLTest_TextWindowAddText(SDLTest_TextWindow *textwin, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2); @@ -135,7 +135,7 @@ void SDLCALL SDLTest_TextWindowAddText(SDLTest_TextWindow *textwin, SDL_PRINTF_F * \param text The text to add to the window * \param len The length, in bytes, of the text to add to the window * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ void SDLCALL SDLTest_TextWindowAddTextWithLength(SDLTest_TextWindow *textwin, const char *text, size_t len); @@ -144,7 +144,7 @@ void SDLCALL SDLTest_TextWindowAddTextWithLength(SDLTest_TextWindow *textwin, co * * \param textwin The text output window * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ void SDLCALL SDLTest_TextWindowClear(SDLTest_TextWindow *textwin); @@ -153,7 +153,7 @@ void SDLCALL SDLTest_TextWindowClear(SDLTest_TextWindow *textwin); * * \param textwin The text output window * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ void SDLCALL SDLTest_TextWindowDestroy(SDLTest_TextWindow *textwin); diff --git a/include/SDL3/SDL_thread.h b/include/SDL3/SDL_thread.h index f21356544..0eb481587 100644 --- a/include/SDL3/SDL_thread.h +++ b/include/SDL3/SDL_thread.h @@ -50,7 +50,7 @@ extern "C" { * * These are opaque data. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_CreateThread * \sa SDL_WaitThread @@ -64,7 +64,7 @@ typedef struct SDL_Thread SDL_Thread; * application will operate on, but having a way to uniquely identify a thread * can be useful at times. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GetThreadID * \sa SDL_GetCurrentThreadID @@ -77,7 +77,7 @@ typedef Uint64 SDL_ThreadID; * 0 is the invalid ID. An app can create these and then set data for these * IDs that is unique to each thread. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GetTLS * \sa SDL_SetTLS @@ -93,7 +93,7 @@ typedef SDL_AtomicInt SDL_TLSID; * state. SDL_HINT_THREAD_PRIORITY_POLICY can be used to control aspects of * this behavior. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_ThreadPriority { SDL_THREAD_PRIORITY_LOW, @@ -108,7 +108,7 @@ typedef enum SDL_ThreadPriority { * \param data what was passed as `data` to SDL_CreateThread(). * \returns a value that can be reported through SDL_WaitThread(). * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef int (SDLCALL * SDL_ThreadFunction) (void *data); @@ -178,7 +178,7 @@ typedef int (SDLCALL * SDL_ThreadFunction) (void *data); * new thread could not be created; 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. * * \sa SDL_CreateThreadWithProperties * \sa SDL_WaitThread @@ -244,7 +244,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(SDL_ThreadFunction fn, * new thread could not be created; 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. * * \sa SDL_CreateThread * \sa SDL_WaitThread @@ -299,7 +299,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithProperties(SDL_Prop * new thread could not be created; 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_Thread * SDLCALL SDL_CreateThreadRuntime(SDL_ThreadFunction fn, const char *name, void *data, SDL_FunctionPointer pfnBeginThread, SDL_FunctionPointer pfnEndThread); @@ -313,7 +313,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadRuntime(SDL_ThreadFunct * new thread could not be created; 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_Thread * SDLCALL SDL_CreateThreadWithPropertiesRuntime(SDL_PropertiesID props, SDL_FunctionPointer pfnBeginThread, SDL_FunctionPointer pfnEndThread); @@ -333,7 +333,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithPropertiesRuntime(S * \returns a pointer to a UTF-8 string that names the specified thread, or * NULL if it doesn't have a name. * - * \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_GetThreadName(SDL_Thread *thread); @@ -349,7 +349,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetThreadName(SDL_Thread *thread); * * \returns the ID of the current thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetThreadID */ @@ -366,7 +366,7 @@ extern SDL_DECLSPEC SDL_ThreadID SDLCALL SDL_GetCurrentThreadID(void); * \returns the ID of the specified thread, or the ID of the current thread if * `thread` is NULL. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetCurrentThreadID */ @@ -383,7 +383,7 @@ extern SDL_DECLSPEC SDL_ThreadID SDLCALL SDL_GetThreadID(SDL_Thread *thread); * \returns true on success or false 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 bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority priority); @@ -415,7 +415,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority * from the thread function by its 'return', or NULL to not * receive such value back. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateThread * \sa SDL_DetachThread @@ -451,7 +451,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status) * \param thread the SDL_Thread pointer that was returned from the * SDL_CreateThread() call that started this thread. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateThread * \sa SDL_WaitThread @@ -467,7 +467,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DetachThread(SDL_Thread *thread); * * \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_SetTLS */ @@ -480,7 +480,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetTLS(SDL_TLSID *id); * * \param value a pointer previously handed to SDL_SetTLS. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_SetTLS */ @@ -508,7 +508,7 @@ typedef void (SDLCALL *SDL_TLSDestructorCallback)(void *value); * * \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_GetTLS */ @@ -523,7 +523,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTLS(SDL_TLSID *id, const void *value, 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. */ extern SDL_DECLSPEC void SDLCALL SDL_CleanupTLS(void); diff --git a/include/SDL3/SDL_time.h b/include/SDL3/SDL_time.h index eb73f7a7f..4dfe84f94 100644 --- a/include/SDL3/SDL_time.h +++ b/include/SDL3/SDL_time.h @@ -41,7 +41,7 @@ extern "C" { * A structure holding a calendar date and time broken down into its * components. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. */ typedef struct SDL_DateTime { @@ -59,7 +59,7 @@ typedef struct SDL_DateTime /** * The preferred date format of the current system locale. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_GetDateTimeLocalePreferences */ @@ -73,7 +73,7 @@ typedef enum SDL_DateFormat /** * The preferred time format of the current system locale. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_GetDateTimeLocalePreferences */ @@ -98,7 +98,7 @@ typedef enum SDL_TimeFormat * \returns true on success or false 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 bool SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFormat *dateFormat, SDL_TimeFormat *timeFormat); @@ -110,7 +110,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFormat * \returns true on success or false 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 bool SDLCALL SDL_GetCurrentTime(SDL_Time *ticks); @@ -126,7 +126,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetCurrentTime(SDL_Time *ticks); * \returns true on success or false 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 bool SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime *dt, bool localTime); @@ -141,7 +141,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime * \returns true on success or false 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 bool SDLCALL SDL_DateTimeToTime(const SDL_DateTime *dt, SDL_Time *ticks); @@ -157,7 +157,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DateTimeToTime(const SDL_DateTime *dt, SDL_ * \param dwHighDateTime a pointer filled in with the high portion of the * Windows FILETIME value. * - * \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_TimeToWindows(SDL_Time ticks, Uint32 *dwLowDateTime, Uint32 *dwHighDateTime); @@ -172,7 +172,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_TimeToWindows(SDL_Time ticks, Uint32 *dwLow * \param dwHighDateTime the high portion of the Windows FILETIME value. * \returns the converted SDL time. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Time SDLCALL SDL_TimeFromWindows(Uint32 dwLowDateTime, Uint32 dwHighDateTime); @@ -184,7 +184,7 @@ extern SDL_DECLSPEC SDL_Time SDLCALL SDL_TimeFromWindows(Uint32 dwLowDateTime, U * \returns the number of days in the requested month or -1 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 int SDLCALL SDL_GetDaysInMonth(int year, int month); @@ -197,7 +197,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month); * \returns the day of year [0-365] if the date is valid or -1 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 int SDLCALL SDL_GetDayOfYear(int year, int month, int day); @@ -210,7 +210,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day); * \returns a value between 0 and 6 (0 being Sunday) if the date is valid or * -1 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 int SDLCALL SDL_GetDayOfWeek(int year, int month, int day); diff --git a/include/SDL3/SDL_timer.h b/include/SDL3/SDL_timer.h index 0f1d943f7..0d5cae399 100644 --- a/include/SDL3/SDL_timer.h +++ b/include/SDL3/SDL_timer.h @@ -58,7 +58,7 @@ extern "C" { * * \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 Uint64 SDLCALL SDL_GetTicks(void); @@ -70,7 +70,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.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetTicksNS(void); @@ -87,7 +87,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.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPerformanceFrequency */ @@ -100,7 +100,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.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetPerformanceCounter */ @@ -117,7 +117,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.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC void SDLCALL SDL_Delay(Uint32 ms); @@ -132,7 +132,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.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC void SDLCALL SDL_DelayNS(Uint64 ns); @@ -147,14 +147,14 @@ 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.4. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC void SDLCALL SDL_DelayPrecise(Uint64 ns); /** * Definition of the timer ID type. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_TimerID; @@ -178,7 +178,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.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_AddTimer */ @@ -213,7 +213,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.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddTimerNS * \sa SDL_RemoveTimer @@ -240,7 +240,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.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_AddTimerNS */ @@ -275,7 +275,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.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddTimer * \sa SDL_RemoveTimer @@ -291,7 +291,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.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_AddTimer */ diff --git a/include/SDL3/SDL_touch.h b/include/SDL3/SDL_touch.h index 2b07d2d32..3eb47d52d 100644 --- a/include/SDL3/SDL_touch.h +++ b/include/SDL3/SDL_touch.h @@ -56,7 +56,7 @@ typedef enum SDL_TouchDeviceType * contact with the touch device (so a "touch" can be a "multitouch," in * reality), and this struct reports details of the specific fingers. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetTouchFingers */ @@ -88,7 +88,7 @@ typedef struct SDL_Finger * SDL_GetError() for more information. This should be freed with * SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_TouchID * SDLCALL SDL_GetTouchDevices(int *count); @@ -99,7 +99,7 @@ extern SDL_DECLSPEC SDL_TouchID * SDLCALL SDL_GetTouchDevices(int *count); * \returns touch device name, or NULL 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 const char * SDLCALL SDL_GetTouchDeviceName(SDL_TouchID touchID); @@ -109,7 +109,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetTouchDeviceName(SDL_TouchID touc * \param touchID the ID of a touch device. * \returns touch device type. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_TouchID touchID); @@ -124,7 +124,7 @@ extern SDL_DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_Touch * allocation that should be freed with SDL_free() when it is no * longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Finger ** SDLCALL SDL_GetTouchFingers(SDL_TouchID touchID, int *count); diff --git a/include/SDL3/SDL_version.h b/include/SDL3/SDL_version.h index 5dd542622..196e8525f 100644 --- a/include/SDL3/SDL_version.h +++ b/include/SDL3/SDL_version.h @@ -42,7 +42,7 @@ extern "C" { * * If this were SDL version 3.2.1, this value would be 3. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_MAJOR_VERSION 3 @@ -51,7 +51,7 @@ extern "C" { * * If this were SDL version 3.2.1, this value would be 2. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_MINOR_VERSION 1 @@ -60,7 +60,7 @@ extern "C" { * * If this were SDL version 3.2.1, this value would be 1. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_MICRO_VERSION 5 @@ -73,7 +73,7 @@ extern "C" { * \param minor the minorversion number. * \param patch the patch version number. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_VERSIONNUM(major, minor, patch) \ ((major) * 1000000 + (minor) * 1000 + (patch)) @@ -85,7 +85,7 @@ extern "C" { * * \param version the version number. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_VERSIONNUM_MAJOR(version) ((version) / 1000000) @@ -96,7 +96,7 @@ extern "C" { * * \param version the version number. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_VERSIONNUM_MINOR(version) (((version) / 1000) % 1000) @@ -107,14 +107,14 @@ extern "C" { * * \param version the version number. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_VERSIONNUM_MICRO(version) ((version) % 1000) /** * This is the version number macro for the current SDL version. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_VERSION \ SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_MICRO_VERSION) @@ -122,7 +122,7 @@ extern "C" { /** * This macro will evaluate to true if compiled with SDL at least X.Y.Z. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_VERSION_ATLEAST(X, Y, Z) \ (SDL_VERSION >= SDL_VERSIONNUM(X, Y, Z)) @@ -139,7 +139,7 @@ extern "C" { * * \returns the version of the linked library. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetRevision */ @@ -165,7 +165,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetVersion(void); * \returns an arbitrary string, uniquely identifying the exact revision of * the SDL library in use. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetVersion */ diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index aafd73481..a49bb2350 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -70,7 +70,7 @@ extern "C" { * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_DisplayID; @@ -79,7 +79,7 @@ typedef Uint32 SDL_DisplayID; * * The value 0 is an invalid ID. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef Uint32 SDL_WindowID; @@ -103,7 +103,7 @@ typedef Uint32 SDL_WindowID; /** * System theme. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_SystemTheme { @@ -118,7 +118,7 @@ typedef struct SDL_DisplayModeData SDL_DisplayModeData; /** * The structure that defines a display mode. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_GetFullscreenDisplayModes * \sa SDL_GetDesktopDisplayMode @@ -144,7 +144,7 @@ typedef struct SDL_DisplayMode /** * Display orientation values; the way a display is rotated. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_DisplayOrientation { @@ -158,7 +158,7 @@ typedef enum SDL_DisplayOrientation /** * The struct used as an opaque handle to a window. * - * \since This struct is available since SDL 3.0.0. + * \since This struct is available since SDL 3.1.3. * * \sa SDL_CreateWindow */ @@ -172,7 +172,7 @@ typedef struct SDL_Window SDL_Window; * changed on existing windows by the app, and some of it might be altered by * the user or system outside of the app's control. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GetWindowFlags */ @@ -208,7 +208,7 @@ typedef Uint64 SDL_WindowFlags; /** * Used to indicate that you don't care what the window position is. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X)) @@ -219,7 +219,7 @@ typedef Uint64 SDL_WindowFlags; /** * Used to indicate that the window position should be centered. * - * \since This macro is available since SDL 3.0.0. + * \since This macro is available since SDL 3.1.3. */ #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X)) @@ -230,7 +230,7 @@ typedef Uint64 SDL_WindowFlags; /** * Window flash operation. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_FlashOperation { @@ -242,7 +242,7 @@ typedef enum SDL_FlashOperation /** * An opaque handle to an OpenGL context. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_GL_CreateContext */ @@ -251,7 +251,7 @@ typedef struct SDL_GLContextState *SDL_GLContext; /** * Opaque EGL types. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. */ typedef void *SDL_EGLDisplay; typedef void *SDL_EGLConfig; @@ -278,7 +278,7 @@ typedef int SDL_EGLint; * \param userdata an app-controlled pointer that is passed to the callback. * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_EGL_SetAttributeCallbacks */ @@ -309,7 +309,7 @@ typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void *userdata); * \param config the EGL config to be used. * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`. * - * \since This datatype is available since SDL 3.0.0. + * \since This datatype is available since SDL 3.1.3. * * \sa SDL_EGL_SetAttributeCallbacks */ @@ -330,7 +330,7 @@ typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void *userdata, SDL_EGLDi * fail if the GL can't provide your requested attributes at a minimum, but * you should check to see exactly what you got. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GLattr { @@ -367,7 +367,7 @@ typedef enum SDL_GLattr /** * Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GLprofile { @@ -379,7 +379,7 @@ typedef enum SDL_GLprofile /** * Possible values to be set for the SDL_GL_CONTEXT_FLAGS attribute. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GLcontextFlag { @@ -393,7 +393,7 @@ typedef enum SDL_GLcontextFlag * Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR * attribute. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GLcontextReleaseFlag { @@ -404,7 +404,7 @@ typedef enum SDL_GLcontextReleaseFlag /** * Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. */ typedef enum SDL_GLContextResetNotification { @@ -419,7 +419,7 @@ typedef enum SDL_GLContextResetNotification * * \returns the number of built in video drivers. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetVideoDriver */ @@ -438,7 +438,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void); * \param index the index of a video driver. * \returns the name of the video driver with the given **index**. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetNumVideoDrivers */ @@ -454,7 +454,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetVideoDriver(int index); * \returns the name of the current video driver or NULL if no driver has been * initialized. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetNumVideoDrivers * \sa SDL_GetVideoDriver @@ -466,7 +466,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentVideoDriver(void); * * \returns the current system theme, light, dark, or unknown. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_SystemTheme SDLCALL SDL_GetSystemTheme(void); @@ -479,7 +479,7 @@ extern SDL_DECLSPEC SDL_SystemTheme SDLCALL SDL_GetSystemTheme(void); * call SDL_GetError() for more information. This should be freed * with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_DisplayID * SDLCALL SDL_GetDisplays(int *count); @@ -489,7 +489,7 @@ extern SDL_DECLSPEC SDL_DisplayID * SDLCALL SDL_GetDisplays(int *count); * \returns the instance ID of the primary display 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. * * \sa SDL_GetDisplays */ @@ -517,7 +517,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void); * \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_GetDisplayProperties(SDL_DisplayID displayID); @@ -531,7 +531,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetDisplayProperties(SDL_Displa * \returns the name of a display or NULL 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. * * \sa SDL_GetDisplays */ @@ -547,7 +547,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetDisplayName(SDL_DisplayID displa * \returns true on success or false 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. * * \sa SDL_GetDisplayUsableBounds * \sa SDL_GetDisplays @@ -571,7 +571,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, S * \returns true on success or false 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. * * \sa SDL_GetDisplayBounds * \sa SDL_GetDisplays @@ -585,7 +585,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayUsableBounds(SDL_DisplayID displa * \returns the SDL_DisplayOrientation enum value of the display, or * `SDL_ORIENTATION_UNKNOWN` if it isn't available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetDisplays */ @@ -598,7 +598,7 @@ extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetNaturalDisplayOrientat * \returns the SDL_DisplayOrientation enum value of the display, or * `SDL_ORIENTATION_UNKNOWN` if it isn't available. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetDisplays */ @@ -616,7 +616,7 @@ extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetCurrentDisplayOrientat * \returns the content scale of the display, or 0.0f 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. * * \sa SDL_GetDisplays */ @@ -642,7 +642,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetDisplayContentScale(SDL_DisplayID displ * single allocation that should be freed with SDL_free() when it is * no longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetDisplays */ @@ -670,7 +670,7 @@ extern SDL_DECLSPEC SDL_DisplayMode ** SDLCALL SDL_GetFullscreenDisplayModes(SDL * \returns true on success or false 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. * * \sa SDL_GetDisplays * \sa SDL_GetFullscreenDisplayModes @@ -689,7 +689,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetClosestFullscreenDisplayMode(SDL_Display * \returns a pointer to the desktop display mode or NULL 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. * * \sa SDL_GetCurrentDisplayMode * \sa SDL_GetDisplays @@ -708,7 +708,7 @@ extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetDesktopDisplayMode(SD * \returns a pointer to the desktop display mode or NULL 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. * * \sa SDL_GetDesktopDisplayMode * \sa SDL_GetDisplays @@ -722,7 +722,7 @@ extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetCurrentDisplayMode(SD * \returns the instance ID of the display containing the point 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. * * \sa SDL_GetDisplayBounds * \sa SDL_GetDisplays @@ -737,7 +737,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForPoint(const SDL_Point * closest to the center of the rect 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. * * \sa SDL_GetDisplayBounds * \sa SDL_GetDisplays @@ -752,7 +752,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForRect(const SDL_Rect * * 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. * * \sa SDL_GetDisplayBounds * \sa SDL_GetDisplays @@ -770,7 +770,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForWindow(SDL_Window *wi * \returns the pixel density or 0.0f 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. * * \sa SDL_GetWindowDisplayScale */ @@ -794,7 +794,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowPixelDensity(SDL_Window *window); * \returns the display scale, or 0.0f 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 float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window); @@ -823,7 +823,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_GetWindowFullscreenMode * \sa SDL_SetWindowFullscreen @@ -838,7 +838,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreenMode(SDL_Window *window, * \returns a pointer to the exclusive fullscreen mode to use or NULL for * borderless fullscreen desktop mode. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowFullscreenMode * \sa SDL_SetWindowFullscreen @@ -854,7 +854,7 @@ extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetWindowFullscreenMode( * SDL_GetError() for more information. This should be freed with * SDL_free() when it is no longer needed. * - * \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_GetWindowICCProfile(SDL_Window *window, size_t *size); @@ -866,7 +866,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetWindowICCProfile(SDL_Window *window, s * SDL_PIXELFORMAT_UNKNOWN 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_PixelFormat SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window); @@ -880,7 +880,7 @@ extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetWindowPixelFormat(SDL_Window * allocation that should be freed with SDL_free() when it is no * longer needed. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_Window ** SDLCALL SDL_GetWindows(int *count); @@ -959,7 +959,7 @@ extern SDL_DECLSPEC SDL_Window ** SDLCALL SDL_GetWindows(int *count); * \returns the window that was created or NULL 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. * * \sa SDL_CreateWindowAndRenderer * \sa SDL_CreatePopupWindow @@ -1019,7 +1019,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int * \returns the window that was created or NULL 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. * * \sa SDL_CreateWindow * \sa SDL_CreateWindowWithProperties @@ -1137,7 +1137,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *paren * \returns the window that was created or NULL 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. * * \sa SDL_CreateProperties * \sa SDL_CreateWindow @@ -1190,7 +1190,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowWithProperties(SDL_Prop * \returns the ID of the window 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. * * \sa SDL_GetWindowFromID */ @@ -1206,7 +1206,7 @@ extern SDL_DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window); * \returns the window associated with `id` or NULL if it doesn't exist; 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. * * \sa SDL_GetWindowID */ @@ -1219,7 +1219,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(SDL_WindowID id); * \returns the parent of the window on success or NULL if the window has no * parent. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreatePopupWindow */ @@ -1339,7 +1339,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowParent(SDL_Window *window) * \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_GetWindowProperties(SDL_Window *window); @@ -1384,7 +1384,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetWindowProperties(SDL_Window * \param window the window to query. * \returns a mask of the SDL_WindowFlags associated with `window`. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreateWindow * \sa SDL_HideWindow @@ -1406,7 +1406,7 @@ extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *windo * \returns true on success or false 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. * * \sa SDL_GetWindowTitle */ @@ -1419,7 +1419,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowTitle(SDL_Window *window, const ch * \returns the title of the window in UTF-8 format or "" if there is no * title. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowTitle */ @@ -1443,7 +1443,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window); * \returns true on success or false 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 bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon); @@ -1480,7 +1480,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surfa * \returns true on success or false 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. * * \sa SDL_GetWindowPosition * \sa SDL_SyncWindow @@ -1504,7 +1504,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x * \returns true on success or false 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. * * \sa SDL_SetWindowPosition */ @@ -1538,7 +1538,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowPosition(SDL_Window *window, int * * \returns true on success or false 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. * * \sa SDL_GetWindowSize * \sa SDL_SetWindowFullscreenMode @@ -1559,7 +1559,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, in * \returns true on success or false 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. * * \sa SDL_GetRenderOutputSize * \sa SDL_GetWindowSizeInPixels @@ -1583,7 +1583,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, i * \returns true on success or false 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 bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect); @@ -1619,7 +1619,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_R * \returns true on success or false 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. * * \sa SDL_GetWindowAspectRatio * \sa SDL_SyncWindow @@ -1637,7 +1637,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window, fl * \returns true on success or false 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. * * \sa SDL_SetWindowAspectRatio */ @@ -1672,7 +1672,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window, fl * \returns true on success or false 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. * * \sa SDL_GetWindowSize */ @@ -1689,7 +1689,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, in * \returns true on success or false 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. * * \sa SDL_CreateWindow * \sa SDL_GetWindowSize @@ -1705,7 +1705,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, i * \returns true on success or false 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. * * \sa SDL_GetWindowMinimumSize * \sa SDL_SetWindowMaximumSize @@ -1723,7 +1723,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, in * \returns true on success or false 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. * * \sa SDL_GetWindowMaximumSize * \sa SDL_SetWindowMinimumSize @@ -1739,7 +1739,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, in * \returns true on success or false 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. * * \sa SDL_GetWindowMaximumSize * \sa SDL_SetWindowMinimumSize @@ -1757,7 +1757,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, in * \returns true on success or false 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. * * \sa SDL_GetWindowMinimumSize * \sa SDL_SetWindowMaximumSize @@ -1778,7 +1778,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, in * \returns true on success or false 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. * * \sa SDL_GetWindowFlags */ @@ -1798,7 +1798,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowBordered(SDL_Window *window, bool * \returns true on success or false 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. * * \sa SDL_GetWindowFlags */ @@ -1815,7 +1815,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowResizable(SDL_Window *window, bool * \returns true on success or false 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. * * \sa SDL_GetWindowFlags */ @@ -1828,7 +1828,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, bo * \returns true on success or false 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. * * \sa SDL_HideWindow * \sa SDL_RaiseWindow @@ -1842,7 +1842,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindow(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_ShowWindow */ @@ -1862,7 +1862,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HideWindow(SDL_Window *window); * \returns true on success or false 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 bool SDLCALL SDL_RaiseWindow(SDL_Window *window); @@ -1890,7 +1890,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RaiseWindow(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_MinimizeWindow * \sa SDL_RestoreWindow @@ -1914,7 +1914,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_MaximizeWindow(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_MaximizeWindow * \sa SDL_RestoreWindow @@ -1939,7 +1939,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_MinimizeWindow(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_MaximizeWindow * \sa SDL_MinimizeWindow @@ -1968,7 +1968,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RestoreWindow(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_GetWindowFullscreenMode * \sa SDL_SetWindowFullscreenMode @@ -1993,7 +1993,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, boo * \returns true on success or false if the operation timed out before the * window was in the requested state. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowSize * \sa SDL_SetWindowPosition @@ -2012,7 +2012,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SyncWindow(SDL_Window *window); * \returns true if there is a surface associated with the window, or false * otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GetWindowSurface */ @@ -2036,7 +2036,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WindowHasSurface(SDL_Window *window); * \returns the surface associated with the window, or NULL 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. * * \sa SDL_DestroyWindowSurface * \sa SDL_WindowHasSurface @@ -2063,7 +2063,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window *windo * \returns true on success or false 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. * * \sa SDL_GetWindowSurfaceVSync */ @@ -2081,7 +2081,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, i * \returns true on success or false 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. * * \sa SDL_SetWindowSurfaceVSync */ @@ -2099,7 +2099,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *window, i * \returns true on success or false 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. * * \sa SDL_GetWindowSurface * \sa SDL_UpdateWindowSurfaceRects @@ -2126,7 +2126,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurface(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_GetWindowSurface * \sa SDL_UpdateWindowSurface @@ -2140,7 +2140,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window * \returns true on success or false 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. * * \sa SDL_GetWindowSurface * \sa SDL_WindowHasSurface @@ -2171,7 +2171,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DestroyWindowSurface(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_GetWindowKeyboardGrab * \sa SDL_SetWindowMouseGrab @@ -2188,7 +2188,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, b * \returns true on success or false 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. * * \sa SDL_GetWindowMouseGrab * \sa SDL_SetWindowKeyboardGrab @@ -2201,7 +2201,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, bool * \param window the window to query. * \returns true if keyboard is grabbed, and false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowKeyboardGrab */ @@ -2213,7 +2213,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *window); * \param window the window to query. * \returns true if mouse is grabbed, and false otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowKeyboardGrab */ @@ -2224,7 +2224,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window *window); * * \returns the window if input is grabbed or NULL otherwise. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowMouseGrab * \sa SDL_SetWindowKeyboardGrab @@ -2243,7 +2243,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void); * \returns true on success or false 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. * * \sa SDL_GetWindowMouseRect * \sa SDL_SetWindowMouseGrab @@ -2257,7 +2257,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, cons * \returns a pointer to the mouse confinement rectangle of a window, or NULL * if there isn't one. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_SetWindowMouseRect */ @@ -2276,7 +2276,7 @@ extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window * * \returns true on success or false 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. * * \sa SDL_GetWindowOpacity */ @@ -2292,7 +2292,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float * \returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f 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. * * \sa SDL_SetWindowOpacity */ @@ -2324,7 +2324,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_SetWindowModal */ @@ -2341,7 +2341,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Win * \returns true on success or false 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. * * \sa SDL_SetWindowParent */ @@ -2355,7 +2355,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowModal(SDL_Window *window, bool mod * \returns true on success or false 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 bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, bool focusable); @@ -2379,14 +2379,14 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, bool * \returns true on success or false 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 bool SDLCALL SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y); /** * Possible return values from the SDL_HitTest callback. * - * \since This enum is available since SDL 3.0.0. + * \since This enum is available since SDL 3.1.3. * * \sa SDL_HitTest */ @@ -2456,7 +2456,7 @@ typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win, * \returns true on success or false 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 bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data); @@ -2482,7 +2482,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_Hi * \returns true on success or false 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 bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape); @@ -2494,7 +2494,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surf * \returns true on success or false 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 bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation); @@ -2506,7 +2506,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOp * * \param window the window to destroy. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_CreatePopupWindow * \sa SDL_CreateWindow @@ -2524,7 +2524,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window); * * \returns true if the screensaver is enabled, false if it is disabled. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_DisableScreenSaver * \sa SDL_EnableScreenSaver @@ -2537,7 +2537,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ScreenSaverEnabled(void); * \returns true on success or false 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. * * \sa SDL_DisableScreenSaver * \sa SDL_ScreenSaverEnabled @@ -2556,7 +2556,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnableScreenSaver(void); * \returns true on success or false 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. * * \sa SDL_EnableScreenSaver * \sa SDL_ScreenSaverEnabled @@ -2584,7 +2584,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DisableScreenSaver(void); * \returns true on success or false 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. * * \sa SDL_GL_GetProcAddress * \sa SDL_GL_UnloadLibrary @@ -2636,7 +2636,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_LoadLibrary(const char *path); * \returns a pointer to the named OpenGL function. The returned pointer * should be cast to the appropriate function signature. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GL_ExtensionSupported * \sa SDL_GL_LoadLibrary @@ -2655,7 +2655,7 @@ extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char * \returns a pointer to the named EGL function. The returned pointer should * be cast to the appropriate function signature. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_EGL_GetCurrentDisplay */ @@ -2664,7 +2664,7 @@ extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_EGL_GetProcAddress(const cha /** * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GL_LoadLibrary */ @@ -2687,14 +2687,14 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void); * \param extension the name of the extension to check. * \returns true if the extension is supported, false otherwise. * - * \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_GL_ExtensionSupported(const char *extension); /** * Reset all previously set OpenGL context attributes to their default values. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_GL_GetAttribute * \sa SDL_GL_SetAttribute @@ -2715,7 +2715,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void); * \returns true on success or false 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. * * \sa SDL_GL_GetAttribute * \sa SDL_GL_ResetAttributes @@ -2731,7 +2731,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value) * \returns true on success or false 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. * * \sa SDL_GL_ResetAttributes * \sa SDL_GL_SetAttribute @@ -2753,7 +2753,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value * \returns the OpenGL context associated with `window` or NULL 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. * * \sa SDL_GL_DestroyContext * \sa SDL_GL_MakeCurrent @@ -2770,7 +2770,7 @@ extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *windo * \returns true on success or false 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. * * \sa SDL_GL_CreateContext */ @@ -2782,7 +2782,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLCo * \returns the currently active OpenGL window on success or NULL 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_Window * SDLCALL SDL_GL_GetCurrentWindow(void); @@ -2792,7 +2792,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GL_GetCurrentWindow(void); * \returns the currently active OpenGL context or NULL 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. * * \sa SDL_GL_MakeCurrent */ @@ -2804,7 +2804,7 @@ extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void); * \returns the currently active EGL display or NULL 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_EGLDisplay SDLCALL SDL_EGL_GetCurrentDisplay(void); @@ -2814,7 +2814,7 @@ extern SDL_DECLSPEC SDL_EGLDisplay SDLCALL SDL_EGL_GetCurrentDisplay(void); * \returns the currently active EGL config or NULL 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_EGLConfig SDLCALL SDL_EGL_GetCurrentConfig(void); @@ -2825,7 +2825,7 @@ extern SDL_DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentConfig(void); * \returns the EGLSurface pointer associated with the window, or NULL on * failure. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. */ extern SDL_DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowSurface(SDL_Window *window); @@ -2845,7 +2845,7 @@ extern SDL_DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowSurface(SDL_Window * * eglCreateContext. May be NULL. * \param userdata a pointer that is passed to the callbacks. * - * \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_EGL_SetAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback, SDL_EGLIntArrayCallback surfaceAttribCallback, @@ -2874,7 +2874,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArra * \returns true on success or false 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. * * \sa SDL_GL_GetSwapInterval */ @@ -2893,7 +2893,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetSwapInterval(int interval); * \returns true on success or false 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. * * \sa SDL_GL_SetSwapInterval */ @@ -2913,7 +2913,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetSwapInterval(int *interval); * \returns true on success or false 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 bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window); @@ -2924,7 +2924,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window); * \returns true on success or false 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. * * \sa SDL_GL_CreateContext */ diff --git a/include/SDL3/SDL_vulkan.h b/include/SDL3/SDL_vulkan.h index b6b54f859..ef3303e7b 100644 --- a/include/SDL3/SDL_vulkan.h +++ b/include/SDL3/SDL_vulkan.h @@ -112,7 +112,7 @@ struct VkAllocationCallbacks; * \returns true on success or false 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. * * \sa SDL_Vulkan_GetVkGetInstanceProcAddr * \sa SDL_Vulkan_UnloadLibrary @@ -136,14 +136,14 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Vulkan_LoadLibrary(const char *path); * \returns the function pointer for `vkGetInstanceProcAddr` or NULL 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_FunctionPointer SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void); /** * Unload the Vulkan library previously loaded by SDL_Vulkan_LoadLibrary(). * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Vulkan_LoadLibrary */ @@ -167,7 +167,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void); * \returns an array of extension name strings on success, NULL 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. * * \sa SDL_Vulkan_CreateSurface */ @@ -192,7 +192,7 @@ extern SDL_DECLSPEC char const * const * SDLCALL SDL_Vulkan_GetInstanceExtension * \returns true on success or false 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. * * \sa SDL_Vulkan_GetInstanceExtensions * \sa SDL_Vulkan_DestroySurface @@ -220,7 +220,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Vulkan_CreateSurface(SDL_Window *window, * \param allocator a VkAllocationCallbacks struct, which lets the app set the * allocator that destroys the surface. Can be NULL. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Vulkan_GetInstanceExtensions * \sa SDL_Vulkan_CreateSurface @@ -242,7 +242,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Vulkan_DestroySurface(VkInstance instance, * device. * \returns true if supported, false if unsupported or an error occurred. * - * \since This function is available since SDL 3.0.0. + * \since This function is available since SDL 3.1.3. * * \sa SDL_Vulkan_GetInstanceExtensions */