eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-29 16:09:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Sync SDL3 wiki -> headers.

Browse source
This commit is contained in:
Ryan C. Gordon 2025-01-21 13:12:25 -05:00
parent 7e130e27ba
commit 7a5604cf0c
No known key found for this signature in database
GPG key ID: FA148B892AB48044
60 changed files with 2070 additions and 2070 deletions
Download patch file Download diff file Expand all files Collapse all files

44
include/SDL3/SDL_assert.h
View file

@ -89,7 +89,7 @@ extern "C" {
* - 3: Paranoid settings: All SDL assertion macros enabled, including * - 3: Paranoid settings: All SDL assertion macros enabled, including
* SDL_assert_paranoid. * SDL_assert_paranoid.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ASSERT_LEVEL SomeNumberBasedOnVariousFactors #define SDL_ASSERT_LEVEL SomeNumberBasedOnVariousFactors
@ -122,7 +122,7 @@ extern "C" {
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner #define SDL_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner
@ -165,7 +165,7 @@ extern "C" {
* *
* If SDL can't figure how the compiler reports this, it will use "???". * If SDL can't figure how the compiler reports this, it will use "???".
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_FUNCTION __FUNCTION__ #define SDL_FUNCTION __FUNCTION__
@ -180,14 +180,14 @@ extern "C" {
/** /**
* A macro that reports the current file being compiled. * A macro that reports the current file being compiled.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_FILE __FILE__ #define SDL_FILE __FILE__
/** /**
* A macro that reports the current line number of the file being compiled. * A macro that reports the current line number of the file being compiled.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_LINE __LINE__ #define SDL_LINE __LINE__
@ -224,7 +224,7 @@ disable assertions.
* do { SomethingOnce(); } while (SDL_NULL_WHILE_LOOP_CONDITION (0)); * do { SomethingOnce(); } while (SDL_NULL_WHILE_LOOP_CONDITION (0));
* ``` * ```
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_NULL_WHILE_LOOP_CONDITION (0) #define SDL_NULL_WHILE_LOOP_CONDITION (0)
@ -248,7 +248,7 @@ disable assertions.
* *
* \param condition the condition to assert (but not actually run here). * \param condition the condition to assert (but not actually run here).
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_disabled_assert(condition) \ #define SDL_disabled_assert(condition) \
do { (void) sizeof ((condition)); } while (SDL_NULL_WHILE_LOOP_CONDITION) do { (void) sizeof ((condition)); } while (SDL_NULL_WHILE_LOOP_CONDITION)
@ -264,7 +264,7 @@ disable assertions.
* condition, try to break in a debugger, kill the program, or ignore the * condition, try to break in a debugger, kill the program, or ignore the
* problem). * problem).
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_AssertState typedef enum SDL_AssertState
{ {
@ -282,7 +282,7 @@ typedef enum SDL_AssertState
* used by the assertion handler, then added to the assertion report. This is * used by the assertion handler, then added to the assertion report. This is
* returned as a linked list from SDL_GetAssertionReport(). * returned as a linked list from SDL_GetAssertionReport().
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_AssertData typedef struct SDL_AssertData
{ {
@ -308,7 +308,7 @@ typedef struct SDL_AssertData
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *data, extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *data,
const char *func, const char *func,
@ -323,7 +323,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* This isn't for direct use by apps; use SDL_assert or SDL_TriggerBreakpoint * This isn't for direct use by apps; use SDL_assert or SDL_TriggerBreakpoint
* instead. * instead.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AssertBreakpoint() SDL_TriggerBreakpoint() #define SDL_AssertBreakpoint() SDL_TriggerBreakpoint()
@ -355,7 +355,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* *
* \param condition the condition to assert. * \param condition the condition to assert.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_enabled_assert(condition) \ #define SDL_enabled_assert(condition) \
do { \ do { \
@ -401,7 +401,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_assert(condition) if (assertion_enabled && (condition)) { trigger_assertion; } #define SDL_assert(condition) if (assertion_enabled && (condition)) { trigger_assertion; }
@ -434,7 +434,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_assert_release(condition) SDL_disabled_assert(condition) #define SDL_assert_release(condition) SDL_disabled_assert(condition)
@ -463,7 +463,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_assert_paranoid(condition) SDL_disabled_assert(condition) #define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
@ -507,7 +507,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_assert_always(condition) SDL_enabled_assert(condition) #define SDL_assert_always(condition) SDL_enabled_assert(condition)
@ -523,7 +523,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
* \threadsafety This callback may be called from any thread that triggers an * \threadsafety This callback may be called from any thread that triggers an
* assert at any time. * assert at any time.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)( typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
const SDL_AssertData *data, void *userdata); const SDL_AssertData *data, void *userdata);
@ -547,7 +547,7 @@ typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAssertionHandler * \sa SDL_GetAssertionHandler
*/ */
@ -568,7 +568,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetAssertionHandler(
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAssertionHandler * \sa SDL_GetAssertionHandler
*/ */
@ -593,7 +593,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAssertionHandler * \sa SDL_SetAssertionHandler
*/ */
@ -627,7 +627,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetAssertionHandler(void **
* SDL_ResetAssertionReport() simultaneously, may render the * SDL_ResetAssertionReport() simultaneously, may render the
* returned pointer invalid. * returned pointer invalid.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ResetAssertionReport * \sa SDL_ResetAssertionReport
*/ */
@ -645,7 +645,7 @@ extern SDL_DECLSPEC const SDL_AssertData * SDLCALL SDL_GetAssertionReport(void);
* assertion, or simultaneously calling this function may cause * assertion, or simultaneously calling this function may cause
* memory leaks or crashes. * memory leaks or crashes.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAssertionReport * \sa SDL_GetAssertionReport
*/ */

22
include/SDL3/SDL_asyncio.h
View file

@ -213,7 +213,7 @@ typedef struct SDL_AsyncIOQueue SDL_AsyncIOQueue;
* \returns a pointer to the SDL_AsyncIO structure that is created or NULL on * \returns a pointer to the SDL_AsyncIO structure that is created or NULL on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseAsyncIO * \sa SDL_CloseAsyncIO
* \sa SDL_ReadAsyncIO * \sa SDL_ReadAsyncIO
@ -234,7 +234,7 @@ extern SDL_DECLSPEC SDL_AsyncIO * SDLCALL SDL_AsyncIOFromFile(const char *file,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio); extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio);
@ -269,7 +269,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WriteAsyncIO * \sa SDL_WriteAsyncIO
* \sa SDL_CreateAsyncIOQueue * \sa SDL_CreateAsyncIOQueue
@ -306,7 +306,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadAsyncIO(SDL_AsyncIO *asyncio, void *ptr
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ReadAsyncIO * \sa SDL_ReadAsyncIO
* \sa SDL_CreateAsyncIOQueue * \sa SDL_CreateAsyncIOQueue
@ -358,7 +358,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteAsyncIO(SDL_AsyncIO *asyncio, void *pt
* \threadsafety It is safe to call this function from any thread, but two * \threadsafety It is safe to call this function from any thread, but two
* threads should not attempt to close the same object. * threads should not attempt to close the same object.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flush, SDL_AsyncIOQueue *queue, void *userdata); extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flush, SDL_AsyncIOQueue *queue, void *userdata);
@ -373,7 +373,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flu
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyAsyncIOQueue * \sa SDL_DestroyAsyncIOQueue
* \sa SDL_GetAsyncIOResult * \sa SDL_GetAsyncIOResult
@ -407,7 +407,7 @@ extern SDL_DECLSPEC SDL_AsyncIOQueue * SDLCALL SDL_CreateAsyncIOQueue(void);
* no other thread is waiting on the queue with * no other thread is waiting on the queue with
* SDL_WaitAsyncIOResult. * SDL_WaitAsyncIOResult.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue); extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue);
@ -431,7 +431,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WaitAsyncIOResult * \sa SDL_WaitAsyncIOResult
*/ */
@ -475,7 +475,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAsyncIOResult(SDL_AsyncIOQueue *queue, S
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SignalAsyncIOQueue * \sa SDL_SignalAsyncIOQueue
*/ */
@ -499,7 +499,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitAsyncIOResult(SDL_AsyncIOQueue *queue,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WaitAsyncIOResult * \sa SDL_WaitAsyncIOResult
*/ */
@ -531,7 +531,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalAsyncIOQueue(SDL_AsyncIOQueue *queue)
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadFile_IO * \sa SDL_LoadFile_IO
*/ */

46
include/SDL3/SDL_atomic.h
View file

@ -92,7 +92,7 @@ typedef int SDL_SpinLock;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockSpinlock * \sa SDL_LockSpinlock
* \sa SDL_UnlockSpinlock * \sa SDL_UnlockSpinlock
@ -109,7 +109,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockSpinlock(SDL_SpinLock *lock);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_TryLockSpinlock * \sa SDL_TryLockSpinlock
* \sa SDL_UnlockSpinlock * \sa SDL_UnlockSpinlock
@ -128,7 +128,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockSpinlock(SDL_SpinLock *lock);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockSpinlock * \sa SDL_LockSpinlock
* \sa SDL_TryLockSpinlock * \sa SDL_TryLockSpinlock
@ -152,7 +152,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockSpinlock(SDL_SpinLock *lock);
* time, but if you find yourself needing this, you are probably * time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_CompilerBarrier() DoCompilerSpecificReadWriteBarrier() #define SDL_CompilerBarrier() DoCompilerSpecificReadWriteBarrier()
@ -185,7 +185,7 @@ extern __inline void SDL_CompilerBarrier(void);
* time, but if you find yourself needing this, you are probably * time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_MemoryBarrierRelease * \sa SDL_MemoryBarrierRelease
*/ */
@ -205,7 +205,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierReleaseFunction(void);
* time, but if you find yourself needing this, you are probably * time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_MemoryBarrierAcquire * \sa SDL_MemoryBarrierAcquire
*/ */
@ -245,7 +245,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierAcquireFunction(void);
* time, but if you find yourself needing this, you are probably * time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_MemoryBarrierAcquire * \sa SDL_MemoryBarrierAcquire
* \sa SDL_MemoryBarrierReleaseFunction * \sa SDL_MemoryBarrierReleaseFunction
@ -268,7 +268,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_MemoryBarrierAcquireFunction(void);
* time, but if you find yourself needing this, you are probably * time, but if you find yourself needing this, you are probably
* dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_MemoryBarrierRelease * \sa SDL_MemoryBarrierRelease
* \sa SDL_MemoryBarrierAcquireFunction * \sa SDL_MemoryBarrierAcquireFunction
@ -341,7 +341,7 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
* *
* \threadsafety This macro is safe to use from any thread. * \threadsafety This macro is safe to use from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_CPUPauseInstruction() DoACPUPauseInACompilerAndArchitectureSpecificWay #define SDL_CPUPauseInstruction() DoACPUPauseInACompilerAndArchitectureSpecificWay
@ -385,7 +385,7 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
* This is a struct so people don't accidentally use numeric operations on it * This is a struct so people don't accidentally use numeric operations on it
* directly. You have to use SDL atomic functions. * directly. You have to use SDL atomic functions.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_CompareAndSwapAtomicInt * \sa SDL_CompareAndSwapAtomicInt
* \sa SDL_GetAtomicInt * \sa SDL_GetAtomicInt
@ -407,7 +407,7 @@ typedef struct SDL_AtomicInt { int value; } SDL_AtomicInt;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAtomicInt * \sa SDL_GetAtomicInt
* \sa SDL_SetAtomicInt * \sa SDL_SetAtomicInt
@ -428,7 +428,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CompareAndSwapAtomicInt(SDL_AtomicInt *a, i
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAtomicInt * \sa SDL_GetAtomicInt
*/ */
@ -445,7 +445,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetAtomicInt(SDL_AtomicInt *a, int v);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAtomicInt * \sa SDL_SetAtomicInt
*/ */
@ -465,7 +465,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAtomicInt(SDL_AtomicInt *a);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AtomicDecRef * \sa SDL_AtomicDecRef
* \sa SDL_AtomicIncRef * \sa SDL_AtomicIncRef
@ -484,7 +484,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_AtomicDecRef * \sa SDL_AtomicDecRef
*/ */
@ -504,7 +504,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_AtomicIncRef * \sa SDL_AtomicIncRef
*/ */
@ -531,7 +531,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
* This is a struct so people don't accidentally use numeric operations on it * This is a struct so people don't accidentally use numeric operations on it
* directly. You have to use SDL atomic functions. * directly. You have to use SDL atomic functions.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_CompareAndSwapAtomicU32 * \sa SDL_CompareAndSwapAtomicU32
* \sa SDL_GetAtomicU32 * \sa SDL_GetAtomicU32
@ -552,7 +552,7 @@ typedef struct SDL_AtomicU32 { Uint32 value; } SDL_AtomicU32;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAtomicU32 * \sa SDL_GetAtomicU32
* \sa SDL_SetAtomicU32 * \sa SDL_SetAtomicU32
@ -573,7 +573,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CompareAndSwapAtomicU32(SDL_AtomicU32 *a, U
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAtomicU32 * \sa SDL_GetAtomicU32
*/ */
@ -590,7 +590,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_SetAtomicU32(SDL_AtomicU32 *a, Uint32 v);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAtomicU32 * \sa SDL_SetAtomicU32
*/ */
@ -609,7 +609,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetAtomicU32(SDL_AtomicU32 *a);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CompareAndSwapAtomicInt * \sa SDL_CompareAndSwapAtomicInt
* \sa SDL_GetAtomicPointer * \sa SDL_GetAtomicPointer
@ -629,7 +629,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CompareAndSwapAtomicPointer(void **a, void
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CompareAndSwapAtomicPointer * \sa SDL_CompareAndSwapAtomicPointer
* \sa SDL_GetAtomicPointer * \sa SDL_GetAtomicPointer
@ -647,7 +647,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_SetAtomicPointer(void **a, void *v);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CompareAndSwapAtomicPointer * \sa SDL_CompareAndSwapAtomicPointer
* \sa SDL_SetAtomicPointer * \sa SDL_SetAtomicPointer

156
include/SDL3/SDL_audio.h
View file

@ -146,7 +146,7 @@ extern "C" {
* *
* Generally one should use SDL_AUDIO_BITSIZE instead of this macro directly. * Generally one should use SDL_AUDIO_BITSIZE instead of this macro directly.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_MASK_BITSIZE (0xFFu) #define SDL_AUDIO_MASK_BITSIZE (0xFFu)
@ -155,7 +155,7 @@ extern "C" {
* *
* Generally one should use SDL_AUDIO_ISFLOAT instead of this macro directly. * Generally one should use SDL_AUDIO_ISFLOAT instead of this macro directly.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_MASK_FLOAT (1u<<8) #define SDL_AUDIO_MASK_FLOAT (1u<<8)
@ -165,7 +165,7 @@ extern "C" {
* Generally one should use SDL_AUDIO_ISBIGENDIAN or SDL_AUDIO_ISLITTLEENDIAN * Generally one should use SDL_AUDIO_ISBIGENDIAN or SDL_AUDIO_ISLITTLEENDIAN
* instead of this macro directly. * instead of this macro directly.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_MASK_BIG_ENDIAN (1u<<12) #define SDL_AUDIO_MASK_BIG_ENDIAN (1u<<12)
@ -174,7 +174,7 @@ extern "C" {
* *
* Generally one should use SDL_AUDIO_ISSIGNED instead of this macro directly. * Generally one should use SDL_AUDIO_ISSIGNED instead of this macro directly.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_MASK_SIGNED (1u<<15) #define SDL_AUDIO_MASK_SIGNED (1u<<15)
@ -199,7 +199,7 @@ extern "C" {
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_DEFINE_AUDIO_FORMAT(signed, bigendian, flt, size) \ #define SDL_DEFINE_AUDIO_FORMAT(signed, bigendian, flt, size) \
(((Uint16)(signed) << 15) | ((Uint16)(bigendian) << 12) | ((Uint16)(flt) << 8) | ((size) & SDL_AUDIO_MASK_BITSIZE)) (((Uint16)(signed) << 15) | ((Uint16)(bigendian) << 12) | ((Uint16)(flt) << 8) | ((size) & SDL_AUDIO_MASK_BITSIZE))
@ -207,7 +207,7 @@ extern "C" {
/** /**
* Audio format. * Audio format.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_AUDIO_BITSIZE * \sa SDL_AUDIO_BITSIZE
* \sa SDL_AUDIO_BYTESIZE * \sa SDL_AUDIO_BYTESIZE
@ -261,7 +261,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_BITSIZE(x) ((x) & SDL_AUDIO_MASK_BITSIZE) #define SDL_AUDIO_BITSIZE(x) ((x) & SDL_AUDIO_MASK_BITSIZE)
@ -275,7 +275,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_BYTESIZE(x) (SDL_AUDIO_BITSIZE(x) / 8) #define SDL_AUDIO_BYTESIZE(x) (SDL_AUDIO_BITSIZE(x) / 8)
@ -289,7 +289,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_ISFLOAT(x) ((x) & SDL_AUDIO_MASK_FLOAT) #define SDL_AUDIO_ISFLOAT(x) ((x) & SDL_AUDIO_MASK_FLOAT)
@ -303,7 +303,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_ISBIGENDIAN(x) ((x) & SDL_AUDIO_MASK_BIG_ENDIAN) #define SDL_AUDIO_ISBIGENDIAN(x) ((x) & SDL_AUDIO_MASK_BIG_ENDIAN)
@ -317,7 +317,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_ISLITTLEENDIAN(x) (!SDL_AUDIO_ISBIGENDIAN(x)) #define SDL_AUDIO_ISLITTLEENDIAN(x) (!SDL_AUDIO_ISBIGENDIAN(x))
@ -331,7 +331,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_ISSIGNED(x) ((x) & SDL_AUDIO_MASK_SIGNED) #define SDL_AUDIO_ISSIGNED(x) ((x) & SDL_AUDIO_MASK_SIGNED)
@ -345,7 +345,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_ISINT(x) (!SDL_AUDIO_ISFLOAT(x)) #define SDL_AUDIO_ISINT(x) (!SDL_AUDIO_ISFLOAT(x))
@ -359,7 +359,7 @@ typedef enum SDL_AudioFormat
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_ISUNSIGNED(x) (!SDL_AUDIO_ISSIGNED(x)) #define SDL_AUDIO_ISUNSIGNED(x) (!SDL_AUDIO_ISSIGNED(x))
@ -369,7 +369,7 @@ typedef enum SDL_AudioFormat
* *
* Zero is used to signify an invalid/null device. * Zero is used to signify an invalid/null device.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_AudioDeviceID; typedef Uint32 SDL_AudioDeviceID;
@ -380,7 +380,7 @@ typedef Uint32 SDL_AudioDeviceID;
* to signify the app just wants the system to choose a default device instead * to signify the app just wants the system to choose a default device instead
* of the app providing a specific one. * of the app providing a specific one.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK ((SDL_AudioDeviceID) 0xFFFFFFFFu) #define SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK ((SDL_AudioDeviceID) 0xFFFFFFFFu)
@ -391,14 +391,14 @@ typedef Uint32 SDL_AudioDeviceID;
* to signify the app just wants the system to choose a default device instead * to signify the app just wants the system to choose a default device instead
* of the app providing a specific one. * of the app providing a specific one.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_DEVICE_DEFAULT_RECORDING ((SDL_AudioDeviceID) 0xFFFFFFFEu) #define SDL_AUDIO_DEVICE_DEFAULT_RECORDING ((SDL_AudioDeviceID) 0xFFFFFFFEu)
/** /**
* Format specifier for audio data. * Format specifier for audio data.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_AudioFormat * \sa SDL_AudioFormat
*/ */
@ -420,7 +420,7 @@ typedef struct SDL_AudioSpec
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_AUDIO_FRAMESIZE(x) (SDL_AUDIO_BYTESIZE((x).format) * (x).channels) #define SDL_AUDIO_FRAMESIZE(x) (SDL_AUDIO_BYTESIZE((x).format) * (x).channels)
@ -444,7 +444,7 @@ typedef struct SDL_AudioSpec
* more of them, bind them to an opened audio device, and feed data to them * more of them, bind them to an opened audio device, and feed data to them
* (or for recording, consume data from them). * (or for recording, consume data from them).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_CreateAudioStream * \sa SDL_CreateAudioStream
*/ */
@ -470,7 +470,7 @@ typedef struct SDL_AudioStream SDL_AudioStream;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioDriver * \sa SDL_GetAudioDriver
*/ */
@ -494,7 +494,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumAudioDrivers * \sa SDL_GetNumAudioDrivers
*/ */
@ -512,7 +512,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioDriver(int index);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentAudioDriver(void); extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentAudioDriver(void);
@ -538,7 +538,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentAudioDriver(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenAudioDevice * \sa SDL_OpenAudioDevice
* \sa SDL_GetAudioRecordingDevices * \sa SDL_GetAudioRecordingDevices
@ -567,7 +567,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID * SDLCALL SDL_GetAudioPlaybackDevices(int
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenAudioDevice * \sa SDL_OpenAudioDevice
* \sa SDL_GetAudioPlaybackDevices * \sa SDL_GetAudioPlaybackDevices
@ -583,7 +583,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID * SDLCALL SDL_GetAudioRecordingDevices(int
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioPlaybackDevices * \sa SDL_GetAudioPlaybackDevices
* \sa SDL_GetAudioRecordingDevices * \sa SDL_GetAudioRecordingDevices
@ -621,7 +621,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioDeviceName(SDL_AudioDeviceI
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devid, SDL_AudioSpec *spec, int *sample_frames); extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devid, SDL_AudioSpec *spec, int *sample_frames);
@ -642,7 +642,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioDeviceFormat(SDL_AudioDeviceID devi
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamInputChannelMap * \sa SDL_SetAudioStreamInputChannelMap
*/ */
@ -717,7 +717,7 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioDeviceChannelMap(SDL_AudioDeviceID
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseAudioDevice * \sa SDL_CloseAudioDevice
* \sa SDL_GetAudioDeviceFormat * \sa SDL_GetAudioDeviceFormat
@ -745,7 +745,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(SDL_AudioDevic
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePhysical(SDL_AudioDeviceID devid); extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePhysical(SDL_AudioDeviceID devid);
@ -759,7 +759,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePhysical(SDL_AudioDeviceID dev
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePlayback(SDL_AudioDeviceID devid); extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePlayback(SDL_AudioDeviceID devid);
@ -787,7 +787,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePlayback(SDL_AudioDeviceID dev
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ResumeAudioDevice * \sa SDL_ResumeAudioDevice
* \sa SDL_AudioDevicePaused * \sa SDL_AudioDevicePaused
@ -815,7 +815,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AudioDevicePaused * \sa SDL_AudioDevicePaused
* \sa SDL_PauseAudioDevice * \sa SDL_PauseAudioDevice
@ -837,7 +837,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeAudioDevice(SDL_AudioDeviceID dev);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PauseAudioDevice * \sa SDL_PauseAudioDevice
* \sa SDL_ResumeAudioDevice * \sa SDL_ResumeAudioDevice
@ -861,7 +861,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AudioDevicePaused(SDL_AudioDeviceID dev);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioDeviceGain * \sa SDL_SetAudioDeviceGain
*/ */
@ -896,7 +896,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 * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioDeviceGain * \sa SDL_GetAudioDeviceGain
*/ */
@ -917,7 +917,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioDeviceGain(SDL_AudioDeviceID devid,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenAudioDevice * \sa SDL_OpenAudioDevice
*/ */
@ -952,7 +952,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID devid);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BindAudioStreams * \sa SDL_BindAudioStreams
* \sa SDL_UnbindAudioStream * \sa SDL_UnbindAudioStream
@ -973,7 +973,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devid, S
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BindAudioStreams * \sa SDL_BindAudioStreams
* \sa SDL_UnbindAudioStream * \sa SDL_UnbindAudioStream
@ -996,7 +996,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BindAudioStream(SDL_AudioDeviceID devid, SD
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BindAudioStreams * \sa SDL_BindAudioStreams
*/ */
@ -1012,7 +1012,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnbindAudioStreams(SDL_AudioStream * const
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BindAudioStream * \sa SDL_BindAudioStream
*/ */
@ -1031,7 +1031,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnbindAudioStream(SDL_AudioStream *stream);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BindAudioStream * \sa SDL_BindAudioStream
* \sa SDL_BindAudioStreams * \sa SDL_BindAudioStreams
@ -1048,7 +1048,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_GetAudioStreamDevice(SDL_Audio
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PutAudioStreamData * \sa SDL_PutAudioStreamData
* \sa SDL_GetAudioStreamData * \sa SDL_GetAudioStreamData
@ -1069,7 +1069,7 @@ extern SDL_DECLSPEC SDL_AudioStream * SDLCALL SDL_CreateAudioStream(const SDL_Au
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_AudioStream *stream); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_AudioStream *stream);
@ -1085,7 +1085,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 * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamFormat * \sa SDL_SetAudioStreamFormat
*/ */
@ -1121,7 +1121,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 * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioStreamFormat * \sa SDL_GetAudioStreamFormat
* \sa SDL_SetAudioStreamFrequencyRatio * \sa SDL_SetAudioStreamFrequencyRatio
@ -1138,7 +1138,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 * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamFrequencyRatio * \sa SDL_SetAudioStreamFrequencyRatio
*/ */
@ -1165,7 +1165,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre
* \threadsafety It is safe to call this function from any thread, as it holds * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioStreamFrequencyRatio * \sa SDL_GetAudioStreamFrequencyRatio
* \sa SDL_SetAudioStreamFormat * \sa SDL_SetAudioStreamFormat
@ -1187,7 +1187,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamFrequencyRatio(SDL_AudioStrea
* \threadsafety It is safe to call this function from any thread, as it holds * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamGain * \sa SDL_SetAudioStreamGain
*/ */
@ -1212,7 +1212,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 * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioStreamGain * \sa SDL_GetAudioStreamGain
*/ */
@ -1236,7 +1236,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 * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamInputChannelMap * \sa SDL_SetAudioStreamInputChannelMap
*/ */
@ -1260,7 +1260,7 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioStreamInputChannelMap(SDL_AudioStr
* \threadsafety It is safe to call this function from any thread, as it holds * \threadsafety It is safe to call this function from any thread, as it holds
* a stream-specific mutex while running. * a stream-specific mutex while running.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamInputChannelMap * \sa SDL_SetAudioStreamInputChannelMap
*/ */
@ -1320,7 +1320,7 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioStreamOutputChannelMap(SDL_AudioSt
* stream's format to have a different number of channels from a * stream's format to have a different number of channels from a
* a different thread at the same time, though! * a different thread at the same time, though!
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamInputChannelMap * \sa SDL_SetAudioStreamInputChannelMap
*/ */
@ -1378,7 +1378,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamInputChannelMap(SDL_AudioStre
* stream's format to have a different number of channels from a * stream's format to have a different number of channels from a
* a different thread at the same time, though! * a different thread at the same time, though!
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamInputChannelMap * \sa SDL_SetAudioStreamInputChannelMap
*/ */
@ -1405,7 +1405,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamOutputChannelMap(SDL_AudioStr
* stream has a callback set, the caller might need to manage * stream has a callback set, the caller might need to manage
* extra locking. * extra locking.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ClearAudioStream * \sa SDL_ClearAudioStream
* \sa SDL_FlushAudioStream * \sa SDL_FlushAudioStream
@ -1436,7 +1436,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *stream,
* stream has a callback set, the caller might need to manage * stream has a callback set, the caller might need to manage
* extra locking. * extra locking.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ClearAudioStream * \sa SDL_ClearAudioStream
* \sa SDL_GetAudioStreamAvailable * \sa SDL_GetAudioStreamAvailable
@ -1463,7 +1463,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamData(SDL_AudioStream *stream,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioStreamData * \sa SDL_GetAudioStreamData
* \sa SDL_PutAudioStreamData * \sa SDL_PutAudioStreamData
@ -1502,7 +1502,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *str
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PutAudioStreamData * \sa SDL_PutAudioStreamData
* \sa SDL_ClearAudioStream * \sa SDL_ClearAudioStream
@ -1524,7 +1524,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(SDL_AudioStream *stream
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PutAudioStreamData * \sa SDL_PutAudioStreamData
*/ */
@ -1542,7 +1542,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushAudioStream(SDL_AudioStream *stream);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioStreamAvailable * \sa SDL_GetAudioStreamAvailable
* \sa SDL_GetAudioStreamData * \sa SDL_GetAudioStreamData
@ -1569,7 +1569,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearAudioStream(SDL_AudioStream *stream);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ResumeAudioStreamDevice * \sa SDL_ResumeAudioStreamDevice
*/ */
@ -1589,7 +1589,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioStreamDevice(SDL_AudioStream *str
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PauseAudioStreamDevice * \sa SDL_PauseAudioStreamDevice
*/ */
@ -1607,7 +1607,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeAudioStreamDevice(SDL_AudioStream *st
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.10. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PauseAudioStreamDevice * \sa SDL_PauseAudioStreamDevice
* \sa SDL_ResumeAudioStreamDevice * \sa SDL_ResumeAudioStreamDevice
@ -1637,7 +1637,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AudioStreamDevicePaused(SDL_AudioStream *st
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_UnlockAudioStream * \sa SDL_UnlockAudioStream
*/ */
@ -1656,7 +1656,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream);
* \threadsafety You should only call this from the same thread that * \threadsafety You should only call this from the same thread that
* previously called SDL_LockAudioStream. * previously called SDL_LockAudioStream.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockAudioStream * \sa SDL_LockAudioStream
*/ */
@ -1697,7 +1697,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UnlockAudioStream(SDL_AudioStream *stream);
* is called, so your callback does not need to manage the lock * is called, so your callback does not need to manage the lock
* explicitly. * explicitly.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamGetCallback * \sa SDL_SetAudioStreamGetCallback
* \sa SDL_SetAudioStreamPutCallback * \sa SDL_SetAudioStreamPutCallback
@ -1744,7 +1744,7 @@ typedef void (SDLCALL *SDL_AudioStreamCallback)(void *userdata, SDL_AudioStream
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamPutCallback * \sa SDL_SetAudioStreamPutCallback
*/ */
@ -1793,7 +1793,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamGetCallback(SDL_AudioStream *
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioStreamGetCallback * \sa SDL_SetAudioStreamGetCallback
*/ */
@ -1815,7 +1815,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamPutCallback(SDL_AudioStream *
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateAudioStream * \sa SDL_CreateAudioStream
*/ */
@ -1877,7 +1877,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAudioStream(SDL_AudioStream *stream)
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAudioStreamDevice * \sa SDL_GetAudioStreamDevice
* \sa SDL_ResumeAudioStreamDevice * \sa SDL_ResumeAudioStreamDevice
@ -1915,7 +1915,7 @@ extern SDL_DECLSPEC SDL_AudioStream * SDLCALL SDL_OpenAudioDeviceStream(SDL_Audi
* application is responsible for locking resources the callback * application is responsible for locking resources the callback
* touches that need to be protected. * touches that need to be protected.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetAudioPostmixCallback * \sa SDL_SetAudioPostmixCallback
*/ */
@ -1971,7 +1971,7 @@ typedef void (SDLCALL *SDL_AudioPostmixCallback)(void *userdata, const SDL_Audio
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID devid, SDL_AudioPostmixCallback callback, void *userdata); extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID devid, SDL_AudioPostmixCallback callback, void *userdata);
@ -2049,7 +2049,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID d
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_free * \sa SDL_free
* \sa SDL_LoadWAV * \sa SDL_LoadWAV
@ -2085,7 +2085,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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_free * \sa SDL_free
* \sa SDL_LoadWAV_IO * \sa SDL_LoadWAV_IO
@ -2124,7 +2124,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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, SDL_AudioFormat format, Uint32 len, float volume); extern SDL_DECLSPEC bool SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, SDL_AudioFormat format, Uint32 len, float volume);
@ -2154,7 +2154,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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ConvertAudioSamples(const SDL_AudioSpec *src_spec, const Uint8 *src_data, int src_len, const SDL_AudioSpec *dst_spec, Uint8 **dst_data, int *dst_len); 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);
@ -2167,7 +2167,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertAudioSamples(const SDL_AudioSpec *sr
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioFormatName(SDL_AudioFormat format); extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioFormatName(SDL_AudioFormat format);
@ -2183,7 +2183,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioFormatName(SDL_AudioFormat
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetSilenceValueForFormat(SDL_AudioFormat format); extern SDL_DECLSPEC int SDLCALL SDL_GetSilenceValueForFormat(SDL_AudioFormat format);

26
include/SDL3/SDL_begin_code.h
View file

@ -62,7 +62,7 @@
* On compilers without a deprecation mechanism, this is defined to nothing, * On compilers without a deprecation mechanism, this is defined to nothing,
* and using a deprecated function will not generate a warning. * and using a deprecated function will not generate a warning.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_DEPRECATED __attribute__((deprecated)) #define SDL_DEPRECATED __attribute__((deprecated))
@ -76,7 +76,7 @@
* This symbol is used in SDL's headers, but apps and other libraries are * This symbol is used in SDL's headers, but apps and other libraries are
* welcome to use it for their own interfaces as well. * welcome to use it for their own interfaces as well.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_DECLSPEC __attribute__ ((visibility("default"))) #define SDL_DECLSPEC __attribute__ ((visibility("default")))
@ -97,7 +97,7 @@
* This symbol is used in SDL's headers, but apps and other libraries are * This symbol is used in SDL's headers, but apps and other libraries are
* welcome to use it for their own interfaces as well. * welcome to use it for their own interfaces as well.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDLCALL __cdecl #define SDLCALL __cdecl
@ -108,7 +108,7 @@
* to ignore this request. On compilers without inline support, this is * to ignore this request. On compilers without inline support, this is
* defined to nothing. * defined to nothing.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_INLINE __inline #define SDL_INLINE __inline
@ -123,7 +123,7 @@
* This symbol is used in SDL's headers, but apps and other libraries are * This symbol is used in SDL's headers, but apps and other libraries are
* welcome to use it for their own interfaces as well. * welcome to use it for their own interfaces as well.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_FORCE_INLINE __forceinline #define SDL_FORCE_INLINE __forceinline
@ -140,7 +140,7 @@
* This symbol is used in SDL's headers, but apps and other libraries are * This symbol is used in SDL's headers, but apps and other libraries are
* welcome to use it for their own interfaces as well. * welcome to use it for their own interfaces as well.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_NORETURN __attribute__((noreturn)) #define SDL_NORETURN __attribute__((noreturn))
@ -160,7 +160,7 @@
* This symbol is used in SDL's headers, but apps and other libraries are * This symbol is used in SDL's headers, but apps and other libraries are
* welcome to use it for their own interfaces as well. * welcome to use it for their own interfaces as well.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ANALYZER_NORETURN __attribute__((analyzer_noreturn)) #define SDL_ANALYZER_NORETURN __attribute__((analyzer_noreturn))
@ -188,7 +188,7 @@
* } * }
* ``` * ```
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_FALLTHROUGH [[fallthrough]] #define SDL_FALLTHROUGH [[fallthrough]]
@ -215,7 +215,7 @@
* *
* On compilers without nodiscard support, this is defined to nothing. * On compilers without nodiscard support, this is defined to nothing.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_NODISCARD [[nodiscard]] #define SDL_NODISCARD [[nodiscard]]
@ -232,7 +232,7 @@
* *
* Most apps don't need to, and should not, use this directly. * Most apps don't need to, and should not, use this directly.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_MALLOC __declspec(allocator) __desclspec(restrict) #define SDL_MALLOC __declspec(allocator) __desclspec(restrict)
@ -248,7 +248,7 @@
* *
* Most apps don't need to, and should not, use this directly. * Most apps don't need to, and should not, use this directly.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ALLOC_SIZE(p) __attribute__((alloc_size(p))) #define SDL_ALLOC_SIZE(p) __attribute__((alloc_size(p)))
@ -261,7 +261,7 @@
* *
* On compilers without restrict support, this is defined to nothing. * On compilers without restrict support, this is defined to nothing.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_RESTRICT __restrict__ #define SDL_RESTRICT __restrict__
@ -277,7 +277,7 @@
* On compilers without has_builtin support, this is defined to 0 (always * On compilers without has_builtin support, this is defined to 0 (always
* false). * false).
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_HAS_BUILTIN(x) __has_builtin(x) #define SDL_HAS_BUILTIN(x) __has_builtin(x)

4
include/SDL3/SDL_bits.h
View file

@ -61,7 +61,7 @@ extern __inline int _SDL_bsr_watcom(Uint32);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x) SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x)
{ {
@ -128,7 +128,7 @@ SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x)
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE bool SDL_HasExactlyOneBitSet32(Uint32 x) SDL_FORCE_INLINE bool SDL_HasExactlyOneBitSet32(Uint32 x)
{ {

8
include/SDL3/SDL_blendmode.h
View file

@ -45,7 +45,7 @@ extern "C" {
* *
* Additional values may be obtained from SDL_ComposeCustomBlendMode. * Additional values may be obtained from SDL_ComposeCustomBlendMode.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_ComposeCustomBlendMode * \sa SDL_ComposeCustomBlendMode
*/ */
@ -64,7 +64,7 @@ typedef Uint32 SDL_BlendMode;
* The blend operation used when combining source and destination pixel * The blend operation used when combining source and destination pixel
* components. * components.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_BlendOperation typedef enum SDL_BlendOperation
{ {
@ -83,7 +83,7 @@ typedef enum SDL_BlendOperation
* operation. The comma-separated factors listed above are always applied in * operation. The comma-separated factors listed above are always applied in
* the component order red, green, blue, and alpha. * the component order red, green, blue, and alpha.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_BlendFactor typedef enum SDL_BlendFactor
{ {
@ -179,7 +179,7 @@ typedef enum SDL_BlendFactor
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderDrawBlendMode * \sa SDL_SetRenderDrawBlendMode
* \sa SDL_GetRenderDrawBlendMode * \sa SDL_GetRenderDrawBlendMode

38
include/SDL3/SDL_camera.h
View file

@ -88,7 +88,7 @@ extern "C" {
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_GetCameras * \sa SDL_GetCameras
*/ */
@ -97,7 +97,7 @@ typedef Uint32 SDL_CameraID;
/** /**
* The opaque structure used to identify an opened SDL camera. * The opaque structure used to identify an opened SDL camera.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Camera SDL_Camera; typedef struct SDL_Camera SDL_Camera;
@ -107,7 +107,7 @@ typedef struct SDL_Camera SDL_Camera;
* Cameras often support multiple formats; each one will be encapsulated in * Cameras often support multiple formats; each one will be encapsulated in
* this struct. * this struct.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GetCameraSupportedFormats * \sa SDL_GetCameraSupportedFormats
* \sa SDL_GetCameraFormat * \sa SDL_GetCameraFormat
@ -125,7 +125,7 @@ typedef struct SDL_CameraSpec
/** /**
* The position of camera in relation to system device. * The position of camera in relation to system device.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_GetCameraPosition * \sa SDL_GetCameraPosition
*/ */
@ -154,7 +154,7 @@ typedef enum SDL_CameraPosition
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCameraDriver * \sa SDL_GetCameraDriver
*/ */
@ -178,7 +178,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumCameraDrivers(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumCameraDrivers * \sa SDL_GetNumCameraDrivers
*/ */
@ -196,7 +196,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCameraDriver(int index);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentCameraDriver(void); extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentCameraDriver(void);
@ -211,7 +211,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentCameraDriver(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenCamera * \sa SDL_OpenCamera
*/ */
@ -249,7 +249,7 @@ extern SDL_DECLSPEC SDL_CameraID * SDLCALL SDL_GetCameras(int *count);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCameras * \sa SDL_GetCameras
* \sa SDL_OpenCamera * \sa SDL_OpenCamera
@ -265,7 +265,7 @@ extern SDL_DECLSPEC SDL_CameraSpec ** SDLCALL SDL_GetCameraSupportedFormats(SDL_
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCameras * \sa SDL_GetCameras
*/ */
@ -284,7 +284,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetCameraName(SDL_CameraID instance
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCameras * \sa SDL_GetCameras
*/ */
@ -330,7 +330,7 @@ extern SDL_DECLSPEC SDL_CameraPosition SDLCALL SDL_GetCameraPosition(SDL_CameraI
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCameras * \sa SDL_GetCameras
* \sa SDL_GetCameraFormat * \sa SDL_GetCameraFormat
@ -363,7 +363,7 @@ extern SDL_DECLSPEC SDL_Camera * SDLCALL SDL_OpenCamera(SDL_CameraID instance_id
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenCamera * \sa SDL_OpenCamera
* \sa SDL_CloseCamera * \sa SDL_CloseCamera
@ -379,7 +379,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetCameraPermissionState(SDL_Camera *camera)
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenCamera * \sa SDL_OpenCamera
*/ */
@ -394,7 +394,7 @@ extern SDL_DECLSPEC SDL_CameraID SDLCALL SDL_GetCameraID(SDL_Camera *camera);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera *camera); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera *camera);
@ -418,7 +418,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenCamera * \sa SDL_OpenCamera
*/ */
@ -461,7 +461,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetCameraFormat(SDL_Camera *camera, SDL_Cam
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ReleaseCameraFrame * \sa SDL_ReleaseCameraFrame
*/ */
@ -489,7 +489,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_AcquireCameraFrame(SDL_Camera *cam
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AcquireCameraFrame * \sa SDL_AcquireCameraFrame
*/ */
@ -504,7 +504,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 * \threadsafety It is safe to call this function from any thread, but no
* thread may reference `device` once this function is called. * thread may reference `device` once this function is called.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenCamera * \sa SDL_OpenCamera
*/ */

26
include/SDL3/SDL_clipboard.h
View file

@ -96,7 +96,7 @@ extern "C" {
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetClipboardText * \sa SDL_GetClipboardText
* \sa SDL_HasClipboardText * \sa SDL_HasClipboardText
@ -115,7 +115,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardText(const char *text);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasClipboardText * \sa SDL_HasClipboardText
* \sa SDL_SetClipboardText * \sa SDL_SetClipboardText
@ -129,7 +129,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetClipboardText(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetClipboardText * \sa SDL_GetClipboardText
* \sa SDL_SetClipboardText * \sa SDL_SetClipboardText
@ -145,7 +145,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardText(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPrimarySelectionText * \sa SDL_GetPrimarySelectionText
* \sa SDL_HasPrimarySelectionText * \sa SDL_HasPrimarySelectionText
@ -164,7 +164,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPrimarySelectionText(const char *text);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasPrimarySelectionText * \sa SDL_HasPrimarySelectionText
* \sa SDL_SetPrimarySelectionText * \sa SDL_SetPrimarySelectionText
@ -179,7 +179,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetPrimarySelectionText(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPrimarySelectionText * \sa SDL_GetPrimarySelectionText
* \sa SDL_SetPrimarySelectionText * \sa SDL_SetPrimarySelectionText
@ -204,7 +204,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasPrimarySelectionText(void);
* breakage in receiving applications. The returned data will not be * breakage in receiving applications. The returned data will not be
* freed so it needs to be retained and dealt with internally. * freed so it needs to be retained and dealt with internally.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetClipboardData * \sa SDL_SetClipboardData
*/ */
@ -216,7 +216,7 @@ typedef const void *(SDLCALL *SDL_ClipboardDataCallback)(void *userdata, const c
* *
* \param userdata a pointer to provided user data. * \param userdata a pointer to provided user data.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetClipboardData * \sa SDL_SetClipboardData
*/ */
@ -246,7 +246,7 @@ typedef void (SDLCALL *SDL_ClipboardCleanupCallback)(void *userdata);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ClearClipboardData * \sa SDL_ClearClipboardData
* \sa SDL_GetClipboardData * \sa SDL_GetClipboardData
@ -262,7 +262,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardData(SDL_ClipboardDataCallback
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetClipboardData * \sa SDL_SetClipboardData
*/ */
@ -282,7 +282,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearClipboardData(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasClipboardData * \sa SDL_HasClipboardData
* \sa SDL_SetClipboardData * \sa SDL_SetClipboardData
@ -298,7 +298,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetClipboardData(const char *mime_type, s
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetClipboardData * \sa SDL_SetClipboardData
* \sa SDL_GetClipboardData * \sa SDL_GetClipboardData
@ -316,7 +316,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardData(const char *mime_type);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetClipboardData * \sa SDL_SetClipboardData
*/ */

38
include/SDL3/SDL_cpuinfo.h
View file

@ -55,7 +55,7 @@ extern "C" {
* processors have a 128 byte cache line. We use the larger value to be * processors have a 128 byte cache line. We use the larger value to be
* generally safe. * generally safe.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_CACHELINE_SIZE 128 #define SDL_CACHELINE_SIZE 128
@ -68,7 +68,7 @@ extern "C" {
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetNumLogicalCPUCores(void); extern SDL_DECLSPEC int SDLCALL SDL_GetNumLogicalCPUCores(void);
@ -82,7 +82,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumLogicalCPUCores(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void); extern SDL_DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void);
@ -96,7 +96,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_HasAltiVec(void); extern SDL_DECLSPEC bool SDLCALL SDL_HasAltiVec(void);
@ -109,7 +109,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAltiVec(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_HasMMX(void); extern SDL_DECLSPEC bool SDLCALL SDL_HasMMX(void);
@ -122,7 +122,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasMMX(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasSSE2 * \sa SDL_HasSSE2
* \sa SDL_HasSSE3 * \sa SDL_HasSSE3
@ -140,7 +140,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasSSE * \sa SDL_HasSSE
* \sa SDL_HasSSE3 * \sa SDL_HasSSE3
@ -158,7 +158,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE2(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasSSE * \sa SDL_HasSSE
* \sa SDL_HasSSE2 * \sa SDL_HasSSE2
@ -176,7 +176,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE3(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasSSE * \sa SDL_HasSSE
* \sa SDL_HasSSE2 * \sa SDL_HasSSE2
@ -194,7 +194,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE41(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasSSE * \sa SDL_HasSSE
* \sa SDL_HasSSE2 * \sa SDL_HasSSE2
@ -212,7 +212,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasSSE42(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasAVX2 * \sa SDL_HasAVX2
* \sa SDL_HasAVX512F * \sa SDL_HasAVX512F
@ -228,7 +228,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAVX(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasAVX * \sa SDL_HasAVX
* \sa SDL_HasAVX512F * \sa SDL_HasAVX512F
@ -244,7 +244,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAVX2(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasAVX * \sa SDL_HasAVX
* \sa SDL_HasAVX2 * \sa SDL_HasAVX2
@ -262,7 +262,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasAVX512F(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasNEON * \sa SDL_HasNEON
*/ */
@ -277,7 +277,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasARMSIMD(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_HasNEON(void); extern SDL_DECLSPEC bool SDLCALL SDL_HasNEON(void);
@ -291,7 +291,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasNEON(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_HasLSX(void); extern SDL_DECLSPEC bool SDLCALL SDL_HasLSX(void);
@ -305,7 +305,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasLSX(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_HasLASX(void); extern SDL_DECLSPEC bool SDLCALL SDL_HasLASX(void);
@ -316,7 +316,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasLASX(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetSystemRAM(void); extern SDL_DECLSPEC int SDLCALL SDL_GetSystemRAM(void);
@ -337,7 +337,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetSystemRAM(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_aligned_alloc * \sa SDL_aligned_alloc
* \sa SDL_aligned_free * \sa SDL_aligned_free

14
include/SDL3/SDL_dialog.h
View file

@ -59,7 +59,7 @@ extern "C" {
* hyphens, underscores and periods. Alternatively, the whole string can be a * hyphens, underscores and periods. Alternatively, the whole string can be a
* single asterisk ("*"), which serves as an "All files" filter. * single asterisk ("*"), which serves as an "All files" filter.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_DialogFileCallback * \sa SDL_DialogFileCallback
* \sa SDL_ShowOpenFileDialog * \sa SDL_ShowOpenFileDialog
@ -102,7 +102,7 @@ typedef struct SDL_DialogFileFilter
* \param filelist the file(s) chosen by the user. * \param filelist the file(s) chosen by the user.
* \param filter index of the selected filter. * \param filter index of the selected filter.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_DialogFileFilter * \sa SDL_DialogFileFilter
* \sa SDL_ShowOpenFileDialog * \sa SDL_ShowOpenFileDialog
@ -153,7 +153,7 @@ typedef void (SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * cons
* callback may be invoked from the same thread or from a * callback may be invoked from the same thread or from a
* different one, depending on the OS's constraints. * different one, depending on the OS's constraints.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DialogFileCallback * \sa SDL_DialogFileCallback
* \sa SDL_DialogFileFilter * \sa SDL_DialogFileFilter
@ -202,7 +202,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowOpenFileDialog(SDL_DialogFileCallback c
* callback may be invoked from the same thread or from a * callback may be invoked from the same thread or from a
* different one, depending on the OS's constraints. * different one, depending on the OS's constraints.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DialogFileCallback * \sa SDL_DialogFileCallback
* \sa SDL_DialogFileFilter * \sa SDL_DialogFileFilter
@ -248,7 +248,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback c
* callback may be invoked from the same thread or from a * callback may be invoked from the same thread or from a
* different one, depending on the OS's constraints. * different one, depending on the OS's constraints.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DialogFileCallback * \sa SDL_DialogFileCallback
* \sa SDL_ShowOpenFileDialog * \sa SDL_ShowOpenFileDialog
@ -263,7 +263,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowOpenFolderDialog(SDL_DialogFileCallback
* This is used by SDL_ShowFileDialogWithProperties() to decide what kind of * This is used by SDL_ShowFileDialogWithProperties() to decide what kind of
* dialog to present to the user. * dialog to present to the user.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_ShowFileDialogWithProperties * \sa SDL_ShowFileDialogWithProperties
*/ */
@ -312,7 +312,7 @@ typedef enum SDL_FileDialogType
* callback may be invoked from the same thread or from a * callback may be invoked from the same thread or from a
* different one, depending on the OS's constraints. * different one, depending on the OS's constraints.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_FileDialogType * \sa SDL_FileDialogType
* \sa SDL_DialogFileCallback * \sa SDL_DialogFileCallback

32
include/SDL3/SDL_endian.h
View file

@ -78,7 +78,7 @@ _m_prefetch(void *__P)
* #endif * #endif
* ``` * ```
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_BYTEORDER * \sa SDL_BYTEORDER
* \sa SDL_BIG_ENDIAN * \sa SDL_BIG_ENDIAN
@ -97,7 +97,7 @@ _m_prefetch(void *__P)
* #endif * #endif
* ``` * ```
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_BYTEORDER * \sa SDL_BYTEORDER
* \sa SDL_LIL_ENDIAN * \sa SDL_LIL_ENDIAN
@ -122,7 +122,7 @@ _m_prefetch(void *__P)
* #endif * #endif
* ``` * ```
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_LIL_ENDIAN * \sa SDL_LIL_ENDIAN
* \sa SDL_BIG_ENDIAN * \sa SDL_BIG_ENDIAN
@ -184,7 +184,7 @@ _m_prefetch(void *__P)
* #endif * #endif
* ``` * ```
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_LIL_ENDIAN * \sa SDL_LIL_ENDIAN
* \sa SDL_BIG_ENDIAN * \sa SDL_BIG_ENDIAN
@ -403,7 +403,7 @@ SDL_FORCE_INLINE Uint64 SDL_Swap64(Uint64 x)
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE float SDL_SwapFloat(float x) SDL_FORCE_INLINE float SDL_SwapFloat(float x)
{ {
@ -442,7 +442,7 @@ SDL_FORCE_INLINE float SDL_SwapFloat(float x)
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x) { return x_but_byteswapped; } SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x) { return x_but_byteswapped; }
@ -463,7 +463,7 @@ SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE Uint32 SDL_Swap32(Uint32 x) { return x_but_byteswapped; } SDL_FORCE_INLINE Uint32 SDL_Swap32(Uint32 x) { return x_but_byteswapped; }
@ -484,7 +484,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap32(Uint32 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; } SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
@ -500,7 +500,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Swap16LE(x) SwapOnlyIfNecessary(x) #define SDL_Swap16LE(x) SwapOnlyIfNecessary(x)
@ -516,7 +516,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Swap32LE(x) SwapOnlyIfNecessary(x) #define SDL_Swap32LE(x) SwapOnlyIfNecessary(x)
@ -532,7 +532,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Swap64LE(x) SwapOnlyIfNecessary(x) #define SDL_Swap64LE(x) SwapOnlyIfNecessary(x)
@ -548,7 +548,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_SwapFloatLE(x) SwapOnlyIfNecessary(x) #define SDL_SwapFloatLE(x) SwapOnlyIfNecessary(x)
@ -564,7 +564,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Swap16BE(x) SwapOnlyIfNecessary(x) #define SDL_Swap16BE(x) SwapOnlyIfNecessary(x)
@ -580,7 +580,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Swap32BE(x) SwapOnlyIfNecessary(x) #define SDL_Swap32BE(x) SwapOnlyIfNecessary(x)
@ -596,7 +596,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Swap64BE(x) SwapOnlyIfNecessary(x) #define SDL_Swap64BE(x) SwapOnlyIfNecessary(x)
@ -612,7 +612,7 @@ SDL_FORCE_INLINE Uint32 SDL_Swap64(Uint64 x) { return x_but_byteswapped; }
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_SwapFloatBE(x) SwapOnlyIfNecessary(x) #define SDL_SwapFloatBE(x) SwapOnlyIfNecessary(x)

14
include/SDL3/SDL_error.h
View file

@ -80,7 +80,7 @@ extern "C" {
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ClearError * \sa SDL_ClearError
* \sa SDL_GetError * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.6. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ClearError * \sa SDL_ClearError
* \sa SDL_GetError * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_OutOfMemory(void); 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ClearError * \sa SDL_ClearError
* \sa SDL_SetError * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetError * \sa SDL_GetError
* \sa SDL_SetError * \sa SDL_SetError
@ -187,7 +187,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearError(void);
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_Unsupported() SDL_SetError("That operation is not supported") #define SDL_Unsupported() SDL_SetError("That operation is not supported")
@ -211,7 +211,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearError(void);
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param)) #define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))

120
include/SDL3/SDL_events.h
View file

@ -79,7 +79,7 @@ extern "C" {
/** /**
* The types of events that can be delivered. * The types of events that can be delivered.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_EventType typedef enum SDL_EventType
{ {
@ -282,7 +282,7 @@ typedef enum SDL_EventType
/** /**
* Fields shared by every event * Fields shared by every event
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_CommonEvent typedef struct SDL_CommonEvent
{ {
@ -294,7 +294,7 @@ typedef struct SDL_CommonEvent
/** /**
* Display state change event data (event.display.*) * Display state change event data (event.display.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_DisplayEvent typedef struct SDL_DisplayEvent
{ {
@ -309,7 +309,7 @@ typedef struct SDL_DisplayEvent
/** /**
* Window state change event data (event.window.*) * Window state change event data (event.window.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_WindowEvent typedef struct SDL_WindowEvent
{ {
@ -324,7 +324,7 @@ typedef struct SDL_WindowEvent
/** /**
* Keyboard device event structure (event.kdevice.*) * Keyboard device event structure (event.kdevice.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_KeyboardDeviceEvent typedef struct SDL_KeyboardDeviceEvent
{ {
@ -343,7 +343,7 @@ typedef struct SDL_KeyboardDeviceEvent
* event scancode and modifiers directly from the keyboard layout, bypassing * event scancode and modifiers directly from the keyboard layout, bypassing
* SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode(). * SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode().
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyFromScancode * \sa SDL_GetKeyFromScancode
* \sa SDL_HINT_KEYCODE_OPTIONS * \sa SDL_HINT_KEYCODE_OPTIONS
@ -370,7 +370,7 @@ typedef struct SDL_KeyboardEvent
* will be inserted into the editing text. The length is the number of UTF-8 * will be inserted into the editing text. The length is the number of UTF-8
* characters that will be replaced by new typing. * characters that will be replaced by new typing.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_TextEditingEvent typedef struct SDL_TextEditingEvent
{ {
@ -386,7 +386,7 @@ typedef struct SDL_TextEditingEvent
/** /**
* Keyboard IME candidates event structure (event.edit_candidates.*) * Keyboard IME candidates event structure (event.edit_candidates.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_TextEditingCandidatesEvent typedef struct SDL_TextEditingCandidatesEvent
{ {
@ -409,7 +409,7 @@ typedef struct SDL_TextEditingCandidatesEvent
* This event will never be delivered unless text input is enabled by calling * This event will never be delivered unless text input is enabled by calling
* SDL_StartTextInput(). Text input is disabled by default! * SDL_StartTextInput(). Text input is disabled by default!
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
* \sa SDL_StopTextInput * \sa SDL_StopTextInput
@ -426,7 +426,7 @@ typedef struct SDL_TextInputEvent
/** /**
* Mouse device event structure (event.mdevice.*) * Mouse device event structure (event.mdevice.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MouseDeviceEvent typedef struct SDL_MouseDeviceEvent
{ {
@ -439,7 +439,7 @@ typedef struct SDL_MouseDeviceEvent
/** /**
* Mouse motion event structure (event.motion.*) * Mouse motion event structure (event.motion.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MouseMotionEvent typedef struct SDL_MouseMotionEvent
{ {
@ -458,7 +458,7 @@ typedef struct SDL_MouseMotionEvent
/** /**
* Mouse button event structure (event.button.*) * Mouse button event structure (event.button.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MouseButtonEvent typedef struct SDL_MouseButtonEvent
{ {
@ -478,7 +478,7 @@ typedef struct SDL_MouseButtonEvent
/** /**
* Mouse wheel event structure (event.wheel.*) * Mouse wheel event structure (event.wheel.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MouseWheelEvent typedef struct SDL_MouseWheelEvent
{ {
@ -497,7 +497,7 @@ typedef struct SDL_MouseWheelEvent
/** /**
* Joystick axis motion event structure (event.jaxis.*) * Joystick axis motion event structure (event.jaxis.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_JoyAxisEvent typedef struct SDL_JoyAxisEvent
{ {
@ -516,7 +516,7 @@ typedef struct SDL_JoyAxisEvent
/** /**
* Joystick trackball motion event structure (event.jball.*) * Joystick trackball motion event structure (event.jball.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_JoyBallEvent typedef struct SDL_JoyBallEvent
{ {
@ -535,7 +535,7 @@ typedef struct SDL_JoyBallEvent
/** /**
* Joystick hat position change event structure (event.jhat.*) * Joystick hat position change event structure (event.jhat.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_JoyHatEvent typedef struct SDL_JoyHatEvent
{ {
@ -558,7 +558,7 @@ typedef struct SDL_JoyHatEvent
/** /**
* Joystick button event structure (event.jbutton.*) * Joystick button event structure (event.jbutton.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_JoyButtonEvent typedef struct SDL_JoyButtonEvent
{ {
@ -578,7 +578,7 @@ typedef struct SDL_JoyButtonEvent
* SDL will send JOYSTICK_ADDED events for devices that are already plugged in * SDL will send JOYSTICK_ADDED events for devices that are already plugged in
* during SDL_Init. * during SDL_Init.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GamepadDeviceEvent * \sa SDL_GamepadDeviceEvent
*/ */
@ -593,7 +593,7 @@ typedef struct SDL_JoyDeviceEvent
/** /**
* Joystick battery level change event structure (event.jbattery.*) * Joystick battery level change event structure (event.jbattery.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_JoyBatteryEvent typedef struct SDL_JoyBatteryEvent
{ {
@ -608,7 +608,7 @@ typedef struct SDL_JoyBatteryEvent
/** /**
* Gamepad axis motion event structure (event.gaxis.*) * Gamepad axis motion event structure (event.gaxis.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_GamepadAxisEvent typedef struct SDL_GamepadAxisEvent
{ {
@ -628,7 +628,7 @@ typedef struct SDL_GamepadAxisEvent
/** /**
* Gamepad button event structure (event.gbutton.*) * Gamepad button event structure (event.gbutton.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_GamepadButtonEvent typedef struct SDL_GamepadButtonEvent
{ {
@ -653,7 +653,7 @@ typedef struct SDL_GamepadButtonEvent
* in during SDL_Init() and are recognized as gamepads. It will also send * in during SDL_Init() and are recognized as gamepads. It will also send
* events for joysticks that get gamepad mappings at runtime. * events for joysticks that get gamepad mappings at runtime.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_JoyDeviceEvent * \sa SDL_JoyDeviceEvent
*/ */
@ -668,7 +668,7 @@ typedef struct SDL_GamepadDeviceEvent
/** /**
* Gamepad touchpad event structure (event.gtouchpad.*) * Gamepad touchpad event structure (event.gtouchpad.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_GamepadTouchpadEvent typedef struct SDL_GamepadTouchpadEvent
{ {
@ -686,7 +686,7 @@ typedef struct SDL_GamepadTouchpadEvent
/** /**
* Gamepad sensor event structure (event.gsensor.*) * Gamepad sensor event structure (event.gsensor.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_GamepadSensorEvent typedef struct SDL_GamepadSensorEvent
{ {
@ -702,7 +702,7 @@ typedef struct SDL_GamepadSensorEvent
/** /**
* Audio device event structure (event.adevice.*) * Audio device event structure (event.adevice.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_AudioDeviceEvent typedef struct SDL_AudioDeviceEvent
{ {
@ -719,7 +719,7 @@ typedef struct SDL_AudioDeviceEvent
/** /**
* Camera device event structure (event.cdevice.*) * Camera device event structure (event.cdevice.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_CameraDeviceEvent typedef struct SDL_CameraDeviceEvent
{ {
@ -733,7 +733,7 @@ typedef struct SDL_CameraDeviceEvent
/** /**
* Renderer event structure (event.render.*) * Renderer event structure (event.render.*)
* *
* \since This struct is available since SDL 3.1.7. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_RenderEvent typedef struct SDL_RenderEvent
{ {
@ -761,7 +761,7 @@ typedef struct SDL_RenderEvent
* report a touch outside of the window, which will also be outside of the * report a touch outside of the window, which will also be outside of the
* range. * range.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_TouchFingerEvent typedef struct SDL_TouchFingerEvent
{ {
@ -791,7 +791,7 @@ typedef struct SDL_TouchFingerEvent
* is there." The pen touching and lifting off from the tablet while not * 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. * leaving the area are handled by SDL_EVENT_PEN_DOWN and SDL_EVENT_PEN_UP.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_PenProximityEvent typedef struct SDL_PenProximityEvent
{ {
@ -811,7 +811,7 @@ typedef struct SDL_PenProximityEvent
* `pen_state & SDL_PEN_INPUT_DOWN` to decide if a pen is "drawing" when * `pen_state & SDL_PEN_INPUT_DOWN` to decide if a pen is "drawing" when
* dealing with pen motion. * dealing with pen motion.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_PenMotionEvent typedef struct SDL_PenMotionEvent
{ {
@ -831,7 +831,7 @@ typedef struct SDL_PenMotionEvent
* These events come when a pen touches a surface (a tablet, etc), or lifts * These events come when a pen touches a surface (a tablet, etc), or lifts
* off from one. * off from one.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_PenTouchEvent typedef struct SDL_PenTouchEvent
{ {
@ -853,7 +853,7 @@ typedef struct SDL_PenTouchEvent
* This is for buttons on the pen itself that the user might click. The pen * 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. * itself pressing down to draw triggers a SDL_EVENT_PEN_DOWN event instead.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_PenButtonEvent typedef struct SDL_PenButtonEvent
{ {
@ -875,7 +875,7 @@ typedef struct SDL_PenButtonEvent
* You might get some of these events even if the pen isn't touching the * You might get some of these events even if the pen isn't touching the
* tablet. * tablet.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_PenAxisEvent typedef struct SDL_PenAxisEvent
{ {
@ -895,7 +895,7 @@ typedef struct SDL_PenAxisEvent
* An event used to drop text or request a file open by the system * An event used to drop text or request a file open by the system
* (event.drop.*) * (event.drop.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_DropEvent typedef struct SDL_DropEvent
{ {
@ -913,7 +913,7 @@ typedef struct SDL_DropEvent
* An event triggered when the clipboard contents have changed * An event triggered when the clipboard contents have changed
* (event.clipboard.*) * (event.clipboard.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_ClipboardEvent typedef struct SDL_ClipboardEvent
{ {
@ -928,7 +928,7 @@ typedef struct SDL_ClipboardEvent
/** /**
* Sensor event structure (event.sensor.*) * Sensor event structure (event.sensor.*)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_SensorEvent typedef struct SDL_SensorEvent
{ {
@ -943,7 +943,7 @@ typedef struct SDL_SensorEvent
/** /**
* The "quit requested" event * The "quit requested" event
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_QuitEvent typedef struct SDL_QuitEvent
{ {
@ -961,7 +961,7 @@ typedef struct SDL_QuitEvent
* the programmer; the only requirement is that '''type''' is a value obtained * the programmer; the only requirement is that '''type''' is a value obtained
* from SDL_RegisterEvents(). * from SDL_RegisterEvents().
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_UserEvent typedef struct SDL_UserEvent
{ {
@ -981,7 +981,7 @@ typedef struct SDL_UserEvent
* The SDL_Event structure is the core of all event handling in SDL. SDL_Event * The SDL_Event structure is the core of all event handling in SDL. SDL_Event
* is a union of all event structures used in SDL. * is a union of all event structures used in SDL.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef union SDL_Event typedef union SDL_Event
{ {
@ -1061,7 +1061,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_Event, sizeof(SDL_Event) == sizeof(((SDL_Event *)NUL
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PollEvent * \sa SDL_PollEvent
* \sa SDL_WaitEvent * \sa SDL_WaitEvent
@ -1073,7 +1073,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_PumpEvents(void);
/** /**
* The type of action to request from SDL_PeepEvents(). * The type of action to request from SDL_PeepEvents().
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_EventAction typedef enum SDL_EventAction
{ {
@ -1118,7 +1118,7 @@ typedef enum SDL_EventAction
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PollEvent * \sa SDL_PollEvent
* \sa SDL_PumpEvents * \sa SDL_PumpEvents
@ -1139,7 +1139,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event *events, int numevents,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasEvents * \sa SDL_HasEvents
*/ */
@ -1160,7 +1160,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasEvent(Uint32 type);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasEvents * \sa SDL_HasEvents
*/ */
@ -1188,7 +1188,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_FlushEvents * \sa SDL_FlushEvents
*/ */
@ -1215,7 +1215,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_FlushEvent * \sa SDL_FlushEvent
*/ */
@ -1259,7 +1259,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType)
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PushEvent * \sa SDL_PushEvent
* \sa SDL_WaitEvent * \sa SDL_WaitEvent
@ -1283,7 +1283,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PollEvent(SDL_Event *event);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PollEvent * \sa SDL_PollEvent
* \sa SDL_PushEvent * \sa SDL_PushEvent
@ -1313,7 +1313,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEvent(SDL_Event *event);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PollEvent * \sa SDL_PollEvent
* \sa SDL_PushEvent * \sa SDL_PushEvent
@ -1347,7 +1347,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEventTimeout(SDL_Event *event, Sint32 t
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PeepEvents * \sa SDL_PeepEvents
* \sa SDL_PollEvent * \sa SDL_PollEvent
@ -1369,7 +1369,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PushEvent(SDL_Event *event);
* application is responsible for locking resources the callback * application is responsible for locking resources the callback
* touches that need to be protected. * touches that need to be protected.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetEventFilter * \sa SDL_SetEventFilter
* \sa SDL_AddEventWatch * \sa SDL_AddEventWatch
@ -1407,7 +1407,7 @@ typedef bool (SDLCALL *SDL_EventFilter)(void *userdata, SDL_Event *event);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddEventWatch * \sa SDL_AddEventWatch
* \sa SDL_SetEventEnabled * \sa SDL_SetEventEnabled
@ -1430,7 +1430,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter, void
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetEventFilter * \sa SDL_SetEventFilter
*/ */
@ -1461,7 +1461,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetEventFilter(SDL_EventFilter *filter, voi
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RemoveEventWatch * \sa SDL_RemoveEventWatch
* \sa SDL_SetEventFilter * \sa SDL_SetEventFilter
@ -1479,7 +1479,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddEventWatch(SDL_EventFilter filter, void
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddEventWatch * \sa SDL_AddEventWatch
*/ */
@ -1498,7 +1498,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveEventWatch(SDL_EventFilter filter, vo
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetEventFilter * \sa SDL_GetEventFilter
* \sa SDL_SetEventFilter * \sa SDL_SetEventFilter
@ -1513,7 +1513,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter, void *
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_EventEnabled * \sa SDL_EventEnabled
*/ */
@ -1527,7 +1527,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetEventEnabled(Uint32 type, bool enabled);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetEventEnabled * \sa SDL_SetEventEnabled
*/ */
@ -1543,7 +1543,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EventEnabled(Uint32 type);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PushEvent * \sa SDL_PushEvent
*/ */
@ -1557,7 +1557,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PollEvent * \sa SDL_PollEvent
* \sa SDL_WaitEvent * \sa SDL_WaitEvent

34
include/SDL3/SDL_filesystem.h
View file

@ -89,7 +89,7 @@ extern "C" {
* doesn't implement this functionality, call SDL_GetError() for more * doesn't implement this functionality, call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPrefPath * \sa SDL_GetPrefPath
*/ */
@ -144,7 +144,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetBasePath(void);
* etc.). This should be freed with SDL_free() when it is no longer * etc.). This should be freed with SDL_free() when it is no longer
* needed. * needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetBasePath * \sa SDL_GetBasePath
*/ */
@ -175,7 +175,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetPrefPath(const char *org, const char *
* *
* Note that on macOS/iOS, the Videos folder is called "Movies". * Note that on macOS/iOS, the Videos folder is called "Movies".
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_GetUserFolder * \sa SDL_GetUserFolder
*/ */
@ -216,7 +216,7 @@ typedef enum SDL_Folder
* \returns either a null-terminated C string containing the full path to the * \returns either a null-terminated C string containing the full path to the
* folder, or NULL if an error happened. * folder, or NULL if an error happened.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetUserFolder(SDL_Folder folder); extern SDL_DECLSPEC const char * SDLCALL SDL_GetUserFolder(SDL_Folder folder);
@ -230,7 +230,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetUserFolder(SDL_Folder folder);
* symlinks, named pipes, etc. They are currently reported as * symlinks, named pipes, etc. They are currently reported as
* SDL_PATHTYPE_OTHER. * SDL_PATHTYPE_OTHER.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_PathInfo * \sa SDL_PathInfo
*/ */
@ -245,7 +245,7 @@ typedef enum SDL_PathType
/** /**
* Information about a path on the filesystem. * Information about a path on the filesystem.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_GetPathInfo * \sa SDL_GetPathInfo
* \sa SDL_GetStoragePathInfo * \sa SDL_GetStoragePathInfo
@ -262,7 +262,7 @@ typedef struct SDL_PathInfo
/** /**
* Flags for path matching. * Flags for path matching.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_GlobDirectory * \sa SDL_GlobDirectory
* \sa SDL_GlobStorageDirectory * \sa SDL_GlobStorageDirectory
@ -283,14 +283,14 @@ typedef Uint32 SDL_GlobFlags;
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_CreateDirectory(const char *path); extern SDL_DECLSPEC bool SDLCALL SDL_CreateDirectory(const char *path);
/** /**
* Possible results from an enumeration callback. * Possible results from an enumeration callback.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_EnumerateDirectoryCallback * \sa SDL_EnumerateDirectoryCallback
*/ */
@ -321,7 +321,7 @@ typedef enum SDL_EnumerationResult
* \param fname the next entry in the enumeration. * \param fname the next entry in the enumeration.
* \returns how the enumeration should proceed. * \returns how the enumeration should proceed.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_EnumerateDirectory * \sa SDL_EnumerateDirectory
*/ */
@ -346,7 +346,7 @@ typedef SDL_EnumerationResult (SDLCALL *SDL_EnumerateDirectoryCallback)(void *us
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateDirectory(const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata); extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateDirectory(const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata);
@ -360,7 +360,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_RemovePath(const char *path); extern SDL_DECLSPEC bool SDLCALL SDL_RemovePath(const char *path);
@ -383,7 +383,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RemovePath(const char *path);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_RenamePath(const char *oldpath, const char *newpath); extern SDL_DECLSPEC bool SDLCALL SDL_RenamePath(const char *oldpath, const char *newpath);
@ -423,7 +423,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_CopyFile(const char *oldpath, const char *newpath); extern SDL_DECLSPEC bool SDLCALL SDL_CopyFile(const char *oldpath, const char *newpath);
@ -436,7 +436,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 * \returns true on success or false if the file doesn't exist, or another
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetPathInfo(const char *path, SDL_PathInfo *info); extern SDL_DECLSPEC bool SDLCALL SDL_GetPathInfo(const char *path, SDL_PathInfo *info);
@ -469,7 +469,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetPathInfo(const char *path, SDL_PathInfo
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC char ** SDLCALL SDL_GlobDirectory(const char *path, const char *pattern, SDL_GlobFlags flags, int *count); extern SDL_DECLSPEC char ** SDLCALL SDL_GlobDirectory(const char *path, const char *pattern, SDL_GlobFlags flags, int *count);
@ -490,7 +490,7 @@ extern SDL_DECLSPEC char ** SDLCALL SDL_GlobDirectory(const char *path, const ch
* platform-dependent notation. NULL if there's a problem. This * platform-dependent notation. NULL if there's a problem. This
* should be freed with SDL_free() when it is no longer needed. * should be freed with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC char * SDLCALL SDL_GetCurrentDirectory(void); extern SDL_DECLSPEC char * SDLCALL SDL_GetCurrentDirectory(void);

158
include/SDL3/SDL_gamepad.h
View file

@ -92,7 +92,7 @@ extern "C" {
/** /**
* The structure used to identify an SDL gamepad * The structure used to identify an SDL gamepad
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Gamepad SDL_Gamepad; typedef struct SDL_Gamepad SDL_Gamepad;
@ -142,7 +142,7 @@ typedef enum SDL_GamepadType
* You can query the labels for the face buttons using * You can query the labels for the face buttons using
* SDL_GetGamepadButtonLabel() * SDL_GetGamepadButtonLabel()
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_GamepadButton typedef enum SDL_GamepadButton
{ {
@ -185,7 +185,7 @@ typedef enum SDL_GamepadButton
* For a complete set, you should look at the button and gamepad type and have * 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. * a set of symbols that work well with your art style.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_GamepadButtonLabel typedef enum SDL_GamepadButtonLabel
{ {
@ -212,7 +212,7 @@ typedef enum SDL_GamepadButtonLabel
* pressed) when reported by SDL_GetGamepadAxis(). Note that this is not the * pressed) when reported by SDL_GetGamepadAxis(). Note that this is not the
* same range that will be reported by the lower-level SDL_GetJoystickAxis(). * same range that will be reported by the lower-level SDL_GetJoystickAxis().
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_GamepadAxis typedef enum SDL_GamepadAxis
{ {
@ -234,7 +234,7 @@ typedef enum SDL_GamepadAxis
* gamepad. This enum is used as part of SDL_GamepadBinding to specify those * gamepad. This enum is used as part of SDL_GamepadBinding to specify those
* mappings. * mappings.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_GamepadBindingType typedef enum SDL_GamepadBindingType
{ {
@ -255,7 +255,7 @@ typedef enum SDL_GamepadBindingType
* more with a simple text string. Those strings are parsed into a collection * 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. * of these structs to make it easier to operate on the data.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadBindings * \sa SDL_GetGamepadBindings
*/ */
@ -328,7 +328,7 @@ typedef struct SDL_GamepadBinding
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddGamepadMappingsFromFile * \sa SDL_AddGamepadMappingsFromFile
* \sa SDL_AddGamepadMappingsFromIO * \sa SDL_AddGamepadMappingsFromIO
@ -368,7 +368,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMapping(const char *mapping);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddGamepadMapping * \sa SDL_AddGamepadMapping
* \sa SDL_AddGamepadMappingsFromFile * \sa SDL_AddGamepadMappingsFromFile
@ -402,7 +402,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromIO(SDL_IOStream *src,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddGamepadMapping * \sa SDL_AddGamepadMapping
* \sa SDL_AddGamepadMappingsFromIO * \sa SDL_AddGamepadMappingsFromIO
@ -422,7 +422,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromFile(const char *file)
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReloadGamepadMappings(void); extern SDL_DECLSPEC bool SDLCALL SDL_ReloadGamepadMappings(void);
@ -436,7 +436,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReloadGamepadMappings(void);
* single allocation that should be freed with SDL_free() when it is * single allocation that should be freed with SDL_free() when it is
* no longer needed. * no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC char ** SDLCALL SDL_GetGamepadMappings(int *count); extern SDL_DECLSPEC char ** SDLCALL SDL_GetGamepadMappings(int *count);
@ -448,7 +448,7 @@ extern SDL_DECLSPEC char ** SDLCALL SDL_GetGamepadMappings(int *count);
* information. This should be freed with SDL_free() when it is no * information. This should be freed with SDL_free() when it is no
* longer needed. * longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickGUIDForID * \sa SDL_GetJoystickGUIDForID
* \sa SDL_GetJoystickGUID * \sa SDL_GetJoystickGUID
@ -465,7 +465,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMappingForGUID(SDL_GUID guid);
* available; call SDL_GetError() for more information. This should * available; call SDL_GetError() for more information. This should
* be freed with SDL_free() when it is no longer needed. * be freed with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddGamepadMapping * \sa SDL_AddGamepadMapping
* \sa SDL_GetGamepadMappingForID * \sa SDL_GetGamepadMappingForID
@ -485,7 +485,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMapping(SDL_Gamepad *gamepad);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddGamepadMapping * \sa SDL_AddGamepadMapping
* \sa SDL_GetGamepadMapping * \sa SDL_GetGamepadMapping
@ -497,7 +497,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadMapping(SDL_JoystickID instance_i
* *
* \returns true if a gamepad is connected, false otherwise. * \returns true if a gamepad is connected, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
*/ */
@ -512,7 +512,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasGamepad(void);
* call SDL_GetError() for more information. This should be freed * call SDL_GetError() for more information. This should be freed
* with SDL_free() when it is no longer needed. * with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasGamepad * \sa SDL_HasGamepad
* \sa SDL_OpenGamepad * \sa SDL_OpenGamepad
@ -526,7 +526,7 @@ extern SDL_DECLSPEC SDL_JoystickID * SDLCALL SDL_GetGamepads(int *count);
* \returns true if the given joystick is supported by the gamepad interface, * \returns true if the given joystick is supported by the gamepad interface,
* false if it isn't or it's an invalid index. * false if it isn't or it's an invalid index.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoysticks * \sa SDL_GetJoysticks
* \sa SDL_OpenGamepad * \sa SDL_OpenGamepad
@ -542,7 +542,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 * \returns the name of the selected gamepad. If no name can be found, this
* function returns NULL; call SDL_GetError() for more information. * function returns NULL; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadName * \sa SDL_GetGamepadName
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -558,7 +558,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 * \returns the path of the selected gamepad. If no path can be found, this
* function returns NULL; call SDL_GetError() for more information. * function returns NULL; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadPath * \sa SDL_GetGamepadPath
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -573,7 +573,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadPathForID(SDL_JoystickID
* \param instance_id the joystick instance ID. * \param instance_id the joystick instance ID.
* \returns the player index of a gamepad, or -1 if it's not available. * \returns the player index of a gamepad, or -1 if it's not available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadPlayerIndex * \sa SDL_GetGamepadPlayerIndex
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -589,7 +589,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndexForID(SDL_JoystickID in
* \returns the GUID of the selected gamepad. If called on an invalid index, * \returns the GUID of the selected gamepad. If called on an invalid index,
* this function returns a zero GUID. * this function returns a zero GUID.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GUIDToString * \sa SDL_GUIDToString
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -606,7 +606,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 * \returns the USB vendor ID of the selected gamepad. If called on an invalid
* index, this function returns zero. * index, this function returns zero.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadVendor * \sa SDL_GetGamepadVendor
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -623,7 +623,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadVendorForID(SDL_JoystickID inst
* \returns the USB product ID of the selected gamepad. If called on an * \returns the USB product ID of the selected gamepad. If called on an
* invalid index, this function returns zero. * invalid index, this function returns zero.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadProduct * \sa SDL_GetGamepadProduct
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -640,7 +640,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductForID(SDL_JoystickID ins
* \returns the product version of the selected gamepad. If called on an * \returns the product version of the selected gamepad. If called on an
* invalid index, this function returns zero. * invalid index, this function returns zero.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadProductVersion * \sa SDL_GetGamepadProductVersion
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -655,7 +655,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductVersionForID(SDL_Joystic
* \param instance_id the joystick instance ID. * \param instance_id the joystick instance ID.
* \returns the gamepad type. * \returns the gamepad type.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadType * \sa SDL_GetGamepadType
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -671,7 +671,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadTypeForID(SDL_Joystick
* \param instance_id the joystick instance ID. * \param instance_id the joystick instance ID.
* \returns the gamepad type. * \returns the gamepad type.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadTypeForID * \sa SDL_GetGamepadTypeForID
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
@ -688,7 +688,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadTypeForID(SDL_Joys
* \returns the mapping string. Returns NULL if no mapping is available. This * \returns the mapping string. Returns NULL if no mapping is available. This
* should be freed with SDL_free() when it is no longer needed. * should be freed with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepads * \sa SDL_GetGamepads
* \sa SDL_GetGamepadMapping * \sa SDL_GetGamepadMapping
@ -702,7 +702,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMappingForID(SDL_JoystickID ins
* \returns a gamepad identifier or NULL if an error occurred; call * \returns a gamepad identifier or NULL if an error occurred; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseGamepad * \sa SDL_CloseGamepad
* \sa SDL_IsGamepad * \sa SDL_IsGamepad
@ -717,7 +717,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 * \returns an SDL_Gamepad on success or NULL on failure or if it hasn't been
* opened yet; call SDL_GetError() for more information. * opened yet; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_GetGamepadFromID(SDL_JoystickID instance_id); extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_GetGamepadFromID(SDL_JoystickID instance_id);
@ -727,7 +727,7 @@ extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_GetGamepadFromID(SDL_JoystickID in
* \param player_index the player index, which different from the instance ID. * \param player_index the player index, which different from the instance ID.
* \returns the SDL_Gamepad associated with a player index. * \returns the SDL_Gamepad associated with a player index.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadPlayerIndex * \sa SDL_GetGamepadPlayerIndex
* \sa SDL_SetGamepadPlayerIndex * \sa SDL_SetGamepadPlayerIndex
@ -757,7 +757,7 @@ extern SDL_DECLSPEC SDL_Gamepad * SDLCALL SDL_GetGamepadFromPlayerIndex(int play
* \returns a valid property ID on success or 0 on failure; call * \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGamepadProperties(SDL_Gamepad *gamepad); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGamepadProperties(SDL_Gamepad *gamepad);
@ -775,7 +775,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGamepadProperties(SDL_Gamepa
* \returns the instance ID of the specified gamepad on success or 0 on * \returns the instance ID of the specified gamepad on success or 0 on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetGamepadID(SDL_Gamepad *gamepad); extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetGamepadID(SDL_Gamepad *gamepad);
@ -787,7 +787,7 @@ extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetGamepadID(SDL_Gamepad *gamepad
* \returns the implementation dependent name for the gamepad, or NULL if * \returns the implementation dependent name for the gamepad, or NULL if
* there is no name or the identifier passed is invalid. * there is no name or the identifier passed is invalid.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadNameForID * \sa SDL_GetGamepadNameForID
*/ */
@ -801,7 +801,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadName(SDL_Gamepad *gamepad
* \returns the implementation dependent path for the gamepad, or NULL if * \returns the implementation dependent path for the gamepad, or NULL if
* there is no path or the identifier passed is invalid. * there is no path or the identifier passed is invalid.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadPathForID * \sa SDL_GetGamepadPathForID
*/ */
@ -814,7 +814,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 * \returns the gamepad type, or SDL_GAMEPAD_TYPE_UNKNOWN if it's not
* available. * available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadTypeForID * \sa SDL_GetGamepadTypeForID
*/ */
@ -827,7 +827,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 * \returns the gamepad type, or SDL_GAMEPAD_TYPE_UNKNOWN if it's not
* available. * available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRealGamepadTypeForID * \sa SDL_GetRealGamepadTypeForID
*/ */
@ -841,7 +841,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadType(SDL_Gamepad *
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the player index for gamepad, or -1 if it's not available. * \returns the player index for gamepad, or -1 if it's not available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetGamepadPlayerIndex * \sa SDL_SetGamepadPlayerIndex
*/ */
@ -856,7 +856,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadPlayerIndex * \sa SDL_GetGamepadPlayerIndex
*/ */
@ -870,7 +870,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadPlayerIndex(SDL_Gamepad *gamepad,
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the USB vendor ID, or zero if unavailable. * \returns the USB vendor ID, or zero if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadVendorForID * \sa SDL_GetGamepadVendorForID
*/ */
@ -884,7 +884,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadVendor(SDL_Gamepad *gamepad);
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the USB product ID, or zero if unavailable. * \returns the USB product ID, or zero if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadProductForID * \sa SDL_GetGamepadProductForID
*/ */
@ -898,7 +898,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProduct(SDL_Gamepad *gamepad);
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the USB product version, or zero if unavailable. * \returns the USB product version, or zero if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadProductVersionForID * \sa SDL_GetGamepadProductVersionForID
*/ */
@ -912,7 +912,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductVersion(SDL_Gamepad *gam
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the gamepad firmware version, or zero if unavailable. * \returns the gamepad firmware version, or zero if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadFirmwareVersion(SDL_Gamepad *gamepad); extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadFirmwareVersion(SDL_Gamepad *gamepad);
@ -924,7 +924,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetGamepadFirmwareVersion(SDL_Gamepad *ga
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the serial number, or NULL if unavailable. * \returns the serial number, or NULL if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadSerial(SDL_Gamepad *gamepad); extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadSerial(SDL_Gamepad *gamepad);
@ -937,7 +937,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadSerial(SDL_Gamepad *gamep
* \param gamepad the gamepad object to query. * \param gamepad the gamepad object to query.
* \returns the gamepad handle, or 0 if unavailable. * \returns the gamepad handle, or 0 if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepad); extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepad);
@ -949,7 +949,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepa
* `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() * `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnectionState(SDL_Gamepad *gamepad); extern SDL_DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnectionState(SDL_Gamepad *gamepad);
@ -969,7 +969,7 @@ extern SDL_DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnection
* battery. * battery.
* \returns the current battery state. * \returns the current battery state.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetGamepadPowerInfo(SDL_Gamepad *gamepad, int *percent); extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetGamepadPowerInfo(SDL_Gamepad *gamepad, int *percent);
@ -981,7 +981,7 @@ extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetGamepadPowerInfo(SDL_Gamepad *
* \returns true if the gamepad has been opened and is currently connected, or * \returns true if the gamepad has been opened and is currently connected, or
* false if not. * false if not.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GamepadConnected(SDL_Gamepad *gamepad); extern SDL_DECLSPEC bool SDLCALL SDL_GamepadConnected(SDL_Gamepad *gamepad);
@ -1001,7 +1001,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadConnected(SDL_Gamepad *gamepad);
* \returns an SDL_Joystick object, or NULL on failure; call SDL_GetError() * \returns an SDL_Joystick object, or NULL on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetGamepadJoystick(SDL_Gamepad *gamepad); extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetGamepadJoystick(SDL_Gamepad *gamepad);
@ -1013,7 +1013,7 @@ extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetGamepadJoystick(SDL_Gamepad *g
* *
* \param enabled whether to process gamepad events or not. * \param enabled whether to process gamepad events or not.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GamepadEventsEnabled * \sa SDL_GamepadEventsEnabled
* \sa SDL_UpdateGamepads * \sa SDL_UpdateGamepads
@ -1028,7 +1028,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGamepadEventsEnabled(bool enabled);
* *
* \returns true if gamepad events are being processed, false otherwise. * \returns true if gamepad events are being processed, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetGamepadEventsEnabled * \sa SDL_SetGamepadEventsEnabled
*/ */
@ -1044,7 +1044,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadEventsEnabled(void);
* single allocation that should be freed with SDL_free() when it is * single allocation that should be freed with SDL_free() when it is
* no longer needed. * no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_GamepadBinding ** SDLCALL SDL_GetGamepadBindings(SDL_Gamepad *gamepad, int *count); extern SDL_DECLSPEC SDL_GamepadBinding ** SDLCALL SDL_GetGamepadBindings(SDL_Gamepad *gamepad, int *count);
@ -1055,7 +1055,7 @@ extern SDL_DECLSPEC SDL_GamepadBinding ** SDLCALL SDL_GetGamepadBindings(SDL_Gam
* enabled. Under such circumstances, it will not be necessary to call this * enabled. Under such circumstances, it will not be necessary to call this
* function. * function.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_UpdateGamepads(void); extern SDL_DECLSPEC void SDLCALL SDL_UpdateGamepads(void);
@ -1071,7 +1071,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UpdateGamepads(void);
* \returns the SDL_GamepadType enum corresponding to the input string, or * \returns the SDL_GamepadType enum corresponding to the input string, or
* `SDL_GAMEPAD_TYPE_UNKNOWN` if no match was found. * `SDL_GAMEPAD_TYPE_UNKNOWN` if no match was found.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadStringForType * \sa SDL_GetGamepadStringForType
*/ */
@ -1085,7 +1085,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadTypeFromString(const c
* specified. The string returned is of the format used by * specified. The string returned is of the format used by
* SDL_Gamepad mapping strings. * SDL_Gamepad mapping strings.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadTypeFromString * \sa SDL_GetGamepadTypeFromString
*/ */
@ -1107,7 +1107,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadStringForType(SDL_Gamepad
* \returns the SDL_GamepadAxis enum corresponding to the input string, or * \returns the SDL_GamepadAxis enum corresponding to the input string, or
* `SDL_GAMEPAD_AXIS_INVALID` if no match was found. * `SDL_GAMEPAD_AXIS_INVALID` if no match was found.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadStringForAxis * \sa SDL_GetGamepadStringForAxis
*/ */
@ -1121,7 +1121,7 @@ extern SDL_DECLSPEC SDL_GamepadAxis SDLCALL SDL_GetGamepadAxisFromString(const c
* specified. The string returned is of the format used by * specified. The string returned is of the format used by
* SDL_Gamepad mapping strings. * SDL_Gamepad mapping strings.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadAxisFromString * \sa SDL_GetGamepadAxisFromString
*/ */
@ -1137,7 +1137,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadStringForAxis(SDL_Gamepad
* \param axis an axis enum value (an SDL_GamepadAxis value). * \param axis an axis enum value (an SDL_GamepadAxis value).
* \returns true if the gamepad has this axis, false otherwise. * \returns true if the gamepad has this axis, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GamepadHasButton * \sa SDL_GamepadHasButton
* \sa SDL_GetGamepadAxis * \sa SDL_GetGamepadAxis
@ -1161,7 +1161,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 * \returns axis state (including 0) on success or 0 (also) on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GamepadHasAxis * \sa SDL_GamepadHasAxis
* \sa SDL_GetGamepadButton * \sa SDL_GetGamepadButton
@ -1180,7 +1180,7 @@ extern SDL_DECLSPEC Sint16 SDLCALL SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_
* \returns the SDL_GamepadButton enum corresponding to the input string, or * \returns the SDL_GamepadButton enum corresponding to the input string, or
* `SDL_GAMEPAD_BUTTON_INVALID` if no match was found. * `SDL_GAMEPAD_BUTTON_INVALID` if no match was found.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadStringForButton * \sa SDL_GetGamepadStringForButton
*/ */
@ -1194,7 +1194,7 @@ extern SDL_DECLSPEC SDL_GamepadButton SDLCALL SDL_GetGamepadButtonFromString(con
* specified. The string returned is of the format used by * specified. The string returned is of the format used by
* SDL_Gamepad mapping strings. * SDL_Gamepad mapping strings.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadButtonFromString * \sa SDL_GetGamepadButtonFromString
*/ */
@ -1210,7 +1210,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadStringForButton(SDL_Gamep
* \param button a button enum value (an SDL_GamepadButton value). * \param button a button enum value (an SDL_GamepadButton value).
* \returns true if the gamepad has this button, false otherwise. * \returns true if the gamepad has this button, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GamepadHasAxis * \sa SDL_GamepadHasAxis
*/ */
@ -1223,7 +1223,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadHasButton(SDL_Gamepad *gamepad, SDL_
* \param button a button index (one of the SDL_GamepadButton values). * \param button a button index (one of the SDL_GamepadButton values).
* \returns true if the button is pressed, false otherwise. * \returns true if the button is pressed, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GamepadHasButton * \sa SDL_GamepadHasButton
* \sa SDL_GetGamepadAxis * \sa SDL_GetGamepadAxis
@ -1237,7 +1237,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadButton(SDL_Gamepad *gamepad, SDL_
* \param button a button index (one of the SDL_GamepadButton values). * \param button a button index (one of the SDL_GamepadButton values).
* \returns the SDL_GamepadButtonLabel enum corresponding to the button label. * \returns the SDL_GamepadButtonLabel enum corresponding to the button label.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadButtonLabel * \sa SDL_GetGamepadButtonLabel
*/ */
@ -1250,7 +1250,7 @@ extern SDL_DECLSPEC SDL_GamepadButtonLabel SDLCALL SDL_GetGamepadButtonLabelForT
* \param button a button index (one of the SDL_GamepadButton values). * \param button a button index (one of the SDL_GamepadButton values).
* \returns the SDL_GamepadButtonLabel enum corresponding to the button label. * \returns the SDL_GamepadButtonLabel enum corresponding to the button label.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadButtonLabelForType * \sa SDL_GetGamepadButtonLabelForType
*/ */
@ -1262,7 +1262,7 @@ extern SDL_DECLSPEC SDL_GamepadButtonLabel SDLCALL SDL_GetGamepadButtonLabel(SDL
* \param gamepad a gamepad. * \param gamepad a gamepad.
* \returns number of touchpads. * \returns number of touchpads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumGamepadTouchpadFingers * \sa SDL_GetNumGamepadTouchpadFingers
*/ */
@ -1276,7 +1276,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpads(SDL_Gamepad *gamepad)
* \param touchpad a touchpad. * \param touchpad a touchpad.
* \returns number of supported simultaneous fingers. * \returns number of supported simultaneous fingers.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadTouchpadFinger * \sa SDL_GetGamepadTouchpadFinger
* \sa SDL_GetNumGamepadTouchpads * \sa SDL_GetNumGamepadTouchpads
@ -1299,7 +1299,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpadFingers(SDL_Gamepad *ga
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumGamepadTouchpadFingers * \sa SDL_GetNumGamepadTouchpadFingers
*/ */
@ -1312,7 +1312,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadTouchpadFinger(SDL_Gamepad *gamep
* \param type the type of sensor to query. * \param type the type of sensor to query.
* \returns true if the sensor exists, false otherwise. * \returns true if the sensor exists, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadSensorData * \sa SDL_GetGamepadSensorData
* \sa SDL_GetGamepadSensorDataRate * \sa SDL_GetGamepadSensorDataRate
@ -1329,7 +1329,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GamepadHasSensor * \sa SDL_GamepadHasSensor
* \sa SDL_GamepadSensorEnabled * \sa SDL_GamepadSensorEnabled
@ -1343,7 +1343,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadSensorEnabled(SDL_Gamepad *gamepa
* \param type the type of sensor to query. * \param type the type of sensor to query.
* \returns true if the sensor is enabled, false otherwise. * \returns true if the sensor is enabled, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetGamepadSensorEnabled * \sa SDL_SetGamepadSensorEnabled
*/ */
@ -1356,7 +1356,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GamepadSensorEnabled(SDL_Gamepad *gamepad,
* \param type the type of sensor to query. * \param type the type of sensor to query.
* \returns the data rate, or 0.0f if the data rate is not available. * \returns the data rate, or 0.0f if the data rate is not available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC float SDLCALL SDL_GetGamepadSensorDataRate(SDL_Gamepad *gamepad, SDL_SensorType type); extern SDL_DECLSPEC float SDLCALL SDL_GetGamepadSensorDataRate(SDL_Gamepad *gamepad, SDL_SensorType type);
@ -1373,7 +1373,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetGamepadSensorDataRate(SDL_Gamepad *game
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamepad, SDL_SensorType type, float *data, int num_values); extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamepad, SDL_SensorType type, float *data, int num_values);
@ -1395,7 +1395,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamepad,
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms); extern SDL_DECLSPEC bool SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
@ -1421,7 +1421,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RumbleGamepad * \sa SDL_RumbleGamepad
*/ */
@ -1443,7 +1443,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RumbleGamepadTriggers(SDL_Gamepad *gamepad,
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadLED(SDL_Gamepad *gamepad, Uint8 red, Uint8 green, Uint8 blue); extern SDL_DECLSPEC bool SDLCALL SDL_SetGamepadLED(SDL_Gamepad *gamepad, Uint8 red, Uint8 green, Uint8 blue);
@ -1456,7 +1456,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SendGamepadEffect(SDL_Gamepad *gamepad, const void *data, int size); extern SDL_DECLSPEC bool SDLCALL SDL_SendGamepadEffect(SDL_Gamepad *gamepad, const void *data, int size);
@ -1466,7 +1466,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SendGamepadEffect(SDL_Gamepad *gamepad, con
* \param gamepad a gamepad identifier previously returned by * \param gamepad a gamepad identifier previously returned by
* SDL_OpenGamepad(). * SDL_OpenGamepad().
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenGamepad * \sa SDL_OpenGamepad
*/ */
@ -1480,7 +1480,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseGamepad(SDL_Gamepad *gamepad);
* \param button a button on the gamepad. * \param button a button on the gamepad.
* \returns the sfSymbolsName or NULL if the name can't be found. * \returns the sfSymbolsName or NULL if the name can't be found.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadAppleSFSymbolsNameForAxis * \sa SDL_GetGamepadAppleSFSymbolsNameForAxis
*/ */
@ -1493,7 +1493,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadAppleSFSymbolsNameForButt
* \param axis an axis on the gamepad. * \param axis an axis on the gamepad.
* \returns the sfSymbolsName or NULL if the name can't be found. * \returns the sfSymbolsName or NULL if the name can't be found.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGamepadAppleSFSymbolsNameForButton * \sa SDL_GetGamepadAppleSFSymbolsNameForButton
*/ */

340
include/SDL3/SDL_gpu.h
View file

File diff suppressed because it is too large Load diff

6
include/SDL3/SDL_guid.h
View file

@ -56,7 +56,7 @@ extern "C" {
* GUIDs may be platform-dependent (i.e., the same device may report different * GUIDs may be platform-dependent (i.e., the same device may report different
* GUIDs on different operating systems). * GUIDs on different operating systems).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_GUID { typedef struct SDL_GUID {
Uint8 data[16]; Uint8 data[16];
@ -71,7 +71,7 @@ typedef struct SDL_GUID {
* \param pszGUID buffer in which to write the ASCII string. * \param pszGUID buffer in which to write the ASCII string.
* \param cbGUID the size of pszGUID, should be at least 33 bytes. * \param cbGUID the size of pszGUID, should be at least 33 bytes.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StringToGUID * \sa SDL_StringToGUID
*/ */
@ -87,7 +87,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GUIDToString(SDL_GUID guid, char *pszGUID,
* \param pchGUID string containing an ASCII representation of a GUID. * \param pchGUID string containing an ASCII representation of a GUID.
* \returns a SDL_GUID structure. * \returns a SDL_GUID structure.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GUIDToString * \sa SDL_GUIDToString
*/ */

132
include/SDL3/SDL_haptic.h
View file

@ -141,7 +141,7 @@ extern "C" {
/** /**
* The haptic structure used to identify an SDL haptic. * The haptic structure used to identify an SDL haptic.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_OpenHaptic * \sa SDL_OpenHaptic
* \sa SDL_OpenHapticFromJoystick * \sa SDL_OpenHapticFromJoystick
@ -167,7 +167,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Constant haptic effect. * Constant haptic effect.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticCondition * \sa SDL_HapticCondition
*/ */
@ -178,7 +178,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Periodic haptic effect that simulates sine waves. * Periodic haptic effect that simulates sine waves.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticPeriodic * \sa SDL_HapticPeriodic
*/ */
@ -189,7 +189,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Periodic haptic effect that simulates square waves. * Periodic haptic effect that simulates square waves.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticPeriodic * \sa SDL_HapticPeriodic
*/ */
@ -200,7 +200,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Periodic haptic effect that simulates triangular waves. * Periodic haptic effect that simulates triangular waves.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticPeriodic * \sa SDL_HapticPeriodic
*/ */
@ -211,7 +211,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Periodic haptic effect that simulates saw tooth up waves. * Periodic haptic effect that simulates saw tooth up waves.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticPeriodic * \sa SDL_HapticPeriodic
*/ */
@ -222,7 +222,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Periodic haptic effect that simulates saw tooth down waves. * Periodic haptic effect that simulates saw tooth down waves.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticPeriodic * \sa SDL_HapticPeriodic
*/ */
@ -233,7 +233,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Ramp haptic effect. * Ramp haptic effect.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticRamp * \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 * Condition haptic effect that simulates a spring. Effect is based on the
* axes position. * axes position.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticCondition * \sa SDL_HapticCondition
*/ */
@ -257,7 +257,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* Condition haptic effect that simulates dampening. Effect is based on the * Condition haptic effect that simulates dampening. Effect is based on the
* axes velocity. * axes velocity.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticCondition * \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 * Condition haptic effect that simulates inertia. Effect is based on the axes
* acceleration. * acceleration.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticCondition * \sa SDL_HapticCondition
*/ */
@ -281,7 +281,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* Condition haptic effect that simulates friction. Effect is based on the * Condition haptic effect that simulates friction. Effect is based on the
* axes movement. * axes movement.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticCondition * \sa SDL_HapticCondition
*/ */
@ -292,7 +292,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Haptic effect for direct control over high/low frequency motors. * Haptic effect for direct control over high/low frequency motors.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticLeftRight * \sa SDL_HapticLeftRight
*/ */
@ -301,21 +301,21 @@ typedef struct SDL_Haptic SDL_Haptic;
/** /**
* Reserved for future use. * Reserved for future use.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_HAPTIC_RESERVED1 (1u<<12) #define SDL_HAPTIC_RESERVED1 (1u<<12)
/** /**
* Reserved for future use. * Reserved for future use.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_HAPTIC_RESERVED2 (1u<<13) #define SDL_HAPTIC_RESERVED2 (1u<<13)
/** /**
* Reserved for future use. * Reserved for future use.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_HAPTIC_RESERVED3 (1u<<14) #define SDL_HAPTIC_RESERVED3 (1u<<14)
@ -324,7 +324,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* User defined custom haptic effect. * User defined custom haptic effect.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_HAPTIC_CUSTOM (1u<<15) #define SDL_HAPTIC_CUSTOM (1u<<15)
@ -337,7 +337,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Device supports setting the global gain. * Device supports setting the global gain.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_SetHapticGain * \sa SDL_SetHapticGain
*/ */
@ -348,7 +348,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Device supports setting autocenter. * Device supports setting autocenter.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_SetHapticAutocenter * \sa SDL_SetHapticAutocenter
*/ */
@ -359,7 +359,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Device supports querying effect status. * Device supports querying effect status.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticEffectStatus * \sa SDL_GetHapticEffectStatus
*/ */
@ -370,7 +370,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* *
* Devices supports being paused. * Devices supports being paused.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PauseHaptic * \sa SDL_PauseHaptic
* \sa SDL_ResumeHaptic * \sa SDL_ResumeHaptic
@ -386,7 +386,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/** /**
* Uses polar coordinates for the direction. * Uses polar coordinates for the direction.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticDirection * \sa SDL_HapticDirection
*/ */
@ -395,7 +395,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/** /**
* Uses cartesian coordinates for the direction. * Uses cartesian coordinates for the direction.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticDirection * \sa SDL_HapticDirection
*/ */
@ -404,7 +404,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/** /**
* Uses spherical coordinates for the direction. * Uses spherical coordinates for the direction.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticDirection * \sa SDL_HapticDirection
*/ */
@ -416,7 +416,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* This provides better compatibility across platforms and devices as SDL will * This provides better compatibility across platforms and devices as SDL will
* guess the correct axis. * guess the correct axis.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_HapticDirection * \sa SDL_HapticDirection
*/ */
@ -433,7 +433,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/** /**
* Used to play a device an infinite number of times. * Used to play a device an infinite number of times.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_RunHapticEffect * \sa SDL_RunHapticEffect
*/ */
@ -534,7 +534,7 @@ typedef struct SDL_Haptic SDL_Haptic;
* direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters. * direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
* ``` * ```
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HAPTIC_POLAR * \sa SDL_HAPTIC_POLAR
* \sa SDL_HAPTIC_CARTESIAN * \sa SDL_HAPTIC_CARTESIAN
@ -558,7 +558,7 @@ typedef struct SDL_HapticDirection
* A constant effect applies a constant force in the specified direction to * A constant effect applies a constant force in the specified direction to
* the joystick. * the joystick.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HAPTIC_CONSTANT * \sa SDL_HAPTIC_CONSTANT
* \sa SDL_HapticEffect * \sa SDL_HapticEffect
@ -640,7 +640,7 @@ typedef struct SDL_HapticConstant
* \| \| \| \| \| \| \| * \| \| \| \| \| \| \|
* ``` * ```
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HAPTIC_SINE * \sa SDL_HAPTIC_SINE
* \sa SDL_HAPTIC_SQUARE * \sa SDL_HAPTIC_SQUARE
@ -696,7 +696,7 @@ typedef struct SDL_HapticPeriodic
* SDL_HapticDirection diagram for which side is positive and which is * SDL_HapticDirection diagram for which side is positive and which is
* negative. * negative.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HapticDirection * \sa SDL_HapticDirection
* \sa SDL_HAPTIC_SPRING * \sa SDL_HAPTIC_SPRING
@ -739,7 +739,7 @@ typedef struct SDL_HapticCondition
* effects get added to the ramp effect making the effect become quadratic * effects get added to the ramp effect making the effect become quadratic
* instead of linear. * instead of linear.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HAPTIC_RAMP * \sa SDL_HAPTIC_RAMP
* \sa SDL_HapticEffect * \sa SDL_HapticEffect
@ -778,7 +778,7 @@ typedef struct SDL_HapticRamp
* motors, commonly found in modern game controllers. The small (right) motor * motors, commonly found in modern game controllers. The small (right) motor
* is high frequency, and the large (left) motor is low frequency. * is high frequency, and the large (left) motor is low frequency.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HAPTIC_LEFTRIGHT * \sa SDL_HAPTIC_LEFTRIGHT
* \sa SDL_HapticEffect * \sa SDL_HapticEffect
@ -808,7 +808,7 @@ typedef struct SDL_HapticLeftRight
* If channels is one, the effect is rotated using the defined direction. * If channels is one, the effect is rotated using the defined direction.
* Otherwise it uses the samples in data for the different axes. * Otherwise it uses the samples in data for the different axes.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HAPTIC_CUSTOM * \sa SDL_HAPTIC_CUSTOM
* \sa SDL_HapticEffect * \sa SDL_HapticEffect
@ -903,7 +903,7 @@ typedef struct SDL_HapticCustom
* Note either the attack_level or the fade_level may be above the actual * Note either the attack_level or the fade_level may be above the actual
* effect level. * effect level.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_HapticConstant * \sa SDL_HapticConstant
* \sa SDL_HapticPeriodic * \sa SDL_HapticPeriodic
@ -932,7 +932,7 @@ typedef union SDL_HapticEffect
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_HapticID; typedef Uint32 SDL_HapticID;
@ -948,7 +948,7 @@ typedef Uint32 SDL_HapticID;
* failure; call SDL_GetError() for more information. This should be * failure; call SDL_GetError() for more information. This should be
* freed with SDL_free() when it is no longer needed. * freed with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenHaptic * \sa SDL_OpenHaptic
*/ */
@ -964,7 +964,7 @@ extern SDL_DECLSPEC SDL_HapticID * SDLCALL SDL_GetHaptics(int *count);
* this function returns NULL; call SDL_GetError() for more * this function returns NULL; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticName * \sa SDL_GetHapticName
* \sa SDL_OpenHaptic * \sa SDL_OpenHaptic
@ -985,7 +985,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetHapticNameForID(SDL_HapticID ins
* \returns the device identifier or NULL on failure; call SDL_GetError() for * \returns the device identifier or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseHaptic * \sa SDL_CloseHaptic
* \sa SDL_GetHaptics * \sa SDL_GetHaptics
@ -1004,7 +1004,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 * \returns an SDL_Haptic on success or NULL on failure or if it hasn't been
* opened yet; call SDL_GetError() for more information. * opened yet; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_GetHapticFromID(SDL_HapticID instance_id); extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_GetHapticFromID(SDL_HapticID instance_id);
@ -1015,7 +1015,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 * \returns the instance ID of the specified haptic device on success or 0 on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticID(SDL_Haptic *haptic); extern SDL_DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticID(SDL_Haptic *haptic);
@ -1027,7 +1027,7 @@ extern SDL_DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticID(SDL_Haptic *haptic);
* this function returns NULL; call SDL_GetError() for more * this function returns NULL; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticNameForID * \sa SDL_GetHapticNameForID
*/ */
@ -1038,7 +1038,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. * \returns true if the mouse is haptic or false if it isn't.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenHapticFromMouse * \sa SDL_OpenHapticFromMouse
*/ */
@ -1050,7 +1050,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsMouseHaptic(void);
* \returns the haptic device identifier or NULL on failure; call * \returns the haptic device identifier or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseHaptic * \sa SDL_CloseHaptic
* \sa SDL_IsMouseHaptic * \sa SDL_IsMouseHaptic
@ -1063,7 +1063,7 @@ extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHapticFromMouse(void);
* \param joystick the SDL_Joystick to test for haptic capabilities. * \param joystick the SDL_Joystick to test for haptic capabilities.
* \returns true if the joystick is haptic or false if it isn't. * \returns true if the joystick is haptic or false if it isn't.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenHapticFromJoystick * \sa SDL_OpenHapticFromJoystick
*/ */
@ -1084,7 +1084,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsJoystickHaptic(SDL_Joystick *joystick);
* \returns a valid haptic device identifier on success or NULL on failure; * \returns a valid haptic device identifier on success or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseHaptic * \sa SDL_CloseHaptic
* \sa SDL_IsJoystickHaptic * \sa SDL_IsJoystickHaptic
@ -1096,7 +1096,7 @@ extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHapticFromJoystick(SDL_Joystick
* *
* \param haptic the SDL_Haptic device to close. * \param haptic the SDL_Haptic device to close.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenHaptic * \sa SDL_OpenHaptic
*/ */
@ -1113,7 +1113,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseHaptic(SDL_Haptic *haptic);
* \returns the number of effects the haptic device can store or a negative * \returns the number of effects the haptic device can store or a negative
* error code on failure; call SDL_GetError() for more information. * error code on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMaxHapticEffectsPlaying * \sa SDL_GetMaxHapticEffectsPlaying
* \sa SDL_GetHapticFeatures * \sa SDL_GetHapticFeatures
@ -1129,7 +1129,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 * \returns the number of effects the haptic device can play at the same time
* or -1 on failure; call SDL_GetError() for more information. * or -1 on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMaxHapticEffects * \sa SDL_GetMaxHapticEffects
* \sa SDL_GetHapticFeatures * \sa SDL_GetHapticFeatures
@ -1143,7 +1143,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 * \returns a list of supported haptic features in bitwise manner (OR'd), or 0
* on failure; call SDL_GetError() for more information. * on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HapticEffectSupported * \sa SDL_HapticEffectSupported
* \sa SDL_GetMaxHapticEffects * \sa SDL_GetMaxHapticEffects
@ -1160,7 +1160,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetHapticFeatures(SDL_Haptic *haptic);
* \returns the number of axes on success or -1 on failure; call * \returns the number of axes on success or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetNumHapticAxes(SDL_Haptic *haptic); extern SDL_DECLSPEC int SDLCALL SDL_GetNumHapticAxes(SDL_Haptic *haptic);
@ -1171,7 +1171,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumHapticAxes(SDL_Haptic *haptic);
* \param effect the desired effect to query. * \param effect the desired effect to query.
* \returns true if the effect is supported or false if it isn't. * \returns true if the effect is supported or false if it isn't.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateHapticEffect * \sa SDL_CreateHapticEffect
* \sa SDL_GetHapticFeatures * \sa SDL_GetHapticFeatures
@ -1187,7 +1187,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 * \returns the ID of the effect on success or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyHapticEffect * \sa SDL_DestroyHapticEffect
* \sa SDL_RunHapticEffect * \sa SDL_RunHapticEffect
@ -1210,7 +1210,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateHapticEffect * \sa SDL_CreateHapticEffect
* \sa SDL_RunHapticEffect * \sa SDL_RunHapticEffect
@ -1233,7 +1233,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticEffectStatus * \sa SDL_GetHapticEffectStatus
* \sa SDL_StopHapticEffect * \sa SDL_StopHapticEffect
@ -1249,7 +1249,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RunHapticEffect * \sa SDL_RunHapticEffect
* \sa SDL_StopHapticEffects * \sa SDL_StopHapticEffects
@ -1265,7 +1265,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 haptic the SDL_Haptic device to destroy the effect on.
* \param effect the ID of the haptic effect to destroy. * \param effect the ID of the haptic effect to destroy.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateHapticEffect * \sa SDL_CreateHapticEffect
*/ */
@ -1281,7 +1281,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 * \returns true if it is playing, false if it isn't playing or haptic status
* isn't supported. * isn't supported.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticFeatures * \sa SDL_GetHapticFeatures
*/ */
@ -1303,7 +1303,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticFeatures * \sa SDL_GetHapticFeatures
*/ */
@ -1322,7 +1322,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetHapticFeatures * \sa SDL_GetHapticFeatures
*/ */
@ -1341,7 +1341,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ResumeHaptic * \sa SDL_ResumeHaptic
*/ */
@ -1356,7 +1356,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseHaptic(SDL_Haptic *haptic);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PauseHaptic * \sa SDL_PauseHaptic
*/ */
@ -1369,7 +1369,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeHaptic(SDL_Haptic *haptic);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RunHapticEffect * \sa SDL_RunHapticEffect
* \sa SDL_StopHapticEffects * \sa SDL_StopHapticEffects
@ -1382,7 +1382,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StopHapticEffects(SDL_Haptic *haptic);
* \param haptic haptic device to check for rumble support. * \param haptic haptic device to check for rumble support.
* \returns true if the effect is supported or false if it isn't. * \returns true if the effect is supported or false if it isn't.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_InitHapticRumble * \sa SDL_InitHapticRumble
*/ */
@ -1395,7 +1395,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *haptic);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PlayHapticRumble * \sa SDL_PlayHapticRumble
* \sa SDL_StopHapticRumble * \sa SDL_StopHapticRumble
@ -1412,7 +1412,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_InitHapticRumble(SDL_Haptic *haptic);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_InitHapticRumble * \sa SDL_InitHapticRumble
* \sa SDL_StopHapticRumble * \sa SDL_StopHapticRumble
@ -1426,7 +1426,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PlayHapticRumble * \sa SDL_PlayHapticRumble
*/ */

50
include/SDL3/SDL_hidapi.h
View file

@ -65,14 +65,14 @@ extern "C" {
/** /**
* An opaque handle representing an open HID device. * An opaque handle representing an open HID device.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_hid_device SDL_hid_device; typedef struct SDL_hid_device SDL_hid_device;
/** /**
* HID underlying bus types. * HID underlying bus types.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_hid_bus_type { typedef enum SDL_hid_bus_type {
/** Unknown bus type */ /** Unknown bus type */
@ -107,7 +107,7 @@ typedef enum SDL_hid_bus_type {
/** /**
* Information about a connected HID device * Information about a connected HID device
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_hid_device_info 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_hid_exit * \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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_hid_init * \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 * \returns a change counter that is incremented with each potential device
* change, or 0 if device change detection isn't available. * change, or 0 if device change detection isn't available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_hid_enumerate * \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 * in the case of failure. Free this linked list by calling
* SDL_hid_free_enumeration(). * SDL_hid_free_enumeration().
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_hid_device_change_count * \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 * \param devs pointer to a list of struct_device returned from
* SDL_hid_enumerate(). * SDL_hid_enumerate().
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_hid_free_enumeration(SDL_hid_device_info *devs); 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 * \returns a pointer to a SDL_hid_device object on success or NULL on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number); 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 * \returns a pointer to a SDL_hid_device object on success or NULL on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path); 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 * \returns the actual number of bytes written and -1 on on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_write(SDL_hid_device *dev, const unsigned char *data, size_t length); 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 * SDL_GetError() for more information. If no packet was available to
* be read within the timeout period, this function returns 0. * be read within the timeout period, this function returns 0.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_read_timeout(SDL_hid_device *dev, unsigned char *data, size_t length, int milliseconds); 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 * be read and the handle is in non-blocking mode, this function
* returns 0. * returns 0.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_read(SDL_hid_device *dev, unsigned char *data, size_t length); 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock); 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 * \returns the actual number of bytes written and -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_send_feature_report(SDL_hid_device *dev, const unsigned char *data, size_t length); 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() * still in the first byte), or -1 on on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, unsigned char *data, size_t length); 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() * still in the first byte), or -1 on on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_input_report(SDL_hid_device *dev, unsigned char *data, size_t length); 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_close(SDL_hid_device *dev); 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_manufacturer_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_product_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_serial_number_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); 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 * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int string_index, wchar_t *string, size_t maxlen); 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 * on failure; call SDL_GetError() for more information. This struct
* is valid until the device is closed with SDL_hid_close(). * is valid until the device is closed with SDL_hid_close().
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_get_device_info(SDL_hid_device *dev); 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 * \returns the number of bytes actually copied or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_hid_get_report_descriptor(SDL_hid_device *dev, unsigned char *buf, size_t buf_size); 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. * \param active true to start the scan, false to stop the scan.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_hid_ble_scan(bool active); extern SDL_DECLSPEC void SDLCALL SDL_hid_ble_scan(bool active);

476
include/SDL3/SDL_hints.h
View file

File diff suppressed because it is too large Load diff

34
include/SDL3/SDL_init.h
View file

@ -67,7 +67,7 @@ extern "C" {
* These are the flags which may be passed to SDL_Init(). You should specify * These are the flags which may be passed to SDL_Init(). You should specify
* the subsystems which you will be using in your application. * the subsystems which you will be using in your application.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_Init * \sa SDL_Init
* \sa SDL_Quit * \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) * [Main callbacks in SDL3](https://wiki.libsdl.org/SDL3/README/main-functions#main-callbacks-in-sdl3)
* for complete details. * for complete details.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_AppResult typedef enum SDL_AppResult
{ {
@ -128,7 +128,7 @@ typedef enum SDL_AppResult
* \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* terminate with success, SDL_APP_CONTINUE to continue. * terminate with success, SDL_APP_CONTINUE to continue.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef SDL_AppResult (SDLCALL *SDL_AppInit_func)(void **appstate, int argc, char *argv[]); typedef SDL_AppResult (SDLCALL *SDL_AppInit_func)(void **appstate, int argc, char *argv[]);
@ -143,7 +143,7 @@ typedef SDL_AppResult (SDLCALL *SDL_AppInit_func)(void **appstate, int argc, cha
* \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* terminate with success, SDL_APP_CONTINUE to continue. * terminate with success, SDL_APP_CONTINUE to continue.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef SDL_AppResult (SDLCALL *SDL_AppIterate_func)(void *appstate); typedef SDL_AppResult (SDLCALL *SDL_AppIterate_func)(void *appstate);
@ -159,7 +159,7 @@ typedef SDL_AppResult (SDLCALL *SDL_AppIterate_func)(void *appstate);
* \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* terminate with success, SDL_APP_CONTINUE to continue. * terminate with success, SDL_APP_CONTINUE to continue.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef SDL_AppResult (SDLCALL *SDL_AppEvent_func)(void *appstate, SDL_Event *event); typedef SDL_AppResult (SDLCALL *SDL_AppEvent_func)(void *appstate, SDL_Event *event);
@ -173,7 +173,7 @@ typedef SDL_AppResult (SDLCALL *SDL_AppEvent_func)(void *appstate, SDL_Event *ev
* \param appstate an optional pointer, provided by the app in SDL_AppInit. * \param appstate an optional pointer, provided by the app in SDL_AppInit.
* \param result the result code that terminated the app (success or failure). * \param result the result code that terminated the app (success or failure).
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate, SDL_AppResult result); typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate, SDL_AppResult result);
@ -224,7 +224,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAppMetadata * \sa SDL_SetAppMetadata
* \sa SDL_SetAppMetadataProperty * \sa SDL_SetAppMetadataProperty
@ -244,7 +244,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Init(SDL_InitFlags flags);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Init * \sa SDL_Init
* \sa SDL_Quit * \sa SDL_Quit
@ -260,7 +260,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. * \param flags any of the flags used by SDL_Init(); see SDL_Init for details.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_InitSubSystem * \sa SDL_InitSubSystem
* \sa SDL_Quit * \sa SDL_Quit
@ -274,7 +274,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 a mask of all initialized subsystems if `flags` is 0, otherwise it
* returns the initialization status of the specified subsystems. * returns the initialization status of the specified subsystems.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Init * \sa SDL_Init
* \sa SDL_InitSubSystem * \sa SDL_InitSubSystem
@ -292,7 +292,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 * application is shutdown, but it is not wise to do this from a library or
* other dynamically loaded code. * other dynamically loaded code.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Init * \sa SDL_Init
* \sa SDL_QuitSubSystem * \sa SDL_QuitSubSystem
@ -313,7 +313,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Quit(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RunOnMainThread * \sa SDL_RunOnMainThread
*/ */
@ -324,7 +324,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsMainThread(void);
* *
* \param userdata an app-controlled pointer that is passed to the callback. * \param userdata an app-controlled pointer that is passed to the callback.
* *
* \since This datatype is available since SDL 3.1.8. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_RunOnMainThread * \sa SDL_RunOnMainThread
*/ */
@ -350,7 +350,7 @@ typedef void (SDLCALL *SDL_MainThreadCallback)(void *userdata);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_IsMainThread * \sa SDL_IsMainThread
*/ */
@ -388,7 +388,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RunOnMainThread(SDL_MainThreadCallback call
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAppMetadataProperty * \sa SDL_SetAppMetadataProperty
*/ */
@ -450,7 +450,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAppMetadata(const char *appname, const c
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAppMetadataProperty * \sa SDL_GetAppMetadataProperty
* \sa SDL_SetAppMetadata * \sa SDL_SetAppMetadata
@ -481,7 +481,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAppMetadataProperty(const char *name, co
* freed if you call SDL_SetAppMetadataProperty() to set that * freed if you call SDL_SetAppMetadataProperty() to set that
* property from another thread. * property from another thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetAppMetadata * \sa SDL_SetAppMetadata
* \sa SDL_SetAppMetadataProperty * \sa SDL_SetAppMetadataProperty

2
include/SDL3/SDL_intrin.h
View file

@ -335,7 +335,7 @@ _m_prefetch(void *__P)
* This symbol is used by SDL internally, but apps and other libraries are * This symbol is used by SDL internally, but apps and other libraries are
* welcome to use it for their own interfaces as well. * welcome to use it for their own interfaces as well.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_TARGETING(x) __attribute__((target(x))) #define SDL_TARGETING(x) __attribute__((target(x)))

104
include/SDL3/SDL_iostream.h
View file

@ -48,7 +48,7 @@ extern "C" {
/** /**
* SDL_IOStream status, set by a read or write operation. * SDL_IOStream status, set by a read or write operation.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_IOStatus 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 * These map to the same "whence" concept that `fseek` or `lseek` use in the
* standard C runtime. * standard C runtime.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_IOWhence typedef enum SDL_IOWhence
{ {
@ -85,7 +85,7 @@ typedef enum SDL_IOWhence
* *
* This structure should be initialized using SDL_INIT_INTERFACE() * This structure should be initialized using SDL_INIT_INTERFACE()
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_INIT_INTERFACE * \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 * SDL_OpenIO() to provide their own stream implementation behind this
* struct's abstract interface. * struct's abstract interface.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_IOStream SDL_IOStream; typedef struct SDL_IOStream SDL_IOStream;
@ -262,7 +262,7 @@ typedef struct SDL_IOStream SDL_IOStream;
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseIO * \sa SDL_CloseIO
* \sa SDL_FlushIO * \sa SDL_FlushIO
@ -307,7 +307,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromFile(const char *file, cons
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_IOFromConstMem * \sa SDL_IOFromConstMem
* \sa SDL_CloseIO * \sa SDL_CloseIO
@ -353,7 +353,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromMem(void *mem, size_t size)
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_IOFromMem * \sa SDL_IOFromMem
* \sa SDL_CloseIO * \sa SDL_CloseIO
@ -383,7 +383,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromConstMem(const void *mem, s
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseIO * \sa SDL_CloseIO
* \sa SDL_ReadIO * \sa SDL_ReadIO
@ -418,7 +418,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromDynamicMem(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseIO * \sa SDL_CloseIO
* \sa SDL_INIT_INTERFACE * \sa SDL_INIT_INTERFACE
@ -454,7 +454,7 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_OpenIO(const SDL_IOStreamInterfac
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenIO * \sa SDL_OpenIO
*/ */
@ -469,7 +469,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseIO(SDL_IOStream *context);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetIOProperties(SDL_IOStream *context); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetIOProperties(SDL_IOStream *context);
@ -489,7 +489,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetIOProperties(SDL_IOStream *c
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context); extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context);
@ -503,7 +503,7 @@ extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context); extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context);
@ -530,7 +530,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_TellIO * \sa SDL_TellIO
*/ */
@ -550,7 +550,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_SeekIO(SDL_IOStream *context, Sint64 offs
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SeekIO * \sa SDL_SeekIO
*/ */
@ -575,7 +575,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WriteIO * \sa SDL_WriteIO
* \sa SDL_GetIOStatus * \sa SDL_GetIOStatus
@ -604,7 +604,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_ReadIO(SDL_IOStream *context, void *ptr,
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_IOprintf * \sa SDL_IOprintf
* \sa SDL_ReadIO * \sa SDL_ReadIO
@ -628,7 +628,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_WriteIO(SDL_IOStream *context, const void
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_IOvprintf * \sa SDL_IOvprintf
* \sa SDL_WriteIO * \sa SDL_WriteIO
@ -648,7 +648,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_IOprintf(SDL_IOStream *context, SDL_PRINT
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_IOprintf * \sa SDL_IOprintf
* \sa SDL_WriteIO * \sa SDL_WriteIO
@ -668,7 +668,7 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRIN
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenIO * \sa SDL_OpenIO
* \sa SDL_WriteIO * \sa SDL_WriteIO
@ -694,7 +694,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushIO(SDL_IOStream *context);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadFile * \sa SDL_LoadFile
* \sa SDL_SaveFile_IO * \sa SDL_SaveFile_IO
@ -717,7 +717,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *da
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadFile_IO * \sa SDL_LoadFile_IO
* \sa SDL_SaveFile * \sa SDL_SaveFile
@ -738,7 +738,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile(const char *file, size_t *datasi
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SaveFile * \sa SDL_SaveFile
* \sa SDL_LoadFile_IO * \sa SDL_LoadFile_IO
@ -757,7 +757,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveFile_IO(SDL_IOStream *src, const void *
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SaveFile_IO * \sa SDL_SaveFile_IO
* \sa SDL_LoadFile * \sa SDL_LoadFile
@ -786,7 +786,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveFile(const char *file, const void *data
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value);
@ -805,7 +805,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value);
@ -828,7 +828,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value);
@ -851,7 +851,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value);
@ -874,7 +874,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value);
@ -897,7 +897,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value);
@ -920,7 +920,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value);
@ -943,7 +943,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value);
@ -966,7 +966,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value);
@ -989,7 +989,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value);
@ -1012,7 +1012,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value);
@ -1035,7 +1035,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value);
@ -1058,7 +1058,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value);
@ -1081,7 +1081,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *value); extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *value);
/* @} *//* Read endian functions */ /* @} *//* Read endian functions */
@ -1103,7 +1103,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value);
@ -1117,7 +1117,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value);
@ -1136,7 +1136,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 value);
@ -1155,7 +1155,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 value);
@ -1173,7 +1173,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 value);
@ -1191,7 +1191,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 value);
@ -1210,7 +1210,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 value);
@ -1229,7 +1229,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 value);
@ -1247,7 +1247,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 value);
@ -1265,7 +1265,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 value);
@ -1284,7 +1284,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 value);
@ -1303,7 +1303,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 value);
@ -1321,7 +1321,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 value);
@ -1339,7 +1339,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 value)
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64BE(SDL_IOStream *dst, Sint64 value); extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64BE(SDL_IOStream *dst, Sint64 value);

134
include/SDL3/SDL_joystick.h
View file

@ -81,7 +81,7 @@ extern SDL_Mutex *SDL_joystick_lock;
* *
* This is opaque data. * This is opaque data.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Joystick SDL_Joystick; typedef struct SDL_Joystick SDL_Joystick;
@ -93,7 +93,7 @@ typedef struct SDL_Joystick SDL_Joystick;
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_JoystickID; 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 * This is by no means a complete list of everything that can be plugged into
* a computer. * a computer.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_JoystickType typedef enum SDL_JoystickType
{ {
@ -130,7 +130,7 @@ typedef enum SDL_JoystickType
* This is used by SDL_GetJoystickConnectionState to report how a device is * This is used by SDL_GetJoystickConnectionState to report how a device is
* connected to the system. * connected to the system.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_JoystickConnectionState typedef enum SDL_JoystickConnectionState
{ {
@ -143,7 +143,7 @@ typedef enum SDL_JoystickConnectionState
/** /**
* The largest value an SDL_Joystick's axis can report. * The largest value an SDL_Joystick's axis can report.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_JOYSTICK_AXIS_MIN * \sa SDL_JOYSTICK_AXIS_MIN
*/ */
@ -154,7 +154,7 @@ typedef enum SDL_JoystickConnectionState
* *
* This is a negative number! * This is a negative number!
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_JOYSTICK_AXIS_MAX * \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 * joysticks while processing to guarantee that the joystick list won't change
* and joystick and gamepad events will not be delivered. * and joystick and gamepad events will not be delivered.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_LockJoysticks(void) SDL_ACQUIRE(SDL_joystick_lock); extern SDL_DECLSPEC void SDLCALL SDL_LockJoysticks(void) SDL_ACQUIRE(SDL_joystick_lock);
/** /**
* Unlocking for atomic access to the joystick API. * Unlocking for atomic access to the joystick API.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_UnlockJoysticks(void) SDL_RELEASE(SDL_joystick_lock); 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. * \returns true if a joystick is connected, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoysticks * \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 * call SDL_GetError() for more information. This should be freed
* with SDL_free() when it is no longer needed. * with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasJoystick * \sa SDL_HasJoystick
* \sa SDL_OpenJoystick * \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 * \returns the name of the selected joystick. If no name can be found, this
* function returns NULL; call SDL_GetError() for more information. * function returns NULL; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickName * \sa SDL_GetJoystickName
* \sa SDL_GetJoysticks * \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 * \returns the path of the selected joystick. If no path can be found, this
* function returns NULL; call SDL_GetError() for more information. * function returns NULL; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickPath * \sa SDL_GetJoystickPath
* \sa SDL_GetJoysticks * \sa SDL_GetJoysticks
@ -248,7 +248,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickPathForID(SDL_JoystickID
* \param instance_id the joystick instance ID. * \param instance_id the joystick instance ID.
* \returns the player index of a joystick, or -1 if it's not available. * \returns the player index of a joystick, or -1 if it's not available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickPlayerIndex * \sa SDL_GetJoystickPlayerIndex
* \sa SDL_GetJoysticks * \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 * \returns the GUID of the selected joystick. If called with an invalid
* instance_id, this function returns a zero GUID. * instance_id, this function returns a zero GUID.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickGUID * \sa SDL_GetJoystickGUID
* \sa SDL_GUIDToString * \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 * \returns the USB vendor ID of the selected joystick. If called with an
* invalid instance_id, this function returns 0. * invalid instance_id, this function returns 0.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickVendor * \sa SDL_GetJoystickVendor
* \sa SDL_GetJoysticks * \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 * \returns the USB product ID of the selected joystick. If called with an
* invalid instance_id, this function returns 0. * invalid instance_id, this function returns 0.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickProduct * \sa SDL_GetJoystickProduct
* \sa SDL_GetJoysticks * \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 * \returns the product version of the selected joystick. If called with an
* invalid instance_id, this function returns 0. * invalid instance_id, this function returns 0.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickProductVersion * \sa SDL_GetJoystickProductVersion
* \sa SDL_GetJoysticks * \sa SDL_GetJoysticks
@ -332,7 +332,7 @@ extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickProductVersionForID(SDL_Joysti
* invalid instance_id, this function returns * invalid instance_id, this function returns
* `SDL_JOYSTICK_TYPE_UNKNOWN`. * `SDL_JOYSTICK_TYPE_UNKNOWN`.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickType * \sa SDL_GetJoystickType
* \sa SDL_GetJoysticks * \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 * \returns a joystick identifier or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseJoystick * \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 * \returns an SDL_Joystick on success or NULL on failure or if it hasn't been
* opened yet; call SDL_GetError() for more information. * opened yet; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Joystick * SDLCALL SDL_GetJoystickFromID(SDL_JoystickID instance_id); 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() * \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickPlayerIndex * \sa SDL_GetJoystickPlayerIndex
* \sa SDL_SetJoystickPlayerIndex * \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. * The structure that describes a virtual joystick touchpad.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_VirtualJoystickDesc * \sa SDL_VirtualJoystickDesc
*/ */
@ -396,7 +396,7 @@ typedef struct SDL_VirtualJoystickTouchpadDesc
/** /**
* The structure that describes a virtual joystick sensor. * The structure that describes a virtual joystick sensor.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_VirtualJoystickDesc * \sa SDL_VirtualJoystickDesc
*/ */
@ -412,7 +412,7 @@ typedef struct SDL_VirtualJoystickSensorDesc
* This structure should be initialized using SDL_INIT_INTERFACE(). All * This structure should be initialized using SDL_INIT_INTERFACE(). All
* elements of this structure are optional. * elements of this structure are optional.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_AttachVirtualJoystick * \sa SDL_AttachVirtualJoystick
* \sa SDL_INIT_INTERFACE * \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 * \returns the joystick instance ID, or 0 on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DetachVirtualJoystick * \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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AttachVirtualJoystick * \sa SDL_AttachVirtualJoystick
*/ */
@ -495,7 +495,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_DetachVirtualJoystick(SDL_JoystickID instan
* \param instance_id the joystick instance ID. * \param instance_id the joystick instance ID.
* \returns true if the joystick is virtual, false otherwise. * \returns true if the joystick is virtual, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsJoystickVirtual(SDL_JoystickID instance_id); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualBall(SDL_Joystick *joystick, int ball, Sint16 xrel, Sint16 yrel); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualButton(SDL_Joystick *joystick, int button, bool down); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualHat(SDL_Joystick *joystick, int hat, Uint8 value); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickVirtualTouchpad(SDL_Joystick *joystick, int touchpad, int finger, bool down, float x, float y, float pressure); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SendJoystickVirtualSensorData(SDL_Joystick *joystick, SDL_SensorType type, Uint64 sensor_timestamp, const float *data, int num_values); 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 * \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetJoystickProperties(SDL_Joystick *joystick); 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 * \returns the name of the selected joystick. If no name can be found, this
* function returns NULL; call SDL_GetError() for more information. * function returns NULL; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickNameForID * \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 * \returns the path of the selected joystick. If no path can be found, this
* function returns NULL; call SDL_GetError() for more information. * function returns NULL; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickPathForID * \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(). * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick().
* \returns the player index, or -1 if it's not available. * \returns the player index, or -1 if it's not available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetJoystickPlayerIndex * \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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickPlayerIndex * \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 * this function returns a zero GUID; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickGUIDForID * \sa SDL_GetJoystickGUIDForID
* \sa SDL_GUIDToString * \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(). * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick().
* \returns the USB vendor ID of the selected joystick, or 0 if unavailable. * \returns the USB vendor ID of the selected joystick, or 0 if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickVendorForID * \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(). * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick().
* \returns the USB product ID of the selected joystick, or 0 if unavailable. * \returns the USB product ID of the selected joystick, or 0 if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickProductForID * \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(). * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick().
* \returns the product version of the selected joystick, or 0 if unavailable. * \returns the product version of the selected joystick, or 0 if unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickProductVersionForID * \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 * \returns the firmware version of the selected joystick, or 0 if
* unavailable. * unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC Uint16 SDLCALL SDL_GetJoystickFirmwareVersion(SDL_Joystick *joystick); 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 * \returns the serial number of the selected joystick, or NULL if
* unavailable. * unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetJoystickSerial(SDL_Joystick *joystick); 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(). * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick().
* \returns the SDL_JoystickType of the selected joystick. * \returns the SDL_JoystickType of the selected joystick.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickTypeForID * \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 * \param crc16 a pointer filled in with a CRC used to distinguish different
* products with the same VID/PID, or 0 if not available. * products with the same VID/PID, or 0 if not available.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickGUIDForID * \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 * \returns true if the joystick has been opened, false if it has not; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_JoystickConnected(SDL_Joystick *joystick); 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 * \returns the instance ID of the specified joystick on success or 0 on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetJoystickID(SDL_Joystick *joystick); 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 * \returns the number of axis controls/number of axes on success or -1 on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickAxis * \sa SDL_GetJoystickAxis
* \sa SDL_GetNumJoystickBalls * \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 * \returns the number of trackballs on success or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickBall * \sa SDL_GetJoystickBall
* \sa SDL_GetNumJoystickAxes * \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 * \returns the number of POV hats on success or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickHat * \sa SDL_GetJoystickHat
* \sa SDL_GetNumJoystickAxes * \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 * \returns the number of buttons on success or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetJoystickButton * \sa SDL_GetJoystickButton
* \sa SDL_GetNumJoystickAxes * \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. * \param enabled whether to process joystick events or not.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_JoystickEventsEnabled * \sa SDL_JoystickEventsEnabled
* \sa SDL_UpdateJoysticks * \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. * \returns true if joystick events are being processed, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetJoystickEventsEnabled * \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 * This is called automatically by the event loop if any joystick events are
* enabled. * enabled.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_UpdateJoysticks(void); 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 * \returns a 16-bit signed integer representing the current position of the
* axis or 0 on failure; call SDL_GetError() for more information. * axis or 0 on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumJoystickAxes * \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. * \param state upon return, the initial value is supplied here.
* \returns true if this axis has any initial value, or false if not. * \returns true if this axis has any initial value, or false if not.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetJoystickAxisInitialState(SDL_Joystick *joystick, int axis, Sint16 *state); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumJoystickBalls * \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. * \param hat the hat index to get the state from; indices start at index 0.
* \returns the current hat position. * \returns the current hat position.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumJoystickHats * \sa SDL_GetNumJoystickHats
*/ */
@ -1060,7 +1060,7 @@ extern SDL_DECLSPEC Uint8 SDLCALL SDL_GetJoystickHat(SDL_Joystick *joystick, int
* index 0. * index 0.
* \returns true if the button is pressed, false otherwise. * \returns true if the button is pressed, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumJoystickButtons * \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. * \param duration_ms the duration of the rumble effect, in milliseconds.
* \returns true, or false if rumble isn't supported on this joystick. * \returns true, or false if rumble isn't supported on this joystick.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_RumbleJoystick(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RumbleJoystick * \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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetJoystickLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue); 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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SendJoystickEffect(SDL_Joystick *joystick, const void *data, int size); 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. * \param joystick the joystick device to close.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenJoystick * \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() * `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetJoystickConnectionState(SDL_Joystick *joystick); 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; * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetJoystickPowerInfo(SDL_Joystick *joystick, int *percent); extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetJoystickPowerInfo(SDL_Joystick *joystick, int *percent);

54
include/SDL3/SDL_keyboard.h
View file

@ -55,7 +55,7 @@ extern "C" {
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_KeyboardID; typedef Uint32 SDL_KeyboardID;
@ -68,7 +68,7 @@ typedef Uint32 SDL_KeyboardID;
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyboards * \sa SDL_GetKeyboards
*/ */
@ -90,7 +90,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasKeyboard(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyboardNameForID * \sa SDL_GetKeyboardNameForID
* \sa SDL_HasKeyboard * \sa SDL_HasKeyboard
@ -108,7 +108,7 @@ extern SDL_DECLSPEC SDL_KeyboardID * SDLCALL SDL_GetKeyboards(int *count);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyboards * \sa SDL_GetKeyboards
*/ */
@ -121,7 +121,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetKeyboardNameForID(SDL_KeyboardID
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void); extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void);
@ -151,7 +151,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_PumpEvents * \sa SDL_PumpEvents
* \sa SDL_ResetKeyboard * \sa SDL_ResetKeyboard
@ -165,7 +165,7 @@ extern SDL_DECLSPEC const bool * SDLCALL SDL_GetKeyboardState(int *numkeys);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyboardState * \sa SDL_GetKeyboardState
*/ */
@ -179,7 +179,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ResetKeyboard(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyboardState * \sa SDL_GetKeyboardState
* \sa SDL_SetModState * \sa SDL_SetModState
@ -201,7 +201,7 @@ extern SDL_DECLSPEC SDL_Keymod SDLCALL SDL_GetModState(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetModState * \sa SDL_GetModState
*/ */
@ -224,7 +224,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyName * \sa SDL_GetKeyName
* \sa SDL_GetScancodeFromKey * \sa SDL_GetScancodeFromKey
@ -245,7 +245,7 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scan
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyFromScancode * \sa SDL_GetKeyFromScancode
* \sa SDL_GetScancodeName * \sa SDL_GetScancodeName
@ -264,7 +264,7 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key,
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetScancodeName * \sa SDL_GetScancodeName
*/ */
@ -288,7 +288,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetScancodeName(SDL_Scancode scancode, cons
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetScancodeFromKey * \sa SDL_GetScancodeFromKey
* \sa SDL_GetScancodeFromName * \sa SDL_GetScancodeFromName
@ -305,7 +305,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetScancodeName(SDL_Scancode scanco
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyFromName * \sa SDL_GetKeyFromName
* \sa SDL_GetScancodeFromKey * \sa SDL_GetScancodeFromKey
@ -325,7 +325,7 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *nam
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyFromName * \sa SDL_GetKeyFromName
* \sa SDL_GetKeyFromScancode * \sa SDL_GetKeyFromScancode
@ -342,7 +342,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetKeyName(SDL_Keycode key);
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetKeyFromScancode * \sa SDL_GetKeyFromScancode
* \sa SDL_GetKeyName * \sa SDL_GetKeyName
@ -369,7 +369,7 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetTextInputArea * \sa SDL_SetTextInputArea
* \sa SDL_StartTextInputWithProperties * \sa SDL_StartTextInputWithProperties
@ -385,7 +385,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 * value is valid on every platform, but where a value isn't supported, a
* reasonable fallback will be used. * reasonable fallback will be used.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInputWithProperties * \sa SDL_StartTextInputWithProperties
*/ */
@ -409,7 +409,7 @@ typedef enum SDL_TextInputType
* Not every value is valid on every platform, but where a value isn't * Not every value is valid on every platform, but where a value isn't
* supported, a reasonable fallback will be used. * supported, a reasonable fallback will be used.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInputWithProperties * \sa SDL_StartTextInputWithProperties
*/ */
@ -464,7 +464,7 @@ typedef enum SDL_Capitalization
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetTextInputArea * \sa SDL_SetTextInputArea
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
@ -487,7 +487,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StartTextInputWithProperties(SDL_Window *wi
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
*/ */
@ -505,7 +505,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TextInputActive(SDL_Window *window);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
*/ */
@ -520,7 +520,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StopTextInput(SDL_Window *window);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
* \sa SDL_StopTextInput * \sa SDL_StopTextInput
@ -543,7 +543,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearComposition(SDL_Window *window);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextInputArea * \sa SDL_GetTextInputArea
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
@ -565,7 +565,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextInputArea(SDL_Window *window, const
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetTextInputArea * \sa SDL_SetTextInputArea
*/ */
@ -579,7 +579,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextInputArea(SDL_Window *window, SDL_Re
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StartTextInput * \sa SDL_StartTextInput
* \sa SDL_ScreenKeyboardShown * \sa SDL_ScreenKeyboardShown
@ -594,7 +594,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasScreenKeyboardSupport(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasScreenKeyboardSupport * \sa SDL_HasScreenKeyboardSupport
*/ */

4
include/SDL3/SDL_keycode.h
View file

@ -50,7 +50,7 @@
* Keys with the `SDLK_EXTENDED_MASK` bit set do not map to a scancode or * Keys with the `SDLK_EXTENDED_MASK` bit set do not map to a scancode or
* unicode code point. * unicode code point.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_Keycode; typedef Uint32 SDL_Keycode;
@ -317,7 +317,7 @@ typedef Uint32 SDL_Keycode;
/** /**
* Valid key modifiers (possibly OR'd together). * Valid key modifiers (possibly OR'd together).
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint16 SDL_Keymod; typedef Uint16 SDL_Keymod;

8
include/SDL3/SDL_loadso.h
View file

@ -68,7 +68,7 @@ extern "C" {
/** /**
* An opaque datatype that represents a loaded shared object. * An opaque datatype that represents a loaded shared object.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_LoadObject * \sa SDL_LoadObject
* \sa SDL_LoadFunction * \sa SDL_LoadFunction
@ -85,7 +85,7 @@ typedef struct SDL_SharedObject SDL_SharedObject;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadFunction * \sa SDL_LoadFunction
* \sa SDL_UnloadObject * \sa SDL_UnloadObject
@ -114,7 +114,7 @@ extern SDL_DECLSPEC SDL_SharedObject * SDLCALL SDL_LoadObject(const char *sofile
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadObject * \sa SDL_LoadObject
*/ */
@ -130,7 +130,7 @@ extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_LoadFunction(SDL_SharedObjec
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadObject * \sa SDL_LoadObject
*/ */

4
include/SDL3/SDL_locale.h
View file

@ -53,7 +53,7 @@ extern "C" {
* would be "en"), and the country, if not NULL, will be an ISO-3166 country * would be "en"), and the country, if not NULL, will be an ISO-3166 country
* code (so Canada would be "CA"). * code (so Canada would be "CA").
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPreferredLocales * \sa SDL_GetPreferredLocales
*/ */
@ -102,7 +102,7 @@ typedef struct SDL_Locale
* allocation that should be freed with SDL_free() when it is no * allocation that should be freed with SDL_free() when it is no
* longer needed. * longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Locale ** SDLCALL SDL_GetPreferredLocales(int *count); extern SDL_DECLSPEC SDL_Locale ** SDLCALL SDL_GetPreferredLocales(int *count);

42
include/SDL3/SDL_log.h
View file

@ -76,7 +76,7 @@ extern "C" {
* level, the assert category is enabled at the WARN level, test is enabled at * 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. * the VERBOSE level and all other categories are enabled at the ERROR level.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_LogCategory typedef enum SDL_LogCategory
{ {
@ -116,7 +116,7 @@ typedef enum SDL_LogCategory
/** /**
* The predefined log priorities * The predefined log priorities
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_LogPriority typedef enum SDL_LogPriority
{ {
@ -139,7 +139,7 @@ typedef enum SDL_LogPriority
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ResetLogPriorities * \sa SDL_ResetLogPriorities
* \sa SDL_SetLogPriority * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetLogPriority * \sa SDL_GetLogPriority
* \sa SDL_ResetLogPriorities * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetLogPriority * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetLogPriorities * \sa SDL_SetLogPriorities
* \sa SDL_SetLogPriority * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetLogPriorities * \sa SDL_SetLogPriorities
* \sa SDL_SetLogPriority * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LogCritical * \sa SDL_LogCritical
* \sa SDL_LogDebug * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogDebug * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Log * \sa SDL_Log
* \sa SDL_LogCritical * \sa SDL_LogCritical
@ -469,7 +469,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogMessageV(int category,
* \param priority the priority of the message. * \param priority the priority of the message.
* \param message the message being output. * \param message the message being output.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_LogPriority priority, const char *message); 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.6. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetLogOutputFunction * \sa SDL_SetLogOutputFunction
* \sa SDL_GetLogOutputFunction * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetDefaultLogOutputFunction * \sa SDL_GetDefaultLogOutputFunction
* \sa SDL_SetLogOutputFunction * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetDefaultLogOutputFunction * \sa SDL_GetDefaultLogOutputFunction
* \sa SDL_GetLogOutputFunction * \sa SDL_GetLogOutputFunction

24
include/SDL3/SDL_main.h
View file

@ -330,7 +330,7 @@ extern "C" {
* \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* terminate with success, SDL_APP_CONTINUE to continue. * terminate with success, SDL_APP_CONTINUE to continue.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AppIterate * \sa SDL_AppIterate
* \sa SDL_AppEvent * \sa SDL_AppEvent
@ -382,7 +382,7 @@ extern SDLMAIN_DECLSPEC SDL_AppResult SDLCALL SDL_AppInit(void **appstate, int a
* \threadsafety This function may get called concurrently with SDL_AppEvent() * \threadsafety This function may get called concurrently with SDL_AppEvent()
* for events not pushed on the main thread. * for events not pushed on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AppInit * \sa SDL_AppInit
* \sa SDL_AppEvent * \sa SDL_AppEvent
@ -431,7 +431,7 @@ extern SDLMAIN_DECLSPEC SDL_AppResult SDLCALL SDL_AppIterate(void *appstate);
* SDL_AppIterate() or SDL_AppQuit() for events not pushed from * SDL_AppIterate() or SDL_AppQuit() for events not pushed from
* the main thread. * the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AppInit * \sa SDL_AppInit
* \sa SDL_AppIterate * \sa SDL_AppIterate
@ -470,7 +470,7 @@ extern SDLMAIN_DECLSPEC SDL_AppResult SDLCALL SDL_AppEvent(void *appstate, SDL_E
* \threadsafety SDL_AppEvent() may get called concurrently with this function * \threadsafety SDL_AppEvent() may get called concurrently with this function
* if other threads that push events are still active. * if other threads that push events are still active.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AppInit * \sa SDL_AppInit
*/ */
@ -488,7 +488,7 @@ extern SDLMAIN_DECLSPEC void SDLCALL SDL_AppQuit(void *appstate, SDL_AppResult r
* program completion, and small non-zero values are considered * program completion, and small non-zero values are considered
* errors. * errors.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]); typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]);
@ -521,7 +521,7 @@ typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]);
* *
* \threadsafety This is the program entry point. * \threadsafety This is the program entry point.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDLMAIN_DECLSPEC int SDLCALL SDL_main(int argc, char *argv[]); extern SDLMAIN_DECLSPEC int SDLCALL SDL_main(int argc, char *argv[]);
@ -534,7 +534,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 * will not be changed it is necessary to define SDL_MAIN_HANDLED before
* including SDL.h. * including SDL.h.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Init * \sa SDL_Init
*/ */
@ -566,7 +566,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetMainReady(void);
* \threadsafety Generally this is called once, near startup, from the * \threadsafety Generally this is called once, near startup, from the
* process's initial thread. * process's initial thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_RunApp(int argc, char *argv[], SDL_main_func mainFunction, void *reserved); extern SDL_DECLSPEC int SDLCALL SDL_RunApp(int argc, char *argv[], SDL_main_func mainFunction, void *reserved);
@ -593,7 +593,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 * \threadsafety It is not safe to call this anywhere except as the only
* function call in SDL_main. * function call in SDL_main.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
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); 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);
@ -622,7 +622,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_RegisterApp(const char *name, Uint32 style, void *hInst); extern SDL_DECLSPEC bool SDLCALL SDL_RegisterApp(const char *name, Uint32 style, void *hInst);
@ -639,7 +639,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RegisterApp(const char *name, Uint32 style,
* deregistered when the registration counter in SDL_RegisterApp decrements to * deregistered when the registration counter in SDL_RegisterApp decrements to
* zero through calls to this function. * zero through calls to this function.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_UnregisterApp(void); extern SDL_DECLSPEC void SDLCALL SDL_UnregisterApp(void);
@ -651,7 +651,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnregisterApp(void);
* This function is only needed for Xbox GDK support; all other platforms will * This function is only needed for Xbox GDK support; all other platforms will
* do nothing and set an "unsupported" error message. * do nothing and set an "unsupported" error message.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_GDKSuspendComplete(void); extern SDL_DECLSPEC void SDLCALL SDL_GDKSuspendComplete(void);

16
include/SDL3/SDL_messagebox.h
View file

@ -54,7 +54,7 @@ extern "C" {
* *
* If supported will display warning icon, etc. * If supported will display warning icon, etc.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_MessageBoxFlags; typedef Uint32 SDL_MessageBoxFlags;
@ -67,7 +67,7 @@ typedef Uint32 SDL_MessageBoxFlags;
/** /**
* SDL_MessageBoxButtonData flags. * SDL_MessageBoxButtonData flags.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_MessageBoxButtonFlags; typedef Uint32 SDL_MessageBoxButtonFlags;
@ -77,7 +77,7 @@ typedef Uint32 SDL_MessageBoxButtonFlags;
/** /**
* Individual button data. * Individual button data.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MessageBoxButtonData typedef struct SDL_MessageBoxButtonData
{ {
@ -89,7 +89,7 @@ typedef struct SDL_MessageBoxButtonData
/** /**
* RGB value used in a message box color scheme * RGB value used in a message box color scheme
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MessageBoxColor typedef struct SDL_MessageBoxColor
{ {
@ -113,7 +113,7 @@ typedef enum SDL_MessageBoxColorType
/** /**
* A set of colors to use for message box dialogs * A set of colors to use for message box dialogs
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MessageBoxColorScheme typedef struct SDL_MessageBoxColorScheme
{ {
@ -123,7 +123,7 @@ typedef struct SDL_MessageBoxColorScheme
/** /**
* MessageBox structure containing title, text, window, etc. * MessageBox structure containing title, text, window, etc.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_MessageBoxData typedef struct SDL_MessageBoxData
{ {
@ -168,7 +168,7 @@ typedef struct SDL_MessageBoxData
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ShowSimpleMessageBox * \sa SDL_ShowSimpleMessageBox
*/ */
@ -210,7 +210,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ShowMessageBox * \sa SDL_ShowMessageBox
*/ */

8
include/SDL3/SDL_metal.h
View file

@ -43,7 +43,7 @@ extern "C" {
/** /**
* A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS). * A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef void *SDL_MetalView; typedef void *SDL_MetalView;
@ -65,7 +65,7 @@ typedef void *SDL_MetalView;
* \param window the window. * \param window the window.
* \returns handle NSView or UIView. * \returns handle NSView or UIView.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Metal_DestroyView * \sa SDL_Metal_DestroyView
* \sa SDL_Metal_GetLayer * \sa SDL_Metal_GetLayer
@ -80,7 +80,7 @@ extern SDL_DECLSPEC SDL_MetalView SDLCALL SDL_Metal_CreateView(SDL_Window *windo
* *
* \param view the SDL_MetalView object. * \param view the SDL_MetalView object.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Metal_CreateView * \sa SDL_Metal_CreateView
*/ */
@ -92,7 +92,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view);
* \param view the SDL_MetalView object. * \param view the SDL_MetalView object.
* \returns a pointer. * \returns a pointer.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void * SDLCALL SDL_Metal_GetLayer(SDL_MetalView view); extern SDL_DECLSPEC void * SDLCALL SDL_Metal_GetLayer(SDL_MetalView view);

2
include/SDL3/SDL_misc.h
View file

@ -65,7 +65,7 @@ extern "C" {
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_OpenURL(const char *url); extern SDL_DECLSPEC bool SDLCALL SDL_OpenURL(const char *url);

54
include/SDL3/SDL_mouse.h
View file

@ -76,7 +76,7 @@ extern "C" {
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_MouseID; typedef Uint32 SDL_MouseID;
@ -85,14 +85,14 @@ typedef Uint32 SDL_MouseID;
* *
* This is opaque data. * This is opaque data.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Cursor SDL_Cursor; typedef struct SDL_Cursor SDL_Cursor;
/** /**
* Cursor types for SDL_CreateSystemCursor(). * Cursor types for SDL_CreateSystemCursor().
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_SystemCursor typedef enum SDL_SystemCursor
{ {
@ -122,7 +122,7 @@ typedef enum SDL_SystemCursor
/** /**
* Scroll direction types for the Scroll event * Scroll direction types for the Scroll event
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_MouseWheelDirection typedef enum SDL_MouseWheelDirection
{ {
@ -139,7 +139,7 @@ typedef enum SDL_MouseWheelDirection
* - Button 4: Side mouse button 1 * - Button 4: Side mouse button 1
* - Button 5: Side mouse button 2 * - Button 5: Side mouse button 2
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_GetMouseState * \sa SDL_GetMouseState
* \sa SDL_GetGlobalMouseState * \sa SDL_GetGlobalMouseState
@ -170,7 +170,7 @@ typedef Uint32 SDL_MouseButtonFlags;
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMice * \sa SDL_GetMice
*/ */
@ -192,7 +192,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasMouse(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMouseNameForID * \sa SDL_GetMouseNameForID
* \sa SDL_HasMouse * \sa SDL_HasMouse
@ -210,7 +210,7 @@ extern SDL_DECLSPEC SDL_MouseID * SDLCALL SDL_GetMice(int *count);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMice * \sa SDL_GetMice
*/ */
@ -223,7 +223,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetMouseNameForID(SDL_MouseID insta
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void); extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
@ -253,7 +253,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGlobalMouseState * \sa SDL_GetGlobalMouseState
* \sa SDL_GetRelativeMouseState * \sa SDL_GetRelativeMouseState
@ -289,7 +289,7 @@ extern SDL_DECLSPEC SDL_MouseButtonFlags SDLCALL SDL_GetMouseState(float *x, flo
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CaptureMouse * \sa SDL_CaptureMouse
* \sa SDL_GetMouseState * \sa SDL_GetMouseState
@ -325,7 +325,7 @@ extern SDL_DECLSPEC SDL_MouseButtonFlags SDLCALL SDL_GetGlobalMouseState(float *
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMouseState * \sa SDL_GetMouseState
* \sa SDL_GetGlobalMouseState * \sa SDL_GetGlobalMouseState
@ -349,7 +349,7 @@ extern SDL_DECLSPEC SDL_MouseButtonFlags SDLCALL SDL_GetRelativeMouseState(float
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WarpMouseGlobal * \sa SDL_WarpMouseGlobal
*/ */
@ -374,7 +374,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WarpMouseInWindow * \sa SDL_WarpMouseInWindow
*/ */
@ -402,7 +402,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WarpMouseGlobal(float x, float y);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetWindowRelativeMouseMode * \sa SDL_GetWindowRelativeMouseMode
*/ */
@ -416,7 +416,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowRelativeMouseMode(SDL_Window *wind
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetWindowRelativeMouseMode * \sa SDL_SetWindowRelativeMouseMode
*/ */
@ -464,7 +464,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowRelativeMouseMode(SDL_Window *wind
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetGlobalMouseState * \sa SDL_GetGlobalMouseState
*/ */
@ -507,7 +507,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CaptureMouse(bool enabled);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateColorCursor * \sa SDL_CreateColorCursor
* \sa SDL_CreateSystemCursor * \sa SDL_CreateSystemCursor
@ -540,7 +540,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor(const Uint8 * data,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateCursor * \sa SDL_CreateCursor
* \sa SDL_CreateSystemCursor * \sa SDL_CreateSystemCursor
@ -560,7 +560,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateColorCursor(SDL_Surface *surf
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyCursor * \sa SDL_DestroyCursor
*/ */
@ -580,7 +580,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCursor * \sa SDL_GetCursor
*/ */
@ -596,7 +596,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCursor(SDL_Cursor *cursor);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetCursor * \sa SDL_SetCursor
*/ */
@ -613,7 +613,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_GetCursor(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_GetDefaultCursor(void); extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_GetDefaultCursor(void);
@ -627,7 +627,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_GetDefaultCursor(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateColorCursor * \sa SDL_CreateColorCursor
* \sa SDL_CreateCursor * \sa SDL_CreateCursor
@ -643,7 +643,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyCursor(SDL_Cursor *cursor);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CursorVisible * \sa SDL_CursorVisible
* \sa SDL_HideCursor * \sa SDL_HideCursor
@ -658,7 +658,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowCursor(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CursorVisible * \sa SDL_CursorVisible
* \sa SDL_ShowCursor * \sa SDL_ShowCursor
@ -673,7 +673,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HideCursor(void);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HideCursor * \sa SDL_HideCursor
* \sa SDL_ShowCursor * \sa SDL_ShowCursor

108
include/SDL3/SDL_mutex.h
View file

@ -72,7 +72,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_CAPABILITY(x) \ #define SDL_CAPABILITY(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(capability(x))
@ -82,7 +82,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_SCOPED_CAPABILITY \ #define SDL_SCOPED_CAPABILITY \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(scoped_lockable) SDL_THREAD_ANNOTATION_ATTRIBUTE__(scoped_lockable)
@ -92,7 +92,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_GUARDED_BY(x) \ #define SDL_GUARDED_BY(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(guarded_by(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(guarded_by(x))
@ -102,7 +102,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PT_GUARDED_BY(x) \ #define SDL_PT_GUARDED_BY(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(pt_guarded_by(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(pt_guarded_by(x))
@ -112,7 +112,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ACQUIRED_BEFORE(x) \ #define SDL_ACQUIRED_BEFORE(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquired_before(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquired_before(x))
@ -122,7 +122,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ACQUIRED_AFTER(x) \ #define SDL_ACQUIRED_AFTER(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquired_after(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquired_after(x))
@ -132,7 +132,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_REQUIRES(x) \ #define SDL_REQUIRES(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(requires_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(requires_capability(x))
@ -142,7 +142,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_REQUIRES_SHARED(x) \ #define SDL_REQUIRES_SHARED(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(requires_shared_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(requires_shared_capability(x))
@ -152,7 +152,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ACQUIRE(x) \ #define SDL_ACQUIRE(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquire_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquire_capability(x))
@ -162,7 +162,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ACQUIRE_SHARED(x) \ #define SDL_ACQUIRE_SHARED(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquire_shared_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(acquire_shared_capability(x))
@ -172,7 +172,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_RELEASE(x) \ #define SDL_RELEASE(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(release_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(release_capability(x))
@ -182,7 +182,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_RELEASE_SHARED(x) \ #define SDL_RELEASE_SHARED(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(release_shared_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(release_shared_capability(x))
@ -192,7 +192,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_RELEASE_GENERIC(x) \ #define SDL_RELEASE_GENERIC(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(release_generic_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(release_generic_capability(x))
@ -202,7 +202,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_TRY_ACQUIRE(x, y) \ #define SDL_TRY_ACQUIRE(x, y) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_capability(x, y)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_capability(x, y))
@ -212,7 +212,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_TRY_ACQUIRE_SHARED(x, y) \ #define SDL_TRY_ACQUIRE_SHARED(x, y) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_shared_capability(x, y)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(try_acquire_shared_capability(x, y))
@ -222,7 +222,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_EXCLUDES(x) \ #define SDL_EXCLUDES(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(locks_excluded(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(locks_excluded(x))
@ -232,7 +232,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ASSERT_CAPABILITY(x) \ #define SDL_ASSERT_CAPABILITY(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(assert_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(assert_capability(x))
@ -242,7 +242,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ASSERT_SHARED_CAPABILITY(x) \ #define SDL_ASSERT_SHARED_CAPABILITY(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(assert_shared_capability(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(assert_shared_capability(x))
@ -252,7 +252,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_RETURN_CAPABILITY(x) \ #define SDL_RETURN_CAPABILITY(x) \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(lock_returned(x)) SDL_THREAD_ANNOTATION_ATTRIBUTE__(lock_returned(x))
@ -262,7 +262,7 @@
* *
* Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h * Please see https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#mutex-h
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_NO_THREAD_SAFETY_ANALYSIS \ #define SDL_NO_THREAD_SAFETY_ANALYSIS \
SDL_THREAD_ANNOTATION_ATTRIBUTE__(no_thread_safety_analysis) SDL_THREAD_ANNOTATION_ATTRIBUTE__(no_thread_safety_analysis)
@ -291,7 +291,7 @@ extern "C" {
* *
* https://en.wikipedia.org/wiki/Mutex * https://en.wikipedia.org/wiki/Mutex
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Mutex SDL_Mutex; typedef struct SDL_Mutex SDL_Mutex;
@ -308,7 +308,7 @@ typedef struct SDL_Mutex SDL_Mutex;
* \returns the initialized and unlocked mutex or NULL on failure; call * \returns the initialized and unlocked mutex or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyMutex * \sa SDL_DestroyMutex
* \sa SDL_LockMutex * \sa SDL_LockMutex
@ -334,7 +334,7 @@ extern SDL_DECLSPEC SDL_Mutex * SDLCALL SDL_CreateMutex(void);
* *
* \param mutex the mutex to lock. * \param mutex the mutex to lock.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_TryLockMutex * \sa SDL_TryLockMutex
* \sa SDL_UnlockMutex * \sa SDL_UnlockMutex
@ -355,7 +355,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockMutex(SDL_Mutex *mutex) SDL_ACQUIRE(mut
* \param mutex the mutex to try to lock. * \param mutex the mutex to try to lock.
* \returns true on success, false if the mutex would block. * \returns true on success, false if the mutex would block.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockMutex * \sa SDL_LockMutex
* \sa SDL_UnlockMutex * \sa SDL_UnlockMutex
@ -374,7 +374,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockMutex(SDL_Mutex *mutex) SDL_TRY_ACQU
* *
* \param mutex the mutex to unlock. * \param mutex the mutex to unlock.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockMutex * \sa SDL_LockMutex
* \sa SDL_TryLockMutex * \sa SDL_TryLockMutex
@ -392,7 +392,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockMutex(SDL_Mutex *mutex) SDL_RELEASE(m
* *
* \param mutex the mutex to destroy. * \param mutex the mutex to destroy.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateMutex * \sa SDL_CreateMutex
*/ */
@ -422,7 +422,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_Mutex *mutex);
* about how threads are scheduled and when they can be recursively locked. * about how threads are scheduled and when they can be recursively locked.
* These are documented in the other rwlock functions. * These are documented in the other rwlock functions.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_RWLock SDL_RWLock; typedef struct SDL_RWLock SDL_RWLock;
@ -457,7 +457,7 @@ typedef struct SDL_RWLock SDL_RWLock;
* \returns the initialized and unlocked read/write lock or NULL on failure; * \returns the initialized and unlocked read/write lock or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyRWLock * \sa SDL_DestroyRWLock
* \sa SDL_LockRWLockForReading * \sa SDL_LockRWLockForReading
@ -497,7 +497,7 @@ extern SDL_DECLSPEC SDL_RWLock * SDLCALL SDL_CreateRWLock(void);
* *
* \param rwlock the read/write lock to lock. * \param rwlock the read/write lock to lock.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockRWLockForWriting * \sa SDL_LockRWLockForWriting
* \sa SDL_TryLockRWLockForReading * \sa SDL_TryLockRWLockForReading
@ -528,7 +528,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockRWLockForReading(SDL_RWLock *rwlock) SD
* *
* \param rwlock the read/write lock to lock. * \param rwlock the read/write lock to lock.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockRWLockForReading * \sa SDL_LockRWLockForReading
* \sa SDL_TryLockRWLockForWriting * \sa SDL_TryLockRWLockForWriting
@ -553,7 +553,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockRWLockForWriting(SDL_RWLock *rwlock) SD
* \param rwlock the rwlock to try to lock. * \param rwlock the rwlock to try to lock.
* \returns true on success, false if the lock would block. * \returns true on success, false if the lock would block.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockRWLockForReading * \sa SDL_LockRWLockForReading
* \sa SDL_TryLockRWLockForWriting * \sa SDL_TryLockRWLockForWriting
@ -583,7 +583,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockRWLockForReading(SDL_RWLock *rwlock)
* \param rwlock the rwlock to try to lock. * \param rwlock the rwlock to try to lock.
* \returns true on success, false if the lock would block. * \returns true on success, false if the lock would block.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockRWLockForWriting * \sa SDL_LockRWLockForWriting
* \sa SDL_TryLockRWLockForReading * \sa SDL_TryLockRWLockForReading
@ -607,7 +607,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockRWLockForWriting(SDL_RWLock *rwlock)
* *
* \param rwlock the rwlock to unlock. * \param rwlock the rwlock to unlock.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockRWLockForReading * \sa SDL_LockRWLockForReading
* \sa SDL_LockRWLockForWriting * \sa SDL_LockRWLockForWriting
@ -627,7 +627,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockRWLock(SDL_RWLock *rwlock) SDL_RELEAS
* *
* \param rwlock the rwlock to destroy. * \param rwlock the rwlock to destroy.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRWLock * \sa SDL_CreateRWLock
*/ */
@ -653,7 +653,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyRWLock(SDL_RWLock *rwlock);
* *
* https://en.wikipedia.org/wiki/Semaphore_(programming) * https://en.wikipedia.org/wiki/Semaphore_(programming)
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Semaphore SDL_Semaphore; typedef struct SDL_Semaphore SDL_Semaphore;
@ -670,7 +670,7 @@ typedef struct SDL_Semaphore SDL_Semaphore;
* \returns a new semaphore or NULL on failure; call SDL_GetError() for more * \returns a new semaphore or NULL on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroySemaphore * \sa SDL_DestroySemaphore
* \sa SDL_SignalSemaphore * \sa SDL_SignalSemaphore
@ -689,7 +689,7 @@ extern SDL_DECLSPEC SDL_Semaphore * SDLCALL SDL_CreateSemaphore(Uint32 initial_v
* *
* \param sem the semaphore to destroy. * \param sem the semaphore to destroy.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateSemaphore * \sa SDL_CreateSemaphore
*/ */
@ -707,7 +707,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_Semaphore *sem);
* *
* \param sem the semaphore wait on. * \param sem the semaphore wait on.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SignalSemaphore * \sa SDL_SignalSemaphore
* \sa SDL_TryWaitSemaphore * \sa SDL_TryWaitSemaphore
@ -726,7 +726,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitSemaphore(SDL_Semaphore *sem);
* \param sem the semaphore to wait on. * \param sem the semaphore to wait on.
* \returns true if the wait succeeds, false if the wait would block. * \returns true if the wait succeeds, false if the wait would block.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SignalSemaphore * \sa SDL_SignalSemaphore
* \sa SDL_WaitSemaphore * \sa SDL_WaitSemaphore
@ -746,7 +746,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryWaitSemaphore(SDL_Semaphore *sem);
* indefinitely. * indefinitely.
* \returns true if the wait succeeds or false if the wait times out. * \returns true if the wait succeeds or false if the wait times out.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SignalSemaphore * \sa SDL_SignalSemaphore
* \sa SDL_TryWaitSemaphore * \sa SDL_TryWaitSemaphore
@ -759,7 +759,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Si
* *
* \param sem the semaphore to increment. * \param sem the semaphore to increment.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_TryWaitSemaphore * \sa SDL_TryWaitSemaphore
* \sa SDL_WaitSemaphore * \sa SDL_WaitSemaphore
@ -773,7 +773,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalSemaphore(SDL_Semaphore *sem);
* \param sem the semaphore to query. * \param sem the semaphore to query.
* \returns the current value of the semaphore. * \returns the current value of the semaphore.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetSemaphoreValue(SDL_Semaphore *sem); extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetSemaphoreValue(SDL_Semaphore *sem);
@ -796,7 +796,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetSemaphoreValue(SDL_Semaphore *sem);
* *
* https://en.wikipedia.org/wiki/Condition_variable * https://en.wikipedia.org/wiki/Condition_variable
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Condition SDL_Condition; typedef struct SDL_Condition SDL_Condition;
@ -806,7 +806,7 @@ typedef struct SDL_Condition SDL_Condition;
* \returns a new condition variable or NULL on failure; call SDL_GetError() * \returns a new condition variable or NULL on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BroadcastCondition * \sa SDL_BroadcastCondition
* \sa SDL_SignalCondition * \sa SDL_SignalCondition
@ -821,7 +821,7 @@ extern SDL_DECLSPEC SDL_Condition * SDLCALL SDL_CreateCondition(void);
* *
* \param cond the condition variable to destroy. * \param cond the condition variable to destroy.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateCondition * \sa SDL_CreateCondition
*/ */
@ -834,7 +834,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyCondition(SDL_Condition *cond);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BroadcastCondition * \sa SDL_BroadcastCondition
* \sa SDL_WaitCondition * \sa SDL_WaitCondition
@ -849,7 +849,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalCondition(SDL_Condition *cond);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SignalCondition * \sa SDL_SignalCondition
* \sa SDL_WaitCondition * \sa SDL_WaitCondition
@ -877,7 +877,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BroadcastCondition(SDL_Condition *cond);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BroadcastCondition * \sa SDL_BroadcastCondition
* \sa SDL_SignalCondition * \sa SDL_SignalCondition
@ -907,7 +907,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitCondition(SDL_Condition *cond, SDL_Mute
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BroadcastCondition * \sa SDL_BroadcastCondition
* \sa SDL_SignalCondition * \sa SDL_SignalCondition
@ -926,7 +926,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitConditionTimeout(SDL_Condition *cond,
/** /**
* The current status of an SDL_InitState structure. * The current status of an SDL_InitState structure.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_InitStatus typedef enum SDL_InitStatus
{ {
@ -990,7 +990,7 @@ typedef enum SDL_InitStatus
* should use other mechanisms to protect those, if that's a concern for your * should use other mechanisms to protect those, if that's a concern for your
* code. * code.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_InitState typedef struct SDL_InitState
{ {
@ -1015,7 +1015,7 @@ typedef struct SDL_InitState
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetInitialized * \sa SDL_SetInitialized
* \sa SDL_ShouldQuit * \sa SDL_ShouldQuit
@ -1036,7 +1036,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShouldInit(SDL_InitState *state);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetInitialized * \sa SDL_SetInitialized
* \sa SDL_ShouldInit * \sa SDL_ShouldInit
@ -1055,7 +1055,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShouldQuit(SDL_InitState *state);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ShouldInit * \sa SDL_ShouldInit
* \sa SDL_ShouldQuit * \sa SDL_ShouldQuit

10
include/SDL3/SDL_pen.h
View file

@ -57,21 +57,21 @@ extern "C" {
* consistent as long as SDL can recognize a tool to be the same pen; but if a * 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. * pen physically leaves the area and returns, it might get a new ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_PenID; typedef Uint32 SDL_PenID;
/** /**
* The SDL_MouseID for mouse events simulated with pen input. * The SDL_MouseID for mouse events simulated with pen input.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PEN_MOUSEID ((SDL_MouseID)-2) #define SDL_PEN_MOUSEID ((SDL_MouseID)-2)
/** /**
* The SDL_TouchID for touch events simulated with pen input. * The SDL_TouchID for touch events simulated with pen input.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PEN_TOUCHID ((SDL_TouchID)-2) #define SDL_PEN_TOUCHID ((SDL_TouchID)-2)
@ -79,7 +79,7 @@ typedef Uint32 SDL_PenID;
/** /**
* Pen input flags, as reported by various pen events' `pen_state` field. * Pen input flags, as reported by various pen events' `pen_state` field.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_PenInputFlags; typedef Uint32 SDL_PenInputFlags;
@ -104,7 +104,7 @@ typedef Uint32 SDL_PenInputFlags;
* *
* `SDL_sinf(xtilt * SDL_PI_F / 180.0)`. * `SDL_sinf(xtilt * SDL_PI_F / 180.0)`.
* *
* \since This enum is available since SDL 3.1.3 * \since This enum is available since SDL 3.2.0
*/ */
typedef enum SDL_PenAxis typedef enum SDL_PenAxis
{ {

118
include/SDL3/SDL_pixels.h
View file

@ -93,7 +93,7 @@ extern "C" {
/** /**
* A fully opaque 8-bit alpha value. * A fully opaque 8-bit alpha value.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_ALPHA_TRANSPARENT * \sa SDL_ALPHA_TRANSPARENT
*/ */
@ -102,7 +102,7 @@ extern "C" {
/** /**
* A fully opaque floating point alpha value. * A fully opaque floating point alpha value.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_ALPHA_TRANSPARENT_FLOAT * \sa SDL_ALPHA_TRANSPARENT_FLOAT
*/ */
@ -111,7 +111,7 @@ extern "C" {
/** /**
* A fully transparent 8-bit alpha value. * A fully transparent 8-bit alpha value.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_ALPHA_OPAQUE * \sa SDL_ALPHA_OPAQUE
*/ */
@ -120,7 +120,7 @@ extern "C" {
/** /**
* A fully transparent floating point alpha value. * A fully transparent floating point alpha value.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_ALPHA_OPAQUE_FLOAT * \sa SDL_ALPHA_OPAQUE_FLOAT
*/ */
@ -129,7 +129,7 @@ extern "C" {
/** /**
* Pixel type. * Pixel type.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_PixelType typedef enum SDL_PixelType
{ {
@ -152,7 +152,7 @@ typedef enum SDL_PixelType
/** /**
* Bitmap pixel order, high bit -> low bit. * Bitmap pixel order, high bit -> low bit.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_BitmapOrder typedef enum SDL_BitmapOrder
{ {
@ -164,7 +164,7 @@ typedef enum SDL_BitmapOrder
/** /**
* Packed component order, high bit -> low bit. * Packed component order, high bit -> low bit.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_PackedOrder typedef enum SDL_PackedOrder
{ {
@ -182,7 +182,7 @@ typedef enum SDL_PackedOrder
/** /**
* Array component order, low byte -> high byte. * Array component order, low byte -> high byte.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ArrayOrder typedef enum SDL_ArrayOrder
{ {
@ -198,7 +198,7 @@ typedef enum SDL_ArrayOrder
/** /**
* Packed component layout. * Packed component layout.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_PackedLayout typedef enum SDL_PackedLayout
{ {
@ -230,7 +230,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D) #define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
@ -254,7 +254,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \ #define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \ ((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
@ -271,7 +271,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PIXELFLAG(format) (((format) >> 28) & 0x0F) #define SDL_PIXELFLAG(format) (((format) >> 28) & 0x0F)
@ -285,7 +285,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PIXELTYPE(format) (((format) >> 24) & 0x0F) #define SDL_PIXELTYPE(format) (((format) >> 24) & 0x0F)
@ -300,7 +300,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PIXELORDER(format) (((format) >> 20) & 0x0F) #define SDL_PIXELORDER(format) (((format) >> 20) & 0x0F)
@ -315,7 +315,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PIXELLAYOUT(format) (((format) >> 16) & 0x0F) #define SDL_PIXELLAYOUT(format) (((format) >> 16) & 0x0F)
@ -333,7 +333,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_BYTESPERPIXEL * \sa SDL_BYTESPERPIXEL
*/ */
@ -354,7 +354,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_BITSPERPIXEL * \sa SDL_BITSPERPIXEL
*/ */
@ -377,7 +377,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_INDEXED(format) \ #define SDL_ISPIXELFORMAT_INDEXED(format) \
(!SDL_ISPIXELFORMAT_FOURCC(format) && \ (!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ -397,7 +397,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_PACKED(format) \ #define SDL_ISPIXELFORMAT_PACKED(format) \
(!SDL_ISPIXELFORMAT_FOURCC(format) && \ (!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ -416,7 +416,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_ARRAY(format) \ #define SDL_ISPIXELFORMAT_ARRAY(format) \
(!SDL_ISPIXELFORMAT_FOURCC(format) && \ (!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ -437,7 +437,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_10BIT(format) \ #define SDL_ISPIXELFORMAT_10BIT(format) \
(!SDL_ISPIXELFORMAT_FOURCC(format) && \ (!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ -455,7 +455,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_FLOAT(format) \ #define SDL_ISPIXELFORMAT_FLOAT(format) \
(!SDL_ISPIXELFORMAT_FOURCC(format) && \ (!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ -473,7 +473,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_ALPHA(format) \ #define SDL_ISPIXELFORMAT_ALPHA(format) \
((SDL_ISPIXELFORMAT_PACKED(format) && \ ((SDL_ISPIXELFORMAT_PACKED(format) && \
@ -501,7 +501,7 @@ typedef enum SDL_PackedLayout
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISPIXELFORMAT_FOURCC(format) /* The flag is set to 1 because 0x1? is not in the printable ASCII range */ \ #define SDL_ISPIXELFORMAT_FOURCC(format) /* The flag is set to 1 because 0x1? is not in the printable ASCII range */ \
((format) && (SDL_PIXELFLAG(format) != 1)) ((format) && (SDL_PIXELFLAG(format) != 1))
@ -543,7 +543,7 @@ typedef enum SDL_PackedLayout
* an alias for ABGR8888 on little-endian CPUs like x86, or an alias for * an alias for ABGR8888 on little-endian CPUs like x86, or an alias for
* RGBA8888 on big-endian CPUs. * RGBA8888 on big-endian CPUs.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_PixelFormat typedef enum SDL_PixelFormat
{ {
@ -701,7 +701,7 @@ typedef enum SDL_PixelFormat
/** /**
* Colorspace color type. * Colorspace color type.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ColorType typedef enum SDL_ColorType
{ {
@ -714,7 +714,7 @@ typedef enum SDL_ColorType
* Colorspace color range, as described by * Colorspace color range, as described by
* https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en * https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ColorRange typedef enum SDL_ColorRange
{ {
@ -727,7 +727,7 @@ typedef enum SDL_ColorRange
* Colorspace color primaries, as described by * Colorspace color primaries, as described by
* https://www.itu.int/rec/T-REC-H.273-201612-S/en * https://www.itu.int/rec/T-REC-H.273-201612-S/en
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ColorPrimaries typedef enum SDL_ColorPrimaries
{ {
@ -752,7 +752,7 @@ typedef enum SDL_ColorPrimaries
* *
* These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en * 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.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_TransferCharacteristics typedef enum SDL_TransferCharacteristics
{ {
@ -782,7 +782,7 @@ typedef enum SDL_TransferCharacteristics
* *
* These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en * 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.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_MatrixCoefficients typedef enum SDL_MatrixCoefficients
{ {
@ -806,7 +806,7 @@ typedef enum SDL_MatrixCoefficients
/** /**
* Colorspace chroma sample location. * Colorspace chroma sample location.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ChromaLocation typedef enum SDL_ChromaLocation
{ {
@ -847,7 +847,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_DEFINE_COLORSPACE(type, range, primaries, transfer, matrix, chroma) \ #define SDL_DEFINE_COLORSPACE(type, range, primaries, transfer, matrix, chroma) \
(((Uint32)(type) << 28) | ((Uint32)(range) << 24) | ((Uint32)(chroma) << 20) | \ (((Uint32)(type) << 28) | ((Uint32)(range) << 24) | ((Uint32)(chroma) << 20) | \
@ -861,7 +861,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_COLORSPACETYPE(cspace) (SDL_ColorType)(((cspace) >> 28) & 0x0F) #define SDL_COLORSPACETYPE(cspace) (SDL_ColorType)(((cspace) >> 28) & 0x0F)
@ -873,7 +873,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_COLORSPACERANGE(cspace) (SDL_ColorRange)(((cspace) >> 24) & 0x0F) #define SDL_COLORSPACERANGE(cspace) (SDL_ColorRange)(((cspace) >> 24) & 0x0F)
@ -885,7 +885,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_COLORSPACECHROMA(cspace) (SDL_ChromaLocation)(((cspace) >> 20) & 0x0F) #define SDL_COLORSPACECHROMA(cspace) (SDL_ChromaLocation)(((cspace) >> 20) & 0x0F)
@ -897,7 +897,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_COLORSPACEPRIMARIES(cspace) (SDL_ColorPrimaries)(((cspace) >> 10) & 0x1F) #define SDL_COLORSPACEPRIMARIES(cspace) (SDL_ColorPrimaries)(((cspace) >> 10) & 0x1F)
@ -909,7 +909,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_COLORSPACETRANSFER(cspace) (SDL_TransferCharacteristics)(((cspace) >> 5) & 0x1F) #define SDL_COLORSPACETRANSFER(cspace) (SDL_TransferCharacteristics)(((cspace) >> 5) & 0x1F)
@ -921,7 +921,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_COLORSPACEMATRIX(cspace) (SDL_MatrixCoefficients)((cspace) & 0x1F) #define SDL_COLORSPACEMATRIX(cspace) (SDL_MatrixCoefficients)((cspace) & 0x1F)
@ -937,7 +937,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISCOLORSPACE_MATRIX_BT601(cspace) (SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT601 || SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT470BG) #define SDL_ISCOLORSPACE_MATRIX_BT601(cspace) (SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT601 || SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT470BG)
@ -949,7 +949,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISCOLORSPACE_MATRIX_BT709(cspace) (SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT709) #define SDL_ISCOLORSPACE_MATRIX_BT709(cspace) (SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT709)
@ -962,7 +962,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISCOLORSPACE_MATRIX_BT2020_NCL(cspace) (SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT2020_NCL) #define SDL_ISCOLORSPACE_MATRIX_BT2020_NCL(cspace) (SDL_COLORSPACEMATRIX(cspace) == SDL_MATRIX_COEFFICIENTS_BT2020_NCL)
@ -974,7 +974,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISCOLORSPACE_LIMITED_RANGE(cspace) (SDL_COLORSPACERANGE(cspace) != SDL_COLOR_RANGE_FULL) #define SDL_ISCOLORSPACE_LIMITED_RANGE(cspace) (SDL_COLORSPACERANGE(cspace) != SDL_COLOR_RANGE_FULL)
@ -986,7 +986,7 @@ typedef enum SDL_ChromaLocation
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ISCOLORSPACE_FULL_RANGE(cspace) (SDL_COLORSPACERANGE(cspace) == SDL_COLOR_RANGE_FULL) #define SDL_ISCOLORSPACE_FULL_RANGE(cspace) (SDL_COLORSPACERANGE(cspace) == SDL_COLOR_RANGE_FULL)
@ -997,7 +997,7 @@ typedef enum SDL_ChromaLocation
* function, etc.), this is not an exhaustive list, but rather a * function, etc.), this is not an exhaustive list, but rather a
* representative sample of the kinds of colorspaces supported in SDL. * representative sample of the kinds of colorspaces supported in SDL.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_ColorPrimaries * \sa SDL_ColorPrimaries
* \sa SDL_ColorRange * \sa SDL_ColorRange
@ -1104,7 +1104,7 @@ typedef enum SDL_Colorspace
* (SDL_PIXELFORMAT_ABGR8888 on little-endian systems and * (SDL_PIXELFORMAT_ABGR8888 on little-endian systems and
* SDL_PIXELFORMAT_RGBA8888 on big-endian systems). * SDL_PIXELFORMAT_RGBA8888 on big-endian systems).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Color typedef struct SDL_Color
{ {
@ -1118,7 +1118,7 @@ typedef struct SDL_Color
* The bits of this structure can be directly reinterpreted as a float-packed * The bits of this structure can be directly reinterpreted as a float-packed
* color which uses the SDL_PIXELFORMAT_RGBA128_FLOAT format * color which uses the SDL_PIXELFORMAT_RGBA128_FLOAT format
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_FColor typedef struct SDL_FColor
{ {
@ -1131,7 +1131,7 @@ typedef struct SDL_FColor
/** /**
* A set of indexed colors representing a palette. * A set of indexed colors representing a palette.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_SetPaletteColors * \sa SDL_SetPaletteColors
*/ */
@ -1146,7 +1146,7 @@ typedef struct SDL_Palette
/** /**
* Details about the format of a pixel. * Details about the format of a pixel.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_PixelFormatDetails typedef struct SDL_PixelFormatDetails
{ {
@ -1177,7 +1177,7 @@ typedef struct SDL_PixelFormatDetails
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat format); extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat format);
@ -1195,7 +1195,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPixelFormatForMasks * \sa SDL_GetPixelFormatForMasks
*/ */
@ -1217,7 +1217,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetMasksForPixelFormat(SDL_PixelFormat form
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetMasksForPixelFormat * \sa SDL_GetMasksForPixelFormat
*/ */
@ -1236,7 +1236,7 @@ extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetPixelFormatForMasks(int bpp,
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDetails(SDL_PixelFormat format); extern SDL_DECLSPEC const SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDetails(SDL_PixelFormat format);
@ -1252,7 +1252,7 @@ extern SDL_DECLSPEC const SDL_PixelFormatDetails * SDLCALL SDL_GetPixelFormatDet
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyPalette * \sa SDL_DestroyPalette
* \sa SDL_SetPaletteColors * \sa SDL_SetPaletteColors
@ -1273,7 +1273,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 * \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified or destroyed in another thread. * the palette is not modified or destroyed in another thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors); extern SDL_DECLSPEC bool SDLCALL SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors);
@ -1285,7 +1285,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 * \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified or destroyed in another thread. * the palette is not modified or destroyed in another thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreatePalette * \sa SDL_CreatePalette
*/ */
@ -1320,7 +1320,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 * \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified. * the palette is not modified.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPixelFormatDetails * \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGB * \sa SDL_GetRGB
@ -1359,7 +1359,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 * \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified. * the palette is not modified.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPixelFormatDetails * \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGBA * \sa SDL_GetRGBA
@ -1387,7 +1387,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 * \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified. * the palette is not modified.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPixelFormatDetails * \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGBA * \sa SDL_GetRGBA
@ -1419,7 +1419,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 * \threadsafety It is safe to call this function from any thread, as long as
* the palette is not modified. * the palette is not modified.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPixelFormatDetails * \sa SDL_GetPixelFormatDetails
* \sa SDL_GetRGB * \sa SDL_GetRGB

2
include/SDL3/SDL_platform.h
View file

@ -51,7 +51,7 @@ extern "C" {
* \returns the name of the platform. If the correct platform name is not * \returns the name of the platform. If the correct platform name is not
* available, returns a string beginning with the text "Unknown". * available, returns a string beginning with the text "Unknown".
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetPlatform(void); extern SDL_DECLSPEC const char * SDLCALL SDL_GetPlatform(void);

68
include/SDL3/SDL_platform_defines.h
View file

@ -33,7 +33,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for AIX. * A preprocessor macro that is only defined if compiling for AIX.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_AIX 1 #define SDL_PLATFORM_AIX 1
#endif #endif
@ -43,7 +43,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Haiku OS. * A preprocessor macro that is only defined if compiling for Haiku OS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_HAIKU 1 #define SDL_PLATFORM_HAIKU 1
#endif #endif
@ -53,7 +53,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for BSDi * A preprocessor macro that is only defined if compiling for BSDi
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_BSDI 1 #define SDL_PLATFORM_BSDI 1
#endif #endif
@ -63,7 +63,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for FreeBSD. * A preprocessor macro that is only defined if compiling for FreeBSD.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_FREEBSD 1 #define SDL_PLATFORM_FREEBSD 1
#endif #endif
@ -73,7 +73,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for HP-UX. * A preprocessor macro that is only defined if compiling for HP-UX.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_HPUX 1 #define SDL_PLATFORM_HPUX 1
#endif #endif
@ -83,7 +83,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for IRIX. * A preprocessor macro that is only defined if compiling for IRIX.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_IRIX 1 #define SDL_PLATFORM_IRIX 1
#endif #endif
@ -96,7 +96,7 @@
* Note that Android, although ostensibly a Linux-based system, will not * Note that Android, although ostensibly a Linux-based system, will not
* define this. It defines SDL_PLATFORM_ANDROID instead. * define this. It defines SDL_PLATFORM_ANDROID instead.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_LINUX 1 #define SDL_PLATFORM_LINUX 1
#endif #endif
@ -106,7 +106,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Android. * A preprocessor macro that is only defined if compiling for Android.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_ANDROID 1 #define SDL_PLATFORM_ANDROID 1
#undef SDL_PLATFORM_LINUX #undef SDL_PLATFORM_LINUX
@ -121,7 +121,7 @@
* Other platforms, like Linux, might define this in addition to their primary * Other platforms, like Linux, might define this in addition to their primary
* define. * define.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_UNIX 1 #define SDL_PLATFORM_UNIX 1
#endif #endif
@ -133,7 +133,7 @@
* *
* iOS, macOS, etc will additionally define a more specific platform macro. * iOS, macOS, etc will additionally define a more specific platform macro.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PLATFORM_MACOS * \sa SDL_PLATFORM_MACOS
* \sa SDL_PLATFORM_IOS * \sa SDL_PLATFORM_IOS
@ -180,7 +180,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for tvOS. * A preprocessor macro that is only defined if compiling for tvOS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PLATFORM_APPLE * \sa SDL_PLATFORM_APPLE
*/ */
@ -192,7 +192,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for VisionOS. * A preprocessor macro that is only defined if compiling for VisionOS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PLATFORM_APPLE * \sa SDL_PLATFORM_APPLE
*/ */
@ -204,7 +204,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for iOS. * A preprocessor macro that is only defined if compiling for iOS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PLATFORM_APPLE * \sa SDL_PLATFORM_APPLE
*/ */
@ -215,7 +215,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for macOS. * A preprocessor macro that is only defined if compiling for macOS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PLATFORM_APPLE * \sa SDL_PLATFORM_APPLE
*/ */
@ -232,7 +232,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Emscripten. * A preprocessor macro that is only defined if compiling for Emscripten.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_EMSCRIPTEN 1 #define SDL_PLATFORM_EMSCRIPTEN 1
#endif #endif
@ -242,7 +242,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for NetBSD. * A preprocessor macro that is only defined if compiling for NetBSD.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_NETBSD 1 #define SDL_PLATFORM_NETBSD 1
#endif #endif
@ -252,7 +252,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for OpenBSD. * A preprocessor macro that is only defined if compiling for OpenBSD.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_OPENBSD 1 #define SDL_PLATFORM_OPENBSD 1
#endif #endif
@ -262,7 +262,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for OS/2. * A preprocessor macro that is only defined if compiling for OS/2.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_OS2 1 #define SDL_PLATFORM_OS2 1
#endif #endif
@ -272,7 +272,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Tru64 (OSF/1). * A preprocessor macro that is only defined if compiling for Tru64 (OSF/1).
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_OSF 1 #define SDL_PLATFORM_OSF 1
#endif #endif
@ -282,7 +282,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for QNX Neutrino. * A preprocessor macro that is only defined if compiling for QNX Neutrino.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_QNXNTO 1 #define SDL_PLATFORM_QNXNTO 1
#endif #endif
@ -292,7 +292,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for RISC OS. * A preprocessor macro that is only defined if compiling for RISC OS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_RISCOS 1 #define SDL_PLATFORM_RISCOS 1
#endif #endif
@ -302,7 +302,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for SunOS/Solaris. * A preprocessor macro that is only defined if compiling for SunOS/Solaris.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_SOLARIS 1 #define SDL_PLATFORM_SOLARIS 1
#endif #endif
@ -312,7 +312,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Cygwin. * A preprocessor macro that is only defined if compiling for Cygwin.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_CYGWIN 1 #define SDL_PLATFORM_CYGWIN 1
#endif #endif
@ -325,7 +325,7 @@
* This also covers several other platforms, like Microsoft GDK, Xbox, WinRT, * This also covers several other platforms, like Microsoft GDK, Xbox, WinRT,
* etc. Each will have their own more-specific platform macros, too. * etc. Each will have their own more-specific platform macros, too.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_PLATFORM_WIN32 * \sa SDL_PLATFORM_WIN32
* \sa SDL_PLATFORM_XBOXONE * \sa SDL_PLATFORM_XBOXONE
@ -362,7 +362,7 @@
/** /**
* A preprocessor macro that defined to 1 if compiling for Windows Phone. * A preprocessor macro that defined to 1 if compiling for Windows Phone.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_WINAPI_FAMILY_PHONE (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP) #define SDL_WINAPI_FAMILY_PHONE (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP)
@ -381,7 +381,7 @@
* A preprocessor macro that is only defined if compiling for Microsoft GDK * A preprocessor macro that is only defined if compiling for Microsoft GDK
* for Windows. * for Windows.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_WINGDK 1 #define SDL_PLATFORM_WINGDK 1
@ -390,7 +390,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Xbox One. * A preprocessor macro that is only defined if compiling for Xbox One.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_XBOXONE 1 #define SDL_PLATFORM_XBOXONE 1
@ -399,7 +399,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Xbox Series. * A preprocessor macro that is only defined if compiling for Xbox Series.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_XBOXSERIES 1 #define SDL_PLATFORM_XBOXSERIES 1
@ -412,7 +412,7 @@
* convention, its system layer tends to still be referred to as "the Win32 * convention, its system layer tends to still be referred to as "the Win32
* API." * API."
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_WIN32 1 #define SDL_PLATFORM_WIN32 1
@ -427,7 +427,7 @@
* A preprocessor macro that is only defined if compiling for Microsoft GDK on * A preprocessor macro that is only defined if compiling for Microsoft GDK on
* any platform. * any platform.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_GDK 1 #define SDL_PLATFORM_GDK 1
#endif #endif
@ -437,7 +437,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Sony PSP. * A preprocessor macro that is only defined if compiling for Sony PSP.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_PSP 1 #define SDL_PLATFORM_PSP 1
#endif #endif
@ -448,7 +448,7 @@
* A preprocessor macro that is only defined if compiling for Sony PlayStation * A preprocessor macro that is only defined if compiling for Sony PlayStation
* 2. * 2.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_PS2 1 #define SDL_PLATFORM_PS2 1
#endif #endif
@ -458,7 +458,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Sony Vita. * A preprocessor macro that is only defined if compiling for Sony Vita.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_VITA 1 #define SDL_PLATFORM_VITA 1
#endif #endif
@ -468,7 +468,7 @@
/** /**
* A preprocessor macro that is only defined if compiling for Nintendo 3DS. * A preprocessor macro that is only defined if compiling for Nintendo 3DS.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_PLATFORM_3DS 1 #define SDL_PLATFORM_3DS 1

4
include/SDL3/SDL_power.h
View file

@ -51,7 +51,7 @@ extern "C" {
* *
* These are results returned by SDL_GetPowerInfo(). * These are results returned by SDL_GetPowerInfo().
* *
* \since This enum is available since SDL 3.1.3 * \since This enum is available since SDL 3.2.0
*/ */
typedef enum SDL_PowerState typedef enum SDL_PowerState
{ {
@ -89,7 +89,7 @@ typedef enum SDL_PowerState
* \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *seconds, int *percent); extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *seconds, int *percent);

22
include/SDL3/SDL_process.h
View file

@ -57,7 +57,7 @@ extern "C" {
/** /**
* An opaque handle representing a system process. * An opaque handle representing a system process.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
*/ */
@ -92,7 +92,7 @@ typedef struct SDL_Process SDL_Process;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
* \sa SDL_GetProcessProperties * \sa SDL_GetProcessProperties
@ -139,7 +139,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 * `SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER` set. This is true for streams
* representing files and process I/O. * representing files and process I/O.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
* \sa SDL_GetProcessProperties * \sa SDL_GetProcessProperties
@ -204,7 +204,7 @@ typedef enum SDL_ProcessIO
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_GetProcessProperties * \sa SDL_GetProcessProperties
@ -252,7 +252,7 @@ extern SDL_DECLSPEC SDL_Process *SDLCALL SDL_CreateProcessWithProperties(SDL_Pro
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
@ -288,7 +288,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetProcessProperties(SDL_Proces
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
@ -314,7 +314,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_ReadProcess(SDL_Process *process, size_t
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
@ -338,7 +338,7 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_GetProcessInput(SDL_Process *proce
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
@ -360,7 +360,7 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_GetProcessOutput(SDL_Process *proc
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
@ -393,7 +393,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_KillProcess(SDL_Process *process, bool forc
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties
@ -413,7 +413,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitProcess(SDL_Process *process, bool bloc
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProcess * \sa SDL_CreateProcess
* \sa SDL_CreateProcessWithProperties * \sa SDL_CreateProcessWithProperties

50
include/SDL3/SDL_properties.h
View file

@ -61,14 +61,14 @@ extern "C" {
/** /**
* SDL properties ID * SDL properties ID
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_PropertiesID; typedef Uint32 SDL_PropertiesID;
/** /**
* SDL property type * SDL property type
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_PropertyType typedef enum SDL_PropertyType
{ {
@ -86,7 +86,7 @@ typedef enum SDL_PropertyType
* \returns a valid property ID on success or 0 on failure; call * \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGlobalProperties(void); 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyProperties * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_CopyProperties(SDL_PropertiesID src, SDL_PropertiesID dst); 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_UnlockProperties * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockProperties * \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 * \threadsafety This callback may fire without any locks held; if this is a
* concern, the app should provide its own locking. * concern, the app should provide its own locking.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetPointerPropertyWithCleanup * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPointerProperty * \sa SDL_GetPointerProperty
* \sa SDL_SetPointerProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPointerProperty * \sa SDL_GetPointerProperty
* \sa SDL_HasProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetStringProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumberProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetFloatProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetBooleanProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPropertyType * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasProperty * \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 * If you need to avoid this, use SDL_LockProperties() and
* SDL_UnlockProperties(). * SDL_UnlockProperties().
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetBooleanProperty * \sa SDL_GetBooleanProperty
* \sa SDL_GetFloatProperty * \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 * If you need to avoid this, use SDL_LockProperties() and
* SDL_UnlockProperties(). * SDL_UnlockProperties().
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const char *name); 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 * \threadsafety SDL_EnumerateProperties holds a lock on `props` during this
* callback. * callback.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_EnumerateProperties * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateProperties(SDL_PropertiesID props, SDL_EnumeratePropertiesCallback callback, void *userdata); 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 * locked or other threads might be setting or getting values
* from these properties. * from these properties.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProperties * \sa SDL_CreateProperties
*/ */

44
include/SDL3/SDL_rect.h
View file

@ -41,7 +41,7 @@ extern "C" {
/** /**
* The structure that defines a point (using integers). * The structure that defines a point (using integers).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GetRectEnclosingPoints * \sa SDL_GetRectEnclosingPoints
* \sa SDL_PointInRect * \sa SDL_PointInRect
@ -55,7 +55,7 @@ typedef struct SDL_Point
/** /**
* The structure that defines a point (using floating point values). * The structure that defines a point (using floating point values).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GetRectEnclosingPointsFloat * \sa SDL_GetRectEnclosingPointsFloat
* \sa SDL_PointInRectFloat * \sa SDL_PointInRectFloat
@ -70,7 +70,7 @@ typedef struct SDL_FPoint
/** /**
* A rectangle, with the origin at the upper left (using integers). * A rectangle, with the origin at the upper left (using integers).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_RectEmpty * \sa SDL_RectEmpty
* \sa SDL_RectsEqual * \sa SDL_RectsEqual
@ -91,7 +91,7 @@ typedef struct SDL_Rect
* A rectangle, with the origin at the upper left (using floating point * A rectangle, with the origin at the upper left (using floating point
* values). * values).
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_RectEmptyFloat * \sa SDL_RectEmptyFloat
* \sa SDL_RectsEqualFloat * \sa SDL_RectsEqualFloat
@ -121,7 +121,7 @@ typedef struct SDL_FRect
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE void SDL_RectToFRect(const SDL_Rect *rect, SDL_FRect *frect) 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r) 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE bool SDL_RectEmpty(const SDL_Rect *r) 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE bool SDL_RectsEqual(const SDL_Rect *a, const SDL_Rect *b) 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRectIntersection * \sa SDL_GetRectIntersection
*/ */
@ -234,7 +234,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasRectIntersection(const SDL_Rect *A, cons
* rectangles `A` and `B`. * rectangles `A` and `B`.
* \returns true if there is an intersection, false otherwise. * \returns true if there is an intersection, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasRectIntersection * \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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectUnion(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result); 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 * \returns true if any points were enclosed or false if all the points were
* outside of the clipping rectangle. * outside of the clipping rectangle.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectEnclosingPoints(const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result); 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. * \param Y2 a pointer to the ending Y-coordinate of the line.
* \returns true if there is an intersection, false otherwise. * \returns true if there is an intersection, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectAndLineIntersection(const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2); 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE bool SDL_PointInRectFloat(const SDL_FPoint *p, const SDL_FRect *r) 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
SDL_FORCE_INLINE bool SDL_RectEmptyFloat(const SDL_FRect *r) 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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RectsEqualFloat * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RectsEqualEpsilon * \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. * \param B an SDL_FRect structure representing the second rectangle.
* \returns true if there is an intersection, false otherwise. * \returns true if there is an intersection, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRectIntersection * \sa SDL_GetRectIntersection
*/ */
@ -437,7 +437,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasRectIntersectionFloat(const SDL_FRect *A
* rectangles `A` and `B`. * rectangles `A` and `B`.
* \returns true if there is an intersection, false otherwise. * \returns true if there is an intersection, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_HasRectIntersectionFloat * \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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectUnionFloat(const SDL_FRect *A, const SDL_FRect *B, SDL_FRect *result); 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 * \returns true if any points were enclosed or false if all the points were
* outside of the clipping rectangle. * outside of the clipping rectangle.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectEnclosingPointsFloat(const SDL_FPoint *points, int count, const SDL_FRect *clip, SDL_FRect *result); 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. * \param Y2 a pointer to the ending Y-coordinate of the line.
* \returns true if there is an intersection, false otherwise. * \returns true if there is an intersection, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectAndLineIntersectionFloat(const SDL_FRect *rect, float *X1, float *Y1, float *X2, float *Y2); extern SDL_DECLSPEC bool SDLCALL SDL_GetRectAndLineIntersectionFloat(const SDL_FRect *rect, float *X1, float *Y1, float *X2, float *Y2);

190
include/SDL3/SDL_render.h
View file

@ -69,14 +69,14 @@ extern "C" {
/** /**
* The name of the software renderer. * The name of the software renderer.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_SOFTWARE_RENDERER "software" #define SDL_SOFTWARE_RENDERER "software"
/** /**
* Vertex structure. * Vertex structure.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Vertex typedef struct SDL_Vertex
{ {
@ -88,7 +88,7 @@ typedef struct SDL_Vertex
/** /**
* The access pattern allowed for a texture. * The access pattern allowed for a texture.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_TextureAccess typedef enum SDL_TextureAccess
{ {
@ -100,7 +100,7 @@ typedef enum SDL_TextureAccess
/** /**
* How the logical size is mapped to the output. * How the logical size is mapped to the output.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_RendererLogicalPresentation typedef enum SDL_RendererLogicalPresentation
{ {
@ -114,7 +114,7 @@ typedef enum SDL_RendererLogicalPresentation
/** /**
* A structure representing rendering state * A structure representing rendering state
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Renderer SDL_Renderer; typedef struct SDL_Renderer SDL_Renderer;
@ -123,7 +123,7 @@ typedef struct SDL_Renderer SDL_Renderer;
/** /**
* An efficient driver-specific representation of pixel data * An efficient driver-specific representation of pixel data
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_CreateTexture * \sa SDL_CreateTexture
* \sa SDL_CreateTextureFromSurface * \sa SDL_CreateTextureFromSurface
@ -157,7 +157,7 @@ typedef struct SDL_Texture SDL_Texture;
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRenderer * \sa SDL_CreateRenderer
* \sa SDL_GetRenderDriver * \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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetNumRenderDrivers * \sa SDL_GetNumRenderDrivers
*/ */
@ -203,7 +203,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetRenderDriver(int index);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRenderer * \sa SDL_CreateRenderer
* \sa SDL_CreateWindow * \sa SDL_CreateWindow
@ -234,7 +234,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateWindowAndRenderer(const char *title,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRendererWithProperties * \sa SDL_CreateRendererWithProperties
* \sa SDL_CreateSoftwareRenderer * \sa SDL_CreateSoftwareRenderer
@ -288,7 +288,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProperties * \sa SDL_CreateProperties
* \sa SDL_CreateRenderer * \sa SDL_CreateRenderer
@ -325,7 +325,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRendererWithProperties(SDL_
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroyRenderer * \sa SDL_DestroyRenderer
*/ */
@ -340,7 +340,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surfac
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window *window); extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window *window);
@ -353,7 +353,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window *window);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetRenderWindow(SDL_Renderer *renderer); extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetRenderWindow(SDL_Renderer *renderer);
@ -366,7 +366,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetRenderWindow(SDL_Renderer *rende
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRenderer * \sa SDL_CreateRenderer
* \sa SDL_CreateRendererWithProperties * \sa SDL_CreateRendererWithProperties
@ -455,7 +455,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetRendererName(SDL_Renderer *rende
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Renderer *renderer); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Renderer *renderer);
@ -498,7 +498,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Rende
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCurrentRenderOutputSize * \sa SDL_GetCurrentRenderOutputSize
*/ */
@ -520,7 +520,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderOutputSize * \sa SDL_GetRenderOutputSize
*/ */
@ -541,7 +541,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetCurrentRenderOutputSize(SDL_Renderer *re
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTextureFromSurface * \sa SDL_CreateTextureFromSurface
* \sa SDL_CreateTextureWithProperties * \sa SDL_CreateTextureWithProperties
@ -571,7 +571,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer *render
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTexture * \sa SDL_CreateTexture
* \sa SDL_CreateTextureWithProperties * \sa SDL_CreateTextureWithProperties
@ -680,7 +680,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Rende
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateProperties * \sa SDL_CreateProperties
* \sa SDL_CreateTexture * \sa SDL_CreateTexture
@ -799,7 +799,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureWithProperties(SDL_Re
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Texture *texture); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Texture *texture);
@ -839,7 +839,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Textur
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Texture *texture); extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Texture *texture);
@ -856,7 +856,7 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Textur
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureSize(SDL_Texture *texture, float *w, float *h); extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureSize(SDL_Texture *texture, float *w, float *h);
@ -881,7 +881,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureSize(SDL_Texture *texture, float
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureColorMod * \sa SDL_GetTextureColorMod
* \sa SDL_SetTextureAlphaMod * \sa SDL_SetTextureAlphaMod
@ -911,7 +911,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureColorMod(SDL_Texture *texture, Ui
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureColorModFloat * \sa SDL_GetTextureColorModFloat
* \sa SDL_SetTextureAlphaModFloat * \sa SDL_SetTextureAlphaModFloat
@ -932,7 +932,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureColorModFloat(SDL_Texture *textur
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureAlphaMod * \sa SDL_GetTextureAlphaMod
* \sa SDL_GetTextureColorModFloat * \sa SDL_GetTextureColorModFloat
@ -952,7 +952,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureColorMod(SDL_Texture *texture, Ui
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureAlphaModFloat * \sa SDL_GetTextureAlphaModFloat
* \sa SDL_GetTextureColorMod * \sa SDL_GetTextureColorMod
@ -978,7 +978,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureColorModFloat(SDL_Texture *textur
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureAlphaMod * \sa SDL_GetTextureAlphaMod
* \sa SDL_SetTextureAlphaModFloat * \sa SDL_SetTextureAlphaModFloat
@ -1004,7 +1004,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureAlphaMod(SDL_Texture *texture, Ui
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureAlphaModFloat * \sa SDL_GetTextureAlphaModFloat
* \sa SDL_SetTextureAlphaMod * \sa SDL_SetTextureAlphaMod
@ -1022,7 +1022,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureAlphaModFloat(SDL_Texture *textur
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureAlphaModFloat * \sa SDL_GetTextureAlphaModFloat
* \sa SDL_GetTextureColorMod * \sa SDL_GetTextureColorMod
@ -1040,7 +1040,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureAlphaMod(SDL_Texture *texture, Ui
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureAlphaMod * \sa SDL_GetTextureAlphaMod
* \sa SDL_GetTextureColorModFloat * \sa SDL_GetTextureColorModFloat
@ -1061,7 +1061,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *textur
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureBlendMode * \sa SDL_GetTextureBlendMode
*/ */
@ -1077,7 +1077,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetTextureBlendMode * \sa SDL_SetTextureBlendMode
*/ */
@ -1097,7 +1097,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureBlendMode(SDL_Texture *texture, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTextureScaleMode * \sa SDL_GetTextureScaleMode
*/ */
@ -1113,7 +1113,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureScaleMode(SDL_Texture *texture, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetTextureScaleMode * \sa SDL_SetTextureScaleMode
*/ */
@ -1144,7 +1144,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureScaleMode(SDL_Texture *texture, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockTexture * \sa SDL_LockTexture
* \sa SDL_UnlockTexture * \sa SDL_UnlockTexture
@ -1178,7 +1178,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_UpdateNVTexture * \sa SDL_UpdateNVTexture
* \sa SDL_UpdateTexture * \sa SDL_UpdateTexture
@ -1210,7 +1210,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_UpdateTexture * \sa SDL_UpdateTexture
* \sa SDL_UpdateYUVTexture * \sa SDL_UpdateYUVTexture
@ -1245,7 +1245,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockTextureToSurface * \sa SDL_LockTextureToSurface
* \sa SDL_UnlockTexture * \sa SDL_UnlockTexture
@ -1283,7 +1283,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockTexture(SDL_Texture *texture,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockTexture * \sa SDL_LockTexture
* \sa SDL_UnlockTexture * \sa SDL_UnlockTexture
@ -1305,7 +1305,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockTextureToSurface(SDL_Texture *texture,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockTexture * \sa SDL_LockTexture
*/ */
@ -1327,7 +1327,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture *texture);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderTarget * \sa SDL_GetRenderTarget
*/ */
@ -1344,7 +1344,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer, SDL
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderTarget * \sa SDL_SetRenderTarget
*/ */
@ -1383,7 +1383,7 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *rend
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ConvertEventToRenderCoordinates * \sa SDL_ConvertEventToRenderCoordinates
* \sa SDL_GetRenderLogicalPresentation * \sa SDL_GetRenderLogicalPresentation
@ -1406,7 +1406,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderLogicalPresentation(SDL_Renderer *
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderLogicalPresentation * \sa SDL_SetRenderLogicalPresentation
*/ */
@ -1428,7 +1428,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer *
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderLogicalPresentation * \sa SDL_SetRenderLogicalPresentation
*/ */
@ -1454,7 +1454,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderLogicalPresentationRect(SDL_Render
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderLogicalPresentation * \sa SDL_SetRenderLogicalPresentation
* \sa SDL_SetRenderScale * \sa SDL_SetRenderScale
@ -1483,7 +1483,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Renderer *r
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderLogicalPresentation * \sa SDL_SetRenderLogicalPresentation
* \sa SDL_SetRenderScale * \sa SDL_SetRenderScale
@ -1521,7 +1521,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderCoordinatesToWindow(SDL_Renderer *ren
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderCoordinatesFromWindow * \sa SDL_RenderCoordinatesFromWindow
*/ */
@ -1544,7 +1544,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertEventToRenderCoordinates(SDL_Rendere
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderViewport * \sa SDL_GetRenderViewport
* \sa SDL_RenderViewportSet * \sa SDL_RenderViewportSet
@ -1561,7 +1561,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderViewport(SDL_Renderer *renderer, c
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderViewportSet * \sa SDL_RenderViewportSet
* \sa SDL_SetRenderViewport * \sa SDL_SetRenderViewport
@ -1581,7 +1581,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderViewport(SDL_Renderer *renderer, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderViewport * \sa SDL_GetRenderViewport
* \sa SDL_SetRenderViewport * \sa SDL_SetRenderViewport
@ -1606,7 +1606,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderViewportSet(SDL_Renderer *renderer);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderSafeArea(SDL_Renderer *renderer, SDL_Rect *rect); extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderSafeArea(SDL_Renderer *renderer, SDL_Rect *rect);
@ -1621,7 +1621,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderSafeArea(SDL_Renderer *renderer, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderClipRect * \sa SDL_GetRenderClipRect
* \sa SDL_RenderClipEnabled * \sa SDL_RenderClipEnabled
@ -1639,7 +1639,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderClipRect(SDL_Renderer *renderer, c
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderClipEnabled * \sa SDL_RenderClipEnabled
* \sa SDL_SetRenderClipRect * \sa SDL_SetRenderClipRect
@ -1655,7 +1655,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderClipRect(SDL_Renderer *renderer, S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderClipRect * \sa SDL_GetRenderClipRect
* \sa SDL_SetRenderClipRect * \sa SDL_SetRenderClipRect
@ -1681,7 +1681,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderClipEnabled(SDL_Renderer *renderer);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderScale * \sa SDL_GetRenderScale
*/ */
@ -1698,7 +1698,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderScale(SDL_Renderer *renderer, floa
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderScale * \sa SDL_SetRenderScale
*/ */
@ -1722,7 +1722,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderScale(SDL_Renderer *renderer, floa
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderDrawColor * \sa SDL_GetRenderDrawColor
* \sa SDL_SetRenderDrawColorFloat * \sa SDL_SetRenderDrawColorFloat
@ -1747,7 +1747,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderDrawColorFloat * \sa SDL_GetRenderDrawColorFloat
* \sa SDL_SetRenderDrawColor * \sa SDL_SetRenderDrawColor
@ -1771,7 +1771,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawColorFloat(SDL_Renderer *rende
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderDrawColorFloat * \sa SDL_GetRenderDrawColorFloat
* \sa SDL_SetRenderDrawColor * \sa SDL_SetRenderDrawColor
@ -1795,7 +1795,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderDrawColor(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderDrawColorFloat * \sa SDL_SetRenderDrawColorFloat
* \sa SDL_GetRenderDrawColor * \sa SDL_GetRenderDrawColor
@ -1820,7 +1820,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderDrawColorFloat(SDL_Renderer *rende
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderColorScale * \sa SDL_GetRenderColorScale
*/ */
@ -1836,7 +1836,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderColorScale(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderColorScale * \sa SDL_SetRenderColorScale
*/ */
@ -1854,7 +1854,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderColorScale(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderDrawBlendMode * \sa SDL_GetRenderDrawBlendMode
*/ */
@ -1870,7 +1870,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *render
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderDrawBlendMode * \sa SDL_SetRenderDrawBlendMode
*/ */
@ -1890,7 +1890,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer *render
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderDrawColor * \sa SDL_SetRenderDrawColor
*/ */
@ -1907,7 +1907,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderClear(SDL_Renderer *renderer);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderPoints * \sa SDL_RenderPoints
*/ */
@ -1924,7 +1924,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, float x
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderPoint * \sa SDL_RenderPoint
*/ */
@ -1943,7 +1943,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, const
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderLines * \sa SDL_RenderLines
*/ */
@ -1961,7 +1961,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderLine(SDL_Renderer *renderer, float x1
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderLine * \sa SDL_RenderLine
*/ */
@ -1978,7 +1978,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderLines(SDL_Renderer *renderer, const S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderRects * \sa SDL_RenderRects
*/ */
@ -1996,7 +1996,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderRect(SDL_Renderer *renderer, const SD
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderRect * \sa SDL_RenderRect
*/ */
@ -2014,7 +2014,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderRects(SDL_Renderer *renderer, const S
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderFillRects * \sa SDL_RenderFillRects
*/ */
@ -2032,7 +2032,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, cons
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderFillRect * \sa SDL_RenderFillRect
*/ */
@ -2053,7 +2053,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, con
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderTextureRotated * \sa SDL_RenderTextureRotated
* \sa SDL_RenderTextureTiled * \sa SDL_RenderTextureTiled
@ -2082,7 +2082,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, SDL_T
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderTexture * \sa SDL_RenderTexture
*/ */
@ -2113,7 +2113,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer
* *
* \threadsafety You may only call this function from the main thread. * \threadsafety You may only call this function from the main thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderTexture * \sa SDL_RenderTexture
*/ */
@ -2142,7 +2142,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTextureAffine(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderTexture * \sa SDL_RenderTexture
*/ */
@ -2176,7 +2176,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTextureTiled(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderTexture * \sa SDL_RenderTexture
*/ */
@ -2200,7 +2200,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTexture9Grid(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderGeometryRaw * \sa SDL_RenderGeometryRaw
*/ */
@ -2232,7 +2232,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderGeometry * \sa SDL_RenderGeometry
*/ */
@ -2261,7 +2261,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer,
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *renderer, const SDL_Rect *rect); extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *renderer, const SDL_Rect *rect);
@ -2298,7 +2298,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *ren
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRenderer * \sa SDL_CreateRenderer
* \sa SDL_RenderClear * \sa SDL_RenderClear
@ -2325,7 +2325,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderPresent(SDL_Renderer *renderer);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTexture * \sa SDL_CreateTexture
* \sa SDL_CreateTextureFromSurface * \sa SDL_CreateTextureFromSurface
@ -2342,7 +2342,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture *texture);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateRenderer * \sa SDL_CreateRenderer
*/ */
@ -2377,7 +2377,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer *renderer);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer); extern SDL_DECLSPEC bool SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer);
@ -2393,7 +2393,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderMetalCommandEncoder * \sa SDL_GetRenderMetalCommandEncoder
*/ */
@ -2416,7 +2416,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalLayer(SDL_Renderer *rendere
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderMetalLayer * \sa SDL_GetRenderMetalLayer
*/ */
@ -2449,7 +2449,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalCommandEncoder(SDL_Renderer
* \threadsafety It is **NOT** safe to call this function from two threads at * \threadsafety It is **NOT** safe to call this function from two threads at
* once. * once.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *renderer, Uint32 wait_stage_mask, Sint64 wait_semaphore, Sint64 signal_semaphore); extern SDL_DECLSPEC bool SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *renderer, Uint32 wait_stage_mask, Sint64 wait_semaphore, Sint64 signal_semaphore);
@ -2472,7 +2472,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *ren
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRenderVSync * \sa SDL_GetRenderVSync
*/ */
@ -2492,7 +2492,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, int
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetRenderVSync * \sa SDL_SetRenderVSync
*/ */
@ -2543,7 +2543,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderVSync(SDL_Renderer *renderer, int
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.6. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderDebugTextFormat * \sa SDL_RenderDebugTextFormat
* \sa SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE * \sa SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE
@ -2571,7 +2571,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderDebugText(SDL_Renderer *renderer, flo
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RenderDebugText * \sa SDL_RenderDebugText
* \sa SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE * \sa SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE

2
include/SDL3/SDL_revision.h
View file

@ -44,7 +44,7 @@
* clue in debugging forensics and not something the app will parse in any * clue in debugging forensics and not something the app will parse in any
* way. * way.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_REVISION "Some arbitrary string decided at SDL build time" #define SDL_REVISION "Some arbitrary string decided at SDL build time"
#elif defined(SDL_VENDOR_INFO) #elif defined(SDL_VENDOR_INFO)

2
include/SDL3/SDL_scancode.h
View file

@ -47,7 +47,7 @@
* The values in this enumeration are based on the USB usage page standard: * The values in this enumeration are based on the USB usage page standard:
* https://usb.org/sites/default/files/hut1_5.pdf * https://usb.org/sites/default/files/hut1_5.pdf
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_Scancode typedef enum SDL_Scancode
{ {

36
include/SDL3/SDL_sensor.h
View file

@ -49,7 +49,7 @@ extern "C" {
/** /**
* The opaque structure used to identify an opened SDL sensor. * The opaque structure used to identify an opened SDL sensor.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Sensor SDL_Sensor; typedef struct SDL_Sensor SDL_Sensor;
@ -59,7 +59,7 @@ typedef struct SDL_Sensor SDL_Sensor;
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_SensorID; typedef Uint32 SDL_SensorID;
@ -71,7 +71,7 @@ typedef Uint32 SDL_SensorID;
* rest will have an value of SDL_STANDARD_GRAVITY away from the center of the * rest will have an value of SDL_STANDARD_GRAVITY away from the center of the
* earth, which is a positive Y value. * earth, which is a positive Y value.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_STANDARD_GRAVITY 9.80665f #define SDL_STANDARD_GRAVITY 9.80665f
@ -125,7 +125,7 @@ typedef Uint32 SDL_SensorID;
* *
* The gyroscope axis data is not changed when the device is rotated. * The gyroscope axis data is not changed when the device is rotated.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_GetCurrentDisplayOrientation * \sa SDL_GetCurrentDisplayOrientation
*/ */
@ -153,7 +153,7 @@ typedef enum SDL_SensorType
* call SDL_GetError() for more information. This should be freed * call SDL_GetError() for more information. This should be freed
* with SDL_free() when it is no longer needed. * with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_SensorID * SDLCALL SDL_GetSensors(int *count); extern SDL_DECLSPEC SDL_SensorID * SDLCALL SDL_GetSensors(int *count);
@ -165,7 +165,7 @@ extern SDL_DECLSPEC SDL_SensorID * SDLCALL SDL_GetSensors(int *count);
* \param instance_id the sensor instance ID. * \param instance_id the sensor instance ID.
* \returns the sensor name, or NULL if `instance_id` is not valid. * \returns the sensor name, or NULL if `instance_id` is not valid.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorNameForID(SDL_SensorID instance_id); extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorNameForID(SDL_SensorID instance_id);
@ -178,7 +178,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorNameForID(SDL_SensorID ins
* \returns the SDL_SensorType, or `SDL_SENSOR_INVALID` if `instance_id` is * \returns the SDL_SensorType, or `SDL_SENSOR_INVALID` if `instance_id` is
* not valid. * not valid.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorTypeForID(SDL_SensorID instance_id); extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorTypeForID(SDL_SensorID instance_id);
@ -191,7 +191,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 * \returns the sensor platform dependent type, or -1 if `instance_id` is not
* valid. * valid.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableTypeForID(SDL_SensorID instance_id); extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableTypeForID(SDL_SensorID instance_id);
@ -202,7 +202,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableTypeForID(SDL_SensorID i
* \returns an SDL_Sensor object or NULL on failure; call SDL_GetError() for * \returns an SDL_Sensor object or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_OpenSensor(SDL_SensorID instance_id); extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_OpenSensor(SDL_SensorID instance_id);
@ -213,7 +213,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 * \returns an SDL_Sensor object or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_GetSensorFromID(SDL_SensorID instance_id); extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_GetSensorFromID(SDL_SensorID instance_id);
@ -224,7 +224,7 @@ extern SDL_DECLSPEC SDL_Sensor * SDLCALL SDL_GetSensorFromID(SDL_SensorID instan
* \returns a valid property ID on success or 0 on failure; call * \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSensorProperties(SDL_Sensor *sensor); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSensorProperties(SDL_Sensor *sensor);
@ -235,7 +235,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSensorProperties(SDL_Sensor
* \returns the sensor name or NULL on failure; call SDL_GetError() for more * \returns the sensor name or NULL on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorName(SDL_Sensor *sensor); extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorName(SDL_Sensor *sensor);
@ -246,7 +246,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetSensorName(SDL_Sensor *sensor);
* \returns the SDL_SensorType type, or `SDL_SENSOR_INVALID` if `sensor` is * \returns the SDL_SensorType type, or `SDL_SENSOR_INVALID` if `sensor` is
* NULL. * NULL.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorType(SDL_Sensor *sensor); extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorType(SDL_Sensor *sensor);
@ -256,7 +256,7 @@ extern SDL_DECLSPEC SDL_SensorType SDLCALL SDL_GetSensorType(SDL_Sensor *sensor)
* \param sensor the SDL_Sensor object to inspect. * \param sensor the SDL_Sensor object to inspect.
* \returns the sensor platform dependent type, or -1 if `sensor` is NULL. * \returns the sensor platform dependent type, or -1 if `sensor` is NULL.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableType(SDL_Sensor *sensor); extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableType(SDL_Sensor *sensor);
@ -267,7 +267,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetSensorNonPortableType(SDL_Sensor *sensor)
* \returns the sensor instance ID, or 0 on failure; call SDL_GetError() for * \returns the sensor instance ID, or 0 on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_SensorID SDLCALL SDL_GetSensorID(SDL_Sensor *sensor); extern SDL_DECLSPEC SDL_SensorID SDLCALL SDL_GetSensorID(SDL_Sensor *sensor);
@ -282,7 +282,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetSensorData(SDL_Sensor *sensor, float *data, int num_values); extern SDL_DECLSPEC bool SDLCALL SDL_GetSensorData(SDL_Sensor *sensor, float *data, int num_values);
@ -291,7 +291,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSensorData(SDL_Sensor *sensor, float *da
* *
* \param sensor the SDL_Sensor object to close. * \param sensor the SDL_Sensor object to close.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_CloseSensor(SDL_Sensor *sensor); extern SDL_DECLSPEC void SDLCALL SDL_CloseSensor(SDL_Sensor *sensor);
@ -304,7 +304,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseSensor(SDL_Sensor *sensor);
* This needs to be called from the thread that initialized the sensor * This needs to be called from the thread that initialized the sensor
* subsystem. * subsystem.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_UpdateSensors(void); extern SDL_DECLSPEC void SDLCALL SDL_UpdateSensors(void);

480
include/SDL3/SDL_stdinc.h
View file

File diff suppressed because it is too large Load diff

38
include/SDL3/SDL_storage.h
View file

@ -267,7 +267,7 @@ extern "C" {
* *
* This structure should be initialized using SDL_INIT_INTERFACE() * This structure should be initialized using SDL_INIT_INTERFACE()
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_INIT_INTERFACE * \sa SDL_INIT_INTERFACE
*/ */
@ -327,7 +327,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_StorageInterface_SIZE,
* functions like SDL_OpenTitleStorage or SDL_OpenUserStorage, etc, or create * functions like SDL_OpenTitleStorage or SDL_OpenUserStorage, etc, or create
* an object with a custom implementation using SDL_OpenStorage. * an object with a custom implementation using SDL_OpenStorage.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_Storage SDL_Storage; typedef struct SDL_Storage SDL_Storage;
@ -339,7 +339,7 @@ typedef struct SDL_Storage SDL_Storage;
* \returns a title storage container on success or NULL on failure; call * \returns a title storage container on success or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseStorage * \sa SDL_CloseStorage
* \sa SDL_GetStorageFileSize * \sa SDL_GetStorageFileSize
@ -362,7 +362,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenTitleStorage(const char *overr
* \returns a user storage container on success or NULL on failure; call * \returns a user storage container on success or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseStorage * \sa SDL_CloseStorage
* \sa SDL_GetStorageFileSize * \sa SDL_GetStorageFileSize
@ -386,7 +386,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 * \returns a filesystem storage container on success or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseStorage * \sa SDL_CloseStorage
* \sa SDL_GetStorageFileSize * \sa SDL_GetStorageFileSize
@ -415,7 +415,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenFileStorage(const char *path);
* \returns a storage container on success or NULL on failure; call * \returns a storage container on success or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CloseStorage * \sa SDL_CloseStorage
* \sa SDL_GetStorageFileSize * \sa SDL_GetStorageFileSize
@ -436,7 +436,7 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenStorage(const SDL_StorageInter
* returns an error, the container data will be freed; the error is * returns an error, the container data will be freed; the error is
* only for informational purposes. * only for informational purposes.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_OpenFileStorage * \sa SDL_OpenFileStorage
* \sa SDL_OpenStorage * \sa SDL_OpenStorage
@ -455,7 +455,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseStorage(SDL_Storage *storage);
* \param storage a storage container to query. * \param storage a storage container to query.
* \returns true if the container is ready, false otherwise. * \returns true if the container is ready, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_StorageReady(SDL_Storage *storage); extern SDL_DECLSPEC bool SDLCALL SDL_StorageReady(SDL_Storage *storage);
@ -468,7 +468,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StorageReady(SDL_Storage *storage);
* \returns true if the file could be queried or false on failure; call * \returns true if the file could be queried or false on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ReadStorageFile * \sa SDL_ReadStorageFile
* \sa SDL_StorageReady * \sa SDL_StorageReady
@ -490,7 +490,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() * \returns true if the file was read or false on failure; call SDL_GetError()
* for more information. * for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetStorageFileSize * \sa SDL_GetStorageFileSize
* \sa SDL_StorageReady * \sa SDL_StorageReady
@ -508,7 +508,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadStorageFile(SDL_Storage *storage, const
* \returns true if the file was written or false on failure; call * \returns true if the file was written or false on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetStorageSpaceRemaining * \sa SDL_GetStorageSpaceRemaining
* \sa SDL_ReadStorageFile * \sa SDL_ReadStorageFile
@ -524,7 +524,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
*/ */
@ -553,7 +553,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
*/ */
@ -567,7 +567,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateStorageDirectory(SDL_Storage *stor
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
*/ */
@ -582,7 +582,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
*/ */
@ -597,7 +597,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
*/ */
@ -613,7 +613,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 * \returns true on success or false if the file doesn't exist, or another
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
*/ */
@ -625,7 +625,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetStoragePathInfo(SDL_Storage *storage, co
* \param storage a storage container to query. * \param storage a storage container to query.
* \returns the amount of remaining space, in bytes. * \returns the amount of remaining space, in bytes.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_StorageReady * \sa SDL_StorageReady
* \sa SDL_WriteStorageFile * \sa SDL_WriteStorageFile
@ -668,7 +668,7 @@ extern SDL_DECLSPEC Uint64 SDLCALL SDL_GetStorageSpaceRemaining(SDL_Storage *sto
* \threadsafety It is safe to call this function from any thread, assuming * \threadsafety It is safe to call this function from any thread, assuming
* the `storage` object is thread-safe. * the `storage` object is thread-safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC char ** SDLCALL SDL_GlobStorageDirectory(SDL_Storage *storage, const char *path, const char *pattern, SDL_GlobFlags flags, int *count); extern SDL_DECLSPEC char ** SDLCALL SDL_GlobStorageDirectory(SDL_Storage *storage, const char *path, const char *pattern, SDL_GlobFlags flags, int *count);

124
include/SDL3/SDL_surface.h
View file

@ -59,7 +59,7 @@ extern "C" {
* *
* These are generally considered read-only. * These are generally considered read-only.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint32 SDL_SurfaceFlags; typedef Uint32 SDL_SurfaceFlags;
@ -71,14 +71,14 @@ typedef Uint32 SDL_SurfaceFlags;
/** /**
* Evaluates to true if the surface needs to be locked before access. * Evaluates to true if the surface needs to be locked before access.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_MUSTLOCK(S) ((((S)->flags & SDL_SURFACE_LOCK_NEEDED)) == SDL_SURFACE_LOCK_NEEDED) #define SDL_MUSTLOCK(S) ((((S)->flags & SDL_SURFACE_LOCK_NEEDED)) == SDL_SURFACE_LOCK_NEEDED)
/** /**
* The scaling mode. * The scaling mode.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ScaleMode typedef enum SDL_ScaleMode
{ {
@ -89,7 +89,7 @@ typedef enum SDL_ScaleMode
/** /**
* The flip mode. * The flip mode.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_FlipMode typedef enum SDL_FlipMode
{ {
@ -120,7 +120,7 @@ typedef enum SDL_FlipMode
* format with a pitch of 32 would consist of 32x32 bytes of Y plane followed * format with a pitch of 32 would consist of 32x32 bytes of Y plane followed
* by 32x16 bytes of UV plane. * by 32x16 bytes of UV plane.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_CreateSurface * \sa SDL_CreateSurface
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
@ -153,7 +153,7 @@ typedef struct SDL_Surface SDL_Surface;
* \returns the new SDL_Surface structure that is created or NULL on failure; * \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateSurfaceFrom * \sa SDL_CreateSurfaceFrom
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
@ -181,7 +181,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; * \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateSurface * \sa SDL_CreateSurface
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
@ -195,7 +195,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_CreateSurfaceFrom(int width, int h
* *
* \param surface the SDL_Surface to free. * \param surface the SDL_Surface to free.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateSurface * \sa SDL_CreateSurface
* \sa SDL_CreateSurfaceFrom * \sa SDL_CreateSurfaceFrom
@ -226,7 +226,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroySurface(SDL_Surface *surface);
* \returns a valid property ID on success or 0 on failure; call * \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surface *surface); extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surface *surface);
@ -246,7 +246,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surfac
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceColorspace * \sa SDL_GetSurfaceColorspace
*/ */
@ -263,7 +263,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorspace(SDL_Surface *surface,
* \returns the colorspace used by the surface, or SDL_COLORSPACE_UNKNOWN if * \returns the colorspace used by the surface, or SDL_COLORSPACE_UNKNOWN if
* the surface is NULL. * the surface is NULL.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfaceColorspace * \sa SDL_SetSurfaceColorspace
*/ */
@ -291,7 +291,7 @@ extern SDL_DECLSPEC SDL_Colorspace SDLCALL SDL_GetSurfaceColorspace(SDL_Surface
* the surface didn't have an index format); call SDL_GetError() for * the surface didn't have an index format); call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetPaletteColors * \sa SDL_SetPaletteColors
*/ */
@ -307,7 +307,7 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreateSurfacePalette(SDL_Surface *
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreatePalette * \sa SDL_CreatePalette
* \sa SDL_GetSurfacePalette * \sa SDL_GetSurfacePalette
@ -321,7 +321,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 * \returns a pointer to the palette used by the surface, or NULL if there is
* no palette used. * no palette used.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfacePalette * \sa SDL_SetSurfacePalette
*/ */
@ -344,7 +344,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RemoveSurfaceAlternateImages * \sa SDL_RemoveSurfaceAlternateImages
* \sa SDL_GetSurfaceImages * \sa SDL_GetSurfaceImages
@ -358,7 +358,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddSurfaceAlternateImage(SDL_Surface *surfa
* \param surface the SDL_Surface structure to query. * \param surface the SDL_Surface structure to query.
* \returns true if alternate versions are available or false otherwise. * \returns true if alternate versions are available or false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddSurfaceAlternateImage * \sa SDL_AddSurfaceAlternateImage
* \sa SDL_RemoveSurfaceAlternateImages * \sa SDL_RemoveSurfaceAlternateImages
@ -383,7 +383,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasAlternateImages(SDL_Surface *surf
* failure; call SDL_GetError() for more information. This should be * failure; call SDL_GetError() for more information. This should be
* freed with SDL_free() when it is no longer needed. * freed with SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddSurfaceAlternateImage * \sa SDL_AddSurfaceAlternateImage
* \sa SDL_RemoveSurfaceAlternateImages * \sa SDL_RemoveSurfaceAlternateImages
@ -399,7 +399,7 @@ extern SDL_DECLSPEC SDL_Surface ** SDLCALL SDL_GetSurfaceImages(SDL_Surface *sur
* *
* \param surface the SDL_Surface structure to update. * \param surface the SDL_Surface structure to update.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_AddSurfaceAlternateImage * \sa SDL_AddSurfaceAlternateImage
* \sa SDL_GetSurfaceImages * \sa SDL_GetSurfaceImages
@ -423,7 +423,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveSurfaceAlternateImages(SDL_Surface *s
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_MUSTLOCK * \sa SDL_MUSTLOCK
* \sa SDL_UnlockSurface * \sa SDL_UnlockSurface
@ -435,7 +435,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockSurface(SDL_Surface *surface);
* *
* \param surface the SDL_Surface structure to be unlocked. * \param surface the SDL_Surface structure to be unlocked.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LockSurface * \sa SDL_LockSurface
*/ */
@ -453,7 +453,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 * \returns a pointer to a new SDL_Surface structure or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
* \sa SDL_LoadBMP * \sa SDL_LoadBMP
@ -471,7 +471,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 * \returns a pointer to a new SDL_Surface structure or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
* \sa SDL_LoadBMP_IO * \sa SDL_LoadBMP_IO
@ -495,7 +495,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadBMP_IO * \sa SDL_LoadBMP_IO
* \sa SDL_SaveBMP * \sa SDL_SaveBMP
@ -516,7 +516,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_LoadBMP * \sa SDL_LoadBMP
* \sa SDL_SaveBMP_IO * \sa SDL_SaveBMP_IO
@ -534,7 +534,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurface * \sa SDL_BlitSurface
* \sa SDL_LockSurface * \sa SDL_LockSurface
@ -550,7 +550,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceRLE(SDL_Surface *surface, bool en
* \param surface the SDL_Surface structure to query. * \param surface the SDL_Surface structure to query.
* \returns true if the surface is RLE enabled, false otherwise. * \returns true if the surface is RLE enabled, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfaceRLE * \sa SDL_SetSurfaceRLE
*/ */
@ -572,7 +572,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasRLE(SDL_Surface *surface);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceColorKey * \sa SDL_GetSurfaceColorKey
* \sa SDL_SetSurfaceRLE * \sa SDL_SetSurfaceRLE
@ -588,7 +588,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorKey(SDL_Surface *surface, bo
* \param surface the SDL_Surface structure to query. * \param surface the SDL_Surface structure to query.
* \returns true if the surface has a color key, false otherwise. * \returns true if the surface has a color key, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfaceColorKey * \sa SDL_SetSurfaceColorKey
* \sa SDL_GetSurfaceColorKey * \sa SDL_GetSurfaceColorKey
@ -608,7 +608,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasColorKey(SDL_Surface *surface);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfaceColorKey * \sa SDL_SetSurfaceColorKey
* \sa SDL_SurfaceHasColorKey * \sa SDL_SurfaceHasColorKey
@ -631,7 +631,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceColorMod * \sa SDL_GetSurfaceColorMod
* \sa SDL_SetSurfaceAlphaMod * \sa SDL_SetSurfaceAlphaMod
@ -649,7 +649,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceAlphaMod * \sa SDL_GetSurfaceAlphaMod
* \sa SDL_SetSurfaceColorMod * \sa SDL_SetSurfaceColorMod
@ -669,7 +669,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceAlphaMod * \sa SDL_GetSurfaceAlphaMod
* \sa SDL_SetSurfaceColorMod * \sa SDL_SetSurfaceColorMod
@ -684,7 +684,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceColorMod * \sa SDL_GetSurfaceColorMod
* \sa SDL_SetSurfaceAlphaMod * \sa SDL_SetSurfaceAlphaMod
@ -703,7 +703,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceBlendMode * \sa SDL_GetSurfaceBlendMode
*/ */
@ -717,7 +717,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfaceBlendMode * \sa SDL_SetSurfaceBlendMode
*/ */
@ -738,7 +738,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface *surface, S
* \returns true if the rectangle intersects the surface, otherwise false and * \returns true if the rectangle intersects the surface, otherwise false and
* blits will be completely clipped. * blits will be completely clipped.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetSurfaceClipRect * \sa SDL_GetSurfaceClipRect
*/ */
@ -757,7 +757,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetSurfaceClipRect * \sa SDL_SetSurfaceClipRect
*/ */
@ -771,7 +771,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipMode flip); extern SDL_DECLSPEC bool SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipMode flip);
@ -787,7 +787,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 * \returns a copy of the surface or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
*/ */
@ -806,7 +806,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 * \returns a copy of the surface or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
*/ */
@ -831,7 +831,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; * \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ConvertSurfaceAndColorspace * \sa SDL_ConvertSurfaceAndColorspace
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
@ -857,7 +857,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; * \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ConvertSurface * \sa SDL_ConvertSurface
* \sa SDL_DestroySurface * \sa SDL_DestroySurface
@ -878,7 +878,7 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurfaceAndColorspace(SDL_Su
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ConvertPixelsAndColorspace * \sa SDL_ConvertPixelsAndColorspace
*/ */
@ -907,7 +907,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertPixels(int width, int height, SDL_Pi
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ConvertPixels * \sa SDL_ConvertPixels
*/ */
@ -931,7 +931,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_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); 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);
@ -946,7 +946,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surface, bool linear); extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surface, bool linear);
@ -966,7 +966,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surfac
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, float r, float g, float b, float a); extern SDL_DECLSPEC bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, float r, float g, float b, float a);
@ -989,7 +989,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_FillSurfaceRects * \sa SDL_FillSurfaceRects
*/ */
@ -1014,7 +1014,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_FillSurfaceRect * \sa SDL_FillSurfaceRect
*/ */
@ -1091,7 +1091,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 * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurfaceScaled * \sa SDL_BlitSurfaceScaled
*/ */
@ -1116,7 +1116,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 * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurface * \sa SDL_BlitSurface
*/ */
@ -1141,7 +1141,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceUnchecked(SDL_Surface *src, cons
* threads at once. It is safe to use the same source surface * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurface * \sa SDL_BlitSurface
*/ */
@ -1167,7 +1167,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 * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurfaceScaled * \sa SDL_BlitSurfaceScaled
*/ */
@ -1193,7 +1193,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceUncheckedScaled(SDL_Surface *src
* threads at once. It is safe to use the same source surface * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurface * \sa SDL_BlitSurface
*/ */
@ -1223,7 +1223,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 * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurface * \sa SDL_BlitSurface
*/ */
@ -1260,7 +1260,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceTiledWithScale(SDL_Surface *src,
* threads at once. It is safe to use the same source surface * threads at once. It is safe to use the same source surface
* from multiple threads. * from multiple threads.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_BlitSurface * \sa SDL_BlitSurface
*/ */
@ -1290,7 +1290,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. * \param b the blue component of the pixel in the range 0-255.
* \returns a pixel value. * \returns a pixel value.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_MapSurfaceRGBA * \sa SDL_MapSurfaceRGBA
*/ */
@ -1321,7 +1321,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. * \param a the alpha component of the pixel in the range 0-255.
* \returns a pixel value. * \returns a pixel value.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_MapSurfaceRGB * \sa SDL_MapSurfaceRGB
*/ */
@ -1350,7 +1350,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a); extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
@ -1374,7 +1374,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface, int x, int y, float *r, float *g, float *b, float *a); extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface, int x, int y, float *r, float *g, float *b, float *a);
@ -1397,7 +1397,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface,
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 r, Uint8 g, Uint8 b, Uint8 a); extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
@ -1417,7 +1417,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixelFloat(SDL_Surface *surface, int x, int y, float r, float g, float b, float a); extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixelFloat(SDL_Surface *surface, int x, int y, float r, float g, float b, float a);

78
include/SDL3/SDL_system.h
View file

@ -70,7 +70,7 @@ typedef struct tagMSG MSG;
* \threadsafety This may only be called (by SDL) from the thread handling the * \threadsafety This may only be called (by SDL) from the thread handling the
* Windows event loop. * Windows event loop.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetWindowsMessageHook * \sa SDL_SetWindowsMessageHook
* \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP * \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP
@ -86,7 +86,7 @@ typedef bool (SDLCALL *SDL_WindowsMessageHook)(void *userdata, MSG *msg);
* \param callback the SDL_WindowsMessageHook function to call. * \param callback the SDL_WindowsMessageHook function to call.
* \param userdata a pointer to pass to every iteration of `callback`. * \param userdata a pointer to pass to every iteration of `callback`.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_WindowsMessageHook * \sa SDL_WindowsMessageHook
* \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP * \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP
@ -107,7 +107,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHoo
* \returns the D3D9 adapter index on success or -1 on failure; call * \returns the D3D9 adapter index on success or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displayID); extern SDL_DECLSPEC int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displayID);
@ -124,7 +124,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displ
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetDXGIOutputInfo(SDL_DisplayID displayID, int *adapterIndex, int *outputIndex); extern SDL_DECLSPEC bool SDLCALL SDL_GetDXGIOutputInfo(SDL_DisplayID displayID, int *adapterIndex, int *outputIndex);
@ -154,7 +154,7 @@ typedef union _XEvent XEvent;
* \threadsafety This may only be called (by SDL) from the thread handling the * \threadsafety This may only be called (by SDL) from the thread handling the
* X11 event loop. * X11 event loop.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetX11EventHook * \sa SDL_SetX11EventHook
*/ */
@ -169,7 +169,7 @@ typedef bool (SDLCALL *SDL_X11EventHook)(void *userdata, XEvent *xevent);
* \param callback the SDL_X11EventHook function to call. * \param callback the SDL_X11EventHook function to call.
* \param userdata a pointer to pass to every iteration of `callback`. * \param userdata a pointer to pass to every iteration of `callback`.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_SetX11EventHook(SDL_X11EventHook callback, void *userdata); extern SDL_DECLSPEC void SDLCALL SDL_SetX11EventHook(SDL_X11EventHook callback, void *userdata);
@ -186,7 +186,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetX11EventHook(SDL_X11EventHook callback,
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, int priority); extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, int priority);
@ -202,7 +202,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, int
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy); extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy);
@ -225,7 +225,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetLinuxThreadPriorityAndPolicy(Sint64 thre
* \param userdata what was passed as `callbackParam` to * \param userdata what was passed as `callbackParam` to
* SDL_SetiOSAnimationCallback as `callbackParam`. * SDL_SetiOSAnimationCallback as `callbackParam`.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetiOSAnimationCallback * \sa SDL_SetiOSAnimationCallback
*/ */
@ -264,7 +264,7 @@ typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetiOSEventPump * \sa SDL_SetiOSEventPump
*/ */
@ -277,7 +277,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetiOSAnimationCallback(SDL_Window *window,
* *
* \param enabled true to enable the event pump, false to disable it. * \param enabled true to enable the event pump, false to disable it.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetiOSAnimationCallback * \sa SDL_SetiOSAnimationCallback
*/ */
@ -307,7 +307,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetiOSEventPump(bool enabled);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAndroidActivity * \sa SDL_GetAndroidActivity
*/ */
@ -332,7 +332,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetAndroidJNIEnv(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAndroidJNIEnv * \sa SDL_GetAndroidJNIEnv
*/ */
@ -370,7 +370,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetAndroidActivity(void);
* *
* \returns the Android API level. * \returns the Android API level.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void); extern SDL_DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void);
@ -379,7 +379,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void);
* *
* \returns true if this is a Chromebook, false otherwise. * \returns true if this is a Chromebook, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsChromebook(void); extern SDL_DECLSPEC bool SDLCALL SDL_IsChromebook(void);
@ -388,7 +388,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsChromebook(void);
* *
* \returns true if this is a DeX docking station, false otherwise. * \returns true if this is a DeX docking station, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsDeXMode(void); extern SDL_DECLSPEC bool SDLCALL SDL_IsDeXMode(void);
@ -397,7 +397,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsDeXMode(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void); extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void);
@ -405,7 +405,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void);
* See the official Android developer guide for more information: * See the official Android developer guide for more information:
* http://developer.android.com/guide/topics/data/data-storage.html * http://developer.android.com/guide/topics/data/data-storage.html
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ANDROID_EXTERNAL_STORAGE_READ 0x01 #define SDL_ANDROID_EXTERNAL_STORAGE_READ 0x01
@ -413,7 +413,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void);
* See the official Android developer guide for more information: * See the official Android developer guide for more information:
* http://developer.android.com/guide/topics/data/data-storage.html * http://developer.android.com/guide/topics/data/data-storage.html
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_ANDROID_EXTERNAL_STORAGE_WRITE 0x02 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE 0x02
@ -433,7 +433,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void);
* \returns the path used for internal storage or NULL on failure; call * \returns the path used for internal storage or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAndroidExternalStoragePath * \sa SDL_GetAndroidExternalStoragePath
* \sa SDL_GetAndroidCachePath * \sa SDL_GetAndroidCachePath
@ -451,7 +451,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidInternalStoragePath(void)
* \returns the current state of external storage, or 0 if external storage is * \returns the current state of external storage, or 0 if external storage is
* currently unavailable. * currently unavailable.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAndroidExternalStoragePath * \sa SDL_GetAndroidExternalStoragePath
*/ */
@ -473,7 +473,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetAndroidExternalStorageState(void);
* \returns the path used for external storage for this application on success * \returns the path used for external storage for this application on success
* or NULL on failure; call SDL_GetError() for more information. * or NULL on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAndroidExternalStorageState * \sa SDL_GetAndroidExternalStorageState
* \sa SDL_GetAndroidInternalStoragePath * \sa SDL_GetAndroidInternalStoragePath
@ -496,7 +496,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidExternalStoragePath(void)
* \returns the path used for caches for this application on success or NULL * \returns the path used for caches for this application on success or NULL
* on failure; call SDL_GetError() for more information. * on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetAndroidInternalStoragePath * \sa SDL_GetAndroidInternalStoragePath
* \sa SDL_GetAndroidExternalStoragePath * \sa SDL_GetAndroidExternalStoragePath
@ -510,7 +510,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidCachePath(void);
* \param permission the Android-specific permission name that was requested. * \param permission the Android-specific permission name that was requested.
* \param granted true if permission is granted, false if denied. * \param granted true if permission is granted, false if denied.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_RequestAndroidPermission * \sa SDL_RequestAndroidPermission
*/ */
@ -548,7 +548,7 @@ typedef void (SDLCALL *SDL_RequestAndroidPermissionCallback)(void *userdata, con
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_RequestAndroidPermission(const char *permission, SDL_RequestAndroidPermissionCallback cb, void *userdata); extern SDL_DECLSPEC bool SDLCALL SDL_RequestAndroidPermission(const char *permission, SDL_RequestAndroidPermissionCallback cb, void *userdata);
@ -576,7 +576,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RequestAndroidPermission(const char *permis
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_ShowAndroidToast(const char *message, int duration, int gravity, int xoffset, int yoffset); extern SDL_DECLSPEC bool SDLCALL SDL_ShowAndroidToast(const char *message, int duration, int gravity, int xoffset, int yoffset);
@ -592,7 +592,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowAndroidToast(const char *message, int d
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SendAndroidMessage(Uint32 command, int param); extern SDL_DECLSPEC bool SDLCALL SDL_SendAndroidMessage(Uint32 command, int param);
@ -605,7 +605,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SendAndroidMessage(Uint32 command, int para
* *
* \returns true if the device is a tablet, false otherwise. * \returns true if the device is a tablet, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsTablet(void); extern SDL_DECLSPEC bool SDLCALL SDL_IsTablet(void);
@ -616,7 +616,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsTablet(void);
* *
* \returns true if the device is a TV, false otherwise. * \returns true if the device is a TV, false otherwise.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_IsTV(void); extern SDL_DECLSPEC bool SDLCALL SDL_IsTV(void);
@ -640,7 +640,7 @@ typedef enum SDL_Sandbox
* \returns the application sandbox environment or SDL_SANDBOX_NONE if the * \returns the application sandbox environment or SDL_SANDBOX_NONE if the
* application is not running in a sandbox environment. * application is not running in a sandbox environment.
* *
* \since This function is available since SDL 3.1.6. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Sandbox SDLCALL SDL_GetSandbox(void); extern SDL_DECLSPEC SDL_Sandbox SDLCALL SDL_GetSandbox(void);
@ -660,7 +660,7 @@ extern SDL_DECLSPEC SDL_Sandbox SDLCALL SDL_GetSandbox(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillTerminate(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillTerminate(void);
@ -677,7 +677,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillTerminate(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidReceiveMemoryWarning(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidReceiveMemoryWarning(void);
@ -694,7 +694,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidReceiveMemoryWarning(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterBackground(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterBackground(void);
@ -711,7 +711,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterBackground(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterBackground(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterBackground(void);
@ -728,7 +728,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterBackground(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterForeground(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterForeground(void);
@ -745,7 +745,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationWillEnterForeground(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterForeground(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterForeground(void);
@ -764,7 +764,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidEnterForeground(void);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidChangeStatusBarOrientation(void); extern SDL_DECLSPEC void SDLCALL SDL_OnApplicationDidChangeStatusBarOrientation(void);
#endif #endif
@ -788,7 +788,7 @@ typedef struct XUser *XUserHandle;
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle *outTaskQueue); extern SDL_DECLSPEC bool SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle *outTaskQueue);
@ -803,7 +803,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle *outTaskQu
* \returns true if success or false on failure; call SDL_GetError() for more * \returns true if success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetGDKDefaultUser(XUserHandle *outUserHandle); extern SDL_DECLSPEC bool SDLCALL SDL_GetGDKDefaultUser(XUserHandle *outUserHandle);

38
include/SDL3/SDL_thread.h
View file

@ -62,7 +62,7 @@ extern "C" {
* *
* These are opaque data. * These are opaque data.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_CreateThread * \sa SDL_CreateThread
* \sa SDL_WaitThread * \sa SDL_WaitThread
@ -76,7 +76,7 @@ typedef struct SDL_Thread SDL_Thread;
* application will operate on, but having a way to uniquely identify a thread * application will operate on, but having a way to uniquely identify a thread
* can be useful at times. * can be useful at times.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_GetThreadID * \sa SDL_GetThreadID
* \sa SDL_GetCurrentThreadID * \sa SDL_GetCurrentThreadID
@ -89,7 +89,7 @@ typedef Uint64 SDL_ThreadID;
* 0 is the invalid ID. An app can create these and then set data for these * 0 is the invalid ID. An app can create these and then set data for these
* IDs that is unique to each thread. * IDs that is unique to each thread.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_GetTLS * \sa SDL_GetTLS
* \sa SDL_SetTLS * \sa SDL_SetTLS
@ -105,7 +105,7 @@ typedef SDL_AtomicInt SDL_TLSID;
* state. SDL_HINT_THREAD_PRIORITY_POLICY can be used to control aspects of * state. SDL_HINT_THREAD_PRIORITY_POLICY can be used to control aspects of
* this behavior. * this behavior.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_ThreadPriority { typedef enum SDL_ThreadPriority {
SDL_THREAD_PRIORITY_LOW, SDL_THREAD_PRIORITY_LOW,
@ -119,7 +119,7 @@ typedef enum SDL_ThreadPriority {
* *
* The current state of a thread can be checked by calling SDL_GetThreadState. * The current state of a thread can be checked by calling SDL_GetThreadState.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_GetThreadState * \sa SDL_GetThreadState
*/ */
@ -137,7 +137,7 @@ typedef enum SDL_ThreadState
* \param data what was passed as `data` to SDL_CreateThread(). * \param data what was passed as `data` to SDL_CreateThread().
* \returns a value that can be reported through SDL_WaitThread(). * \returns a value that can be reported through SDL_WaitThread().
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef int (SDLCALL * SDL_ThreadFunction) (void *data); typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
@ -207,7 +207,7 @@ typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
* new thread could not be created; call SDL_GetError() for more * new thread could not be created; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateThreadWithProperties * \sa SDL_CreateThreadWithProperties
* \sa SDL_WaitThread * \sa SDL_WaitThread
@ -273,7 +273,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(SDL_ThreadFunction fn,
* new thread could not be created; call SDL_GetError() for more * new thread could not be created; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateThread * \sa SDL_CreateThread
* \sa SDL_WaitThread * \sa SDL_WaitThread
@ -362,7 +362,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithPropertiesRuntime(S
* \returns a pointer to a UTF-8 string that names the specified thread, or * \returns a pointer to a UTF-8 string that names the specified thread, or
* NULL if it doesn't have a name. * NULL if it doesn't have a name.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetThreadName(SDL_Thread *thread); extern SDL_DECLSPEC const char * SDLCALL SDL_GetThreadName(SDL_Thread *thread);
@ -378,7 +378,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetThreadName(SDL_Thread *thread);
* *
* \returns the ID of the current thread. * \returns the ID of the current thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetThreadID * \sa SDL_GetThreadID
*/ */
@ -395,7 +395,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 * \returns the ID of the specified thread, or the ID of the current thread if
* `thread` is NULL. * `thread` is NULL.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetCurrentThreadID * \sa SDL_GetCurrentThreadID
*/ */
@ -412,7 +412,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority priority); extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority priority);
@ -444,7 +444,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority
* function by its 'return', or -1 if the thread has been * function by its 'return', or -1 if the thread has been
* detached or isn't valid, may be NULL. * detached or isn't valid, may be NULL.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateThread * \sa SDL_CreateThread
* \sa SDL_DetachThread * \sa SDL_DetachThread
@ -458,7 +458,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status)
* \returns the current state of a thread, or SDL_THREAD_UNKNOWN if the thread * \returns the current state of a thread, or SDL_THREAD_UNKNOWN if the thread
* isn't valid. * isn't valid.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_ThreadState * \sa SDL_ThreadState
*/ */
@ -493,7 +493,7 @@ extern SDL_DECLSPEC SDL_ThreadState SDLCALL SDL_GetThreadState(SDL_Thread *threa
* \param thread the SDL_Thread pointer that was returned from the * \param thread the SDL_Thread pointer that was returned from the
* SDL_CreateThread() call that started this thread. * SDL_CreateThread() call that started this thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateThread * \sa SDL_CreateThread
* \sa SDL_WaitThread * \sa SDL_WaitThread
@ -509,7 +509,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DetachThread(SDL_Thread *thread);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_SetTLS * \sa SDL_SetTLS
*/ */
@ -522,7 +522,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetTLS(SDL_TLSID *id);
* *
* \param value a pointer previously handed to SDL_SetTLS. * \param value a pointer previously handed to SDL_SetTLS.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
* *
* \sa SDL_SetTLS * \sa SDL_SetTLS
*/ */
@ -550,7 +550,7 @@ typedef void (SDLCALL *SDL_TLSDestructorCallback)(void *value);
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTLS * \sa SDL_GetTLS
*/ */
@ -565,7 +565,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. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_CleanupTLS(void); extern SDL_DECLSPEC void SDLCALL SDL_CleanupTLS(void);

24
include/SDL3/SDL_time.h
View file

@ -49,7 +49,7 @@ extern "C" {
* A structure holding a calendar date and time broken down into its * A structure holding a calendar date and time broken down into its
* components. * components.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
*/ */
typedef struct SDL_DateTime typedef struct SDL_DateTime
{ {
@ -67,7 +67,7 @@ typedef struct SDL_DateTime
/** /**
* The preferred date format of the current system locale. * The preferred date format of the current system locale.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_GetDateTimeLocalePreferences * \sa SDL_GetDateTimeLocalePreferences
*/ */
@ -81,7 +81,7 @@ typedef enum SDL_DateFormat
/** /**
* The preferred time format of the current system locale. * The preferred time format of the current system locale.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
* *
* \sa SDL_GetDateTimeLocalePreferences * \sa SDL_GetDateTimeLocalePreferences
*/ */
@ -106,7 +106,7 @@ typedef enum SDL_TimeFormat
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFormat *dateFormat, SDL_TimeFormat *timeFormat); extern SDL_DECLSPEC bool SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFormat *dateFormat, SDL_TimeFormat *timeFormat);
@ -118,7 +118,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFormat
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_GetCurrentTime(SDL_Time *ticks); extern SDL_DECLSPEC bool SDLCALL SDL_GetCurrentTime(SDL_Time *ticks);
@ -134,7 +134,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetCurrentTime(SDL_Time *ticks);
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime *dt, bool localTime); extern SDL_DECLSPEC bool SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime *dt, bool localTime);
@ -149,7 +149,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 * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC bool SDLCALL SDL_DateTimeToTime(const SDL_DateTime *dt, SDL_Time *ticks); extern SDL_DECLSPEC bool SDLCALL SDL_DateTimeToTime(const SDL_DateTime *dt, SDL_Time *ticks);
@ -165,7 +165,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 * \param dwHighDateTime a pointer filled in with the high portion of the
* Windows FILETIME value. * Windows FILETIME value.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_TimeToWindows(SDL_Time ticks, Uint32 *dwLowDateTime, Uint32 *dwHighDateTime); extern SDL_DECLSPEC void SDLCALL SDL_TimeToWindows(SDL_Time ticks, Uint32 *dwLowDateTime, Uint32 *dwHighDateTime);
@ -180,7 +180,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_TimeToWindows(SDL_Time ticks, Uint32 *dwLow
* \param dwHighDateTime the high portion of the Windows FILETIME value. * \param dwHighDateTime the high portion of the Windows FILETIME value.
* \returns the converted SDL time. * \returns the converted SDL time.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Time SDLCALL SDL_TimeFromWindows(Uint32 dwLowDateTime, Uint32 dwHighDateTime); extern SDL_DECLSPEC SDL_Time SDLCALL SDL_TimeFromWindows(Uint32 dwLowDateTime, Uint32 dwHighDateTime);
@ -192,7 +192,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 * \returns the number of days in the requested month or -1 on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month); extern SDL_DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month);
@ -205,7 +205,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; * \returns the day of year [0-365] if the date is valid or -1 on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day); extern SDL_DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day);
@ -218,7 +218,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 * \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. * -1 on failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC int SDLCALL SDL_GetDayOfWeek(int year, int month, int day); extern SDL_DECLSPEC int SDLCALL SDL_GetDayOfWeek(int year, int month, int day);

48
include/SDL3/SDL_timer.h
View file

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

20
include/SDL3/SDL_touch.h
View file

@ -57,7 +57,7 @@ extern "C" {
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint64 SDL_TouchID; typedef Uint64 SDL_TouchID;
@ -71,14 +71,14 @@ typedef Uint64 SDL_TouchID;
* *
* The value 0 is an invalid ID. * The value 0 is an invalid ID.
* *
* \since This datatype is available since SDL 3.1.3. * \since This datatype is available since SDL 3.2.0.
*/ */
typedef Uint64 SDL_FingerID; typedef Uint64 SDL_FingerID;
/** /**
* An enum that describes the type of a touch device. * An enum that describes the type of a touch device.
* *
* \since This enum is available since SDL 3.1.3. * \since This enum is available since SDL 3.2.0.
*/ */
typedef enum SDL_TouchDeviceType typedef enum SDL_TouchDeviceType
{ {
@ -95,7 +95,7 @@ typedef enum SDL_TouchDeviceType
* contact with the touch device (so a "touch" can be a "multitouch," in * contact with the touch device (so a "touch" can be a "multitouch," in
* reality), and this struct reports details of the specific fingers. * reality), and this struct reports details of the specific fingers.
* *
* \since This struct is available since SDL 3.1.3. * \since This struct is available since SDL 3.2.0.
* *
* \sa SDL_GetTouchFingers * \sa SDL_GetTouchFingers
*/ */
@ -110,14 +110,14 @@ typedef struct SDL_Finger
/** /**
* The SDL_MouseID for mouse events simulated with touch input. * The SDL_MouseID for mouse events simulated with touch input.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_TOUCH_MOUSEID ((SDL_MouseID)-1) #define SDL_TOUCH_MOUSEID ((SDL_MouseID)-1)
/** /**
* The SDL_TouchID for touch events simulated with mouse input. * The SDL_TouchID for touch events simulated with mouse input.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_MOUSE_TOUCHID ((SDL_TouchID)-1) #define SDL_MOUSE_TOUCHID ((SDL_TouchID)-1)
@ -135,7 +135,7 @@ typedef struct SDL_Finger
* SDL_GetError() for more information. This should be freed with * SDL_GetError() for more information. This should be freed with
* SDL_free() when it is no longer needed. * SDL_free() when it is no longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_TouchID * SDLCALL SDL_GetTouchDevices(int *count); extern SDL_DECLSPEC SDL_TouchID * SDLCALL SDL_GetTouchDevices(int *count);
@ -146,7 +146,7 @@ extern SDL_DECLSPEC SDL_TouchID * SDLCALL SDL_GetTouchDevices(int *count);
* \returns touch device name, or NULL on failure; call SDL_GetError() for * \returns touch device name, or NULL on failure; call SDL_GetError() for
* more information. * more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC const char * SDLCALL SDL_GetTouchDeviceName(SDL_TouchID touchID); extern SDL_DECLSPEC const char * SDLCALL SDL_GetTouchDeviceName(SDL_TouchID touchID);
@ -156,7 +156,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetTouchDeviceName(SDL_TouchID touc
* \param touchID the ID of a touch device. * \param touchID the ID of a touch device.
* \returns touch device type. * \returns touch device type.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_TouchID touchID); extern SDL_DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_TouchID touchID);
@ -171,7 +171,7 @@ extern SDL_DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_Touch
* allocation that should be freed with SDL_free() when it is no * allocation that should be freed with SDL_free() when it is no
* longer needed. * longer needed.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_Finger ** SDLCALL SDL_GetTouchFingers(SDL_TouchID touchID, int *count); extern SDL_DECLSPEC SDL_Finger ** SDLCALL SDL_GetTouchFingers(SDL_TouchID touchID, int *count);

44
include/SDL3/SDL_tray.h
View file

@ -112,7 +112,7 @@ typedef void (SDLCALL *SDL_TrayCallback)(void *userdata, SDL_TrayEntry *entry);
* *
* \threadsafety This function should only be called on the main thread. * \threadsafety This function should only be called on the main thread.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTrayMenu * \sa SDL_CreateTrayMenu
* \sa SDL_GetTrayMenu * \sa SDL_GetTrayMenu
@ -129,7 +129,7 @@ extern SDL_DECLSPEC SDL_Tray *SDLCALL SDL_CreateTray(SDL_Surface *icon, const ch
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTray * \sa SDL_CreateTray
*/ */
@ -144,7 +144,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayIcon(SDL_Tray *tray, SDL_Surface *ic
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTray * \sa SDL_CreateTray
*/ */
@ -166,7 +166,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayTooltip(SDL_Tray *tray, const char *
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTray * \sa SDL_CreateTray
* \sa SDL_GetTrayMenu * \sa SDL_GetTrayMenu
@ -190,7 +190,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_CreateTrayMenu(SDL_Tray *tray);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
* \sa SDL_GetTraySubmenu * \sa SDL_GetTraySubmenu
@ -215,7 +215,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_CreateTraySubmenu(SDL_TrayEntry *e
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTray * \sa SDL_CreateTray
* \sa SDL_CreateTrayMenu * \sa SDL_CreateTrayMenu
@ -239,7 +239,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_GetTrayMenu(SDL_Tray *tray);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
* \sa SDL_CreateTraySubmenu * \sa SDL_CreateTraySubmenu
@ -259,7 +259,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_GetTraySubmenu(SDL_TrayEntry *entr
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_RemoveTrayEntry * \sa SDL_RemoveTrayEntry
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -274,7 +274,7 @@ extern SDL_DECLSPEC const SDL_TrayEntry **SDLCALL SDL_GetTrayEntries(SDL_TrayMen
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -300,7 +300,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveTrayEntry(SDL_TrayEntry *entry);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_TrayEntryFlags * \sa SDL_TrayEntryFlags
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
@ -323,7 +323,7 @@ extern SDL_DECLSPEC SDL_TrayEntry *SDLCALL SDL_InsertTrayEntryAt(SDL_TrayMenu *m
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -342,7 +342,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryLabel(SDL_TrayEntry *entry, con
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -361,7 +361,7 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetTrayEntryLabel(SDL_TrayEntry *ent
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -380,7 +380,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryChecked(SDL_TrayEntry *entry, b
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -397,7 +397,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTrayEntryChecked(SDL_TrayEntry *entry);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -414,7 +414,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryEnabled(SDL_TrayEntry *entry, b
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -433,7 +433,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTrayEntryEnabled(SDL_TrayEntry *entry);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetTrayEntries * \sa SDL_GetTrayEntries
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
@ -448,7 +448,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryCallback(SDL_TrayEntry *entry,
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.10. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_ClickTrayEntry(SDL_TrayEntry *entry); extern SDL_DECLSPEC void SDLCALL SDL_ClickTrayEntry(SDL_TrayEntry *entry);
@ -462,7 +462,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ClickTrayEntry(SDL_TrayEntry *entry);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTray * \sa SDL_CreateTray
*/ */
@ -477,7 +477,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyTray(SDL_Tray *tray);
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_InsertTrayEntryAt * \sa SDL_InsertTrayEntryAt
*/ */
@ -496,7 +496,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_GetTrayEntryParent(SDL_TrayEntry *
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTraySubmenu * \sa SDL_CreateTraySubmenu
* \sa SDL_GetTrayMenuParentTray * \sa SDL_GetTrayMenuParentTray
@ -516,7 +516,7 @@ extern SDL_DECLSPEC SDL_TrayEntry *SDLCALL SDL_GetTrayMenuParentEntry(SDL_TrayMe
* \threadsafety This function should be called on the thread that created the * \threadsafety This function should be called on the thread that created the
* tray. * tray.
* *
* \since This function is available since SDL 3.1.8. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_CreateTrayMenu * \sa SDL_CreateTrayMenu
* \sa SDL_GetTrayMenuParentEntry * \sa SDL_GetTrayMenuParentEntry

22
include/SDL3/SDL_version.h
View file

@ -42,7 +42,7 @@ extern "C" {
* *
* If this were SDL version 3.2.1, this value would be 3. * If this were SDL version 3.2.1, this value would be 3.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_MAJOR_VERSION 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. * If this were SDL version 3.2.1, this value would be 2.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_MINOR_VERSION 2 #define SDL_MINOR_VERSION 2
@ -60,7 +60,7 @@ extern "C" {
* *
* If this were SDL version 3.2.1, this value would be 1. * If this were SDL version 3.2.1, this value would be 1.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_MICRO_VERSION 0 #define SDL_MICRO_VERSION 0
@ -73,7 +73,7 @@ extern "C" {
* \param minor the minorversion number. * \param minor the minorversion number.
* \param patch the patch version number. * \param patch the patch version number.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_VERSIONNUM(major, minor, patch) \ #define SDL_VERSIONNUM(major, minor, patch) \
((major) * 1000000 + (minor) * 1000 + (patch)) ((major) * 1000000 + (minor) * 1000 + (patch))
@ -85,7 +85,7 @@ extern "C" {
* *
* \param version the version number. * \param version the version number.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_VERSIONNUM_MAJOR(version) ((version) / 1000000) #define SDL_VERSIONNUM_MAJOR(version) ((version) / 1000000)
@ -96,7 +96,7 @@ extern "C" {
* *
* \param version the version number. * \param version the version number.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_VERSIONNUM_MINOR(version) (((version) / 1000) % 1000) #define SDL_VERSIONNUM_MINOR(version) (((version) / 1000) % 1000)
@ -107,14 +107,14 @@ extern "C" {
* *
* \param version the version number. * \param version the version number.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_VERSIONNUM_MICRO(version) ((version) % 1000) #define SDL_VERSIONNUM_MICRO(version) ((version) % 1000)
/** /**
* This is the version number macro for the current SDL version. * This is the version number macro for the current SDL version.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
* *
* \sa SDL_GetVersion * \sa SDL_GetVersion
*/ */
@ -124,7 +124,7 @@ extern "C" {
/** /**
* This macro will evaluate to true if compiled with SDL at least X.Y.Z. * This macro will evaluate to true if compiled with SDL at least X.Y.Z.
* *
* \since This macro is available since SDL 3.1.3. * \since This macro is available since SDL 3.2.0.
*/ */
#define SDL_VERSION_ATLEAST(X, Y, Z) \ #define SDL_VERSION_ATLEAST(X, Y, Z) \
(SDL_VERSION >= SDL_VERSIONNUM(X, Y, Z)) (SDL_VERSION >= SDL_VERSIONNUM(X, Y, Z))
@ -141,7 +141,7 @@ extern "C" {
* *
* \returns the version of the linked library. * \returns the version of the linked library.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetRevision * \sa SDL_GetRevision
*/ */
@ -167,7 +167,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetVersion(void);
* \returns an arbitrary string, uniquely identifying the exact revision of * \returns an arbitrary string, uniquely identifying the exact revision of
* the SDL library in use. * the SDL library in use.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GetVersion * \sa SDL_GetVersion
*/ */

280
include/SDL3/SDL_video.h
View file

File diff suppressed because it is too large Load diff

14
include/SDL3/SDL_vulkan.h
View file

@ -125,7 +125,7 @@ struct VkAllocationCallbacks;
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Vulkan_GetVkGetInstanceProcAddr * \sa SDL_Vulkan_GetVkGetInstanceProcAddr
* \sa SDL_Vulkan_UnloadLibrary * \sa SDL_Vulkan_UnloadLibrary
@ -149,7 +149,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Vulkan_LoadLibrary(const char *path);
* \returns the function pointer for `vkGetInstanceProcAddr` or NULL on * \returns the function pointer for `vkGetInstanceProcAddr` or NULL on
* failure; call SDL_GetError() for more information. * failure; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
*/ */
extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void); extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void);
@ -169,7 +169,7 @@ extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_Vulkan_GetVkGetInstanceProcA
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Vulkan_LoadLibrary * \sa SDL_Vulkan_LoadLibrary
*/ */
@ -193,7 +193,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void);
* \returns an array of extension name strings on success, NULL on failure; * \returns an array of extension name strings on success, NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Vulkan_CreateSurface * \sa SDL_Vulkan_CreateSurface
*/ */
@ -218,7 +218,7 @@ extern SDL_DECLSPEC char const * const * SDLCALL SDL_Vulkan_GetInstanceExtension
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Vulkan_GetInstanceExtensions * \sa SDL_Vulkan_GetInstanceExtensions
* \sa SDL_Vulkan_DestroySurface * \sa SDL_Vulkan_DestroySurface
@ -246,7 +246,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Vulkan_CreateSurface(SDL_Window *window,
* \param allocator a VkAllocationCallbacks struct, which lets the app set the * \param allocator a VkAllocationCallbacks struct, which lets the app set the
* allocator that destroys the surface. Can be NULL. * allocator that destroys the surface. Can be NULL.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Vulkan_GetInstanceExtensions * \sa SDL_Vulkan_GetInstanceExtensions
* \sa SDL_Vulkan_CreateSurface * \sa SDL_Vulkan_CreateSurface
@ -268,7 +268,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Vulkan_DestroySurface(VkInstance instance,
* device. * device.
* \returns true if supported, false if unsupported or an error occurred. * \returns true if supported, false if unsupported or an error occurred.
* *
* \since This function is available since SDL 3.1.3. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_Vulkan_GetInstanceExtensions * \sa SDL_Vulkan_GetInstanceExtensions
*/ */