diff --git a/include/SDL.h b/include/SDL.h index 90e173822f..946ff158f9 100644 --- a/include/SDL.h +++ b/include/SDL.h @@ -134,7 +134,7 @@ extern "C" { * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_InitSubSystem * \sa SDL_Quit @@ -152,7 +152,7 @@ extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Init * \sa SDL_Quit @@ -175,7 +175,7 @@ extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); * * \param flags any of the flags used by SDL_Init(); see SDL_Init for details. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_InitSubSystem * \sa SDL_Quit @@ -191,7 +191,7 @@ extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); * * The return value does not include SDL_INIT_NOPARACHUTE. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Init * \sa SDL_InitSubSystem @@ -215,7 +215,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); * application is shutdown, but it is not wise to do this from a library or * other dynamically loaded code. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Init * \sa SDL_QuitSubSystem diff --git a/include/SDL_assert.h b/include/SDL_assert.h index df399b5dd6..15709e6921 100644 --- a/include/SDL_assert.h +++ b/include/SDL_assert.h @@ -219,7 +219,7 @@ typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)( * fails or NULL for the default handler * \param userdata a pointer that is passed to `handler` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAssertionHandler */ @@ -238,7 +238,7 @@ extern DECLSPEC void SDLCALL SDL_SetAssertionHandler( * \returns the default SDL_AssertionHandler that is called when an assert * triggers. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAssertionHandler */ @@ -261,7 +261,7 @@ extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(void * was passed to SDL_SetAssertionHandler() * \returns the SDL_AssertionHandler that is called when an assert triggers. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetAssertionHandler */ @@ -289,7 +289,7 @@ extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetAssertionHandler(void **puse * \returns a list of all failed assertions or NULL if the list is empty. This * memory should not be modified or freed by the application. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ResetAssertionReport */ @@ -303,7 +303,7 @@ extern DECLSPEC const SDL_AssertData * SDLCALL SDL_GetAssertionReport(void); * no items. In addition, any previously-triggered assertions will be reset to * a trigger_count of zero, and their always_ignore state will be false. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAssertionReport */ diff --git a/include/SDL_atomic.h b/include/SDL_atomic.h index 266b53e12e..09c8a7c67c 100644 --- a/include/SDL_atomic.h +++ b/include/SDL_atomic.h @@ -98,7 +98,7 @@ typedef int SDL_SpinLock; * \returns SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already * held. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicLock * \sa SDL_AtomicUnlock @@ -113,7 +113,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTryLock(SDL_SpinLock *lock); * * \param lock a pointer to a lock variable * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicTryLock * \sa SDL_AtomicUnlock @@ -130,7 +130,7 @@ extern DECLSPEC void SDLCALL SDL_AtomicLock(SDL_SpinLock *lock); * * \param lock a pointer to a lock variable * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicLock * \sa SDL_AtomicTryLock @@ -178,7 +178,7 @@ extern __inline void SDL_CompilerBarrier(void); * For more information on these semantics, take a look at the blog post: * http://preshing.com/20120913/acquire-and-release-semantics * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_MemoryBarrierReleaseFunction(void); extern DECLSPEC void SDLCALL SDL_MemoryBarrierAcquireFunction(void); @@ -269,7 +269,7 @@ typedef struct { int value; } SDL_atomic_t; * \param newval the new value * \returns SDL_TRUE if the atomic variable was set, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicCASPtr * \sa SDL_AtomicGet @@ -289,7 +289,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCAS(SDL_atomic_t *a, int oldval, int * \param v the desired value * \returns the previous value of the atomic variable. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicGet */ @@ -304,7 +304,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicSet(SDL_atomic_t *a, int v); * \param a a pointer to an SDL_atomic_t variable * \returns the current value of an atomic variable. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicSet */ @@ -322,7 +322,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicGet(SDL_atomic_t *a); * \param v the desired value to add * \returns the previous value of the atomic variable. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicDecRef * \sa SDL_AtomicIncRef @@ -357,7 +357,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_atomic_t *a, int v); * \param newval the new pointer value * \returns SDL_TRUE if the pointer was set, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicCAS * \sa SDL_AtomicGetPtr @@ -375,7 +375,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCASPtr(void **a, void *oldval, void * * \param v the desired pointer value * \returns the previous value of the pointer. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicCASPtr * \sa SDL_AtomicGetPtr @@ -391,7 +391,7 @@ extern DECLSPEC void* SDLCALL SDL_AtomicSetPtr(void **a, void* v); * \param a a pointer to a pointer * \returns the current value of a pointer. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicCASPtr * \sa SDL_AtomicSetPtr diff --git a/include/SDL_audio.h b/include/SDL_audio.h index 3ad8e6c9d8..a5d4ef8bf7 100644 --- a/include/SDL_audio.h +++ b/include/SDL_audio.h @@ -269,7 +269,7 @@ typedef struct SDL_AudioCVT * * \returns the number of built-in audio drivers. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAudioDriver */ @@ -291,7 +291,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void); * \returns the name of the audio driver at the requested index, or NULL if an * invalid index was specified. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumAudioDrivers */ @@ -318,7 +318,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AudioQuit */ @@ -332,7 +332,7 @@ extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name); * specific need to specify the audio driver you want to use. You should * normally use SDL_Quit() or SDL_QuitSubSystem(). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AudioInit */ @@ -351,7 +351,7 @@ extern DECLSPEC void SDLCALL SDL_AudioQuit(void); * \returns the name of the current audio driver or NULL if no driver has been * initialized. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AudioInit */ @@ -397,7 +397,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void); * audio device or failure to set up the audio thread; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CloseAudio * \sa SDL_LockAudio @@ -457,7 +457,7 @@ typedef Uint32 SDL_AudioDeviceID; * -1 if an explicit list of devices can't be determined. A return * value of -1 does not necessarily mean an error condition. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAudioDeviceName * \sa SDL_OpenAudioDevice @@ -484,7 +484,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDevices(int iscapture); * \returns the name of the audio device at the requested index, or NULL on * error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumAudioDevices * \sa SDL_GetDefaultAudioInfo @@ -510,7 +510,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName(int index, * \param spec The SDL_AudioSpec to be initialized by this function. * \returns 0 on success, nonzero on error * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumAudioDevices * \sa SDL_GetDefaultAudioInfo @@ -544,7 +544,7 @@ extern DECLSPEC int SDLCALL SDL_GetAudioDeviceSpec(int index, * query the default output device. * \returns 0 on success, nonzero on error * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAudioDeviceName * \sa SDL_GetAudioDeviceSpec @@ -657,7 +657,7 @@ extern DECLSPEC int SDLCALL SDL_GetDefaultAudioInfo(char **name, * For compatibility with SDL 1.2, this will never return 1, since * SDL reserves that ID for the legacy SDL_OpenAudio() function. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CloseAudioDevice * \sa SDL_GetAudioDeviceName @@ -702,7 +702,7 @@ typedef enum * * \returns the SDL_AudioStatus of the audio device opened by SDL_OpenAudio(). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAudioDeviceStatus */ @@ -715,7 +715,7 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioStatus(void); * SDL_OpenAudioDevice() * \returns the SDL_AudioStatus of the specified audio device. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PauseAudioDevice */ @@ -747,7 +747,7 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioDeviceStatus(SDL_AudioDevice * * \param pause_on non-zero to pause, 0 to unpause * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAudioStatus * \sa SDL_PauseAudioDevice @@ -778,7 +778,7 @@ extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on); * \param dev a device opened by SDL_OpenAudioDevice() * \param pause_on non-zero to pause, 0 to unpause * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockAudioDevice */ @@ -862,7 +862,7 @@ extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev, * When the application is done with the data returned in * `audio_buf`, it should call SDL_FreeWAV() to dispose of it. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreeWAV * \sa SDL_LoadWAV @@ -890,7 +890,7 @@ extern DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW(SDL_RWops * src, * \param audio_buf a pointer to the buffer created by SDL_LoadWAV() or * SDL_LoadWAV_RW() * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadWAV * \sa SDL_LoadWAV_RW @@ -925,7 +925,7 @@ extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 * audio_buf); * or a negative error code on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ConvertAudio */ @@ -971,7 +971,7 @@ extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT * cvt, * \returns 0 if the conversion was completed successfully or a negative error * code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BuildAudioCVT */ @@ -999,7 +999,7 @@ typedef struct _SDL_AudioStream SDL_AudioStream; * \param dst_rate The sampling rate of the desired audio output * \returns 0 on success, or -1 on error. * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AudioStreamPut * \sa SDL_AudioStreamGet @@ -1023,7 +1023,7 @@ extern DECLSPEC SDL_AudioStream * SDLCALL SDL_NewAudioStream(const SDL_AudioForm * \param len The number of bytes to write to the stream * \returns 0 on success, or -1 on error. * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NewAudioStream * \sa SDL_AudioStreamGet @@ -1042,7 +1042,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamPut(SDL_AudioStream *stream, const vo * \param len The maximum number of bytes to fill * \returns the number of bytes read from the stream, or -1 on error * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NewAudioStream * \sa SDL_AudioStreamPut @@ -1060,7 +1060,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamGet(SDL_AudioStream *stream, void *bu * resample correctly, so this number might be lower than what you expect, or * even be zero. Add more data or flush the stream if you need the data now. * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NewAudioStream * \sa SDL_AudioStreamPut @@ -1079,7 +1079,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamAvailable(SDL_AudioStream *stream); * audio gaps in the output. Generally this is intended to signal the end of * input, so the complete output becomes available. * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NewAudioStream * \sa SDL_AudioStreamPut @@ -1093,7 +1093,7 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamFlush(SDL_AudioStream *stream); /** * Clear any pending data in the stream without converting it * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NewAudioStream * \sa SDL_AudioStreamPut @@ -1107,7 +1107,7 @@ extern DECLSPEC void SDLCALL SDL_AudioStreamClear(SDL_AudioStream *stream); /** * Free an audio stream * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NewAudioStream * \sa SDL_AudioStreamPut @@ -1138,7 +1138,7 @@ extern DECLSPEC void SDLCALL SDL_FreeAudioStream(SDL_AudioStream *stream); * \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME * for full audio volume * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_MixAudioFormat */ @@ -1173,7 +1173,7 @@ extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 * dst, const Uint8 * src, * \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME * for full audio volume * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst, const Uint8 * src, @@ -1221,7 +1221,7 @@ extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ClearQueuedAudio * \sa SDL_GetQueuedAudioSize @@ -1269,7 +1269,7 @@ extern DECLSPEC int SDLCALL SDL_QueueAudio(SDL_AudioDeviceID dev, const void *da * \returns the number of bytes dequeued, which could be less than requested; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ClearQueuedAudio * \sa SDL_GetQueuedAudioSize @@ -1302,7 +1302,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_DequeueAudio(SDL_AudioDeviceID dev, void *dat * \param dev the device ID of which we will query queued audio size * \returns the number of bytes (not samples!) of queued audio. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ClearQueuedAudio * \sa SDL_QueueAudio @@ -1336,7 +1336,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetQueuedAudioSize(SDL_AudioDeviceID dev); * * \param dev the device ID of which to clear the audio queue * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetQueuedAudioSize * \sa SDL_QueueAudio @@ -1367,7 +1367,7 @@ extern DECLSPEC void SDLCALL SDL_ClearQueuedAudio(SDL_AudioDeviceID dev); * * ...and is only useful if you used the legacy SDL_OpenAudio() function. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockAudioDevice * \sa SDL_UnlockAudio @@ -1408,7 +1408,7 @@ extern DECLSPEC void SDLCALL SDL_LockAudio(void); * * \param dev the ID of the device to be locked * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_UnlockAudioDevice */ @@ -1426,7 +1426,7 @@ extern DECLSPEC void SDLCALL SDL_LockAudioDevice(SDL_AudioDeviceID dev); * * ...and is only useful if you used the legacy SDL_OpenAudio() function. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockAudio * \sa SDL_UnlockAudioDevice @@ -1441,7 +1441,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudio(void); * * \param dev the ID of the device to be unlocked * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockAudioDevice */ @@ -1459,7 +1459,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev); * * ...and is only useful if you used the legacy SDL_OpenAudio() function. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_OpenAudio */ @@ -1483,7 +1483,7 @@ extern DECLSPEC void SDLCALL SDL_CloseAudio(void); * * \param dev an audio device previously opened with SDL_OpenAudioDevice() * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_OpenAudioDevice */ diff --git a/include/SDL_blendmode.h b/include/SDL_blendmode.h index 08c9f9dd65..0df3d14567 100644 --- a/include/SDL_blendmode.h +++ b/include/SDL_blendmode.h @@ -173,7 +173,7 @@ typedef enum * \returns an SDL_BlendMode that represents the chosen factors and * operations. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRenderDrawBlendMode * \sa SDL_GetRenderDrawBlendMode diff --git a/include/SDL_clipboard.h b/include/SDL_clipboard.h index 783c7c251a..29be3b8911 100644 --- a/include/SDL_clipboard.h +++ b/include/SDL_clipboard.h @@ -45,7 +45,7 @@ extern "C" { * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetClipboardText * \sa SDL_HasClipboardText @@ -63,7 +63,7 @@ extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text); * on the returned pointer when done with it (even if there was an * error). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasClipboardText * \sa SDL_SetClipboardText @@ -75,7 +75,7 @@ extern DECLSPEC char * SDLCALL SDL_GetClipboardText(void); * * \returns SDL_TRUE if the clipboard has text, or SDL_FALSE if it does not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetClipboardText * \sa SDL_SetClipboardText @@ -89,7 +89,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetPrimarySelectionText * \sa SDL_HasPrimarySelectionText @@ -108,7 +108,7 @@ extern DECLSPEC int SDLCALL SDL_SetPrimarySelectionText(const char *text); * call SDL_free() on the returned pointer when done with it (even if * there was an error). * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasPrimarySelectionText * \sa SDL_SetPrimarySelectionText @@ -122,7 +122,7 @@ extern DECLSPEC char * SDLCALL SDL_GetPrimarySelectionText(void); * \returns SDL_TRUE if the primary selection has text, or SDL_FALSE if it * does not. * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetPrimarySelectionText * \sa SDL_SetPrimarySelectionText diff --git a/include/SDL_cpuinfo.h b/include/SDL_cpuinfo.h index 1d224420b1..a810d5e2a5 100644 --- a/include/SDL_cpuinfo.h +++ b/include/SDL_cpuinfo.h @@ -144,7 +144,7 @@ extern "C" { * technologies such as hyperthreading, the number of logical cores * may be more than the number of physical cores. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GetCPUCount(void); @@ -156,7 +156,7 @@ extern DECLSPEC int SDLCALL SDL_GetCPUCount(void); * * \returns the L1 cache line size of the CPU, in bytes. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void); @@ -167,7 +167,7 @@ extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void); * * \returns SDL_TRUE if the CPU has the RDTSC instruction or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -190,7 +190,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void); * * \returns SDL_TRUE if the CPU has AltiVec features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAVX @@ -212,7 +212,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void); * * \returns SDL_TRUE if the CPU has MMX features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -234,7 +234,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void); * * \returns SDL_TRUE if the CPU has 3DNow! features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasAltiVec * \sa SDL_HasAVX @@ -256,7 +256,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void); * * \returns SDL_TRUE if the CPU has SSE features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -278,7 +278,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void); * * \returns SDL_TRUE if the CPU has SSE2 features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -300,7 +300,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void); * * \returns SDL_TRUE if the CPU has SSE3 features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -322,7 +322,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE3(void); * * \returns SDL_TRUE if the CPU has SSE4.1 features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -344,7 +344,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE41(void); * * \returns SDL_TRUE if the CPU has SSE4.2 features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -366,7 +366,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE42(void); * * \returns SDL_TRUE if the CPU has AVX features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -388,7 +388,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX(void); * * \returns SDL_TRUE if the CPU has AVX2 features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Has3DNow * \sa SDL_HasAltiVec @@ -410,7 +410,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX2(void); * * \returns SDL_TRUE if the CPU has AVX-512F features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasAVX */ @@ -425,7 +425,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX512F(void); * * \returns SDL_TRUE if the CPU has ARM SIMD features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasNEON */ @@ -438,7 +438,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasARMSIMD(void); * * \returns SDL_TRUE if the CPU has ARM NEON features or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_HasNEON(void); @@ -451,7 +451,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasNEON(void); * \returns SDL_TRUE if the CPU has LOONGARCH LSX features or SDL_FALSE if * not. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_HasLSX(void); @@ -464,7 +464,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasLSX(void); * \returns SDL_TRUE if the CPU has LOONGARCH LASX features or SDL_FALSE if * not. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_HasLASX(void); @@ -473,7 +473,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasLASX(void); * * \returns the amount of RAM configured in the system in MiB. * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GetSystemRAM(void); @@ -492,7 +492,7 @@ extern DECLSPEC int SDLCALL SDL_GetSystemRAM(void); * \returns the alignment in bytes needed for available, known SIMD * instructions. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC size_t SDLCALL SDL_SIMDGetAlignment(void); @@ -527,7 +527,7 @@ extern DECLSPEC size_t SDLCALL SDL_SIMDGetAlignment(void); * allocated block might be larger due to padding, etc. * \returns a pointer to the newly-allocated block, NULL if out of memory. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SIMDGetAlignment * \sa SDL_SIMDRealloc @@ -551,7 +551,7 @@ extern DECLSPEC void * SDLCALL SDL_SIMDAlloc(const size_t len); * memory. * \returns a pointer to the newly-reallocated block, NULL if out of memory. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SIMDGetAlignment * \sa SDL_SIMDAlloc @@ -576,7 +576,7 @@ extern DECLSPEC void * SDLCALL SDL_SIMDRealloc(void *mem, const size_t len); * \param ptr The pointer, returned from SDL_SIMDAlloc or SDL_SIMDRealloc, to * deallocate. NULL is a legal no-op. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SIMDAlloc * \sa SDL_SIMDRealloc diff --git a/include/SDL_error.h b/include/SDL_error.h index 5c961e4284..e4fda71d69 100644 --- a/include/SDL_error.h +++ b/include/SDL_error.h @@ -58,7 +58,7 @@ extern "C" { * any * \returns always -1. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ClearError * \sa SDL_GetError @@ -95,7 +95,7 @@ extern DECLSPEC int SDLCALL SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fm * return values of SDL function calls to determine when to * appropriately call SDL_GetError(). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ClearError * \sa SDL_SetError @@ -113,7 +113,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetError(void); * \param maxlen The size of the buffer pointed to by the errstr parameter * \returns the pointer passed in as the `errstr` parameter. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetError */ @@ -122,7 +122,7 @@ extern DECLSPEC char * SDLCALL SDL_GetErrorMsg(char *errstr, int maxlen); /** * Clear any previous error message for this thread. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetError * \sa SDL_SetError diff --git a/include/SDL_events.h b/include/SDL_events.h index 55a343e080..3d02beedc4 100644 --- a/include/SDL_events.h +++ b/include/SDL_events.h @@ -695,7 +695,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_Event, sizeof(SDL_Event) == sizeof(((SDL_Event *)NUL * polling or waiting for events (e.g. you are filtering them), then you must * call SDL_PumpEvents() to force an event queue update. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PollEvent * \sa SDL_WaitEvent @@ -742,7 +742,7 @@ typedef enum * \returns the number of events actually stored or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PollEvent * \sa SDL_PumpEvents @@ -763,7 +763,7 @@ extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents, * \returns SDL_TRUE if events matching `type` are present, or SDL_FALSE if * events matching `type` are not present. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasEvents */ @@ -782,7 +782,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type); * \returns SDL_TRUE if events with type >= `minType` and <= `maxType` are * present, or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasEvents */ @@ -804,7 +804,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType); * * \param type the type of event to be cleared; see SDL_EventType for details * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FlushEvents */ @@ -829,7 +829,7 @@ extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type); * \param maxType the high end of event type to be cleared, inclusive; see * SDL_EventType for details * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FlushEvent */ @@ -871,7 +871,7 @@ extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType); * the queue, or NULL * \returns 1 if there is a pending event or 0 if there are none available. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetEventFilter * \sa SDL_PeepEvents @@ -896,7 +896,7 @@ extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event); * \returns 1 on success or 0 if there was an error while waiting for events; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PollEvent * \sa SDL_PumpEvents @@ -922,7 +922,7 @@ extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event); * call SDL_GetError() for more information. This also returns 0 if * the timeout elapsed without an event arriving. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PollEvent * \sa SDL_PumpEvents @@ -957,7 +957,7 @@ extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event, * code on failure; call SDL_GetError() for more information. A * common reason for error is the event queue being full. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PeepEvents * \sa SDL_PollEvent @@ -1013,7 +1013,7 @@ typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event); * \param filter An SDL_EventFilter function to call when an event happens * \param userdata a pointer that is passed to `filter` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AddEventWatch * \sa SDL_EventState @@ -1035,7 +1035,7 @@ extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter, * be stored here * \returns SDL_TRUE on success or SDL_FALSE if there is no event filter set. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetEventFilter */ @@ -1063,7 +1063,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter, * \param filter an SDL_EventFilter function to call when an event happens. * \param userdata a pointer that is passed to `filter` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DelEventWatch * \sa SDL_SetEventFilter @@ -1080,7 +1080,7 @@ extern DECLSPEC void SDLCALL SDL_AddEventWatch(SDL_EventFilter filter, * \param filter the function originally passed to SDL_AddEventWatch() * \param userdata the pointer originally passed to SDL_AddEventWatch() * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AddEventWatch */ @@ -1098,7 +1098,7 @@ extern DECLSPEC void SDLCALL SDL_DelEventWatch(SDL_EventFilter filter, * \param filter the SDL_EventFilter function to call when an event happens * \param userdata a pointer that is passed to `filter` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetEventFilter * \sa SDL_SetEventFilter @@ -1127,7 +1127,7 @@ extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter, * \returns `SDL_DISABLE` or `SDL_ENABLE`, representing the processing state * of the event before this function makes any changes to it. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetEventState */ @@ -1149,7 +1149,7 @@ extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state); * \returns the beginning event number, or (Uint32)-1 if there are not enough * user-defined events left. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PushEvent */ diff --git a/include/SDL_filesystem.h b/include/SDL_filesystem.h index 1914f81d91..7baa343b44 100644 --- a/include/SDL_filesystem.h +++ b/include/SDL_filesystem.h @@ -75,7 +75,7 @@ extern "C" { * doesn't implement this functionality, call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetPrefPath */ @@ -132,7 +132,7 @@ extern DECLSPEC char *SDLCALL SDL_GetBasePath(void); * notation. NULL if there's a problem (creating directory failed, * etc.). * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetBasePath */ diff --git a/include/SDL_gamecontroller.h b/include/SDL_gamecontroller.h index 4703b63948..66373a8026 100644 --- a/include/SDL_gamecontroller.h +++ b/include/SDL_gamecontroller.h @@ -156,7 +156,7 @@ typedef struct SDL_GameControllerButtonBind * \returns the number of mappings added or -1 on error; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerAddMapping * \sa SDL_GameControllerAddMappingsFromFile @@ -193,7 +193,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw, * \returns 1 if a new mapping is added, 0 if an existing mapping is updated, * -1 on error; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerMapping * \sa SDL_GameControllerMappingForGUID @@ -205,7 +205,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping(const char* mappingStri * * \returns the number of mappings. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerNumMappings(void); @@ -215,7 +215,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerNumMappings(void); * \returns the mapping string. Must be freed with SDL_free(). Returns NULL if * the index is out of range. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForIndex(int mapping_index); @@ -228,7 +228,7 @@ extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForIndex(int mapping_ind * \returns a mapping string or NULL on error; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetDeviceGUID * \sa SDL_JoystickGetGUID @@ -247,7 +247,7 @@ extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID(SDL_JoystickGUID * \returns a string that has the controller's mapping or NULL if no mapping * is available; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerAddMapping * \sa SDL_GameControllerMappingForGUID @@ -265,7 +265,7 @@ extern DECLSPEC char * SDLCALL SDL_GameControllerMapping(SDL_GameController *gam * \returns SDL_TRUE if the given joystick is supported by the game controller * interface, SDL_FALSE if it isn't or it's an invalid index. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerNameForIndex * \sa SDL_GameControllerOpen @@ -285,7 +285,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsGameController(int joystick_index); * \returns the implementation-dependent name for the game controller, or NULL * if there is no name or the index is invalid. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerName * \sa SDL_GameControllerOpen @@ -306,7 +306,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_ * \returns the implementation-dependent path for the game controller, or NULL * if there is no path or the index is invalid. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerPath */ @@ -321,7 +321,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerPathForIndex(int joystick_ * SDL_NumJoysticks()-1 * \returns the controller type. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_GameControllerType SDLCALL SDL_GameControllerTypeForIndex(int joystick_index); @@ -335,7 +335,7 @@ extern DECLSPEC SDL_GameControllerType SDLCALL SDL_GameControllerTypeForIndex(in * \returns the mapping string. Must be freed with SDL_free(). Returns NULL if * no mapping is available. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC char *SDLCALL SDL_GameControllerMappingForDeviceIndex(int joystick_index); @@ -355,7 +355,7 @@ extern DECLSPEC char *SDLCALL SDL_GameControllerMappingForDeviceIndex(int joysti * \returns a gamecontroller identifier or NULL if an error occurred; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerClose * \sa SDL_GameControllerNameForIndex @@ -370,7 +370,7 @@ extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerOpen(int joystick_ * \returns an SDL_GameController on success or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerFromInstanceID(SDL_JoystickID joyid); @@ -384,7 +384,7 @@ extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerFromInstanceID(SDL * instance id! * \returns the SDL_GameController associated with a player index. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetPlayerIndex * \sa SDL_GameControllerSetPlayerIndex @@ -402,7 +402,7 @@ extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerFromPlayerIndex(in * \returns the implementation dependent name for the game controller, or NULL * if there is no name or the identifier passed is invalid. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerNameForIndex * \sa SDL_GameControllerOpen @@ -420,7 +420,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerName(SDL_GameController *g * \returns the implementation dependent path for the game controller, or NULL * if there is no path or the identifier passed is invalid. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerPathForIndex */ @@ -435,7 +435,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerPath(SDL_GameController *g * \param gamecontroller the game controller object to query. * \returns the controller type. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_GameControllerType SDLCALL SDL_GameControllerGetType(SDL_GameController *gamecontroller); @@ -447,7 +447,7 @@ extern DECLSPEC SDL_GameControllerType SDLCALL SDL_GameControllerGetType(SDL_Gam * \param gamecontroller the game controller object to query. * \returns the player index for controller, or -1 if it's not available. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerGetPlayerIndex(SDL_GameController *gamecontroller); @@ -458,7 +458,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetPlayerIndex(SDL_GameController * \param player_index Player index to assign to this controller, or -1 to * clear the player index and turn off player LEDs. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_GameControllerSetPlayerIndex(SDL_GameController *gamecontroller, int player_index); @@ -470,7 +470,7 @@ extern DECLSPEC void SDLCALL SDL_GameControllerSetPlayerIndex(SDL_GameController * \param gamecontroller the game controller object to query. * \return the USB vendor ID, or zero if unavailable. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetVendor(SDL_GameController *gamecontroller); @@ -482,7 +482,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetVendor(SDL_GameController *g * \param gamecontroller the game controller object to query. * \return the USB product ID, or zero if unavailable. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProduct(SDL_GameController *gamecontroller); @@ -494,7 +494,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProduct(SDL_GameController * * \param gamecontroller the game controller object to query. * \return the USB product version, or zero if unavailable. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProductVersion(SDL_GameController *gamecontroller); @@ -506,7 +506,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProductVersion(SDL_GameContr * \param gamecontroller the game controller object to query. * \return the controller firmware version, or zero if unavailable. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetFirmwareVersion(SDL_GameController *gamecontroller); @@ -519,7 +519,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetFirmwareVersion(SDL_GameCont * \param gamecontroller the game controller object to query. * \return the serial number, or NULL if unavailable. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char * SDLCALL SDL_GameControllerGetSerial(SDL_GameController *gamecontroller); @@ -531,7 +531,7 @@ extern DECLSPEC const char * SDLCALL SDL_GameControllerGetSerial(SDL_GameControl * \returns SDL_TRUE if the controller has been opened and is currently * connected, or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerClose * \sa SDL_GameControllerOpen @@ -555,7 +555,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerGetAttached(SDL_GameControlle * joystick from * \returns a SDL_Joystick object; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller); @@ -573,7 +573,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameCont * \returns the same value passed to the function, with exception to -1 * (SDL_QUERY), which will return the current state. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickEventState */ @@ -586,7 +586,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerEventState(int state); * enabled. Under such circumstances, it will not be necessary to call this * function. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void); @@ -628,7 +628,7 @@ typedef enum * \returns the SDL_GameControllerAxis enum corresponding to the input string, * or `SDL_CONTROLLER_AXIS_INVALID` if no match was found. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetStringForAxis */ @@ -644,7 +644,7 @@ extern DECLSPEC SDL_GameControllerAxis SDLCALL SDL_GameControllerGetAxisFromStri * specified. The string returned is of the format used by * SDL_GameController mapping strings. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetAxisFromString */ @@ -659,7 +659,7 @@ extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForAxis(SDL_GameC * (like the given Controller axis doesn't exist on the device), its * `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetBindForButton */ @@ -677,7 +677,7 @@ SDL_GameControllerGetBindForAxis(SDL_GameController *gamecontroller, * \param axis an axis enum value (an SDL_GameControllerAxis value) * \returns SDL_TRUE if the controller has this axis, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasAxis(SDL_GameController *gamecontroller, SDL_GameControllerAxis axis); @@ -695,7 +695,7 @@ SDL_GameControllerHasAxis(SDL_GameController *gamecontroller, SDL_GameController * \returns axis state (including 0) on success or 0 (also) on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetButton */ @@ -744,7 +744,7 @@ typedef enum * \returns the SDL_GameControllerButton enum corresponding to the input * string, or `SDL_CONTROLLER_AXIS_INVALID` if no match was found. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFromString(const char *str); @@ -758,7 +758,7 @@ extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFrom * specified. The string returned is of the format used by * SDL_GameController mapping strings. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetButtonFromString */ @@ -773,7 +773,7 @@ extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForButton(SDL_Gam * (like the given Controller button doesn't exist on the device), * its `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetBindForAxis */ @@ -791,7 +791,7 @@ SDL_GameControllerGetBindForButton(SDL_GameController *gamecontroller, * \param button a button enum value (an SDL_GameControllerButton value) * \returns SDL_TRUE if the controller has this button, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasButton(SDL_GameController *gamecontroller, SDL_GameControllerButton button); @@ -804,7 +804,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasButton(SDL_GameController * \returns 1 for pressed state or 0 for not pressed state or error; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetAxis */ @@ -814,7 +814,7 @@ extern DECLSPEC Uint8 SDLCALL SDL_GameControllerGetButton(SDL_GameController *ga /** * Get the number of touchpads on a game controller. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerGetNumTouchpads(SDL_GameController *gamecontroller); @@ -822,14 +822,14 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetNumTouchpads(SDL_GameController * Get the number of supported simultaneous fingers on a touchpad on a game * controller. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerGetNumTouchpadFingers(SDL_GameController *gamecontroller, int touchpad); /** * Get the current state of a finger on a touchpad on a game controller. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerGetTouchpadFinger(SDL_GameController *gamecontroller, int touchpad, int finger, Uint8 *state, float *x, float *y, float *pressure); @@ -840,7 +840,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetTouchpadFinger(SDL_GameControll * \param type The type of sensor to query * \returns SDL_TRUE if the sensor exists, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasSensor(SDL_GameController *gamecontroller, SDL_SensorType type); @@ -852,7 +852,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasSensor(SDL_GameController * \param enabled Whether data reporting should be enabled * \returns 0 or -1 if an error occurred. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerSetSensorEnabled(SDL_GameController *gamecontroller, SDL_SensorType type, SDL_bool enabled); @@ -863,7 +863,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSetSensorEnabled(SDL_GameControlle * \param type The type of sensor to query * \returns SDL_TRUE if the sensor is enabled, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerIsSensorEnabled(SDL_GameController *gamecontroller, SDL_SensorType type); @@ -875,7 +875,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerIsSensorEnabled(SDL_GameContr * \param type The type of sensor to query * \return the data rate, or 0.0f if the data rate is not available. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC float SDLCALL SDL_GameControllerGetSensorDataRate(SDL_GameController *gamecontroller, SDL_SensorType type); @@ -891,7 +891,7 @@ extern DECLSPEC float SDLCALL SDL_GameControllerGetSensorDataRate(SDL_GameContro * \param num_values The number of values to write to data * \return 0 or -1 if an error occurred. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorData(SDL_GameController *gamecontroller, SDL_SensorType type, float *data, int num_values); @@ -910,7 +910,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorData(SDL_GameController * * \param num_values The number of values to write to data * \return 0 or -1 if an error occurred. * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorDataWithTimestamp(SDL_GameController *gamecontroller, SDL_SensorType type, Uint64 *timestamp, float *data, int num_values); @@ -928,7 +928,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorDataWithTimestamp(SDL_Gam * \param duration_ms The duration of the rumble effect, in milliseconds * \returns 0, or -1 if rumble isn't supported on this controller * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerHasRumble */ @@ -953,7 +953,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerRumble(SDL_GameController *gamecon * \param duration_ms The duration of the rumble effect, in milliseconds * \returns 0, or -1 if trigger rumble isn't supported on this controller * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerHasRumbleTriggers */ @@ -966,7 +966,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerRumbleTriggers(SDL_GameController * \returns SDL_TRUE, or SDL_FALSE if this controller does not have a * modifiable LED * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasLED(SDL_GameController *gamecontroller); @@ -977,7 +977,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasLED(SDL_GameController *ga * \returns SDL_TRUE, or SDL_FALSE if this controller does not have rumble * support * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerRumble */ @@ -990,7 +990,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasRumble(SDL_GameController * \returns SDL_TRUE, or SDL_FALSE if this controller does not have trigger * rumble support * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerRumbleTriggers */ @@ -1005,7 +1005,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasRumbleTriggers(SDL_GameCon * \param blue The intensity of the blue LED * \returns 0, or -1 if this controller does not have a modifiable LED * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerSetLED(SDL_GameController *gamecontroller, Uint8 red, Uint8 green, Uint8 blue); @@ -1018,7 +1018,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSetLED(SDL_GameController *gamecon * \returns 0, or -1 if this controller or driver doesn't support effect * packets * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GameControllerSendEffect(SDL_GameController *gamecontroller, const void *data, int size); @@ -1028,7 +1028,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSendEffect(SDL_GameController *gam * \param gamecontroller a game controller identifier previously returned by * SDL_GameControllerOpen() * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerOpen */ @@ -1042,7 +1042,7 @@ extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecon * \param button a button on the game controller * \returns the sfSymbolsName or NULL if the name can't be found * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetAppleSFSymbolsNameForAxis */ @@ -1056,7 +1056,7 @@ extern DECLSPEC const char* SDLCALL SDL_GameControllerGetAppleSFSymbolsNameForBu * \param axis an axis on the game controller * \returns the sfSymbolsName or NULL if the name can't be found * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerGetAppleSFSymbolsNameForButton */ diff --git a/include/SDL_gesture.h b/include/SDL_gesture.h index e2caea2a92..7ba2dcba63 100644 --- a/include/SDL_gesture.h +++ b/include/SDL_gesture.h @@ -54,7 +54,7 @@ typedef Sint64 SDL_GestureID; * \param touchId the touch device id, or -1 for all touch devices * \returns 1 on success or 0 if the specified device could not be found. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTouchDevice */ @@ -68,7 +68,7 @@ extern DECLSPEC int SDLCALL SDL_RecordGesture(SDL_TouchID touchId); * \returns the number of saved templates on success or 0 on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadDollarTemplates * \sa SDL_SaveDollarTemplate @@ -83,7 +83,7 @@ extern DECLSPEC int SDLCALL SDL_SaveAllDollarTemplates(SDL_RWops *dst); * \returns 1 on success or 0 on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadDollarTemplates * \sa SDL_SaveAllDollarTemplates @@ -99,7 +99,7 @@ extern DECLSPEC int SDLCALL SDL_SaveDollarTemplate(SDL_GestureID gestureId,SDL_R * \returns the number of loaded templates on success or a negative error code * (or 0) on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SaveAllDollarTemplates * \sa SDL_SaveDollarTemplate diff --git a/include/SDL_guid.h b/include/SDL_guid.h index b971636a06..3b4d372a45 100644 --- a/include/SDL_guid.h +++ b/include/SDL_guid.h @@ -67,7 +67,7 @@ typedef struct { * \param pszGUID buffer in which to write the ASCII string * \param cbGUID the size of pszGUID * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GUIDFromString */ @@ -83,7 +83,7 @@ extern DECLSPEC void SDLCALL SDL_GUIDToString(SDL_GUID guid, char *pszGUID, int * \param pchGUID string containing an ASCII representation of a GUID * \returns a ::SDL_GUID structure. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GUIDToString */ diff --git a/include/SDL_haptic.h b/include/SDL_haptic.h index f240ae9272..9161152dae 100644 --- a/include/SDL_haptic.h +++ b/include/SDL_haptic.h @@ -827,7 +827,7 @@ typedef union SDL_HapticEffect * \returns the number of haptic devices detected on the system or a negative * error code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticName */ @@ -843,7 +843,7 @@ extern DECLSPEC int SDLCALL SDL_NumHaptics(void); * \returns the name of the device or NULL on failure; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_NumHaptics */ @@ -863,7 +863,7 @@ extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index); * \returns the device identifier or NULL on failure; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticClose * \sa SDL_HapticIndex @@ -883,7 +883,7 @@ extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index); * \returns 1 if it has been opened, 0 if it hasn't or on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticIndex * \sa SDL_HapticOpen @@ -897,7 +897,7 @@ extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index); * \returns the index of the specified haptic device or a negative error code * on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticOpen * \sa SDL_HapticOpened @@ -909,7 +909,7 @@ extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic); * * \returns SDL_TRUE if the mouse is haptic or SDL_FALSE if it isn't. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticOpenFromMouse */ @@ -921,7 +921,7 @@ extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void); * \returns the haptic device identifier or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticOpen * \sa SDL_MouseIsHaptic @@ -936,7 +936,7 @@ extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void); * negative error code on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticOpenFromJoystick */ @@ -957,7 +957,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick); * \returns a valid haptic device identifier on success or NULL on failure; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticClose * \sa SDL_HapticOpen @@ -971,7 +971,7 @@ extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick * * * \param haptic the SDL_Haptic device to close * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticOpen */ @@ -988,7 +988,7 @@ extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic); * \returns the number of effects the haptic device can store or a negative * error code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticNumEffectsPlaying * \sa SDL_HapticQuery @@ -1005,7 +1005,7 @@ extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic); * or a negative error code on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticNumEffects * \sa SDL_HapticQuery @@ -1019,7 +1019,7 @@ extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic); * \returns a list of supported haptic features in bitwise manner (OR'd), or 0 * on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticEffectSupported * \sa SDL_HapticNumEffects @@ -1037,7 +1037,7 @@ extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic); * \returns the number of axes on success or a negative error code on failure; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic); @@ -1050,7 +1050,7 @@ extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic); * negative error code on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticNewEffect * \sa SDL_HapticQuery @@ -1068,7 +1068,7 @@ extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic, * \returns the ID of the effect on success or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticDestroyEffect * \sa SDL_HapticRunEffect @@ -1092,7 +1092,7 @@ extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticDestroyEffect * \sa SDL_HapticNewEffect @@ -1118,7 +1118,7 @@ extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticDestroyEffect * \sa SDL_HapticGetEffectStatus @@ -1138,7 +1138,7 @@ extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticDestroyEffect * \sa SDL_HapticRunEffect @@ -1155,7 +1155,7 @@ extern DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic * haptic, * \param haptic the SDL_Haptic device to destroy the effect on * \param effect the ID of the haptic effect to destroy * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticNewEffect */ @@ -1172,7 +1172,7 @@ extern DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic * haptic, * \returns 0 if it isn't playing, 1 if it is playing, or a negative error * code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticRunEffect * \sa SDL_HapticStopEffect @@ -1195,7 +1195,7 @@ extern DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic * haptic, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticQuery */ @@ -1214,7 +1214,7 @@ extern DECLSPEC int SDLCALL SDL_HapticSetGain(SDL_Haptic * haptic, int gain); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticQuery */ @@ -1234,7 +1234,7 @@ extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticUnpause */ @@ -1249,7 +1249,7 @@ extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticPause */ @@ -1262,7 +1262,7 @@ extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic); @@ -1274,7 +1274,7 @@ extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic); * negative error code on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticRumbleInit * \sa SDL_HapticRumblePlay @@ -1289,7 +1289,7 @@ extern DECLSPEC int SDLCALL SDL_HapticRumbleSupported(SDL_Haptic * haptic); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticOpen * \sa SDL_HapticRumblePlay @@ -1307,7 +1307,7 @@ extern DECLSPEC int SDLCALL SDL_HapticRumbleInit(SDL_Haptic * haptic); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticRumbleInit * \sa SDL_HapticRumbleStop @@ -1322,7 +1322,7 @@ extern DECLSPEC int SDLCALL SDL_HapticRumblePlay(SDL_Haptic * haptic, float stre * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HapticRumbleInit * \sa SDL_HapticRumblePlay diff --git a/include/SDL_hidapi.h b/include/SDL_hidapi.h index 354af5c52d..393053b2d2 100644 --- a/include/SDL_hidapi.h +++ b/include/SDL_hidapi.h @@ -135,7 +135,7 @@ typedef struct SDL_hid_device_info * * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_hid_exit */ @@ -149,7 +149,7 @@ extern DECLSPEC int SDLCALL SDL_hid_init(void); * * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_hid_init */ @@ -170,7 +170,7 @@ extern DECLSPEC int SDLCALL SDL_hid_exit(void); * \returns a change counter that is incremented with each potential device * change, or 0 if device change detection isn't available. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_hid_enumerate */ @@ -192,7 +192,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_hid_device_change_count(void); * in the case of failure. Free this linked list by calling * SDL_hid_free_enumeration(). * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_hid_device_change_count */ @@ -206,7 +206,7 @@ extern DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_enumerate(unsigned short v * \param devs Pointer to a list of struct_device returned from * SDL_hid_enumerate(). * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_hid_free_enumeration(SDL_hid_device_info *devs); @@ -224,7 +224,7 @@ extern DECLSPEC void SDLCALL SDL_hid_free_enumeration(SDL_hid_device_info *devs) * \returns a pointer to a SDL_hid_device object on success or NULL on * failure. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number); @@ -238,7 +238,7 @@ extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id, * \returns a pointer to a SDL_hid_device object on success or NULL on * failure. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path, int bExclusive /* = false */); @@ -264,7 +264,7 @@ extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path, int * \param length The length in bytes of the data to send. * \returns the actual number of bytes written and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_write(SDL_hid_device *dev, const unsigned char *data, size_t length); @@ -285,7 +285,7 @@ extern DECLSPEC int SDLCALL SDL_hid_write(SDL_hid_device *dev, const unsigned ch * available to be read within the timeout period, this function * returns 0. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_read_timeout(SDL_hid_device *dev, unsigned char *data, size_t length, int milliseconds); @@ -305,7 +305,7 @@ extern DECLSPEC int SDLCALL SDL_hid_read_timeout(SDL_hid_device *dev, unsigned c * available to be read and the handle is in non-blocking mode, this * function returns 0. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_read(SDL_hid_device *dev, unsigned char *data, size_t length); @@ -323,7 +323,7 @@ extern DECLSPEC int SDLCALL SDL_hid_read(SDL_hid_device *dev, unsigned char *dat * nonblocking - 0 to disable nonblocking. * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock); @@ -347,7 +347,7 @@ extern DECLSPEC int SDLCALL SDL_hid_set_nonblocking(SDL_hid_device *dev, int non * number. * \returns the actual number of bytes written and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_send_feature_report(SDL_hid_device *dev, const unsigned char *data, size_t length); @@ -369,7 +369,7 @@ extern DECLSPEC int SDLCALL SDL_hid_send_feature_report(SDL_hid_device *dev, con * \returns the number of bytes read plus one for the report ID (which is * still in the first byte), or -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, unsigned char *data, size_t length); @@ -378,7 +378,7 @@ extern DECLSPEC int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, unsi * * \param dev A device handle returned from SDL_hid_open(). * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_hid_close(SDL_hid_device *dev); @@ -390,7 +390,7 @@ extern DECLSPEC void SDLCALL SDL_hid_close(SDL_hid_device *dev); * \param maxlen The length of the buffer in multiples of wchar_t. * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_get_manufacturer_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); @@ -402,7 +402,7 @@ extern DECLSPEC int SDLCALL SDL_hid_get_manufacturer_string(SDL_hid_device *dev, * \param maxlen The length of the buffer in multiples of wchar_t. * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_get_product_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); @@ -414,7 +414,7 @@ extern DECLSPEC int SDLCALL SDL_hid_get_product_string(SDL_hid_device *dev, wcha * \param maxlen The length of the buffer in multiples of wchar_t. * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_get_serial_number_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen); @@ -427,7 +427,7 @@ extern DECLSPEC int SDLCALL SDL_hid_get_serial_number_string(SDL_hid_device *dev * \param maxlen The length of the buffer in multiples of wchar_t. * \returns 0 on success and -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int string_index, wchar_t *string, size_t maxlen); @@ -436,7 +436,7 @@ extern DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int * * \param active SDL_TRUE to start the scan, SDL_FALSE to stop the scan * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_hid_ble_scan(SDL_bool active); diff --git a/include/SDL_hints.h b/include/SDL_hints.h index 7261489b68..b12eb60fd2 100644 --- a/include/SDL_hints.h +++ b/include/SDL_hints.h @@ -2312,7 +2312,7 @@ typedef enum * \param priority the SDL_HintPriority level for the hint * \returns SDL_TRUE if the hint was set, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint * \sa SDL_SetHint @@ -2332,7 +2332,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name, * \param value the value of the hint variable * \returns SDL_TRUE if the hint was set, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint * \sa SDL_SetHintWithPriority @@ -2350,7 +2350,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name, * \param name the hint to set * \returns SDL_TRUE if the hint was set, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint * \sa SDL_SetHint @@ -2364,7 +2364,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_ResetHint(const char *name); * variable, or NULL if the environment isn't set. Callbacks will be called * normally with this change. * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint * \sa SDL_SetHint @@ -2378,7 +2378,7 @@ extern DECLSPEC void SDLCALL SDL_ResetHints(void); * \param name the hint to query * \returns the string value of a hint or NULL if the hint isn't set. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetHint * \sa SDL_SetHintWithPriority @@ -2393,7 +2393,7 @@ extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name); * \returns the boolean value of a hint or the provided default value if the * hint does not exist. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint * \sa SDL_SetHint @@ -2418,7 +2418,7 @@ typedef void (SDLCALL *SDL_HintCallback)(void *userdata, const char *name, const * hint value changes * \param userdata a pointer to pass to the callback function * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DelHintCallback */ @@ -2434,7 +2434,7 @@ extern DECLSPEC void SDLCALL SDL_AddHintCallback(const char *name, * hint value changes * \param userdata a pointer being passed to the callback function * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AddHintCallback */ @@ -2452,7 +2452,7 @@ extern DECLSPEC void SDLCALL SDL_DelHintCallback(const char *name, * * This function will be removed from the API the next time we rev the ABI. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ResetHints */ diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h index 72c6604df2..63b04ce2c6 100644 --- a/include/SDL_joystick.h +++ b/include/SDL_joystick.h @@ -129,7 +129,7 @@ typedef enum * uninitialized state. However, all open joysticks will be closed and SDL * functions called with them will fail. * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_LockJoysticks(void); @@ -144,7 +144,7 @@ extern DECLSPEC void SDLCALL SDL_LockJoysticks(void); * the API functions that take a joystick index will be valid, and joystick * and game controller events will not be delivered. * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void); @@ -154,7 +154,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void); * \returns the number of attached joysticks on success or a negative error * code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickName * \sa SDL_JoystickPath @@ -172,7 +172,7 @@ extern DECLSPEC int SDLCALL SDL_NumJoysticks(void); * \returns the name of the selected joystick. If no name can be found, this * function returns NULL; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickName * \sa SDL_JoystickOpen @@ -189,7 +189,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index); * \returns the path of the selected joystick. If no path can be found, this * function returns NULL; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickPath * \sa SDL_JoystickOpen @@ -200,7 +200,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickPathForIndex(int device_index); * Get the player index of a joystick, or -1 if it's not available This can be * called before any joysticks are opened. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index); @@ -215,7 +215,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index); * \returns the GUID of the selected joystick. If called on an invalid index, * this function returns a zero GUID * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetGUID * \sa SDL_JoystickGetGUIDString @@ -233,7 +233,7 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_in * \returns the USB vendor ID of the selected joystick. If called on an * invalid index, this function returns zero * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index); @@ -248,7 +248,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index); * \returns the USB product ID of the selected joystick. If called on an * invalid index, this function returns zero * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index); @@ -263,7 +263,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index); * \returns the product version of the selected joystick. If called on an * invalid index, this function returns zero * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index); @@ -277,7 +277,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_in * \returns the SDL_JoystickType of the selected joystick. If called on an * invalid index, this function returns `SDL_JOYSTICK_TYPE_UNKNOWN` * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index); @@ -292,7 +292,7 @@ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_in * \returns the instance id of the selected joystick. If called on an invalid * index, this function returns zero * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index); @@ -311,7 +311,7 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int devic * \returns a joystick identifier or NULL if an error occurred; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickClose * \sa SDL_JoystickInstanceID @@ -325,7 +325,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index); * \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID instance_id); @@ -336,7 +336,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID * \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromPlayerIndex(int player_index); @@ -345,7 +345,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromPlayerIndex(int player_ind * * \returns the joystick's device index, or -1 if an error occurred. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtual(SDL_JoystickType type, int naxes, @@ -396,7 +396,7 @@ typedef struct SDL_VirtualJoystickDesc * * \returns the joystick's device index, or -1 if an error occurred. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtualEx(const SDL_VirtualJoystickDesc *desc); @@ -407,7 +407,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtualEx(const SDL_VirtualJoystic * SDL_JoystickAttachVirtual() * \returns 0 on success, or -1 if an error occurred. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickDetachVirtual(int device_index); @@ -417,7 +417,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickDetachVirtual(int device_index); * \param device_index a joystick device index. * \returns SDL_TRUE if the joystick is virtual, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index); @@ -439,7 +439,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index); * \param value the new value for the specified axis. * \returns 0 on success, -1 on error. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value); @@ -457,7 +457,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick *joystick, i * \param value the new value for the specified button. * \returns 0 on success, -1 on error. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualButton(SDL_Joystick *joystick, int button, Uint8 value); @@ -475,7 +475,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualButton(SDL_Joystick *joystick, * \param value the new value for the specified hat. * \returns 0 on success, -1 on error. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualHat(SDL_Joystick *joystick, int hat, Uint8 value); @@ -486,7 +486,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualHat(SDL_Joystick *joystick, in * \returns the name of the selected joystick. If no name can be found, this * function returns NULL; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickNameForIndex * \sa SDL_JoystickOpen @@ -500,7 +500,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick *joystick); * \returns the path of the selected joystick. If no path can be found, this * function returns NULL; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickPathForIndex */ @@ -515,7 +515,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickPath(SDL_Joystick *joystick); * \param joystick the SDL_Joystick obtained from SDL_JoystickOpen() * \returns the player index, or -1 if it's not available. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick); @@ -526,7 +526,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick); * \param player_index Player index to assign to this joystick, or -1 to clear * the player index and turn off player LEDs. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_JoystickSetPlayerIndex(SDL_Joystick *joystick, int player_index); @@ -540,7 +540,7 @@ extern DECLSPEC void SDLCALL SDL_JoystickSetPlayerIndex(SDL_Joystick *joystick, * this function returns a zero GUID; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetDeviceGUID * \sa SDL_JoystickGetGUIDString @@ -555,7 +555,7 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick *joyst * \param joystick the SDL_Joystick obtained from SDL_JoystickOpen() * \returns the USB vendor ID of the selected joystick, or 0 if unavailable. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick *joystick); @@ -567,7 +567,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick *joystick); * \param joystick the SDL_Joystick obtained from SDL_JoystickOpen() * \returns the USB product ID of the selected joystick, or 0 if unavailable. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick *joystick); @@ -579,7 +579,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick *joystick); * \param joystick the SDL_Joystick obtained from SDL_JoystickOpen() * \returns the product version of the selected joystick, or 0 if unavailable. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick *joystick); @@ -592,7 +592,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick *joyst * \returns the firmware version of the selected joystick, or 0 if * unavailable. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetFirmwareVersion(SDL_Joystick *joystick); @@ -605,7 +605,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetFirmwareVersion(SDL_Joystick *joys * \returns the serial number of the selected joystick, or NULL if * unavailable. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char * SDLCALL SDL_JoystickGetSerial(SDL_Joystick *joystick); @@ -615,7 +615,7 @@ extern DECLSPEC const char * SDLCALL SDL_JoystickGetSerial(SDL_Joystick *joystic * \param joystick the SDL_Joystick obtained from SDL_JoystickOpen() * \returns the SDL_JoystickType of the selected joystick. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick *joystick); @@ -628,7 +628,7 @@ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick *joyst * \param pszGUID buffer in which to write the ASCII string * \param cbGUID the size of pszGUID * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetDeviceGUID * \sa SDL_JoystickGetGUID @@ -646,7 +646,7 @@ extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, ch * \param pchGUID string containing an ASCII representation of a GUID * \returns a SDL_JoystickGUID structure. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetGUIDString */ @@ -665,7 +665,7 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const cha * \param crc16 A pointer filled in with a CRC used to distinguish different * products with the same VID/PID, or 0 if not available * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetDeviceGUID */ @@ -678,7 +678,7 @@ extern DECLSPEC void SDLCALL SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint * \returns SDL_TRUE if the joystick has been opened, SDL_FALSE if it has not; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickClose * \sa SDL_JoystickOpen @@ -692,7 +692,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick *joystick) * \returns the instance ID of the specified joystick on success or a negative * error code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickOpen */ @@ -710,7 +710,7 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick *joys * negative error code on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetAxis * \sa SDL_JoystickOpen @@ -729,7 +729,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick); * \returns the number of trackballs on success or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetBall */ @@ -742,7 +742,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick); * \returns the number of POV hats on success or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetHat * \sa SDL_JoystickOpen @@ -756,7 +756,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick); * \returns the number of buttons on success or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickGetButton * \sa SDL_JoystickOpen @@ -769,7 +769,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick); * This is called automatically by the event loop if any joystick events are * enabled. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickEventState */ @@ -794,7 +794,7 @@ extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void); * If `state` is `SDL_QUERY` then the current state is returned, * otherwise the new processing state is returned. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GameControllerEventState */ @@ -821,7 +821,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state); * \returns a 16-bit signed integer representing the current position of the * axis or 0 on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickNumAxes */ @@ -840,7 +840,7 @@ extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick, * \param state Upon return, the initial value is supplied here. * \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick *joystick, int axis, Sint16 *state); @@ -879,7 +879,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick *j * \param hat the hat index to get the state from; indices start at index 0 * \returns the current hat position. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickNumHats */ @@ -901,7 +901,7 @@ extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickNumBalls */ @@ -916,7 +916,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick, * index 0 * \returns 1 if the specified button is pressed, 0 otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickNumButtons */ @@ -937,7 +937,7 @@ extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick, * \param duration_ms The duration of the rumble effect, in milliseconds * \returns 0, or -1 if rumble isn't supported on this joystick * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickHasRumble */ @@ -962,7 +962,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 lo * \param duration_ms The duration of the rumble effect, in milliseconds * \returns 0, or -1 if trigger rumble isn't supported on this joystick * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickHasRumbleTriggers */ @@ -977,7 +977,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickRumbleTriggers(SDL_Joystick *joystick, U * \param joystick The joystick to query * \return SDL_TRUE if the joystick has a modifiable LED, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasLED(SDL_Joystick *joystick); @@ -987,7 +987,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasLED(SDL_Joystick *joystick); * \param joystick The joystick to query * \return SDL_TRUE if the joystick has rumble, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickRumble */ @@ -999,7 +999,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasRumble(SDL_Joystick *joystick); * \param joystick The joystick to query * \return SDL_TRUE if the joystick has trigger rumble, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickRumbleTriggers */ @@ -1017,7 +1017,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasRumbleTriggers(SDL_Joystick *joy * \param blue The intensity of the blue LED * \returns 0 on success, -1 if this joystick does not have a modifiable LED * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickSetLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue); @@ -1029,7 +1029,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSetLED(SDL_Joystick *joystick, Uint8 red * \param size The size of the data to send to the joystick * \returns 0, or -1 if this joystick or driver doesn't support effect packets * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_JoystickSendEffect(SDL_Joystick *joystick, const void *data, int size); @@ -1038,7 +1038,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSendEffect(SDL_Joystick *joystick, const * * \param joystick The joystick device to close * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickOpen */ @@ -1051,7 +1051,7 @@ extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick); * \returns the current battery level as SDL_JoystickPowerLevel on success or * `SDL_JOYSTICK_POWER_UNKNOWN` if it is unknown * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick *joystick); diff --git a/include/SDL_keyboard.h b/include/SDL_keyboard.h index e7663fb34c..cf296f2391 100644 --- a/include/SDL_keyboard.h +++ b/include/SDL_keyboard.h @@ -59,7 +59,7 @@ typedef struct SDL_Keysym * * \returns the window with keyboard focus. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void); @@ -87,7 +87,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void); * \param numkeys if non-NULL, receives the length of the returned array * \returns a pointer to an array of key states. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PumpEvents * \sa SDL_ResetKeyboard @@ -99,7 +99,7 @@ extern DECLSPEC const Uint8 *SDLCALL SDL_GetKeyboardState(int *numkeys); * * This function will generate key up events for all pressed keys. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyboardState */ @@ -111,7 +111,7 @@ extern DECLSPEC void SDLCALL SDL_ResetKeyboard(void); * \returns an OR'd combination of the modifier keys for the keyboard. See * SDL_Keymod for details. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyboardState * \sa SDL_SetModState @@ -131,7 +131,7 @@ extern DECLSPEC SDL_Keymod SDLCALL SDL_GetModState(void); * * \param modstate the desired SDL_Keymod for the keyboard * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetModState */ @@ -146,7 +146,7 @@ extern DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate); * \param scancode the desired SDL_Scancode to query * \returns the SDL_Keycode that corresponds to the given SDL_Scancode. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyName * \sa SDL_GetScancodeFromKey @@ -162,7 +162,7 @@ extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode * \param key the desired SDL_Keycode to query * \returns the SDL_Scancode that corresponds to the given SDL_Keycode. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyFromScancode * \sa SDL_GetScancodeName @@ -187,7 +187,7 @@ extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key); * \returns a pointer to the name for the scancode. If the scancode doesn't * have a name this function returns an empty string (""). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetScancodeFromKey * \sa SDL_GetScancodeFromName @@ -201,7 +201,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode scancode); * \returns the SDL_Scancode, or `SDL_SCANCODE_UNKNOWN` if the name wasn't * recognized; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyFromName * \sa SDL_GetScancodeFromKey @@ -220,7 +220,7 @@ extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *name); * must copy it. If the key doesn't have a name, this function * returns an empty string (""). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyFromName * \sa SDL_GetKeyFromScancode @@ -235,7 +235,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Keycode key); * \returns key code, or `SDLK_UNKNOWN` if the name wasn't recognized; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetKeyFromScancode * \sa SDL_GetKeyName @@ -253,7 +253,7 @@ extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name); * * On some platforms using this function activates the screen keyboard. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetTextInputRect * \sa SDL_StopTextInput @@ -265,7 +265,7 @@ extern DECLSPEC void SDLCALL SDL_StartTextInput(void); * * \returns SDL_TRUE if text input events are enabled else SDL_FALSE. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_StartTextInput */ @@ -274,7 +274,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputActive(void); /** * Stop receiving any text input events. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_StartTextInput */ @@ -283,7 +283,7 @@ extern DECLSPEC void SDLCALL SDL_StopTextInput(void); /** * Dismiss the composition window/IME without disabling the subsystem. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. * * \sa SDL_StartTextInput * \sa SDL_StopTextInput @@ -293,7 +293,7 @@ extern DECLSPEC void SDLCALL SDL_ClearComposition(void); /** * Returns if an IME Composite or Candidate window is currently shown. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void); @@ -311,7 +311,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void); * \param rect the SDL_Rect structure representing the rectangle to receive * text (ignored if NULL) * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_StartTextInput */ @@ -323,7 +323,7 @@ extern DECLSPEC void SDLCALL SDL_SetTextInputRect(const SDL_Rect *rect); * \returns SDL_TRUE if the platform has some screen keyboard support or * SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_StartTextInput * \sa SDL_IsScreenKeyboardShown @@ -336,7 +336,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasScreenKeyboardSupport(void); * \param window the window for which screen keyboard should be queried * \returns SDL_TRUE if screen keyboard is shown or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasScreenKeyboardSupport */ diff --git a/include/SDL_loadso.h b/include/SDL_loadso.h index 61857c8137..e8b248501d 100644 --- a/include/SDL_loadso.h +++ b/include/SDL_loadso.h @@ -57,7 +57,7 @@ extern "C" { * \returns an opaque pointer to the object handle or NULL if there was an * error; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadFunction * \sa SDL_UnloadObject @@ -84,7 +84,7 @@ extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile); * \returns a pointer to the function or NULL if there was an error; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadObject * \sa SDL_UnloadObject @@ -97,7 +97,7 @@ extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle, * * \param handle a valid shared object handle returned by SDL_LoadObject() * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadFunction * \sa SDL_LoadObject diff --git a/include/SDL_locale.h b/include/SDL_locale.h index 7515779947..97ae11d81f 100644 --- a/include/SDL_locale.h +++ b/include/SDL_locale.h @@ -86,7 +86,7 @@ typedef struct SDL_Locale * \return array of locales, terminated with a locale with a NULL language * field. Will return NULL on error. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Locale * SDLCALL SDL_GetPreferredLocales(void); diff --git a/include/SDL_log.h b/include/SDL_log.h index 1d8b20b62c..522a9843df 100644 --- a/include/SDL_log.h +++ b/include/SDL_log.h @@ -116,7 +116,7 @@ typedef enum * * \param priority the SDL_LogPriority to assign * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogSetPriority */ @@ -128,7 +128,7 @@ extern DECLSPEC void SDLCALL SDL_LogSetAllPriority(SDL_LogPriority priority); * \param category the category to assign a priority to * \param priority the SDL_LogPriority to assign * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogGetPriority * \sa SDL_LogSetAllPriority @@ -142,7 +142,7 @@ extern DECLSPEC void SDLCALL SDL_LogSetPriority(int category, * \param category the category to query * \returns the SDL_LogPriority for the requested category * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogSetPriority */ @@ -153,7 +153,7 @@ extern DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority(int category); * * This is called by SDL_Quit(). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogSetAllPriority * \sa SDL_LogSetPriority @@ -168,7 +168,7 @@ extern DECLSPEC void SDLCALL SDL_LogResetPriorities(void); * \param ... additional parameters matching % tokens in the `fmt` string, if * any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogCritical * \sa SDL_LogDebug @@ -189,7 +189,7 @@ extern DECLSPEC void SDLCALL SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, . * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -210,7 +210,7 @@ extern DECLSPEC void SDLCALL SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_STRI * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -231,7 +231,7 @@ extern DECLSPEC void SDLCALL SDL_LogDebug(int category, SDL_PRINTF_FORMAT_STRING * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -252,7 +252,7 @@ extern DECLSPEC void SDLCALL SDL_LogInfo(int category, SDL_PRINTF_FORMAT_STRING * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -273,7 +273,7 @@ extern DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STRING * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -294,7 +294,7 @@ extern DECLSPEC void SDLCALL SDL_LogError(int category, SDL_PRINTF_FORMAT_STRING * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogDebug @@ -316,7 +316,7 @@ extern DECLSPEC void SDLCALL SDL_LogCritical(int category, SDL_PRINTF_FORMAT_STR * \param ... additional parameters matching % tokens in the **fmt** string, * if any * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -339,7 +339,7 @@ extern DECLSPEC void SDLCALL SDL_LogMessage(int category, * \param fmt a printf() style message format string * \param ap a variable argument list * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Log * \sa SDL_LogCritical @@ -374,7 +374,7 @@ typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_ * \param userdata a pointer filled in with the pointer that is passed to * `callback` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogSetOutputFunction */ @@ -386,7 +386,7 @@ extern DECLSPEC void SDLCALL SDL_LogGetOutputFunction(SDL_LogOutputFunction *cal * \param callback an SDL_LogOutputFunction to call instead of the default * \param userdata a pointer that is passed to `callback` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LogGetOutputFunction */ diff --git a/include/SDL_main.h b/include/SDL_main.h index 5953bffeaf..01dfb26694 100644 --- a/include/SDL_main.h +++ b/include/SDL_main.h @@ -143,7 +143,7 @@ extern SDLMAIN_DECLSPEC int SDL_main(int argc, char *argv[]); * will not be changed it is necessary to define SDL_MAIN_HANDLED before * including SDL.h. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Init */ @@ -172,7 +172,7 @@ extern DECLSPEC void SDLCALL SDL_SetMainReady(void); * will use `GetModuleHandle(NULL)` instead. * \returns 0 on success, -1 on error. SDL_GetError() may have details. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RegisterApp(const char *name, Uint32 style, void *hInst); @@ -189,7 +189,7 @@ extern DECLSPEC int SDLCALL SDL_RegisterApp(const char *name, Uint32 style, void * deregistered when the registration counter in SDL_RegisterApp decrements to * zero through calls to this function. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_UnregisterApp(void); @@ -206,7 +206,7 @@ extern DECLSPEC void SDLCALL SDL_UnregisterApp(void); * \param mainFunction The SDL app's C-style main(), an SDL_main_func * \return the return value from mainFunction * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_UIKitRunApp(int argc, char *argv[], SDL_main_func mainFunction); @@ -222,7 +222,7 @@ extern DECLSPEC int SDLCALL SDL_UIKitRunApp(int argc, char *argv[], SDL_main_fun * \returns 0 on success or -1 on failure; call SDL_GetError() to retrieve * more information on the failure. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GDKRunApp(SDL_main_func mainFunction, void *reserved); diff --git a/include/SDL_messagebox.h b/include/SDL_messagebox.h index d763534d21..d6c01a5d1d 100644 --- a/include/SDL_messagebox.h +++ b/include/SDL_messagebox.h @@ -133,7 +133,7 @@ typedef struct * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ShowSimpleMessageBox */ @@ -175,7 +175,7 @@ extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *message * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ShowMessageBox */ diff --git a/include/SDL_metal.h b/include/SDL_metal.h index 92854710e4..da6f991910 100644 --- a/include/SDL_metal.h +++ b/include/SDL_metal.h @@ -58,7 +58,7 @@ typedef void *SDL_MetalView; * The returned handle can be casted directly to a NSView or UIView. To access * the backing CAMetalLayer, call SDL_Metal_GetLayer(). * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Metal_DestroyView * \sa SDL_Metal_GetLayer @@ -71,7 +71,7 @@ extern DECLSPEC SDL_MetalView SDLCALL SDL_Metal_CreateView(SDL_Window * window); * This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was * called after SDL_CreateWindow. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Metal_CreateView */ @@ -80,7 +80,7 @@ extern DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view); /** * Get a pointer to the backing CAMetalLayer for the given view. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Metal_CreateView */ @@ -94,7 +94,7 @@ extern DECLSPEC void *SDLCALL SDL_Metal_GetLayer(SDL_MetalView view); * \param w Pointer to variable for storing the width in pixels, may be NULL * \param h Pointer to variable for storing the height in pixels, may be NULL * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowSize * \sa SDL_CreateWindow diff --git a/include/SDL_misc.h b/include/SDL_misc.h index 261b6b8713..84644ba1f0 100644 --- a/include/SDL_misc.h +++ b/include/SDL_misc.h @@ -64,7 +64,7 @@ extern "C" { * \returns 0 on success, or -1 on error; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_OpenURL(const char *url); diff --git a/include/SDL_mouse.h b/include/SDL_mouse.h index b318c70383..f9d81dc607 100644 --- a/include/SDL_mouse.h +++ b/include/SDL_mouse.h @@ -76,7 +76,7 @@ typedef enum * * \returns the window with mouse focus. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void); @@ -95,7 +95,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void); * focus window * \returns a 32-bit button bitmask of the current button state. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGlobalMouseState * \sa SDL_GetRelativeMouseState @@ -126,7 +126,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y); * \returns the current button state as a bitmask which can be tested using * the SDL_BUTTON(X) macros. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CaptureMouse */ @@ -145,7 +145,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetGlobalMouseState(int *x, int *y); * \param y a pointer filled with the last recorded y coordinate of the mouse * \returns a 32-bit button bitmask of the relative button state. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetMouseState */ @@ -166,7 +166,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y); * \param x the x coordinate within the window * \param y the y coordinate within the window * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WarpMouseGlobal */ @@ -189,7 +189,7 @@ extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WarpMouseInWindow */ @@ -214,7 +214,7 @@ extern DECLSPEC int SDLCALL SDL_WarpMouseGlobal(int x, int y); * * If relative mode is not supported, this returns -1. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRelativeMouseMode */ @@ -260,7 +260,7 @@ extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled); * \returns 0 on success or -1 if not supported; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGlobalMouseState */ @@ -271,7 +271,7 @@ extern DECLSPEC int SDLCALL SDL_CaptureMouse(SDL_bool enabled); * * \returns SDL_TRUE if relative mode is enabled or SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRelativeMouseMode */ @@ -312,7 +312,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void); * \returns a new cursor with the specified parameters on success or NULL on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreeCursor * \sa SDL_SetCursor @@ -332,7 +332,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data, * \returns the new cursor on success or NULL on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateCursor * \sa SDL_FreeCursor @@ -348,7 +348,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface, * \returns a cursor on success or NULL on failure; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreeCursor */ @@ -364,7 +364,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id); * * \param cursor a cursor to make active * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateCursor * \sa SDL_GetCursor @@ -380,7 +380,7 @@ extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor); * * \returns the active cursor or NULL if there is no mouse. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetCursor */ @@ -391,7 +391,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void); * * \returns the default cursor on success or NULL on failure. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSystemCursor */ @@ -405,7 +405,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void); * * \param cursor the cursor to free * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateColorCursor * \sa SDL_CreateCursor @@ -428,7 +428,7 @@ extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor); * cursor is hidden, or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateCursor * \sa SDL_SetCursor diff --git a/include/SDL_mutex.h b/include/SDL_mutex.h index 173468f6ac..a855c97f42 100644 --- a/include/SDL_mutex.h +++ b/include/SDL_mutex.h @@ -71,7 +71,7 @@ typedef struct SDL_mutex SDL_mutex; * \returns the initialized and unlocked mutex or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DestroyMutex * \sa SDL_LockMutex @@ -94,7 +94,7 @@ extern DECLSPEC SDL_mutex *SDLCALL SDL_CreateMutex(void); * \param mutex the mutex to lock * \return 0, or -1 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_LockMutex(SDL_mutex * mutex); #define SDL_mutexP(m) SDL_LockMutex(m) @@ -112,7 +112,7 @@ extern DECLSPEC int SDLCALL SDL_LockMutex(SDL_mutex * mutex); * \returns 0, `SDL_MUTEX_TIMEDOUT`, or -1 on error; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateMutex * \sa SDL_DestroyMutex @@ -136,7 +136,7 @@ extern DECLSPEC int SDLCALL SDL_TryLockMutex(SDL_mutex * mutex); * \param mutex the mutex to unlock. * \returns 0, or -1 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_UnlockMutex(SDL_mutex * mutex); #define SDL_mutexV(m) SDL_UnlockMutex(m) @@ -152,7 +152,7 @@ extern DECLSPEC int SDLCALL SDL_UnlockMutex(SDL_mutex * mutex); * * \param mutex the mutex to destroy * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateMutex * \sa SDL_LockMutex @@ -186,7 +186,7 @@ typedef struct SDL_semaphore SDL_sem; * \returns a new semaphore or NULL on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DestroySemaphore * \sa SDL_SemPost @@ -205,7 +205,7 @@ extern DECLSPEC SDL_sem *SDLCALL SDL_CreateSemaphore(Uint32 initial_value); * * \param sem the semaphore to destroy * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore * \sa SDL_SemPost @@ -231,7 +231,7 @@ extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem * sem); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore * \sa SDL_DestroySemaphore @@ -256,7 +256,7 @@ extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem * sem); * block, or a negative error code on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore * \sa SDL_DestroySemaphore @@ -281,7 +281,7 @@ extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem * sem); * succeed in the allotted time, or a negative error code on failure; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore * \sa SDL_DestroySemaphore @@ -299,7 +299,7 @@ extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem * sem, Uint32 ms); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore * \sa SDL_DestroySemaphore @@ -316,7 +316,7 @@ extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem * sem); * \param sem the semaphore to query * \returns the current value of the semaphore. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore */ @@ -340,7 +340,7 @@ typedef struct SDL_cond SDL_cond; * \returns a new condition variable or NULL on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CondBroadcast * \sa SDL_CondSignal @@ -355,7 +355,7 @@ extern DECLSPEC SDL_cond *SDLCALL SDL_CreateCond(void); * * \param cond the condition variable to destroy * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CondBroadcast * \sa SDL_CondSignal @@ -372,7 +372,7 @@ extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond * cond); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CondBroadcast * \sa SDL_CondWait @@ -389,7 +389,7 @@ extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond * cond); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CondSignal * \sa SDL_CondWait @@ -417,7 +417,7 @@ extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond * cond); * \returns 0 when it is signaled or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CondBroadcast * \sa SDL_CondSignal @@ -446,7 +446,7 @@ extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond * cond, SDL_mutex * mutex); * the condition is not signaled in the allotted time, or a negative * error code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CondBroadcast * \sa SDL_CondSignal diff --git a/include/SDL_pixels.h b/include/SDL_pixels.h index 5d2c0c8982..3766e4328c 100644 --- a/include/SDL_pixels.h +++ b/include/SDL_pixels.h @@ -356,7 +356,7 @@ typedef struct SDL_PixelFormat * \returns the human readable name of the specified pixel format or * `SDL_PIXELFORMAT_UNKNOWN` if the format isn't recognized. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format); @@ -372,7 +372,7 @@ extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format); * \returns SDL_TRUE on success or SDL_FALSE if the conversion wasn't * possible; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_MasksToPixelFormatEnum */ @@ -396,7 +396,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format, * \param Amask the alpha mask for the format * \returns one of the SDL_PixelFormatEnum values * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_PixelFormatEnumToMasks */ @@ -417,7 +417,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp, * \returns the new SDL_PixelFormat structure or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreeFormat */ @@ -428,7 +428,7 @@ extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format); * * \param format the SDL_PixelFormat structure to free * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocFormat */ @@ -444,7 +444,7 @@ extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format); * there wasn't enough memory); call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreePalette */ @@ -458,7 +458,7 @@ extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocPalette * \sa SDL_FreePalette @@ -476,7 +476,7 @@ extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format, * \returns 0 on success or a negative error code if not all of the colors * could be set; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocPalette * \sa SDL_CreateRGBSurface @@ -490,7 +490,7 @@ extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette, * * \param palette the SDL_Palette structure to be freed * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocPalette */ @@ -520,7 +520,7 @@ extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette); * \param b the blue component of the pixel in the range 0-255 * \returns a pixel value * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRGB * \sa SDL_GetRGBA @@ -555,7 +555,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format, * \param a the alpha component of the pixel in the range 0-255 * \returns a pixel value * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRGB * \sa SDL_GetRGBA @@ -580,7 +580,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format, * \param g a pointer filled in with the green component * \param b a pointer filled in with the blue component * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRGBA * \sa SDL_MapRGB @@ -609,7 +609,7 @@ extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, * \param b a pointer filled in with the blue component * \param a a pointer filled in with the alpha component * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRGB * \sa SDL_MapRGB @@ -626,7 +626,7 @@ extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, * \param gamma a gamma value where 0.0 is black and 1.0 is identity * \param ramp an array of 256 values filled in with the gamma ramp * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowGammaRamp */ diff --git a/include/SDL_platform.h b/include/SDL_platform.h index 21a5b24644..af9e9558fc 100644 --- a/include/SDL_platform.h +++ b/include/SDL_platform.h @@ -229,7 +229,7 @@ extern "C" { * \returns the name of the platform. If the correct platform name is not * available, returns a string beginning with the text "Unknown". * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char * SDLCALL SDL_GetPlatform (void); diff --git a/include/SDL_power.h b/include/SDL_power.h index ecb3f4b023..a1d4efadea 100644 --- a/include/SDL_power.h +++ b/include/SDL_power.h @@ -73,7 +73,7 @@ typedef enum * determine a value, or we're not running on a battery * \returns an SDL_PowerState enum representing the current battery state. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct); diff --git a/include/SDL_rect.h b/include/SDL_rect.h index 6c641c581c..5d2965d93e 100644 --- a/include/SDL_rect.h +++ b/include/SDL_rect.h @@ -139,7 +139,7 @@ SDL_FORCE_INLINE SDL_bool SDL_RectEquals(const SDL_Rect *a, const SDL_Rect *b) * \param B an SDL_Rect structure representing the second rectangle * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_IntersectRect */ @@ -157,7 +157,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A, * rectangles `A` and `B` * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasIntersection */ @@ -173,7 +173,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A, * \param result an SDL_Rect structure filled in with the union of rectangles * `A` and `B` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A, const SDL_Rect * B, @@ -194,7 +194,7 @@ extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A, * \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the * points were outside of the clipping rectangle. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points, int count, @@ -217,7 +217,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points, * \param Y2 a pointer to the ending Y-coordinate of the line * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect * rect, int *X1, @@ -278,7 +278,7 @@ SDL_FORCE_INLINE SDL_bool SDL_FRectEquals(const SDL_FRect *a, const SDL_FRect *b * \param B an SDL_FRect structure representing the second rectangle * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. * * \sa SDL_IntersectRect */ @@ -296,7 +296,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersectionF(const SDL_FRect * A, * rectangles `A` and `B` * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HasIntersectionF */ @@ -312,7 +312,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IntersectFRect(const SDL_FRect * A, * \param result an SDL_FRect structure filled in with the union of rectangles * `A` and `B` * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_UnionFRect(const SDL_FRect * A, const SDL_FRect * B, @@ -334,7 +334,7 @@ extern DECLSPEC void SDLCALL SDL_UnionFRect(const SDL_FRect * A, * \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the * points were outside of the clipping rectangle. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_EncloseFPoints(const SDL_FPoint * points, int count, @@ -358,7 +358,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_EncloseFPoints(const SDL_FPoint * points, * \param Y2 a pointer to the ending Y-coordinate of the line * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IntersectFRectAndLine(const SDL_FRect * rect, float *X1, diff --git a/include/SDL_render.h b/include/SDL_render.h index 5b7b059aff..657f2d4dcd 100644 --- a/include/SDL_render.h +++ b/include/SDL_render.h @@ -161,7 +161,7 @@ typedef struct SDL_Texture SDL_Texture; * \returns a number >= 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer * \sa SDL_GetRenderDriverInfo @@ -177,7 +177,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer * \sa SDL_GetNumRenderDrivers @@ -197,7 +197,7 @@ extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index, * \returns 0 on success, or -1 on error; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer * \sa SDL_CreateWindow @@ -217,7 +217,7 @@ extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer( * \returns a valid rendering context or NULL if there was an error; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSoftwareRenderer * \sa SDL_DestroyRenderer @@ -240,7 +240,7 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window, * \returns a valid rendering context or NULL if there was an error; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer * \sa SDL_CreateWindowRenderer @@ -255,7 +255,7 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface * * \returns the rendering context on success or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer */ @@ -268,7 +268,7 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window * window); * \returns the window on success or NULL on failure; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Window * SDLCALL SDL_RenderGetWindow(SDL_Renderer *renderer); @@ -281,7 +281,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_RenderGetWindow(SDL_Renderer *renderer) * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer */ @@ -301,7 +301,7 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderer */ @@ -323,7 +323,7 @@ extern DECLSPEC int SDLCALL SDL_GetRendererOutputSize(SDL_Renderer * renderer, * was active, the format was unsupported, or the width or height * were out of range; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateTextureFromSurface * \sa SDL_DestroyTexture @@ -353,7 +353,7 @@ extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer, * \returns the created texture or NULL on failure; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateTexture * \sa SDL_DestroyTexture @@ -379,7 +379,7 @@ extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateTexture */ @@ -406,7 +406,7 @@ extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureColorMod * \sa SDL_SetTextureAlphaMod @@ -425,7 +425,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureAlphaMod * \sa SDL_SetTextureColorMod @@ -450,7 +450,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureAlphaMod * \sa SDL_SetTextureColorMod @@ -466,7 +466,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureColorMod * \sa SDL_SetTextureAlphaMod @@ -485,7 +485,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureBlendMode * \sa SDL_RenderCopy @@ -501,7 +501,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetTextureBlendMode */ @@ -517,7 +517,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture, * \param scaleMode the SDL_ScaleMode to use for texture scaling. * \returns 0 on success, or -1 if the texture is not valid. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureScaleMode */ @@ -531,7 +531,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_Texture * texture, * \param scaleMode a pointer filled in with the current scale mode. * \return 0 on success, or -1 if the texture is not valid. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetTextureScaleMode */ @@ -545,7 +545,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_Texture * texture, * \param userdata the pointer to associate with the texture. * \returns 0 on success, or -1 if the texture is not valid. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureUserData */ @@ -559,7 +559,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureUserData(SDL_Texture * texture, * \return the pointer associated with the texture, or NULL if the texture is * not valid. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetTextureUserData */ @@ -588,7 +588,7 @@ extern DECLSPEC void * SDLCALL SDL_GetTextureUserData(SDL_Texture * texture); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateTexture * \sa SDL_LockTexture @@ -621,7 +621,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture, * \returns 0 on success or -1 if the texture is not valid; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. * * \sa SDL_UpdateTexture */ @@ -649,7 +649,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture * texture, * plane. * \return 0 on success, or -1 if the texture is not valid. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_UpdateNVTexture(SDL_Texture * texture, const SDL_Rect * rect, @@ -679,7 +679,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateNVTexture(SDL_Texture * texture, * or was not created with `SDL_TEXTUREACCESS_STREAMING`; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_UnlockTexture */ @@ -714,7 +714,7 @@ extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture, * \returns 0 on success, or -1 if the texture is not valid or was not created * with `SDL_TEXTUREACCESS_STREAMING` * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockTexture * \sa SDL_UnlockTexture @@ -736,7 +736,7 @@ extern DECLSPEC int SDLCALL SDL_LockTextureToSurface(SDL_Texture *texture, * * \param texture a texture locked by SDL_LockTexture() * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockTexture */ @@ -748,7 +748,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture); * \param renderer the renderer that will be checked * \returns SDL_TRUE if supported or SDL_FALSE if not. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRenderTarget */ @@ -772,7 +772,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_RenderTargetSupported(SDL_Renderer *rendere * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderTarget */ @@ -788,7 +788,7 @@ extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer, * \param renderer the rendering context * \returns the current render target or NULL for the default render target. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRenderTarget */ @@ -816,7 +816,7 @@ extern DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetLogicalSize */ @@ -837,7 +837,7 @@ extern DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer * renderer, in * \param w an int to be filled with the width * \param h an int to be filled with the height * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderSetLogicalSize */ @@ -855,7 +855,7 @@ extern DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer * renderer, i * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetIntegerScale * \sa SDL_RenderSetLogicalSize @@ -870,7 +870,7 @@ extern DECLSPEC int SDLCALL SDL_RenderSetIntegerScale(SDL_Renderer * renderer, * \returns SDL_TRUE if integer scales are forced or SDL_FALSE if not and on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderSetIntegerScale */ @@ -888,7 +888,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_RenderGetIntegerScale(SDL_Renderer * render * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetViewport */ @@ -901,7 +901,7 @@ extern DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer * renderer, * \param renderer the rendering context * \param rect an SDL_Rect structure filled in with the current drawing area * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderSetViewport */ @@ -918,7 +918,7 @@ extern DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetClipRect * \sa SDL_RenderIsClipEnabled @@ -934,7 +934,7 @@ extern DECLSPEC int SDLCALL SDL_RenderSetClipRect(SDL_Renderer * renderer, * \param rect an SDL_Rect structure filled in with the current clipping area * or an empty rectangle if clipping is disabled * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderIsClipEnabled * \sa SDL_RenderSetClipRect @@ -949,7 +949,7 @@ extern DECLSPEC void SDLCALL SDL_RenderGetClipRect(SDL_Renderer * renderer, * \returns SDL_TRUE if clipping is enabled or SDL_FALSE if not; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetClipRect * \sa SDL_RenderSetClipRect @@ -974,7 +974,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_RenderIsClipEnabled(SDL_Renderer * renderer * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetScale * \sa SDL_RenderSetLogicalSize @@ -989,7 +989,7 @@ extern DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer * renderer, * \param scaleX a pointer filled in with the horizontal scaling factor * \param scaleY a pointer filled in with the vertical scaling factor * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderSetScale */ @@ -1010,7 +1010,7 @@ extern DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer * renderer, * \param logicalX the pointer filled with the logical x coordinate * \param logicalY the pointer filled with the logical y coordinate * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetScale * \sa SDL_RenderSetScale @@ -1036,7 +1036,7 @@ extern DECLSPEC void SDLCALL SDL_RenderWindowToLogical(SDL_Renderer * renderer, * \param windowX the pointer filled with the real X coordinate in the window * \param windowY the pointer filled with the real Y coordinate in the window * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetScale * \sa SDL_RenderSetScale @@ -1063,7 +1063,7 @@ extern DECLSPEC void SDLCALL SDL_RenderLogicalToWindow(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderDrawColor * \sa SDL_RenderClear @@ -1095,7 +1095,7 @@ extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRenderDrawColor */ @@ -1113,7 +1113,7 @@ extern DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderDrawBlendMode * \sa SDL_RenderDrawLine @@ -1136,7 +1136,7 @@ extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRenderDrawBlendMode */ @@ -1153,7 +1153,7 @@ extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetRenderDrawColor */ @@ -1171,7 +1171,7 @@ extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLines @@ -1197,7 +1197,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLines @@ -1228,7 +1228,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLines * \sa SDL_RenderDrawPoint @@ -1254,7 +1254,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawPoint @@ -1280,7 +1280,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLines @@ -1306,7 +1306,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLines @@ -1336,7 +1336,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLines @@ -1363,7 +1363,7 @@ extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLines @@ -1399,7 +1399,7 @@ extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderCopyEx * \sa SDL_SetTextureAlphaMod @@ -1443,7 +1443,7 @@ extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderCopy * \sa SDL_SetTextureAlphaMod @@ -1467,7 +1467,7 @@ extern DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer * renderer, * \param y The y coordinate of the point. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderDrawPointF(SDL_Renderer * renderer, float x, float y); @@ -1480,7 +1480,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawPointF(SDL_Renderer * renderer, * \param count The number of points to draw * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderDrawPointsF(SDL_Renderer * renderer, const SDL_FPoint * points, @@ -1496,7 +1496,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawPointsF(SDL_Renderer * renderer, * \param y2 The y coordinate of the end point. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderDrawLineF(SDL_Renderer * renderer, float x1, float y1, float x2, float y2); @@ -1510,7 +1510,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawLineF(SDL_Renderer * renderer, * \param count The number of points, drawing count-1 lines * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderDrawLinesF(SDL_Renderer * renderer, const SDL_FPoint * points, @@ -1524,7 +1524,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawLinesF(SDL_Renderer * renderer, * entire rendering target. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderDrawRectF(SDL_Renderer * renderer, const SDL_FRect * rect); @@ -1538,7 +1538,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawRectF(SDL_Renderer * renderer, * \param count The number of rectangles. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderDrawRectsF(SDL_Renderer * renderer, const SDL_FRect * rects, @@ -1553,7 +1553,7 @@ extern DECLSPEC int SDLCALL SDL_RenderDrawRectsF(SDL_Renderer * renderer, * rendering target. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderFillRectF(SDL_Renderer * renderer, const SDL_FRect * rect); @@ -1567,7 +1567,7 @@ extern DECLSPEC int SDLCALL SDL_RenderFillRectF(SDL_Renderer * renderer, * \param count The number of rectangles. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderFillRectsF(SDL_Renderer * renderer, const SDL_FRect * rects, @@ -1585,7 +1585,7 @@ extern DECLSPEC int SDLCALL SDL_RenderFillRectsF(SDL_Renderer * renderer, * entire rendering target. * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderCopyF(SDL_Renderer * renderer, SDL_Texture * texture, @@ -1611,7 +1611,7 @@ extern DECLSPEC int SDLCALL SDL_RenderCopyF(SDL_Renderer * renderer, * be performed on the texture * \return 0 on success, or -1 on error * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderCopyExF(SDL_Renderer * renderer, SDL_Texture * texture, @@ -1636,7 +1636,7 @@ extern DECLSPEC int SDLCALL SDL_RenderCopyExF(SDL_Renderer * renderer, * \param num_indices Number of indices. * \return 0 on success, or -1 if the operation is not supported * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGeometryRaw * \sa SDL_Vertex @@ -1666,7 +1666,7 @@ extern DECLSPEC int SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer, * \param size_indices Index size: 1 (byte), 2 (short), 4 (int) * \return 0 on success, or -1 if the operation is not supported * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGeometry * \sa SDL_Vertex @@ -1703,7 +1703,7 @@ extern DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer, const SDL_Rect * rect, @@ -1731,7 +1731,7 @@ extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer, * * \param renderer the rendering context * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderClear * \sa SDL_RenderDrawLine @@ -1755,7 +1755,7 @@ extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer); * * \param texture the texture to destroy * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateTexture * \sa SDL_CreateTextureFromSurface @@ -1770,7 +1770,7 @@ extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture); * * \param renderer the rendering context * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer */ @@ -1803,7 +1803,7 @@ extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderFlush(SDL_Renderer * renderer); @@ -1838,7 +1838,7 @@ extern DECLSPEC int SDLCALL SDL_RenderFlush(SDL_Renderer * renderer); * \returns 0 on success, or -1 if the operation is not supported; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_MakeCurrent * \sa SDL_GL_UnbindTexture @@ -1853,7 +1853,7 @@ extern DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw * \param texture the texture to unbind from the current OpenGL/ES/ES2 context * \returns 0 on success, or -1 if the operation is not supported * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_BindTexture * \sa SDL_GL_MakeCurrent @@ -1870,7 +1870,7 @@ extern DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture); * \returns a `CAMetalLayer *` on success, or NULL if the renderer isn't a * Metal renderer * - * \since This function is available since SDL 2.0.8. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetMetalCommandEncoder */ @@ -1891,7 +1891,7 @@ extern DECLSPEC void *SDLCALL SDL_RenderGetMetalLayer(SDL_Renderer * renderer); * \returns an `id` on success, or NULL if the * renderer isn't a Metal renderer or there was an error. * - * \since This function is available since SDL 2.0.8. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGetMetalLayer */ @@ -1904,7 +1904,7 @@ extern DECLSPEC void *SDLCALL SDL_RenderGetMetalCommandEncoder(SDL_Renderer * re * \param vsync 1 for on, 0 for off. All other values are reserved * \returns a 0 int on success, or non-zero on failure * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_RenderSetVSync(SDL_Renderer* renderer, int vsync); diff --git a/include/SDL_rwops.h b/include/SDL_rwops.h index 3960f567cb..b8da8fcbf8 100644 --- a/include/SDL_rwops.h +++ b/include/SDL_rwops.h @@ -192,7 +192,7 @@ typedef struct SDL_RWops * \returns a pointer to the SDL_RWops structure that is created, or NULL on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -231,7 +231,7 @@ extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(FILE * fp, SDL_bool autoclose); * \returns a pointer to the SDL_RWops structure that is created, or NULL on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -265,7 +265,7 @@ extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(void * fp, * \returns a pointer to a new SDL_RWops structure, or NULL if it fails; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -300,7 +300,7 @@ extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromMem(void *mem, int size); * \returns a pointer to a new SDL_RWops structure, or NULL if it fails; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -336,7 +336,7 @@ extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromConstMem(const void *mem, * \returns a pointer to the allocated memory on success, or NULL on failure; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreeRW */ @@ -360,7 +360,7 @@ extern DECLSPEC SDL_RWops *SDLCALL SDL_AllocRW(void); * * \param area the SDL_RWops structure to be freed * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocRW */ @@ -380,7 +380,7 @@ extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops * area); * unknown or a negative error code on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Sint64 SDLCALL SDL_RWsize(SDL_RWops *context); @@ -408,7 +408,7 @@ extern DECLSPEC Sint64 SDLCALL SDL_RWsize(SDL_RWops *context); * \param whence any of `RW_SEEK_SET`, `RW_SEEK_CUR`, `RW_SEEK_END` * \returns the final offset in the data stream after the seek or -1 on error. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -436,7 +436,7 @@ extern DECLSPEC Sint64 SDLCALL SDL_RWseek(SDL_RWops *context, * \returns the current offset in the stream, or -1 if the information can not * be determined. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -469,7 +469,7 @@ extern DECLSPEC Sint64 SDLCALL SDL_RWtell(SDL_RWops *context); * \returns the number of objects read, or 0 at error or end of file; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -503,7 +503,7 @@ extern DECLSPEC size_t SDLCALL SDL_RWread(SDL_RWops *context, * \returns the number of objects written, which will be less than **num** on * error; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWclose * \sa SDL_RWFromConstMem @@ -534,7 +534,7 @@ extern DECLSPEC size_t SDLCALL SDL_RWwrite(SDL_RWops *context, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RWFromConstMem * \sa SDL_RWFromFile @@ -560,7 +560,7 @@ extern DECLSPEC int SDLCALL SDL_RWclose(SDL_RWops *context); * \param freesrc if non-zero, calls SDL_RWclose() on `src` before returning * \returns the data, or NULL if there was an error. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void *SDLCALL SDL_LoadFile_RW(SDL_RWops *src, size_t *datasize, @@ -582,7 +582,7 @@ extern DECLSPEC void *SDLCALL SDL_LoadFile_RW(SDL_RWops *src, * \param datasize if not NULL, will store the number of bytes read * \returns the data, or NULL if there was an error. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void *SDLCALL SDL_LoadFile(const char *file, size_t *datasize); @@ -600,7 +600,7 @@ extern DECLSPEC void *SDLCALL SDL_LoadFile(const char *file, size_t *datasize); * \returns the read byte on success or 0 on failure; call SDL_GetError() for * more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteU8 */ @@ -616,7 +616,7 @@ extern DECLSPEC Uint8 SDLCALL SDL_ReadU8(SDL_RWops * src); * \param src the stream from which to read data * \returns 16 bits of data in the native byte order of the platform. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadBE16 */ @@ -632,7 +632,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops * src); * \param src the stream from which to read data * \returns 16 bits of data in the native byte order of the platform. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadLE16 */ @@ -648,7 +648,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops * src); * \param src the stream from which to read data * \returns 32 bits of data in the native byte order of the platform. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadBE32 */ @@ -664,7 +664,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops * src); * \param src the stream from which to read data * \returns 32 bits of data in the native byte order of the platform. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadLE32 */ @@ -680,7 +680,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops * src); * \param src the stream from which to read data * \returns 64 bits of data in the native byte order of the platform. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadBE64 */ @@ -696,7 +696,7 @@ extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops * src); * \param src the stream from which to read data * \returns 64 bits of data in the native byte order of the platform. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadLE64 */ @@ -718,7 +718,7 @@ extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops * src); * \returns 1 on success or 0 on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ReadU8 */ @@ -736,7 +736,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteU8(SDL_RWops * dst, Uint8 value); * \param value the data to be written, in native format * \returns 1 on successful write, 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteBE16 */ @@ -753,7 +753,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteLE16(SDL_RWops * dst, Uint16 value); * \param value the data to be written, in native format * \returns 1 on successful write, 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteLE16 */ @@ -771,7 +771,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteBE16(SDL_RWops * dst, Uint16 value); * \param value the data to be written, in native format * \returns 1 on successful write, 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteBE32 */ @@ -788,7 +788,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteLE32(SDL_RWops * dst, Uint32 value); * \param value the data to be written, in native format * \returns 1 on successful write, 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteLE32 */ @@ -806,7 +806,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteBE32(SDL_RWops * dst, Uint32 value); * \param value the data to be written, in native format * \returns 1 on successful write, 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteBE64 */ @@ -823,7 +823,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteLE64(SDL_RWops * dst, Uint64 value); * \param value the data to be written, in native format * \returns 1 on successful write, 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WriteLE64 */ diff --git a/include/SDL_sensor.h b/include/SDL_sensor.h index 684d2c6eb6..0708ad9638 100644 --- a/include/SDL_sensor.h +++ b/include/SDL_sensor.h @@ -138,7 +138,7 @@ typedef enum * API functions that take a sensor index will be valid, and sensor events * will not be delivered. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_LockSensors(void); extern DECLSPEC void SDLCALL SDL_UnlockSensors(void); @@ -148,7 +148,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockSensors(void); * * \returns the number of sensors detected. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_NumSensors(void); @@ -158,7 +158,7 @@ extern DECLSPEC int SDLCALL SDL_NumSensors(void); * \param device_index The sensor to obtain name from * \returns the sensor name, or NULL if `device_index` is out of range. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char *SDLCALL SDL_SensorGetDeviceName(int device_index); @@ -169,7 +169,7 @@ extern DECLSPEC const char *SDLCALL SDL_SensorGetDeviceName(int device_index); * \returns the SDL_SensorType, or `SDL_SENSOR_INVALID` if `device_index` is * out of range. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_SensorType SDLCALL SDL_SensorGetDeviceType(int device_index); @@ -180,7 +180,7 @@ extern DECLSPEC SDL_SensorType SDLCALL SDL_SensorGetDeviceType(int device_index) * \returns the sensor platform dependent type, or -1 if `device_index` is out * of range. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SensorGetDeviceNonPortableType(int device_index); @@ -190,7 +190,7 @@ extern DECLSPEC int SDLCALL SDL_SensorGetDeviceNonPortableType(int device_index) * \param device_index The sensor to get instance id from * \returns the sensor instance ID, or -1 if `device_index` is out of range. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetDeviceInstanceID(int device_index); @@ -200,7 +200,7 @@ extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetDeviceInstanceID(int device_in * \param device_index The sensor to open * \returns an SDL_Sensor sensor object, or NULL if an error occurred. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Sensor *SDLCALL SDL_SensorOpen(int device_index); @@ -210,7 +210,7 @@ extern DECLSPEC SDL_Sensor *SDLCALL SDL_SensorOpen(int device_index); * \param instance_id The sensor from instance id * \returns an SDL_Sensor object. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Sensor *SDLCALL SDL_SensorFromInstanceID(SDL_SensorID instance_id); @@ -220,7 +220,7 @@ extern DECLSPEC SDL_Sensor *SDLCALL SDL_SensorFromInstanceID(SDL_SensorID instan * \param sensor The SDL_Sensor object * \returns the sensor name, or NULL if `sensor` is NULL. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char *SDLCALL SDL_SensorGetName(SDL_Sensor *sensor); @@ -231,7 +231,7 @@ extern DECLSPEC const char *SDLCALL SDL_SensorGetName(SDL_Sensor *sensor); * \returns the SDL_SensorType type, or `SDL_SENSOR_INVALID` if `sensor` is * NULL. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_SensorType SDLCALL SDL_SensorGetType(SDL_Sensor *sensor); @@ -241,7 +241,7 @@ extern DECLSPEC SDL_SensorType SDLCALL SDL_SensorGetType(SDL_Sensor *sensor); * \param sensor The SDL_Sensor object to inspect * \returns the sensor platform dependent type, or -1 if `sensor` is NULL. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SensorGetNonPortableType(SDL_Sensor *sensor); @@ -251,7 +251,7 @@ extern DECLSPEC int SDLCALL SDL_SensorGetNonPortableType(SDL_Sensor *sensor); * \param sensor The SDL_Sensor object to inspect * \returns the sensor instance ID, or -1 if `sensor` is NULL. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetInstanceID(SDL_Sensor *sensor); @@ -265,7 +265,7 @@ extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetInstanceID(SDL_Sensor *sensor) * \param num_values The number of values to write to data * \returns 0 or -1 if an error occurred. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SensorGetData(SDL_Sensor *sensor, float *data, int num_values); @@ -282,7 +282,7 @@ extern DECLSPEC int SDLCALL SDL_SensorGetData(SDL_Sensor *sensor, float *data, i * \param num_values The number of values to write to data * \returns 0 or -1 if an error occurred. * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SensorGetDataWithTimestamp(SDL_Sensor *sensor, Uint64 *timestamp, float *data, int num_values); @@ -291,7 +291,7 @@ extern DECLSPEC int SDLCALL SDL_SensorGetDataWithTimestamp(SDL_Sensor *sensor, U * * \param sensor The SDL_Sensor object to close * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_SensorClose(SDL_Sensor *sensor); @@ -304,7 +304,7 @@ extern DECLSPEC void SDLCALL SDL_SensorClose(SDL_Sensor *sensor); * This needs to be called from the thread that initialized the sensor * subsystem. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_SensorUpdate(void); diff --git a/include/SDL_shape.h b/include/SDL_shape.h index 1bca9270e5..c03fe8bbcb 100644 --- a/include/SDL_shape.h +++ b/include/SDL_shape.h @@ -62,7 +62,7 @@ extern "C" { * and ::SDL_WINDOW_FULLSCREEN is always unset. * \return the window created, or NULL if window creation failed. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DestroyWindow */ @@ -75,7 +75,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,un * \return SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if * the window is unshaped or NULL. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateShapedWindow */ @@ -120,7 +120,7 @@ typedef struct SDL_WindowShapeMode { * argument, or SDL_NONSHAPEABLE_WINDOW if the SDL_Window given does * not reference a valid shaped window. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WindowShapeMode * \sa SDL_GetShapedWindowMode @@ -139,7 +139,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *s * window, or SDL_WINDOW_LACKS_SHAPE if the SDL_Window given is a * shapeable window currently lacking a shape. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WindowShapeMode * \sa SDL_SetWindowShape diff --git a/include/SDL_stdinc.h b/include/SDL_stdinc.h index 4015152113..5183fd5fb8 100644 --- a/include/SDL_stdinc.h +++ b/include/SDL_stdinc.h @@ -449,7 +449,7 @@ typedef void (SDLCALL *SDL_free_func)(void *mem); /** * Get the original set of SDL memory functions * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func *malloc_func, SDL_calloc_func *calloc_func, @@ -459,7 +459,7 @@ extern DECLSPEC void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func *mal /** * Get the current set of SDL memory functions * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func, SDL_calloc_func *calloc_func, @@ -469,7 +469,7 @@ extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func /** * Replace SDL's memory allocation functions with a custom set * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func, SDL_calloc_func calloc_func, @@ -479,7 +479,7 @@ extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func, /** * Get the number of outstanding (unfreed) allocations * - * \since This function is available since SDL 2.0.7. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GetNumAllocations(void); @@ -633,7 +633,7 @@ extern DECLSPEC int SDLCALL SDL_vasprintf(char **strp, const char *fmt, va_list * \param x floating point value, in radians. * \returns arc cosine of `x`. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC double SDLCALL SDL_acos(double x); extern DECLSPEC float SDLCALL SDL_acosf(float x); @@ -697,7 +697,7 @@ extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, * This function converts a string between encodings in one pass, returning a * string that must be freed with SDL_free() or NULL on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode, const char *fromcode, diff --git a/include/SDL_surface.h b/include/SDL_surface.h index 838de654ee..fdb1c8a892 100644 --- a/include/SDL_surface.h +++ b/include/SDL_surface.h @@ -151,7 +151,7 @@ typedef enum * \returns the new SDL_Surface structure that is created or NULL if it fails; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRGBSurfaceFrom * \sa SDL_CreateRGBSurfaceWithFormat @@ -179,7 +179,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface * \returns the new SDL_Surface structure that is created or NULL if it fails; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRGBSurface * \sa SDL_CreateRGBSurfaceFrom @@ -210,7 +210,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceWithFormat * \returns the new SDL_Surface structure that is created or NULL if it fails; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRGBSurface * \sa SDL_CreateRGBSurfaceWithFormat @@ -248,7 +248,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels, * \returns the new SDL_Surface structure that is created or NULL if it fails; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRGBSurfaceFrom * \sa SDL_CreateRGBSurfaceWithFormat @@ -264,7 +264,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceWithFormatFrom * * \param surface the SDL_Surface to free. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRGBSurface * \sa SDL_CreateRGBSurfaceFrom @@ -283,7 +283,7 @@ extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface, SDL_Palette * palette); @@ -304,7 +304,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_MUSTLOCK * \sa SDL_UnlockSurface @@ -316,7 +316,7 @@ extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface); * * \param surface the SDL_Surface structure to be unlocked * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LockSurface */ @@ -337,7 +337,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface); * \returns a pointer to a new SDL_Surface structure or NULL if there was an * error; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FreeSurface * \sa SDL_RWFromFile @@ -369,7 +369,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadBMP_RW * \sa SDL_SaveBMP @@ -396,7 +396,7 @@ extern DECLSPEC int SDLCALL SDL_SaveBMP_RW * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface * \sa SDL_LockSurface @@ -413,7 +413,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceRLE(SDL_Surface * surface, * \param surface the SDL_Surface structure to query * \returns SDL_TRUE if the surface is RLE enabled, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetSurfaceRLE */ @@ -438,7 +438,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSurfaceRLE(SDL_Surface * surface); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface * \sa SDL_GetColorKey @@ -454,7 +454,7 @@ extern DECLSPEC int SDLCALL SDL_SetColorKey(SDL_Surface * surface, * \param surface the SDL_Surface structure to query * \return SDL_TRUE if the surface has a color key, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetColorKey * \sa SDL_GetColorKey @@ -474,7 +474,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasColorKey(SDL_Surface * surface); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface * \sa SDL_SetColorKey @@ -498,7 +498,7 @@ extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetSurfaceColorMod * \sa SDL_SetSurfaceAlphaMod @@ -517,7 +517,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetSurfaceAlphaMod * \sa SDL_SetSurfaceColorMod @@ -539,7 +539,7 @@ extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetSurfaceAlphaMod * \sa SDL_SetSurfaceColorMod @@ -555,7 +555,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetSurfaceColorMod * \sa SDL_SetSurfaceAlphaMod @@ -575,7 +575,7 @@ extern DECLSPEC int SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetSurfaceBlendMode */ @@ -590,7 +590,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface * surface, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetSurfaceBlendMode */ @@ -612,7 +612,7 @@ extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface * surface, * \returns SDL_TRUE if the rectangle intersects the surface, otherwise * SDL_FALSE and blits will be completely clipped. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface * \sa SDL_GetClipRect @@ -631,7 +631,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface, * \param rect an SDL_Rect structure filled in with the clipping rectangle for * the surface * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface * \sa SDL_SetClipRect @@ -666,7 +666,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_DuplicateSurface(SDL_Surface * surface) * \returns the new SDL_Surface structure that is created or NULL if it fails; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocFormat * \sa SDL_ConvertSurfaceFormat @@ -691,7 +691,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface * \returns the new SDL_Surface structure that is created or NULL if it fails; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AllocFormat * \sa SDL_ConvertSurface @@ -714,7 +714,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormat * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height, Uint32 src_format, @@ -740,7 +740,7 @@ extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_PremultiplyAlpha(int width, int height, Uint32 src_format, @@ -767,7 +767,7 @@ extern DECLSPEC int SDLCALL SDL_PremultiplyAlpha(int width, int height, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FillRects */ @@ -793,7 +793,7 @@ extern DECLSPEC int SDLCALL SDL_FillRect * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_FillRect */ @@ -866,7 +866,7 @@ extern DECLSPEC int SDLCALL SDL_FillRects * SDL_UpperBlit() has been replaced by SDL_BlitSurface(), which is merely a * macro for this function with a less confusing name. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface */ @@ -892,7 +892,7 @@ extern DECLSPEC int SDLCALL SDL_UpperBlit * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitSurface */ @@ -907,7 +907,7 @@ extern DECLSPEC int SDLCALL SDL_LowerBlit * * Please use SDL_BlitScaled() instead. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src, const SDL_Rect * srcrect, @@ -917,7 +917,7 @@ extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src, /** * Perform bilinear scaling between two surfaces of the same format, 32BPP. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SoftStretchLinear(SDL_Surface * src, const SDL_Rect * srcrect, @@ -933,7 +933,7 @@ extern DECLSPEC int SDLCALL SDL_SoftStretchLinear(SDL_Surface * src, * SDL_UpperBlitScaled() has been replaced by SDL_BlitScaled(), which is * merely a macro for this function with a less confusing name. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitScaled */ @@ -956,7 +956,7 @@ extern DECLSPEC int SDLCALL SDL_UpperBlitScaled * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_BlitScaled */ @@ -967,14 +967,14 @@ extern DECLSPEC int SDLCALL SDL_LowerBlitScaled /** * Set the YUV conversion mode * - * \since This function is available since SDL 2.0.8. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_SetYUVConversionMode(SDL_YUV_CONVERSION_MODE mode); /** * Get the YUV conversion mode * - * \since This function is available since SDL 2.0.8. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionMode(void); @@ -982,7 +982,7 @@ extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionMode(void); * Get the YUV conversion mode, returning the correct mode for the resolution * when the current conversion mode is SDL_YUV_CONVERSION_AUTOMATIC * - * \since This function is available since SDL 2.0.8. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionModeForResolution(int width, int height); diff --git a/include/SDL_system.h b/include/SDL_system.h index 2a2e7ce816..d70f9a6a9b 100644 --- a/include/SDL_system.h +++ b/include/SDL_system.h @@ -51,7 +51,7 @@ typedef void (SDLCALL * SDL_WindowsMessageHook)(void *userdata, void *hWnd, unsi * \param callback The SDL_WindowsMessageHook function to call. * \param userdata a pointer to pass to every iteration of `callback` * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHook callback, void *userdata); @@ -70,7 +70,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHook ca * \returns the D3D9 adapter index on success or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex ); @@ -86,7 +86,7 @@ typedef struct IDirect3DDevice9 IDirect3DDevice9; * \returns the D3D9 device associated with given renderer or NULL if it is * not a D3D9 renderer; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer); @@ -102,7 +102,7 @@ typedef struct ID3D11Device ID3D11Device; * \returns the D3D11 device associated with given renderer or NULL if it is * not a D3D11 renderer; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC ID3D11Device* SDLCALL SDL_RenderGetD3D11Device(SDL_Renderer * renderer); @@ -122,7 +122,7 @@ typedef struct ID3D12Device ID3D12Device; * \returns the D3D12 device associated with given renderer or NULL if it is * not a D3D12 renderer; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC ID3D12Device* SDLCALL SDL_RenderGetD3D12Device(SDL_Renderer* renderer); @@ -146,7 +146,7 @@ extern DECLSPEC ID3D12Device* SDLCALL SDL_RenderGetD3D12Device(SDL_Renderer* ren * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex ); @@ -164,7 +164,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *a * \param priority The new, Unix-specific, priority value. * \returns 0 on success, or -1 on error. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriority(Sint64 threadID, int priority); @@ -179,7 +179,7 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriority(Sint64 threadID, int prio * SCHED_OTHER, etc...) * \returns 0 on success, or -1 on error. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy); @@ -218,7 +218,7 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_iPhoneSetEventPump */ @@ -236,7 +236,7 @@ extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, * * \param enabled SDL_TRUE to enable the event pump, SDL_FALSE to disable it * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_iPhoneSetAnimationCallback */ @@ -261,7 +261,7 @@ extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled); * \returns a pointer to Java native interface object (JNIEnv) to which the * current thread is attached, or 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AndroidGetActivity */ @@ -283,7 +283,7 @@ extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv(void); * \returns the jobject representing the instance of the Activity class of the * Android application, or NULL on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AndroidGetJNIEnv */ @@ -317,7 +317,7 @@ extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity(void); * * \returns the Android API level. * - * \since This function is available since SDL 2.0.12. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void); @@ -326,7 +326,7 @@ extern DECLSPEC int SDLCALL SDL_GetAndroidSDKVersion(void); * * \returns SDL_TRUE if this is Android TV, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.8. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IsAndroidTV(void); @@ -335,7 +335,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsAndroidTV(void); * * \returns SDL_TRUE if this is a Chromebook, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IsChromebook(void); @@ -344,14 +344,14 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsChromebook(void); * * \returns SDL_TRUE if this is a DeX docking station, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IsDeXMode(void); /** * Trigger the Android system back button behavior. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_AndroidBackButton(void); @@ -374,7 +374,7 @@ extern DECLSPEC void SDLCALL SDL_AndroidBackButton(void); * \returns the path used for internal storage or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AndroidGetExternalStorageState */ @@ -391,7 +391,7 @@ extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath(void); * \returns the current state of external storage on success or 0 on failure; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AndroidGetExternalStoragePath */ @@ -409,7 +409,7 @@ extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState(void); * \returns the path used for external storage for this application on success * or NULL on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AndroidGetExternalStorageState */ @@ -423,7 +423,7 @@ extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath(void); * \param permission The permission to request. * \returns SDL_TRUE if the permission was granted, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.14. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_AndroidRequestPermission(const char *permission); @@ -448,7 +448,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AndroidRequestPermission(const char *permis * \param yoffset set this parameter only when gravity >=0 * \returns 0 if success, -1 if any error occurs. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_AndroidShowToast(const char* message, int duration, int gravity, int xoffset, int yoffset); @@ -460,7 +460,7 @@ extern DECLSPEC int SDLCALL SDL_AndroidShowToast(const char* message, int durati * \param command user command that must be greater or equal to 0x8000 * \param param user parameter * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_AndroidSendMessage(Uint32 command, int param); @@ -473,7 +473,7 @@ extern DECLSPEC int SDLCALL SDL_AndroidSendMessage(Uint32 command, int param); * * \returns SDL_TRUE if the device is a tablet, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_IsTablet(void); @@ -503,7 +503,7 @@ typedef struct XTaskQueueObject * XTaskQueueHandle; * \param outTaskQueue a pointer to be filled in with task queue handle. * \returns 0 if success, -1 if any error occurs. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_GDKGetTaskQueue(XTaskQueueHandle * outTaskQueue); diff --git a/include/SDL_syswm.h b/include/SDL_syswm.h index da43b4a5bf..820f2a700a 100644 --- a/include/SDL_syswm.h +++ b/include/SDL_syswm.h @@ -309,7 +309,7 @@ typedef struct SDL_SysWMinfo SDL_SysWMinfo; * of the `info` struct is valid, or SDL_FALSE if the information * could not be retrieved; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window, SDL_SysWMinfo * info); diff --git a/include/SDL_thread.h b/include/SDL_thread.h index ea8d36fb65..a5e1fe4ef7 100644 --- a/include/SDL_thread.h +++ b/include/SDL_thread.h @@ -156,7 +156,7 @@ SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, * new thread could not be created; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateThreadWithStackSize * \sa SDL_WaitThread @@ -203,7 +203,7 @@ SDL_CreateThread(SDL_ThreadFunction fn, const char *name, void *data); * new thread could not be created; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. * * \sa SDL_WaitThread */ @@ -222,7 +222,7 @@ SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, const char *name, const siz * \returns a pointer to a UTF-8 string that names the specified thread, or * NULL if it doesn't have a name. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateThread */ @@ -240,7 +240,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetThreadName(SDL_Thread *thread); * * \returns the ID of the current thread. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetThreadID */ @@ -257,7 +257,7 @@ extern DECLSPEC SDL_threadID SDLCALL SDL_ThreadID(void); * \returns the ID of the specified thread, or the ID of the current thread if * `thread` is NULL. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ThreadID */ @@ -274,7 +274,7 @@ extern DECLSPEC SDL_threadID SDLCALL SDL_GetThreadID(SDL_Thread * thread); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SetThreadPriority(SDL_ThreadPriority priority); @@ -306,7 +306,7 @@ extern DECLSPEC int SDLCALL SDL_SetThreadPriority(SDL_ThreadPriority priority); * from the thread function by its 'return', or NULL to not * receive such value back. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateThread * \sa SDL_DetachThread @@ -342,7 +342,7 @@ extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status); * \param thread the SDL_Thread pointer that was returned from the * SDL_CreateThread() call that started this thread * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateThread * \sa SDL_WaitThread @@ -357,7 +357,7 @@ extern DECLSPEC void SDLCALL SDL_DetachThread(SDL_Thread * thread); * * \returns the newly created thread local storage identifier or 0 on error. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_TLSGet * \sa SDL_TLSSet @@ -371,7 +371,7 @@ extern DECLSPEC SDL_TLSID SDLCALL SDL_TLSCreate(void); * \returns the value associated with the ID for the current thread or NULL if * no value has been set; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_TLSCreate * \sa SDL_TLSSet @@ -396,7 +396,7 @@ extern DECLSPEC void * SDLCALL SDL_TLSGet(SDL_TLSID id); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_TLSCreate * \sa SDL_TLSGet @@ -406,7 +406,7 @@ extern DECLSPEC int SDLCALL SDL_TLSSet(SDL_TLSID id, const void *value, void (SD /** * Cleanup all TLS data for this thread. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_TLSCleanup(void); diff --git a/include/SDL_timer.h b/include/SDL_timer.h index 62f81d42db..36d5f43a24 100644 --- a/include/SDL_timer.h +++ b/include/SDL_timer.h @@ -51,7 +51,7 @@ extern "C" { * \returns an unsigned 32-bit value representing the number of milliseconds * since the SDL library initialized. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_TICKS_PASSED */ @@ -77,7 +77,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void); * \returns an unsigned 64-bit value representing the number of milliseconds * since the SDL library initialized. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint64 SDLCALL SDL_GetTicks64(void); @@ -116,7 +116,7 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetTicks64(void); * * \returns the current counter value. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetPerformanceFrequency */ @@ -127,7 +127,7 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void); * * \returns a platform-specific count per second. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetPerformanceCounter */ @@ -142,7 +142,7 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void); * * \param ms the number of milliseconds to delay * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms); @@ -189,7 +189,7 @@ typedef int SDL_TimerID; * \returns a timer ID or 0 if an error occurs; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RemoveTimer */ @@ -204,7 +204,7 @@ extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, * \returns SDL_TRUE if the timer is removed or SDL_FALSE if the timer wasn't * found. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_AddTimer */ diff --git a/include/SDL_touch.h b/include/SDL_touch.h index 95924135e1..2f76adacd2 100644 --- a/include/SDL_touch.h +++ b/include/SDL_touch.h @@ -76,7 +76,7 @@ typedef struct SDL_Finger * * \returns the number of registered touch devices. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTouchDevice */ @@ -89,7 +89,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumTouchDevices(void); * \returns the touch ID with the given index on success or 0 if the index is * invalid; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumTouchDevices */ @@ -99,14 +99,14 @@ extern DECLSPEC SDL_TouchID SDLCALL SDL_GetTouchDevice(int index); * Get the touch device name as reported from the driver or NULL if the index * is invalid. * - * \since This function is available since SDL 2.0.22. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC const char* SDLCALL SDL_GetTouchName(int index); /** * Get the type of the given touch device. * - * \since This function is available since SDL 2.0.10. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_TouchID touchID); @@ -117,7 +117,7 @@ extern DECLSPEC SDL_TouchDeviceType SDLCALL SDL_GetTouchDeviceType(SDL_TouchID t * \returns the number of active fingers for a given touch device on success * or 0 on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTouchFinger */ @@ -133,7 +133,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumTouchFingers(SDL_TouchID touchID); * \returns a pointer to the SDL_Finger object or NULL if no object at the * given ID and index could be found. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RecordGesture */ diff --git a/include/SDL_version.h b/include/SDL_version.h index 81b521cda7..6f86ab7561 100644 --- a/include/SDL_version.h +++ b/include/SDL_version.h @@ -116,7 +116,7 @@ typedef struct SDL_version * * \param ver the SDL_version structure that contains the version information * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRevision */ @@ -145,7 +145,7 @@ extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver); * \returns an arbitrary string, uniquely identifying the exact revision of * the SDL library in use. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetVersion */ @@ -168,7 +168,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetRevision(void); * * \returns zero, always, in modern SDL releases. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRevision */ diff --git a/include/SDL_video.h b/include/SDL_video.h index b2f1509f73..ccd43394ed 100644 --- a/include/SDL_video.h +++ b/include/SDL_video.h @@ -287,7 +287,7 @@ typedef enum * \returns a number >= 1 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetVideoDriver */ @@ -302,7 +302,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void); * \param index the index of a video driver * \returns the name of the video driver with the given **index**. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDrivers */ @@ -330,7 +330,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDrivers * \sa SDL_GetVideoDriver @@ -344,7 +344,7 @@ extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name); * * This function closes all windows, and restores the original video mode. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_VideoInit */ @@ -356,7 +356,7 @@ extern DECLSPEC void SDLCALL SDL_VideoQuit(void); * \returns the name of the current video driver or NULL if no driver has been * initialized. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDrivers * \sa SDL_GetVideoDriver @@ -369,7 +369,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void); * \returns a number >= 1 or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayBounds */ @@ -383,7 +383,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void); * \returns the name of a display or NULL for an invalid display index or * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDisplays */ @@ -399,7 +399,7 @@ extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDisplays */ @@ -429,7 +429,7 @@ extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * re * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayBounds * \sa SDL_GetNumVideoDisplays @@ -465,7 +465,7 @@ extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rec * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDisplays */ @@ -478,7 +478,7 @@ extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, fl * \returns The SDL_DisplayOrientation enum value of the display, or * `SDL_ORIENTATION_UNKNOWN` if it isn't available. * - * \since This function is available since SDL 2.0.9. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumVideoDisplays */ @@ -494,7 +494,7 @@ extern DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetDisplayOrientation(int dis * \returns a number >= 1 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayMode * \sa SDL_GetNumVideoDisplays @@ -519,7 +519,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetNumDisplayModes */ @@ -540,7 +540,7 @@ extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetCurrentDisplayMode * \sa SDL_GetDisplayMode @@ -562,7 +562,7 @@ extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_Disp * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDesktopDisplayMode * \sa SDL_GetDisplayMode @@ -590,7 +590,7 @@ extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_Disp * \returns the passed in value `closest` or NULL if no matching video mode * was available; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayMode * \sa SDL_GetNumDisplayModes @@ -604,7 +604,7 @@ extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayI * \returns the index of the display containing the point or a negative error * code on failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayBounds * \sa SDL_GetNumVideoDisplays @@ -619,7 +619,7 @@ extern DECLSPEC int SDLCALL SDL_GetPointDisplayIndex(const SDL_Point * point); * to the center of the rect on success or a negative error code on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 2.24.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayBounds * \sa SDL_GetNumVideoDisplays @@ -634,7 +634,7 @@ extern DECLSPEC int SDLCALL SDL_GetRectDisplayIndex(const SDL_Rect * rect); * success or a negative error code on failure; call SDL_GetError() * for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetDisplayBounds * \sa SDL_GetNumVideoDisplays @@ -655,7 +655,7 @@ extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowDisplayMode * \sa SDL_SetWindowFullscreen @@ -672,7 +672,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowDisplayMode * \sa SDL_SetWindowFullscreen @@ -690,7 +690,7 @@ extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window, * \returns the raw ICC profile data on success or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void* SDLCALL SDL_GetWindowICCProfile(SDL_Window * window, size_t* size); @@ -702,7 +702,7 @@ extern DECLSPEC void* SDLCALL SDL_GetWindowICCProfile(SDL_Window * window, size_ * SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window); @@ -772,7 +772,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window); * \returns the window that was created or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateWindowFrom * \sa SDL_DestroyWindow @@ -793,7 +793,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, * \returns the window that was created or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateWindow * \sa SDL_DestroyWindow @@ -810,7 +810,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data); * \returns the ID of the window on success or 0 on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowFromID */ @@ -826,7 +826,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window); * \returns the window associated with `id` or NULL if it doesn't exist; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowID */ @@ -838,7 +838,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id); * \param window the window to query * \returns a mask of the SDL_WindowFlags associated with `window` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateWindow * \sa SDL_HideWindow @@ -858,7 +858,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window); * \param window the window to change * \param title the desired window title in UTF-8 format * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowTitle */ @@ -872,7 +872,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window, * \returns the title of the window in UTF-8 format or "" if there is no * title. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowTitle */ @@ -884,7 +884,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window); * \param window the window to change * \param icon an SDL_Surface structure containing the icon for the window * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window, SDL_Surface * icon); @@ -899,7 +899,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window, * \param userdata the associated pointer * \returns the previous value associated with `name`. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowData */ @@ -914,7 +914,7 @@ extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window, * \param name the name of the pointer * \returns the value associated with `name`. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowData */ @@ -932,7 +932,7 @@ extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window, * \param y the y coordinate of the window in screen coordinates, or * `SDL_WINDOWPOS_CENTERED` or `SDL_WINDOWPOS_UNDEFINED` * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowPosition */ @@ -951,7 +951,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window, * \param y a pointer filled in with the y position of the window, in screen * coordinates, may be NULL * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowPosition */ @@ -975,7 +975,7 @@ extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window, * \param h the height of the window in pixels, in screen coordinates, must be * > 0 * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowSize * \sa SDL_SetWindowDisplayMode @@ -1001,7 +1001,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w, * \param h a pointer filled in with the height of the window, in screen * coordinates, may be NULL * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_GetDrawableSize * \sa SDL_Vulkan_GetDrawableSize @@ -1038,7 +1038,7 @@ extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowSize */ @@ -1059,7 +1059,7 @@ extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window * window, * \param h a pointer to variable for storing the height in pixels, may be * NULL * - * \since This function is available since SDL 2.26.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateWindow * \sa SDL_GetWindowSize @@ -1074,7 +1074,7 @@ extern DECLSPEC void SDLCALL SDL_GetWindowSizeInPixels(SDL_Window * window, * \param min_w the minimum width of the window in pixels * \param min_h the minimum height of the window in pixels * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowMinimumSize * \sa SDL_SetWindowMaximumSize @@ -1091,7 +1091,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window, * \param h a pointer filled in with the minimum height of the window, may be * NULL * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowMaximumSize * \sa SDL_SetWindowMinimumSize @@ -1106,7 +1106,7 @@ extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window, * \param max_w the maximum width of the window in pixels * \param max_h the maximum height of the window in pixels * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowMaximumSize * \sa SDL_SetWindowMinimumSize @@ -1123,7 +1123,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window, * \param h a pointer filled in with the maximum height of the window, may be * NULL * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowMinimumSize * \sa SDL_SetWindowMaximumSize @@ -1143,7 +1143,7 @@ extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window, * \param window the window of which to change the border state * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowFlags */ @@ -1162,7 +1162,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window, * \param window the window of which to change the resizable state * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowFlags */ @@ -1179,7 +1179,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window * window, * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to * disable * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowFlags */ @@ -1191,7 +1191,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window * window, * * \param window the window to show * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_HideWindow * \sa SDL_RaiseWindow @@ -1203,7 +1203,7 @@ extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window); * * \param window the window to hide * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_ShowWindow */ @@ -1214,7 +1214,7 @@ extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window); * * \param window the window to raise * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window); @@ -1223,7 +1223,7 @@ extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window); * * \param window the window to maximize * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_MinimizeWindow * \sa SDL_RestoreWindow @@ -1235,7 +1235,7 @@ extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window); * * \param window the window to minimize * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_MaximizeWindow * \sa SDL_RestoreWindow @@ -1247,7 +1247,7 @@ extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window); * * \param window the window to restore * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_MaximizeWindow * \sa SDL_MinimizeWindow @@ -1266,7 +1266,7 @@ extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowDisplayMode * \sa SDL_SetWindowDisplayMode @@ -1292,7 +1292,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window, * \returns the surface associated with the window, or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_UpdateWindowSurface * \sa SDL_UpdateWindowSurfaceRects @@ -1311,7 +1311,7 @@ extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowSurface * \sa SDL_UpdateWindowSurfaceRects @@ -1333,7 +1333,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowSurface * \sa SDL_UpdateWindowSurface @@ -1355,7 +1355,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window, * \param window the window for which the input grab mode should be set * \param grabbed SDL_TRUE to grab input or SDL_FALSE to release input * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGrabbedWindow * \sa SDL_GetWindowGrab @@ -1385,7 +1385,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window, * \param window The window for which the keyboard grab mode should be set. * \param grabbed This is SDL_TRUE to grab keyboard, and SDL_FALSE to release. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowKeyboardGrab * \sa SDL_SetWindowMouseGrab @@ -1402,7 +1402,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window * window, * \param window The window for which the mouse grab mode should be set. * \param grabbed This is SDL_TRUE to grab mouse, and SDL_FALSE to release. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowMouseGrab * \sa SDL_SetWindowKeyboardGrab @@ -1417,7 +1417,7 @@ extern DECLSPEC void SDLCALL SDL_SetWindowMouseGrab(SDL_Window * window, * \param window the window to query * \returns SDL_TRUE if input is grabbed, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowGrab */ @@ -1429,7 +1429,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window); * \param window the window to query * \returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowKeyboardGrab * \sa SDL_GetWindowGrab @@ -1442,7 +1442,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window * window); * \param window the window to query * \returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowKeyboardGrab * \sa SDL_GetWindowGrab @@ -1454,7 +1454,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window * window); * * \returns the window if input is grabbed or NULL otherwise. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowGrab * \sa SDL_SetWindowGrab @@ -1473,7 +1473,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowMouseRect * \sa SDL_SetWindowMouseGrab @@ -1487,7 +1487,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window * window, const SD * \returns A pointer to the mouse confinement rectangle of a window, or NULL * if there isn't one. * - * \since This function is available since SDL 2.0.18. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowMouseRect */ @@ -1514,7 +1514,7 @@ extern DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window * win * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowBrightness * \sa SDL_SetWindowGammaRamp @@ -1534,7 +1534,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float b * \returns the brightness for the display where 0.0 is completely dark and * 1.0 is normal brightness. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowBrightness */ @@ -1553,7 +1553,7 @@ extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowOpacity */ @@ -1574,7 +1574,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opac * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowOpacity */ @@ -1588,7 +1588,7 @@ extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * ou * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window); @@ -1603,7 +1603,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.5. + * \since This function is available since SDL 3.0.0. * * \sa SDL_RaiseWindow */ @@ -1635,7 +1635,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window * window); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowGammaRamp */ @@ -1663,7 +1663,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_SetWindowGammaRamp */ @@ -1743,7 +1743,7 @@ typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win, * \returns 0 on success or -1 on error (including unsupported); call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.4. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window, SDL_HitTest callback, @@ -1757,7 +1757,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window, * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.16. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window * window, SDL_FlashOperation operation); @@ -1769,7 +1769,7 @@ extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window * window, SDL_FlashOperat * * \param window the window to destroy * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateWindow * \sa SDL_CreateWindowFrom @@ -1788,7 +1788,7 @@ extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window); * \returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is * disabled. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DisableScreenSaver * \sa SDL_EnableScreenSaver @@ -1798,7 +1798,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void); /** * Allow the screen to be blanked by a screen saver. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_DisableScreenSaver * \sa SDL_IsScreenSaverEnabled @@ -1814,7 +1814,7 @@ extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void); * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2 * the screensaver was enabled by default. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_EnableScreenSaver * \sa SDL_IsScreenSaverEnabled @@ -1842,7 +1842,7 @@ extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_GetProcAddress * \sa SDL_GL_UnloadLibrary @@ -1894,7 +1894,7 @@ extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path); * \returns a pointer to the named OpenGL function. The returned pointer * should be cast to the appropriate function signature. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_ExtensionSupported * \sa SDL_GL_LoadLibrary @@ -1905,7 +1905,7 @@ extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc); /** * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_LoadLibrary */ @@ -1928,7 +1928,7 @@ extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void); * \param extension the name of the extension to check * \returns SDL_TRUE if the extension is supported, SDL_FALSE otherwise. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char *extension); @@ -1936,7 +1936,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char /** * Reset all previously set OpenGL context attributes to their default values. * - * \since This function is available since SDL 2.0.2. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_GetAttribute * \sa SDL_GL_SetAttribute @@ -1956,7 +1956,7 @@ extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_GetAttribute * \sa SDL_GL_ResetAttributes @@ -1971,7 +1971,7 @@ extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value); * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_ResetAttributes * \sa SDL_GL_SetAttribute @@ -1993,7 +1993,7 @@ extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value); * \returns the OpenGL context associated with `window` or NULL on error; call * SDL_GetError() for more details. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_DeleteContext * \sa SDL_GL_MakeCurrent @@ -2011,7 +2011,7 @@ extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window * * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_CreateContext */ @@ -2024,7 +2024,7 @@ extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window, * \returns the currently active OpenGL window on success or NULL on failure; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void); @@ -2034,7 +2034,7 @@ extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void); * \returns the currently active OpenGL context or NULL on failure; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_MakeCurrent */ @@ -2055,7 +2055,7 @@ extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void); * \param h a pointer to variable for storing the height in pixels, may be * NULL * - * \since This function is available since SDL 2.0.1. + * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateWindow * \sa SDL_GetWindowSize @@ -2086,7 +2086,7 @@ extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w, * \returns 0 on success or -1 if setting the swap interval is not supported; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_GetSwapInterval */ @@ -2103,7 +2103,7 @@ extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval); * swaps happen immediately instead of waiting for the next retrace; * call SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_SetSwapInterval */ @@ -2121,7 +2121,7 @@ extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void); * * \param window the window to change * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window); @@ -2130,7 +2130,7 @@ extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window); * * \param context the OpenGL context to be deleted * - * \since This function is available since SDL 2.0.0. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GL_CreateContext */ diff --git a/include/SDL_vulkan.h b/include/SDL_vulkan.h index ab86a0b865..7e52584896 100644 --- a/include/SDL_vulkan.h +++ b/include/SDL_vulkan.h @@ -101,7 +101,7 @@ typedef VkSurfaceKHR SDL_vulkanSurface; /* for compatibility with Tizen */ * \returns 0 on success or -1 if the library couldn't be loaded; call * SDL_GetError() for more information. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Vulkan_GetVkInstanceProcAddr * \sa SDL_Vulkan_UnloadLibrary @@ -116,14 +116,14 @@ extern DECLSPEC int SDLCALL SDL_Vulkan_LoadLibrary(const char *path); * * \returns the function pointer for `vkGetInstanceProcAddr` or NULL on error. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. */ extern DECLSPEC void *SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void); /** * Unload the Vulkan library previously loaded by SDL_Vulkan_LoadLibrary() * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Vulkan_LoadLibrary */ @@ -153,7 +153,7 @@ extern DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void); * Vulkan instance extensions * \returns SDL_TRUE on success, SDL_FALSE on error. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Vulkan_CreateSurface */ @@ -174,7 +174,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_GetInstanceExtensions(SDL_Window *wi * created surface * \returns SDL_TRUE on success, SDL_FALSE on error. * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. * * \sa SDL_Vulkan_GetInstanceExtensions * \sa SDL_Vulkan_GetDrawableSize @@ -195,7 +195,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_CreateSurface(SDL_Window *window, * \param w Pointer to the variable to write the width to or NULL * \param h Pointer to the variable to write the height to or NULL * - * \since This function is available since SDL 2.0.6. + * \since This function is available since SDL 3.0.0. * * \sa SDL_GetWindowSize * \sa SDL_CreateWindow