diff --git a/include/SDL3/SDL_atomic.h b/include/SDL3/SDL_atomic.h index c7e4e6c39..b5ebe0079 100644 --- a/include/SDL3/SDL_atomic.h +++ b/include/SDL3/SDL_atomic.h @@ -283,8 +283,6 @@ typedef struct SDL_AtomicInt { int value; } SDL_AtomicInt; * \since This function is available since SDL 3.0.0. * * \sa SDL_AtomicCompareAndSwapPointer - * \sa SDL_AtomicGet - * \sa SDL_AtomicSet */ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareAndSwap(SDL_AtomicInt *a, int oldval, int newval); diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h index 16820be6f..feac79c5a 100644 --- a/include/SDL3/SDL_audio.h +++ b/include/SDL3/SDL_audio.h @@ -561,7 +561,6 @@ extern DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID devid); * \since This function is available since SDL 3.0.0. * * \sa SDL_BindAudioStreams - * \sa SDL_UnbindAudioStreams * \sa SDL_UnbindAudioStream * \sa SDL_GetAudioStreamDevice */ @@ -583,7 +582,6 @@ extern DECLSPEC int SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devid, SDL_Au * \since This function is available since SDL 3.0.0. * * \sa SDL_BindAudioStreams - * \sa SDL_UnbindAudioStreams * \sa SDL_UnbindAudioStream * \sa SDL_GetAudioStreamDevice */ @@ -607,9 +605,6 @@ extern DECLSPEC int SDLCALL SDL_BindAudioStream(SDL_AudioDeviceID devid, SDL_Aud * \since This function is available since SDL 3.0.0. * * \sa SDL_BindAudioStreams - * \sa SDL_BindAudioStream - * \sa SDL_UnbindAudioStream - * \sa SDL_GetAudioStreamDevice */ extern DECLSPEC void SDLCALL SDL_UnbindAudioStreams(SDL_AudioStream **streams, int num_streams); @@ -626,9 +621,6 @@ extern DECLSPEC void SDLCALL SDL_UnbindAudioStreams(SDL_AudioStream **streams, i * \since This function is available since SDL 3.0.0. * * \sa SDL_BindAudioStream - * \sa SDL_BindAudioStreams - * \sa SDL_UnbindAudioStreams - * \sa SDL_GetAudioStreamDevice */ extern DECLSPEC void SDLCALL SDL_UnbindAudioStream(SDL_AudioStream *stream); @@ -649,8 +641,6 @@ extern DECLSPEC void SDLCALL SDL_UnbindAudioStream(SDL_AudioStream *stream); * * \sa SDL_BindAudioStream * \sa SDL_BindAudioStreams - * \sa SDL_UnbindAudioStream - * \sa SDL_UnbindAudioStreams */ extern DECLSPEC SDL_AudioDeviceID SDLCALL SDL_GetAudioStreamDevice(SDL_AudioStream *stream); @@ -727,9 +717,6 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamFormat(SDL_AudioStream *stream, * \since This function is available since SDL 3.0.0. * * \sa SDL_GetAudioStreamFormat - * \sa SDL_PutAudioStreamData - * \sa SDL_GetAudioStreamData - * \sa SDL_GetAudioStreamAvailable * \sa SDL_SetAudioStreamFrequencyRatio */ extern DECLSPEC int SDLCALL SDL_SetAudioStreamFormat(SDL_AudioStream *stream, @@ -801,12 +788,10 @@ extern DECLSPEC int SDLCALL SDL_SetAudioStreamFrequencyRatio(SDL_AudioStream *st * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateAudioStream - * \sa SDL_GetAudioStreamData - * \sa SDL_GetAudioStreamAvailable - * \sa SDL_FlushAudioStream * \sa SDL_ClearAudioStream - * \sa SDL_DestroyAudioStream + * \sa SDL_FlushAudioStream + * \sa SDL_GetAudioStreamData + * \sa SDL_GetAudioStreamQueued */ extern DECLSPEC int SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *stream, const void *buf, int len); @@ -833,13 +818,9 @@ extern DECLSPEC int SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *stream, cons * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateAudioStream - * \sa SDL_PutAudioStreamData - * \sa SDL_GetAudioStreamAvailable - * \sa SDL_SetAudioStreamFormat - * \sa SDL_FlushAudioStream * \sa SDL_ClearAudioStream - * \sa SDL_DestroyAudioStream + * \sa SDL_GetAudioStreamAvailable + * \sa SDL_PutAudioStreamData */ extern DECLSPEC int SDLCALL SDL_GetAudioStreamData(SDL_AudioStream *stream, void *buf, int len); @@ -863,12 +844,8 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamData(SDL_AudioStream *stream, void * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateAudioStream - * \sa SDL_PutAudioStreamData * \sa SDL_GetAudioStreamData - * \sa SDL_FlushAudioStream - * \sa SDL_ClearAudioStream - * \sa SDL_DestroyAudioStream + * \sa SDL_PutAudioStreamData */ extern DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *stream); @@ -900,7 +877,6 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *stream) * \since This function is available since SDL 3.0.0. * * \sa SDL_PutAudioStreamData - * \sa SDL_GetAudioStreamData * \sa SDL_ClearAudioStream */ extern DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(SDL_AudioStream *stream); @@ -922,12 +898,7 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(SDL_AudioStream *stream); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateAudioStream * \sa SDL_PutAudioStreamData - * \sa SDL_GetAudioStreamData - * \sa SDL_GetAudioStreamAvailable - * \sa SDL_ClearAudioStream - * \sa SDL_DestroyAudioStream */ extern DECLSPEC int SDLCALL SDL_FlushAudioStream(SDL_AudioStream *stream); @@ -942,12 +913,10 @@ extern DECLSPEC int SDLCALL SDL_FlushAudioStream(SDL_AudioStream *stream); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateAudioStream - * \sa SDL_PutAudioStreamData - * \sa SDL_GetAudioStreamData * \sa SDL_GetAudioStreamAvailable - * \sa SDL_FlushAudioStream - * \sa SDL_DestroyAudioStream + * \sa SDL_GetAudioStreamData + * \sa SDL_GetAudioStreamQueued + * \sa SDL_PutAudioStreamData */ extern DECLSPEC int SDLCALL SDL_ClearAudioStream(SDL_AudioStream *stream); @@ -976,8 +945,6 @@ extern DECLSPEC int SDLCALL SDL_ClearAudioStream(SDL_AudioStream *stream); * \since This function is available since SDL 3.0.0. * * \sa SDL_UnlockAudioStream - * \sa SDL_SetAudioStreamPutCallback - * \sa SDL_SetAudioStreamGetCallback */ extern DECLSPEC int SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream); @@ -997,8 +964,6 @@ extern DECLSPEC int SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream); * \since This function is available since SDL 3.0.0. * * \sa SDL_LockAudioStream - * \sa SDL_SetAudioStreamPutCallback - * \sa SDL_SetAudioStreamGetCallback */ extern DECLSPEC int SDLCALL SDL_UnlockAudioStream(SDL_AudioStream *stream); @@ -1134,11 +1099,6 @@ extern DECLSPEC int SDLCALL SDL_SetAudioStreamPutCallback(SDL_AudioStream *strea * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateAudioStream - * \sa SDL_PutAudioStreamData - * \sa SDL_GetAudioStreamData - * \sa SDL_GetAudioStreamAvailable - * \sa SDL_FlushAudioStream - * \sa SDL_ClearAudioStream */ extern DECLSPEC void SDLCALL SDL_DestroyAudioStream(SDL_AudioStream *stream); @@ -1458,8 +1418,6 @@ extern DECLSPEC int SDLCALL SDL_MixAudioFormat(Uint8 * dst, * \threadsafety It is safe to call this function from any thread. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreateAudioStream */ extern DECLSPEC int SDLCALL SDL_ConvertAudioSamples(const SDL_AudioSpec *src_spec, const Uint8 *src_data, diff --git a/include/SDL3/SDL_clipboard.h b/include/SDL3/SDL_clipboard.h index 84317613f..7e2d3aba6 100644 --- a/include/SDL3/SDL_clipboard.h +++ b/include/SDL3/SDL_clipboard.h @@ -187,8 +187,7 @@ typedef void (SDLCALL *SDL_ClipboardCleanupCallback)(void *userdata); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_ClipboardDataCallback - * \sa SDL_SetClipboardData + * \sa SDL_ClearClipboardData * \sa SDL_GetClipboardData * \sa SDL_HasClipboardData */ diff --git a/include/SDL3/SDL_cpuinfo.h b/include/SDL3/SDL_cpuinfo.h index c4b3d3988..59a4b3253 100644 --- a/include/SDL3/SDL_cpuinfo.h +++ b/include/SDL3/SDL_cpuinfo.h @@ -75,16 +75,6 @@ extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void); * \returns SDL_TRUE if the CPU has AltiVec features or SDL_FALSE if not. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasMMX - * \sa SDL_HasSSE - * \sa SDL_HasSSE2 - * \sa SDL_HasSSE3 - * \sa SDL_HasSSE41 - * \sa SDL_HasSSE42 */ extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void); @@ -96,16 +86,6 @@ 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 3.0.0. - * - * \sa SDL_HasAltiVec - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasSSE - * \sa SDL_HasSSE2 - * \sa SDL_HasSSE3 - * \sa SDL_HasSSE41 - * \sa SDL_HasSSE42 */ extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void); @@ -118,11 +98,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasMMX * \sa SDL_HasSSE2 * \sa SDL_HasSSE3 * \sa SDL_HasSSE41 @@ -139,11 +114,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasMMX * \sa SDL_HasSSE * \sa SDL_HasSSE3 * \sa SDL_HasSSE41 @@ -160,11 +130,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasMMX * \sa SDL_HasSSE * \sa SDL_HasSSE2 * \sa SDL_HasSSE41 @@ -181,11 +146,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE3(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasMMX * \sa SDL_HasSSE * \sa SDL_HasSSE2 * \sa SDL_HasSSE3 @@ -202,11 +162,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE41(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec - * \sa SDL_HasAVX - * \sa SDL_HasAVX2 - * \sa SDL_HasAVX512F - * \sa SDL_HasMMX * \sa SDL_HasSSE * \sa SDL_HasSSE2 * \sa SDL_HasSSE3 @@ -223,15 +178,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE42(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec * \sa SDL_HasAVX2 * \sa SDL_HasAVX512F - * \sa SDL_HasMMX - * \sa SDL_HasSSE - * \sa SDL_HasSSE2 - * \sa SDL_HasSSE3 - * \sa SDL_HasSSE41 - * \sa SDL_HasSSE42 */ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX(void); @@ -244,15 +192,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec * \sa SDL_HasAVX * \sa SDL_HasAVX512F - * \sa SDL_HasMMX - * \sa SDL_HasSSE - * \sa SDL_HasSSE2 - * \sa SDL_HasSSE3 - * \sa SDL_HasSSE41 - * \sa SDL_HasSSE42 */ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX2(void); @@ -265,15 +206,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX2(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_HasAltiVec * \sa SDL_HasAVX * \sa SDL_HasAVX2 - * \sa SDL_HasMMX - * \sa SDL_HasSSE - * \sa SDL_HasSSE2 - * \sa SDL_HasSSE3 - * \sa SDL_HasSSE41 - * \sa SDL_HasSSE42 */ extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX512F(void); diff --git a/include/SDL3/SDL_dialog.h b/include/SDL3/SDL_dialog.h index 0554a932b..4af592e50 100644 --- a/include/SDL3/SDL_dialog.h +++ b/include/SDL3/SDL_dialog.h @@ -116,8 +116,6 @@ typedef void(SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * const * * \since This function is available since SDL 3.0.0. * - * \sa SDL_DialogFileFilter - * \sa SDL_DialogFileCallback * \sa SDL_ShowSaveFileDialog * \sa SDL_ShowOpenFolderDialog */ @@ -161,10 +159,7 @@ extern DECLSPEC void SDLCALL SDL_ShowOpenFileDialog(SDL_DialogFileCallback callb * * \since This function is available since SDL 3.0.0. * - * \sa SDL_DialogFileFilter - * \sa SDL_DialogFileCallback * \sa SDL_ShowOpenFileDialog - * \sa SDL_ShowOpenFolderDialog */ extern DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback callback, void *userdata, SDL_Window *window, const SDL_DialogFileFilter *filters, const char *default_location); @@ -205,10 +200,7 @@ extern DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback callb * * \since This function is available since SDL 3.0.0. * - * \sa SDL_DialogFileFilter - * \sa SDL_DialogFileCallback * \sa SDL_ShowOpenFileDialog - * \sa SDL_ShowSaveFileDialog */ extern DECLSPEC void SDLCALL SDL_ShowOpenFolderDialog(SDL_DialogFileCallback callback, void *userdata, SDL_Window *window, const char *default_location, SDL_bool allow_many); diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h index 1d49be7df..c98c1b1a0 100644 --- a/include/SDL3/SDL_filesystem.h +++ b/include/SDL3/SDL_filesystem.h @@ -231,8 +231,6 @@ typedef enum * folder, or NULL if an error happened. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_Folder */ extern DECLSPEC char *SDLCALL SDL_GetUserFolder(SDL_Folder folder); diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h index c35adf3c4..1b2f25f59 100644 --- a/include/SDL3/SDL_gamepad.h +++ b/include/SDL3/SDL_gamepad.h @@ -251,7 +251,7 @@ typedef struct SDL_GamepadBinding extern DECLSPEC int SDLCALL SDL_AddGamepadMapping(const char *mapping); /** - * Load a set of gamepad mappings from a seekable SDL data stream. + * Load a set of gamepad mappings from an SDL_IOStream. * * You can call this function several times, if needed, to load different * database files. @@ -277,6 +277,7 @@ extern DECLSPEC int SDLCALL SDL_AddGamepadMapping(const char *mapping); * * \sa SDL_AddGamepadMapping * \sa SDL_AddGamepadMappingsFromFile + * \sa SDL_GetGamepadMapping * \sa SDL_GetGamepadMappingForGUID */ extern DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_bool closeio); @@ -302,6 +303,7 @@ extern DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_ * * \sa SDL_AddGamepadMapping * \sa SDL_AddGamepadMappingsFromIO + * \sa SDL_GetGamepadMapping * \sa SDL_GetGamepadMappingForGUID */ extern DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromFile(const char *file); @@ -363,6 +365,7 @@ extern DECLSPEC char * SDLCALL SDL_GetGamepadMappingForGUID(SDL_JoystickGUID gui * \since This function is available since SDL 3.0.0. * * \sa SDL_AddGamepadMapping + * \sa SDL_GetGamepadInstanceMapping * \sa SDL_GetGamepadMappingForGUID * \sa SDL_SetGamepadMapping */ @@ -409,6 +412,7 @@ extern DECLSPEC SDL_JoystickID *SDLCALL SDL_GetGamepads(int *count); * * \since This function is available since SDL 3.0.0. * + * \sa SDL_GetJoysticks * \sa SDL_OpenGamepad */ extern DECLSPEC SDL_bool SDLCALL SDL_IsGamepad(SDL_JoystickID instance_id); @@ -425,7 +429,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsGamepad(SDL_JoystickID instance_id); * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGamepadName - * \sa SDL_OpenGamepad + * \sa SDL_GetGamepads */ extern DECLSPEC const char *SDLCALL SDL_GetGamepadInstanceName(SDL_JoystickID instance_id); @@ -441,7 +445,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetGamepadInstanceName(SDL_JoystickID in * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGamepadPath - * \sa SDL_OpenGamepad + * \sa SDL_GetGamepads */ extern DECLSPEC const char *SDLCALL SDL_GetGamepadInstancePath(SDL_JoystickID instance_id); @@ -456,7 +460,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetGamepadInstancePath(SDL_JoystickID in * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGamepadPlayerIndex - * \sa SDL_OpenGamepad + * \sa SDL_GetGamepads */ extern DECLSPEC int SDLCALL SDL_GetGamepadInstancePlayerIndex(SDL_JoystickID instance_id); @@ -473,6 +477,7 @@ extern DECLSPEC int SDLCALL SDL_GetGamepadInstancePlayerIndex(SDL_JoystickID ins * * \sa SDL_GetGamepadGUID * \sa SDL_GetGamepadGUIDString + * \sa SDL_GetGamepads */ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_GetGamepadInstanceGUID(SDL_JoystickID instance_id); @@ -487,6 +492,9 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_GetGamepadInstanceGUID(SDL_Joystick * index, this function returns zero * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadVendor + * \sa SDL_GetGamepads */ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadInstanceVendor(SDL_JoystickID instance_id); @@ -501,6 +509,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadInstanceVendor(SDL_JoystickID insta * invalid index, this function returns zero * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadProduct + * \sa SDL_GetGamepads */ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadInstanceProduct(SDL_JoystickID instance_id); @@ -515,6 +526,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadInstanceProduct(SDL_JoystickID inst * invalid index, this function returns zero * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadProductVersion + * \sa SDL_GetGamepads */ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadInstanceProductVersion(SDL_JoystickID instance_id); @@ -527,6 +541,10 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadInstanceProductVersion(SDL_Joystick * \returns the gamepad type. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadType + * \sa SDL_GetGamepads + * \sa SDL_GetRealGamepadInstanceType */ extern DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadInstanceType(SDL_JoystickID instance_id); @@ -539,6 +557,10 @@ extern DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadInstanceType(SDL_JoystickI * \returns the gamepad type. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadInstanceType + * \sa SDL_GetGamepads + * \sa SDL_GetRealGamepadType */ extern DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadInstanceType(SDL_JoystickID instance_id); @@ -552,6 +574,9 @@ extern DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadInstanceType(SDL_Joyst * no mapping is available. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepads + * \sa SDL_GetGamepadMapping */ extern DECLSPEC char *SDLCALL SDL_GetGamepadInstanceMapping(SDL_JoystickID instance_id); @@ -639,8 +664,6 @@ extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGamepadProperties(SDL_Gamepad *g * failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_OpenGamepad */ extern DECLSPEC SDL_JoystickID SDLCALL SDL_GetGamepadInstanceID(SDL_Gamepad *gamepad); @@ -655,7 +678,6 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_GetGamepadInstanceID(SDL_Gamepad *gam * \since This function is available since SDL 3.0.0. * * \sa SDL_GetGamepadInstanceName - * \sa SDL_OpenGamepad */ extern DECLSPEC const char *SDLCALL SDL_GetGamepadName(SDL_Gamepad *gamepad); @@ -708,6 +730,8 @@ extern DECLSPEC SDL_GamepadType SDLCALL SDL_GetRealGamepadType(SDL_Gamepad *game * \returns the player index for gamepad, or -1 if it's not available. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_SetGamepadPlayerIndex */ extern DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad); @@ -721,6 +745,8 @@ extern DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad); * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadPlayerIndex */ extern DECLSPEC int SDLCALL SDL_SetGamepadPlayerIndex(SDL_Gamepad *gamepad, int player_index); @@ -733,6 +759,8 @@ extern DECLSPEC int SDLCALL SDL_SetGamepadPlayerIndex(SDL_Gamepad *gamepad, int * \returns the USB vendor ID, or zero if unavailable. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadInstanceVendor */ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadVendor(SDL_Gamepad *gamepad); @@ -745,6 +773,8 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadVendor(SDL_Gamepad *gamepad); * \returns the USB product ID, or zero if unavailable. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadInstanceProduct */ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadProduct(SDL_Gamepad *gamepad); @@ -757,6 +787,8 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadProduct(SDL_Gamepad *gamepad); * \returns the USB product version, or zero if unavailable. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadInstanceProductVersion */ extern DECLSPEC Uint16 SDLCALL SDL_GetGamepadProductVersion(SDL_Gamepad *gamepad); @@ -818,9 +850,6 @@ extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_GetGamepadPowerLevel(SDL_Game * connected, or SDL_FALSE if not. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CloseGamepad - * \sa SDL_OpenGamepad */ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadConnected(SDL_Gamepad *gamepad); @@ -854,6 +883,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GetGamepadJoystick(SDL_Gamepad *gamepa * \since This function is available since SDL 3.0.0. * * \sa SDL_GamepadEventsEnabled + * \sa SDL_UpdateGamepads */ extern DECLSPEC void SDLCALL SDL_SetGamepadEventsEnabled(SDL_bool enabled); @@ -966,7 +996,7 @@ extern DECLSPEC SDL_GamepadAxis SDLCALL SDL_GetGamepadAxisFromString(const char * * \sa SDL_GetGamepadAxisFromString */ -extern DECLSPEC const char* SDLCALL SDL_GetGamepadStringForAxis(SDL_GamepadAxis axis); +extern DECLSPEC const char * SDLCALL SDL_GetGamepadStringForAxis(SDL_GamepadAxis axis); /** * Query whether a gamepad has a given axis. @@ -979,6 +1009,9 @@ extern DECLSPEC const char* SDLCALL SDL_GetGamepadStringForAxis(SDL_GamepadAxis * \returns SDL_TRUE if the gamepad has this axis, SDL_FALSE otherwise. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GamepadHasButton + * \sa SDL_GetGamepadAxis */ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadHasAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis); @@ -1001,6 +1034,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadHasAxis(SDL_Gamepad *gamepad, SDL_Ga * * \since This function is available since SDL 3.0.0. * + * \sa SDL_GamepadHasAxis * \sa SDL_GetGamepadButton */ extern DECLSPEC Sint16 SDLCALL SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis); @@ -1018,6 +1052,8 @@ extern DECLSPEC Sint16 SDLCALL SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_Game * `SDL_GAMEPAD_BUTTON_INVALID` if no match was found. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadStringForButton */ extern DECLSPEC SDL_GamepadButton SDLCALL SDL_GetGamepadButtonFromString(const char *str); @@ -1048,6 +1084,8 @@ extern DECLSPEC const char* SDLCALL SDL_GetGamepadStringForButton(SDL_GamepadBut * \returns SDL_TRUE if the gamepad has this button, SDL_FALSE otherwise. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GamepadHasAxis */ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadHasButton(SDL_Gamepad *gamepad, SDL_GamepadButton button); @@ -1061,6 +1099,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadHasButton(SDL_Gamepad *gamepad, SDL_ * * \since This function is available since SDL 3.0.0. * + * \sa SDL_GamepadHasButton * \sa SDL_GetGamepadAxis */ extern DECLSPEC Uint8 SDLCALL SDL_GetGamepadButton(SDL_Gamepad *gamepad, SDL_GamepadButton button); @@ -1098,6 +1137,8 @@ extern DECLSPEC SDL_GamepadButtonLabel SDLCALL SDL_GetGamepadButtonLabel(SDL_Gam * \returns number of touchpads * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetNumGamepadTouchpadFingers */ extern DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpads(SDL_Gamepad *gamepad); @@ -1110,6 +1151,9 @@ extern DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpads(SDL_Gamepad *gamepad); * \returns number of supported simultaneous fingers * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadTouchpadFinger + * \sa SDL_GetNumGamepadTouchpads */ extern DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpadFingers(SDL_Gamepad *gamepad, int touchpad); @@ -1127,6 +1171,8 @@ extern DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpadFingers(SDL_Gamepad *gamepa * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetNumGamepadTouchpadFingers */ extern DECLSPEC int SDLCALL SDL_GetGamepadTouchpadFinger(SDL_Gamepad *gamepad, int touchpad, int finger, Uint8 *state, float *x, float *y, float *pressure); @@ -1138,6 +1184,10 @@ extern DECLSPEC int SDLCALL SDL_GetGamepadTouchpadFinger(SDL_Gamepad *gamepad, i * \returns SDL_TRUE if the sensor exists, SDL_FALSE otherwise. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetGamepadSensorData + * \sa SDL_GetGamepadSensorDataRate + * \sa SDL_SetGamepadSensorEnabled */ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadHasSensor(SDL_Gamepad *gamepad, SDL_SensorType type); @@ -1151,6 +1201,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadHasSensor(SDL_Gamepad *gamepad, SDL_ * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GamepadHasSensor + * \sa SDL_GamepadSensorEnabled */ extern DECLSPEC int SDLCALL SDL_SetGamepadSensorEnabled(SDL_Gamepad *gamepad, SDL_SensorType type, SDL_bool enabled); @@ -1162,6 +1215,8 @@ extern DECLSPEC int SDLCALL SDL_SetGamepadSensorEnabled(SDL_Gamepad *gamepad, SD * \returns SDL_TRUE if the sensor is enabled, SDL_FALSE otherwise. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_SetGamepadSensorEnabled */ extern DECLSPEC SDL_bool SDLCALL SDL_GamepadSensorEnabled(SDL_Gamepad *gamepad, SDL_SensorType type); @@ -1237,6 +1292,8 @@ extern DECLSPEC int SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_f * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RumbleGamepad */ extern DECLSPEC int SDLCALL SDL_RumbleGamepadTriggers(SDL_Gamepad *gamepad, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms); diff --git a/include/SDL3/SDL_haptic.h b/include/SDL3/SDL_haptic.h index 3bf180848..3bc17b8a8 100644 --- a/include/SDL3/SDL_haptic.h +++ b/include/SDL3/SDL_haptic.h @@ -898,10 +898,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetHapticInstanceName(SDL_HapticID insta * \sa SDL_GetHaptics * \sa SDL_OpenHapticFromJoystick * \sa SDL_OpenHapticFromMouse - * \sa SDL_PauseHaptic * \sa SDL_SetHapticAutocenter * \sa SDL_SetHapticGain - * \sa SDL_StopHapticEffects */ extern DECLSPEC SDL_Haptic *SDLCALL SDL_OpenHaptic(SDL_HapticID instance_id); @@ -925,8 +923,6 @@ extern DECLSPEC SDL_Haptic *SDLCALL SDL_GetHapticFromInstanceID(SDL_HapticID ins * failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_OpenHaptic */ extern DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticInstanceID(SDL_Haptic *haptic); @@ -941,7 +937,6 @@ extern DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticInstanceID(SDL_Haptic *haptic) * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHapticInstanceName - * \sa SDL_OpenHaptic */ extern DECLSPEC const char *SDLCALL SDL_GetHapticName(SDL_Haptic *haptic); @@ -964,7 +959,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsMouseHaptic(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenHaptic + * \sa SDL_CloseHaptic * \sa SDL_IsMouseHaptic */ extern DECLSPEC SDL_Haptic *SDLCALL SDL_OpenHapticFromMouse(void); @@ -999,7 +994,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsJoystickHaptic(SDL_Joystick *joystick); * \since This function is available since SDL 3.0.0. * * \sa SDL_CloseHaptic - * \sa SDL_OpenHaptic * \sa SDL_IsJoystickHaptic */ extern DECLSPEC SDL_Haptic *SDLCALL SDL_OpenHapticFromJoystick(SDL_Joystick *joystick); @@ -1127,7 +1121,6 @@ extern DECLSPEC int SDLCALL SDL_CreateHapticEffect(SDL_Haptic *haptic, const SDL * * \since This function is available since SDL 3.0.0. * - * \sa SDL_DestroyHapticEffect * \sa SDL_CreateHapticEffect * \sa SDL_RunHapticEffect */ @@ -1151,9 +1144,9 @@ extern DECLSPEC int SDLCALL SDL_UpdateHapticEffect(SDL_Haptic *haptic, int effec * * \since This function is available since SDL 3.0.0. * - * \sa SDL_DestroyHapticEffect * \sa SDL_GetHapticEffectStatus * \sa SDL_StopHapticEffect + * \sa SDL_StopHapticEffects */ extern DECLSPEC int SDLCALL SDL_RunHapticEffect(SDL_Haptic *haptic, int effect, Uint32 iterations); @@ -1169,8 +1162,8 @@ extern DECLSPEC int SDLCALL SDL_RunHapticEffect(SDL_Haptic *haptic, int effect, * * \since This function is available since SDL 3.0.0. * - * \sa SDL_DestroyHapticEffect * \sa SDL_RunHapticEffect + * \sa SDL_StopHapticEffects */ extern DECLSPEC int SDLCALL SDL_StopHapticEffect(SDL_Haptic *haptic, int effect); @@ -1200,9 +1193,6 @@ extern DECLSPEC void SDLCALL SDL_DestroyHapticEffect(SDL_Haptic *haptic, int eff * code on failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_RunHapticEffect - * \sa SDL_StopHapticEffect */ extern DECLSPEC int SDLCALL SDL_GetHapticEffectStatus(SDL_Haptic *haptic, int effect); @@ -1288,6 +1278,9 @@ extern DECLSPEC int SDLCALL SDL_ResumeHaptic(SDL_Haptic *haptic); * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RunHapticEffect + * \sa SDL_StopHapticEffects */ extern DECLSPEC int SDLCALL SDL_StopHapticEffects(SDL_Haptic *haptic); @@ -1300,8 +1293,6 @@ extern DECLSPEC int SDLCALL SDL_StopHapticEffects(SDL_Haptic *haptic); * \since This function is available since SDL 3.0.0. * * \sa SDL_InitHapticRumble - * \sa SDL_PlayHapticRumble - * \sa SDL_StopHapticRumble */ extern DECLSPEC SDL_bool SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *haptic); @@ -1314,7 +1305,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *haptic); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenHaptic * \sa SDL_PlayHapticRumble * \sa SDL_StopHapticRumble * \sa SDL_HapticRumbleSupported @@ -1334,7 +1324,6 @@ extern DECLSPEC int SDLCALL SDL_InitHapticRumble(SDL_Haptic *haptic); * * \sa SDL_InitHapticRumble * \sa SDL_StopHapticRumble - * \sa SDL_HapticRumbleSupported */ extern DECLSPEC int SDLCALL SDL_PlayHapticRumble(SDL_Haptic *haptic, float strength, Uint32 length); @@ -1347,9 +1336,7 @@ extern DECLSPEC int SDLCALL SDL_PlayHapticRumble(SDL_Haptic *haptic, float stren * * \since This function is available since SDL 3.0.0. * - * \sa SDL_InitHapticRumble * \sa SDL_PlayHapticRumble - * \sa SDL_HapticRumbleSupported */ extern DECLSPEC int SDLCALL SDL_StopHapticRumble(SDL_Haptic *haptic); diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h index 0dbbe4e31..4e95fa341 100644 --- a/include/SDL3/SDL_hints.h +++ b/include/SDL3/SDL_hints.h @@ -949,7 +949,7 @@ extern "C" { * "1" - Sony driver (sixaxis.sys) is used. * * The default value is 0. - * + * * This hint should be set before enumerating controllers. */ #define SDL_HINT_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER "SDL_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER" @@ -2564,6 +2564,7 @@ typedef enum * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint + * \sa SDL_ResetHint * \sa SDL_SetHint */ extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name, @@ -2584,6 +2585,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name, * \since This function is available since SDL 3.0.0. * * \sa SDL_GetHint + * \sa SDL_ResetHint * \sa SDL_SetHintWithPriority */ extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name, @@ -2601,8 +2603,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name, * * \since This function is available since SDL 3.0.0. * - * \sa SDL_GetHint * \sa SDL_SetHint + * \sa SDL_ResetHints */ extern DECLSPEC SDL_bool SDLCALL SDL_ResetHint(const char *name); @@ -2615,8 +2617,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_ResetHint(const char *name); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_GetHint - * \sa SDL_SetHint * \sa SDL_ResetHint */ extern DECLSPEC void SDLCALL SDL_ResetHints(void); diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index 0d1ad0898..675d5f79c 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -292,6 +292,9 @@ extern DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromConstMem(const void *mem, size_t * \since This function is available since SDL 3.0.0. * * \sa SDL_CloseIO + * \sa SDL_IOFromConstMem + * \sa SDL_IOFromFile + * \sa SDL_IOFromMem */ extern DECLSPEC SDL_IOStream *SDLCALL SDL_OpenIO(const SDL_IOStreamInterface *iface, void *userdata); @@ -312,12 +315,7 @@ extern DECLSPEC SDL_IOStream *SDLCALL SDL_OpenIO(const SDL_IOStreamInterface *if * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem - * \sa SDL_ReadIO - * \sa SDL_SeekIO - * \sa SDL_WriteIO + * \sa SDL_OpenIO */ extern DECLSPEC int SDLCALL SDL_CloseIO(SDL_IOStream *context); @@ -395,12 +393,7 @@ extern DECLSPEC Sint64 SDLCALL SDL_SizeIO(SDL_IOStream *context); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem - * \sa SDL_ReadIO * \sa SDL_TellIO - * \sa SDL_WriteIO */ extern DECLSPEC Sint64 SDLCALL SDL_SeekIO(SDL_IOStream *context, Sint64 offset, int whence); @@ -418,12 +411,7 @@ extern DECLSPEC Sint64 SDLCALL SDL_SeekIO(SDL_IOStream *context, Sint64 offset, * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem - * \sa SDL_ReadIO * \sa SDL_SeekIO - * \sa SDL_WriteIO */ extern DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context); @@ -445,9 +433,6 @@ extern DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem * \sa SDL_SeekIO * \sa SDL_WriteIO */ @@ -479,9 +464,6 @@ extern DECLSPEC size_t SDLCALL SDL_ReadIO(SDL_IOStream *context, void *ptr, size * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem * \sa SDL_IOprintf * \sa SDL_ReadIO * \sa SDL_SeekIO @@ -502,11 +484,7 @@ extern DECLSPEC size_t SDLCALL SDL_WriteIO(SDL_IOStream *context, const void *pt * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem - * \sa SDL_ReadIO - * \sa SDL_SeekIO + * \sa SDL_IOvprintf * \sa SDL_WriteIO */ extern DECLSPEC size_t SDLCALL SDL_IOprintf(SDL_IOStream *context, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2); @@ -524,11 +502,7 @@ extern DECLSPEC size_t SDLCALL SDL_IOprintf(SDL_IOStream *context, SDL_PRINTF_FO * * \since This function is available since SDL 3.0.0. * - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem - * \sa SDL_ReadIO - * \sa SDL_SeekIO + * \sa SDL_IOprintf * \sa SDL_WriteIO */ extern DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRINTF_FORMAT_STRING const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(2); @@ -549,6 +523,8 @@ extern DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRINTF_F * \returns the data, or NULL if there was an error. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_LoadFile */ extern DECLSPEC void *SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, SDL_bool closeio); @@ -566,6 +542,8 @@ extern DECLSPEC void *SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasiz * \returns the data, or NULL if there was an error. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_LoadFile_IO */ extern DECLSPEC void *SDLCALL SDL_LoadFile(const char *file, size_t *datasize); diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h index 4d45467b3..b0135c024 100644 --- a/include/SDL3/SDL_joystick.h +++ b/include/SDL3/SDL_joystick.h @@ -163,7 +163,7 @@ extern DECLSPEC SDL_JoystickID *SDLCALL SDL_GetJoysticks(int *count); * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickName - * \sa SDL_OpenJoystick + * \sa SDL_GetJoysticks */ extern DECLSPEC const char *SDLCALL SDL_GetJoystickInstanceName(SDL_JoystickID instance_id); @@ -179,7 +179,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetJoystickInstanceName(SDL_JoystickID i * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickPath - * \sa SDL_OpenJoystick + * \sa SDL_GetJoysticks */ extern DECLSPEC const char *SDLCALL SDL_GetJoystickInstancePath(SDL_JoystickID instance_id); @@ -194,7 +194,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetJoystickInstancePath(SDL_JoystickID i * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickPlayerIndex - * \sa SDL_OpenJoystick + * \sa SDL_GetJoysticks */ extern DECLSPEC int SDLCALL SDL_GetJoystickInstancePlayerIndex(SDL_JoystickID instance_id); @@ -225,6 +225,9 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_GetJoystickInstanceGUID(SDL_Joystic * invalid index, this function returns zero * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickVendor + * \sa SDL_GetJoysticks */ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickInstanceVendor(SDL_JoystickID instance_id); @@ -239,6 +242,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickInstanceVendor(SDL_JoystickID inst * invalid index, this function returns zero * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickProduct + * \sa SDL_GetJoysticks */ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickInstanceProduct(SDL_JoystickID instance_id); @@ -253,6 +259,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickInstanceProduct(SDL_JoystickID ins * invalid index, this function returns zero * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickProductVersion + * \sa SDL_GetJoysticks */ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickInstanceProductVersion(SDL_JoystickID instance_id); @@ -266,6 +275,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickInstanceProductVersion(SDL_Joystic * invalid index, this function returns `SDL_JOYSTICK_TYPE_UNKNOWN` * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickType + * \sa SDL_GetJoysticks */ extern DECLSPEC SDL_JoystickType SDLCALL SDL_GetJoystickInstanceType(SDL_JoystickID instance_id); @@ -304,6 +316,9 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GetJoystickFromInstanceID(SDL_Joystick * for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickPlayerIndex + * \sa SDL_SetJoystickPlayerIndex */ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GetJoystickFromPlayerIndex(int player_index); @@ -318,6 +333,9 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GetJoystickFromPlayerIndex(int player_ * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_AttachVirtualJoystickEx + * \sa SDL_DetachVirtualJoystick */ extern DECLSPEC SDL_JoystickID SDLCALL SDL_AttachVirtualJoystick(SDL_JoystickType type, int naxes, @@ -371,6 +389,9 @@ typedef struct SDL_VirtualJoystickDesc * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_AttachVirtualJoystick + * \sa SDL_DetachVirtualJoystick */ extern DECLSPEC SDL_JoystickID SDLCALL SDL_AttachVirtualJoystickEx(const SDL_VirtualJoystickDesc *desc); @@ -383,6 +404,9 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_AttachVirtualJoystickEx(const SDL_Vir * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_AttachVirtualJoystick + * \sa SDL_AttachVirtualJoystickEx */ extern DECLSPEC int SDLCALL SDL_DetachVirtualJoystick(SDL_JoystickID instance_id); @@ -500,7 +524,6 @@ extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetJoystickProperties(SDL_Joystick * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickInstanceName - * \sa SDL_OpenJoystick */ extern DECLSPEC const char *SDLCALL SDL_GetJoystickName(SDL_Joystick *joystick); @@ -527,6 +550,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetJoystickPath(SDL_Joystick *joystick); * \returns the player index, or -1 if it's not available. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_SetJoystickPlayerIndex */ extern DECLSPEC int SDLCALL SDL_GetJoystickPlayerIndex(SDL_Joystick *joystick); @@ -540,6 +565,8 @@ extern DECLSPEC int SDLCALL SDL_GetJoystickPlayerIndex(SDL_Joystick *joystick); * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickPlayerIndex */ extern DECLSPEC int SDLCALL SDL_SetJoystickPlayerIndex(SDL_Joystick *joystick, int player_index); @@ -569,6 +596,8 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_GetJoystickGUID(SDL_Joystick *joyst * \returns the USB vendor ID of the selected joystick, or 0 if unavailable. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickInstanceVendor */ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickVendor(SDL_Joystick *joystick); @@ -581,6 +610,8 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickVendor(SDL_Joystick *joystick); * \returns the USB product ID of the selected joystick, or 0 if unavailable. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickInstanceProduct */ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickProduct(SDL_Joystick *joystick); @@ -593,6 +624,8 @@ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickProduct(SDL_Joystick *joystick); * \returns the product version of the selected joystick, or 0 if unavailable. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickInstanceProductVersion */ extern DECLSPEC Uint16 SDLCALL SDL_GetJoystickProductVersion(SDL_Joystick *joystick); @@ -629,6 +662,8 @@ extern DECLSPEC const char * SDLCALL SDL_GetJoystickSerial(SDL_Joystick *joystic * \returns the SDL_JoystickType of the selected joystick. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetJoystickInstanceType */ extern DECLSPEC SDL_JoystickType SDLCALL SDL_GetJoystickType(SDL_Joystick *joystick); @@ -694,9 +729,6 @@ extern DECLSPEC void SDLCALL SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint * call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CloseJoystick - * \sa SDL_OpenJoystick */ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickConnected(SDL_Joystick *joystick); @@ -708,8 +740,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickConnected(SDL_Joystick *joystick); * failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_OpenJoystick */ extern DECLSPEC SDL_JoystickID SDLCALL SDL_GetJoystickInstanceID(SDL_Joystick *joystick); @@ -728,7 +758,9 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_GetJoystickInstanceID(SDL_Joystick *j * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickAxis - * \sa SDL_OpenJoystick + * \sa SDL_GetNumJoystickBalls + * \sa SDL_GetNumJoystickButtons + * \sa SDL_GetNumJoystickHats */ extern DECLSPEC int SDLCALL SDL_GetNumJoystickAxes(SDL_Joystick *joystick); @@ -747,6 +779,9 @@ extern DECLSPEC int SDLCALL SDL_GetNumJoystickAxes(SDL_Joystick *joystick); * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickBall + * \sa SDL_GetNumJoystickAxes + * \sa SDL_GetNumJoystickButtons + * \sa SDL_GetNumJoystickHats */ extern DECLSPEC int SDLCALL SDL_GetNumJoystickBalls(SDL_Joystick *joystick); @@ -760,7 +795,9 @@ extern DECLSPEC int SDLCALL SDL_GetNumJoystickBalls(SDL_Joystick *joystick); * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickHat - * \sa SDL_OpenJoystick + * \sa SDL_GetNumJoystickAxes + * \sa SDL_GetNumJoystickBalls + * \sa SDL_GetNumJoystickButtons */ extern DECLSPEC int SDLCALL SDL_GetNumJoystickHats(SDL_Joystick *joystick); @@ -774,7 +811,9 @@ extern DECLSPEC int SDLCALL SDL_GetNumJoystickHats(SDL_Joystick *joystick); * \since This function is available since SDL 3.0.0. * * \sa SDL_GetJoystickButton - * \sa SDL_OpenJoystick + * \sa SDL_GetNumJoystickAxes + * \sa SDL_GetNumJoystickBalls + * \sa SDL_GetNumJoystickHats */ extern DECLSPEC int SDLCALL SDL_GetNumJoystickButtons(SDL_Joystick *joystick); @@ -790,6 +829,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumJoystickButtons(SDL_Joystick *joystick); * \since This function is available since SDL 3.0.0. * * \sa SDL_JoystickEventsEnabled + * \sa SDL_UpdateJoysticks */ extern DECLSPEC void SDLCALL SDL_SetJoystickEventsEnabled(SDL_bool enabled); @@ -979,6 +1019,8 @@ extern DECLSPEC int SDLCALL SDL_RumbleJoystick(SDL_Joystick *joystick, Uint16 lo * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RumbleJoystick */ extern DECLSPEC int SDLCALL SDL_RumbleJoystickTriggers(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms); diff --git a/include/SDL3/SDL_loadso.h b/include/SDL3/SDL_loadso.h index 58e14d37f..c406f8d42 100644 --- a/include/SDL3/SDL_loadso.h +++ b/include/SDL3/SDL_loadso.h @@ -87,7 +87,6 @@ extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile); * \since This function is available since SDL 3.0.0. * * \sa SDL_LoadObject - * \sa SDL_UnloadObject */ extern DECLSPEC SDL_FunctionPointer SDLCALL SDL_LoadFunction(void *handle, const char *name); @@ -98,7 +97,6 @@ extern DECLSPEC SDL_FunctionPointer SDLCALL SDL_LoadFunction(void *handle, const * * \since This function is available since SDL 3.0.0. * - * \sa SDL_LoadFunction * \sa SDL_LoadObject */ extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle); diff --git a/include/SDL3/SDL_log.h b/include/SDL3/SDL_log.h index 3e1614553..4bed8f423 100644 --- a/include/SDL3/SDL_log.h +++ b/include/SDL3/SDL_log.h @@ -118,6 +118,7 @@ typedef enum * * \since This function is available since SDL 3.0.0. * + * \sa SDL_LogResetPriorities * \sa SDL_LogSetPriority */ extern DECLSPEC void SDLCALL SDL_LogSetAllPriority(SDL_LogPriority priority); @@ -131,6 +132,7 @@ extern DECLSPEC void SDLCALL SDL_LogSetAllPriority(SDL_LogPriority priority); * \since This function is available since SDL 3.0.0. * * \sa SDL_LogGetPriority + * \sa SDL_LogResetPriorities * \sa SDL_LogSetAllPriority */ extern DECLSPEC void SDLCALL SDL_LogSetPriority(int category, diff --git a/include/SDL3/SDL_main.h b/include/SDL3/SDL_main.h index a201721ca..b7705d660 100644 --- a/include/SDL3/SDL_main.h +++ b/include/SDL3/SDL_main.h @@ -263,7 +263,6 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppInit(int argc, char *argv[]); * * \sa SDL_AppInit * \sa SDL_AppEvent - * \sa SDL_AppQuit */ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppIterate(void); @@ -309,7 +308,6 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppIterate(void); * * \sa SDL_AppInit * \sa SDL_AppIterate - * \sa SDL_AppQuit */ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppEvent(const SDL_Event *event); @@ -337,8 +335,6 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppEvent(const SDL_Event *event); * \since This function is available since SDL 3.0.0. * * \sa SDL_AppInit - * \sa SDL_AppIterate - * \sa SDL_AppEvent */ extern SDLMAIN_DECLSPEC void SDLCALL SDL_AppQuit(void); diff --git a/include/SDL3/SDL_metal.h b/include/SDL3/SDL_metal.h index 016ee9474..e08ff3610 100644 --- a/include/SDL3/SDL_metal.h +++ b/include/SDL3/SDL_metal.h @@ -89,8 +89,6 @@ extern DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view); * \returns a pointer * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_Metal_CreateView */ extern DECLSPEC void *SDLCALL SDL_Metal_GetLayer(SDL_MetalView view); diff --git a/include/SDL3/SDL_mouse.h b/include/SDL3/SDL_mouse.h index d9df80df8..92a8eab0a 100644 --- a/include/SDL3/SDL_mouse.h +++ b/include/SDL3/SDL_mouse.h @@ -109,7 +109,6 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void); * * \sa SDL_GetGlobalMouseState * \sa SDL_GetRelativeMouseState - * \sa SDL_PumpEvents */ extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(float *x, float *y); @@ -139,6 +138,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(float *x, float *y); * \since This function is available since SDL 3.0.0. * * \sa SDL_CaptureMouse + * \sa SDL_GetMouseState */ extern DECLSPEC Uint32 SDLCALL SDL_GetGlobalMouseState(float *x, float *y); @@ -318,6 +318,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void); * * \since This function is available since SDL 3.0.0. * + * \sa SDL_CreateColorCursor + * \sa SDL_CreateSystemCursor * \sa SDL_DestroyCursor * \sa SDL_SetCursor */ @@ -338,7 +340,9 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data, * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateCursor + * \sa SDL_CreateSystemCursor * \sa SDL_DestroyCursor + * \sa SDL_SetCursor */ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, @@ -371,7 +375,6 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateCursor * \sa SDL_GetCursor */ extern DECLSPEC int SDLCALL SDL_SetCursor(SDL_Cursor * cursor); @@ -399,8 +402,6 @@ 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 3.0.0. - * - * \sa SDL_CreateSystemCursor */ extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void); diff --git a/include/SDL3/SDL_mutex.h b/include/SDL3/SDL_mutex.h index d4610cb40..8c6c5a6da 100644 --- a/include/SDL3/SDL_mutex.h +++ b/include/SDL3/SDL_mutex.h @@ -171,6 +171,9 @@ extern DECLSPEC SDL_Mutex *SDLCALL SDL_CreateMutex(void); * \param mutex the mutex to lock * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_TryLockMutex + * \sa SDL_UnlockMutex */ extern DECLSPEC void SDLCALL SDL_LockMutex(SDL_Mutex *mutex) SDL_ACQUIRE(mutex); @@ -193,8 +196,6 @@ extern DECLSPEC void SDLCALL SDL_LockMutex(SDL_Mutex *mutex) SDL_ACQUIRE(mutex); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateMutex - * \sa SDL_DestroyMutex * \sa SDL_LockMutex * \sa SDL_UnlockMutex */ @@ -213,6 +214,9 @@ extern DECLSPEC int SDLCALL SDL_TryLockMutex(SDL_Mutex *mutex) SDL_TRY_ACQUIRE(0 * \param mutex the mutex to unlock. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_LockMutex + * \sa SDL_TryLockMutex */ extern DECLSPEC void SDLCALL SDL_UnlockMutex(SDL_Mutex *mutex) SDL_RELEASE(mutex); @@ -230,9 +234,6 @@ extern DECLSPEC void SDLCALL SDL_UnlockMutex(SDL_Mutex *mutex) SDL_RELEASE(mutex * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateMutex - * \sa SDL_LockMutex - * \sa SDL_TryLockMutex - * \sa SDL_UnlockMutex */ extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_Mutex *mutex); @@ -290,8 +291,8 @@ typedef struct SDL_RWLock SDL_RWLock; * * \sa SDL_DestroyRWLock * \sa SDL_LockRWLockForReading - * \sa SDL_TryLockRWLockForReading * \sa SDL_LockRWLockForWriting + * \sa SDL_TryLockRWLockForReading * \sa SDL_TryLockRWLockForWriting * \sa SDL_UnlockRWLock */ @@ -328,6 +329,8 @@ extern DECLSPEC SDL_RWLock *SDLCALL SDL_CreateRWLock(void); * * \since This function is available since SDL 3.0.0. * + * \sa SDL_LockRWLockForWriting + * \sa SDL_TryLockRWLockForReading * \sa SDL_UnlockRWLock */ extern DECLSPEC void SDLCALL SDL_LockRWLockForReading(SDL_RWLock *rwlock) SDL_ACQUIRE_SHARED(rwlock); @@ -357,6 +360,8 @@ extern DECLSPEC void SDLCALL SDL_LockRWLockForReading(SDL_RWLock *rwlock) SDL_AC * * \since This function is available since SDL 3.0.0. * + * \sa SDL_LockRWLockForReading + * \sa SDL_TryLockRWLockForWriting * \sa SDL_UnlockRWLock */ extern DECLSPEC void SDLCALL SDL_LockRWLockForWriting(SDL_RWLock *rwlock) SDL_ACQUIRE(rwlock); @@ -383,9 +388,8 @@ extern DECLSPEC void SDLCALL SDL_LockRWLockForWriting(SDL_RWLock *rwlock) SDL_AC * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateRWLock - * \sa SDL_DestroyRWLock - * \sa SDL_TryLockRWLockForReading + * \sa SDL_LockRWLockForReading + * \sa SDL_TryLockRWLockForWriting * \sa SDL_UnlockRWLock */ extern DECLSPEC int SDLCALL SDL_TryLockRWLockForReading(SDL_RWLock *rwlock) SDL_TRY_ACQUIRE_SHARED(0, rwlock); @@ -417,9 +421,8 @@ extern DECLSPEC int SDLCALL SDL_TryLockRWLockForReading(SDL_RWLock *rwlock) SDL_ * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateRWLock - * \sa SDL_DestroyRWLock - * \sa SDL_TryLockRWLockForWriting + * \sa SDL_LockRWLockForWriting + * \sa SDL_TryLockRWLockForReading * \sa SDL_UnlockRWLock */ extern DECLSPEC int SDLCALL SDL_TryLockRWLockForWriting(SDL_RWLock *rwlock) SDL_TRY_ACQUIRE(0, rwlock); @@ -441,6 +444,11 @@ extern DECLSPEC int SDLCALL SDL_TryLockRWLockForWriting(SDL_RWLock *rwlock) SDL_ * \param rwlock the rwlock to unlock. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_LockRWLockForReading + * \sa SDL_LockRWLockForWriting + * \sa SDL_TryLockRWLockForReading + * \sa SDL_TryLockRWLockForWriting */ extern DECLSPEC void SDLCALL SDL_UnlockRWLock(SDL_RWLock *rwlock) SDL_RELEASE_GENERIC(rwlock); @@ -458,11 +466,6 @@ extern DECLSPEC void SDLCALL SDL_UnlockRWLock(SDL_RWLock *rwlock) SDL_RELEASE_GE * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRWLock - * \sa SDL_LockRWLockForReading - * \sa SDL_LockRWLockForWriting - * \sa SDL_TryLockRWLockForReading - * \sa SDL_TryLockRWLockForWriting - * \sa SDL_UnlockRWLock */ extern DECLSPEC void SDLCALL SDL_DestroyRWLock(SDL_RWLock *rwlock); @@ -513,11 +516,6 @@ extern DECLSPEC SDL_Semaphore *SDLCALL SDL_CreateSemaphore(Uint32 initial_value) * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateSemaphore - * \sa SDL_PostSemaphore - * \sa SDL_TryWaitSemaphore - * \sa SDL_GetSemaphoreValue - * \sa SDL_WaitSemaphore - * \sa SDL_WaitSemaphoreTimeout */ extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_Semaphore *sem); @@ -538,12 +536,8 @@ extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_Semaphore *sem); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateSemaphore - * \sa SDL_DestroySemaphore * \sa SDL_PostSemaphore * \sa SDL_TryWaitSemaphore - * \sa SDL_GetSemaphoreValue - * \sa SDL_WaitSemaphore * \sa SDL_WaitSemaphoreTimeout */ extern DECLSPEC int SDLCALL SDL_WaitSemaphore(SDL_Semaphore *sem); @@ -563,10 +557,7 @@ extern DECLSPEC int SDLCALL SDL_WaitSemaphore(SDL_Semaphore *sem); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateSemaphore - * \sa SDL_DestroySemaphore * \sa SDL_PostSemaphore - * \sa SDL_GetSemaphoreValue * \sa SDL_WaitSemaphore * \sa SDL_WaitSemaphoreTimeout */ @@ -588,11 +579,8 @@ extern DECLSPEC int SDLCALL SDL_TryWaitSemaphore(SDL_Semaphore *sem); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateSemaphore - * \sa SDL_DestroySemaphore * \sa SDL_PostSemaphore * \sa SDL_TryWaitSemaphore - * \sa SDL_GetSemaphoreValue * \sa SDL_WaitSemaphore */ extern DECLSPEC int SDLCALL SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Sint32 timeoutMS); @@ -606,10 +594,7 @@ extern DECLSPEC int SDLCALL SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Sint32 * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateSemaphore - * \sa SDL_DestroySemaphore * \sa SDL_TryWaitSemaphore - * \sa SDL_GetSemaphoreValue * \sa SDL_WaitSemaphore * \sa SDL_WaitSemaphoreTimeout */ @@ -622,8 +607,6 @@ extern DECLSPEC int SDLCALL SDL_PostSemaphore(SDL_Semaphore *sem); * \returns the current value of the semaphore. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreateSemaphore */ extern DECLSPEC Uint32 SDLCALL SDL_GetSemaphoreValue(SDL_Semaphore *sem); @@ -662,10 +645,6 @@ extern DECLSPEC SDL_Condition *SDLCALL SDL_CreateCondition(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_BroadcastCondition - * \sa SDL_SignalCondition - * \sa SDL_WaitCondition - * \sa SDL_WaitConditionTimeout * \sa SDL_CreateCondition */ extern DECLSPEC void SDLCALL SDL_DestroyCondition(SDL_Condition *cond); @@ -682,8 +661,6 @@ extern DECLSPEC void SDLCALL SDL_DestroyCondition(SDL_Condition *cond); * \sa SDL_BroadcastCondition * \sa SDL_WaitCondition * \sa SDL_WaitConditionTimeout - * \sa SDL_CreateCondition - * \sa SDL_DestroyCondition */ extern DECLSPEC int SDLCALL SDL_SignalCondition(SDL_Condition *cond); @@ -699,8 +676,6 @@ extern DECLSPEC int SDLCALL SDL_SignalCondition(SDL_Condition *cond); * \sa SDL_SignalCondition * \sa SDL_WaitCondition * \sa SDL_WaitConditionTimeout - * \sa SDL_CreateCondition - * \sa SDL_DestroyCondition */ extern DECLSPEC int SDLCALL SDL_BroadcastCondition(SDL_Condition *cond); @@ -729,8 +704,6 @@ extern DECLSPEC int SDLCALL SDL_BroadcastCondition(SDL_Condition *cond); * \sa SDL_BroadcastCondition * \sa SDL_SignalCondition * \sa SDL_WaitConditionTimeout - * \sa SDL_CreateCondition - * \sa SDL_DestroyCondition */ extern DECLSPEC int SDLCALL SDL_WaitCondition(SDL_Condition *cond, SDL_Mutex *mutex); @@ -760,8 +733,6 @@ extern DECLSPEC int SDLCALL SDL_WaitCondition(SDL_Condition *cond, SDL_Mutex *mu * \sa SDL_BroadcastCondition * \sa SDL_SignalCondition * \sa SDL_WaitCondition - * \sa SDL_CreateCondition - * \sa SDL_DestroyCondition */ extern DECLSPEC int SDLCALL SDL_WaitConditionTimeout(SDL_Condition *cond, SDL_Mutex *mutex, Sint32 timeoutMS); diff --git a/include/SDL3/SDL_pen.h b/include/SDL3/SDL_pen.h index 4f81629a5..2f368af4c 100644 --- a/include/SDL3/SDL_pen.h +++ b/include/SDL3/SDL_pen.h @@ -191,8 +191,6 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetPenStatus(SDL_PenID instance_id, float *x, * SDL_PenID. * * \since This function is available since SDL 3.0.0 - * - * \sa SDL_GUID */ extern DECLSPEC SDL_PenID SDLCALL SDL_GetPenFromGUID(SDL_GUID guid); @@ -204,8 +202,6 @@ extern DECLSPEC SDL_PenID SDLCALL SDL_GetPenFromGUID(SDL_GUID guid); * If "instance_id" is ::SDL_PEN_INVALID, returns an all-zeroes GUID. * * \since This function is available since SDL 3.0.0 - * - * \sa SDL_PenForID */ extern DECLSPEC SDL_GUID SDLCALL SDL_GetPenGUID(SDL_PenID instance_id); diff --git a/include/SDL3/SDL_pixels.h b/include/SDL3/SDL_pixels.h index 096eeaee4..24b4d370b 100644 --- a/include/SDL3/SDL_pixels.h +++ b/include/SDL3/SDL_pixels.h @@ -792,6 +792,7 @@ extern DECLSPEC SDL_PixelFormatEnum SDLCALL SDL_GetPixelFormatEnumForMasks(int b * \since This function is available since SDL 3.0.0. * * \sa SDL_DestroyPixelFormat + * \sa SDL_SetPixelFormatPalette */ extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_CreatePixelFormat(SDL_PixelFormatEnum pixel_format); @@ -819,6 +820,8 @@ extern DECLSPEC void SDLCALL SDL_DestroyPixelFormat(SDL_PixelFormat *format); * \since This function is available since SDL 3.0.0. * * \sa SDL_DestroyPalette + * \sa SDL_SetPaletteColors + * \sa SDL_SetPixelFormatPalette */ extern DECLSPEC SDL_Palette *SDLCALL SDL_CreatePalette(int ncolors); @@ -831,9 +834,6 @@ extern DECLSPEC SDL_Palette *SDLCALL SDL_CreatePalette(int ncolors); * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreatePalette - * \sa SDL_DestroyPalette */ extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format, SDL_Palette *palette); @@ -849,9 +849,6 @@ extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format, * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreatePalette - * \sa SDL_CreateSurface */ extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette, const SDL_Color * colors, diff --git a/include/SDL3/SDL_properties.h b/include/SDL3/SDL_properties.h index 33945defa..80c2f5239 100644 --- a/include/SDL3/SDL_properties.h +++ b/include/SDL3/SDL_properties.h @@ -178,7 +178,12 @@ extern DECLSPEC int SDLCALL SDL_SetPropertyWithCleanup(SDL_PropertiesID props, c * \since This function is available since SDL 3.0.0. * * \sa SDL_GetProperty + * \sa SDL_HasProperty + * \sa SDL_SetBooleanProperty + * \sa SDL_SetFloatProperty + * \sa SDL_SetNumberProperty * \sa SDL_SetPropertyWithCleanup + * \sa SDL_SetStringProperty */ extern DECLSPEC int SDLCALL SDL_SetProperty(SDL_PropertiesID props, const char *name, void *value); @@ -306,7 +311,11 @@ extern DECLSPEC SDL_PropertyType SDLCALL SDL_GetPropertyType(SDL_PropertiesID pr * * \since This function is available since SDL 3.0.0. * + * \sa SDL_GetBooleanProperty + * \sa SDL_GetFloatProperty + * \sa SDL_GetNumberProperty * \sa SDL_GetPropertyType + * \sa SDL_GetStringProperty * \sa SDL_HasProperty * \sa SDL_SetProperty */ diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h index 724c402a0..91ab6b198 100644 --- a/include/SDL3/SDL_render.h +++ b/include/SDL3/SDL_render.h @@ -271,6 +271,7 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window, co * * \since This function is available since SDL 3.0.0. * + * \sa SDL_CreateProperties * \sa SDL_CreateRenderer * \sa SDL_CreateSoftwareRenderer * \sa SDL_DestroyRenderer @@ -305,8 +306,6 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRendererWithProperties(SDL_Prop * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateRenderer - * \sa SDL_CreateWindowRenderer * \sa SDL_DestroyRenderer */ extern DECLSPEC SDL_Renderer *SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface *surface); @@ -319,8 +318,6 @@ extern DECLSPEC SDL_Renderer *SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface *su * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreateRenderer */ extern DECLSPEC SDL_Renderer *SDLCALL SDL_GetRenderer(SDL_Window *window); @@ -347,6 +344,7 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetRenderWindow(SDL_Renderer *renderer); * \since This function is available since SDL 3.0.0. * * \sa SDL_CreateRenderer + * \sa SDL_CreateRendererWithProperties */ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_RendererInfo *info); @@ -455,7 +453,7 @@ extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Renderer * * \since This function is available since SDL 3.0.0. * - * \sa SDL_GetRenderer + * \sa SDL_GetCurrentRenderOutputSize */ extern DECLSPEC int SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *renderer, int *w, int *h); @@ -476,7 +474,6 @@ extern DECLSPEC int SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *renderer, int * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderOutputSize - * \sa SDL_GetRenderer */ extern DECLSPEC int SDLCALL SDL_GetCurrentRenderOutputSize(SDL_Renderer *renderer, int *w, int *h); @@ -634,8 +631,9 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateTextureFromSurface + * \sa SDL_CreateProperties * \sa SDL_CreateTexture + * \sa SDL_CreateTextureFromSurface * \sa SDL_DestroyTexture * \sa SDL_QueryTexture * \sa SDL_UpdateTexture @@ -793,10 +791,6 @@ extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Texture *t * \threadsafety It is safe to call this function from any thread. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreateTexture - * \sa SDL_CreateTextureFromSurface - * \sa SDL_CreateTextureWithProperties */ extern DECLSPEC SDL_Renderer *SDLCALL SDL_GetRendererFromTexture(SDL_Texture *texture); @@ -819,8 +813,6 @@ extern DECLSPEC SDL_Renderer *SDLCALL SDL_GetRendererFromTexture(SDL_Texture *te * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreateTexture */ extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture *texture, Uint32 *format, int *access, int *w, int *h); @@ -1010,7 +1002,6 @@ extern DECLSPEC int SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *texture, fl * \since This function is available since SDL 3.0.0. * * \sa SDL_GetTextureBlendMode - * \sa SDL_RenderTexture */ extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode blendMode); @@ -1085,9 +1076,10 @@ extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_Texture *texture, SDL_Sc * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateTexture * \sa SDL_LockTexture * \sa SDL_UnlockTexture + * \sa SDL_UpdateNVTexture + * \sa SDL_UpdateYUVTexture */ extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch); @@ -1116,6 +1108,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const SDL_Re * * \since This function is available since SDL 3.0.0. * + * \sa SDL_UpdateNVTexture * \sa SDL_UpdateTexture */ extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture, @@ -1144,6 +1137,9 @@ extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture, * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_UpdateTexture + * \sa SDL_UpdateYUVTexture */ extern DECLSPEC int SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture, const SDL_Rect *rect, @@ -1175,6 +1171,7 @@ extern DECLSPEC int SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture, * * \since This function is available since SDL 3.0.0. * + * \sa SDL_LockTextureToSurface * \sa SDL_UnlockTexture */ extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture *texture, @@ -1529,15 +1526,6 @@ extern DECLSPEC int SDLCALL SDL_GetRenderScale(SDL_Renderer *renderer, float *sc * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderDrawColor - * \sa SDL_RenderClear - * \sa SDL_RenderFillRect - * \sa SDL_RenderFillRects - * \sa SDL_RenderLine - * \sa SDL_RenderLines - * \sa SDL_RenderPoint - * \sa SDL_RenderPoints - * \sa SDL_RenderRect - * \sa SDL_RenderRects * \sa SDL_SetRenderDrawColorFloat */ extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a); @@ -1561,15 +1549,6 @@ extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer, Uint8 * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderDrawColorFloat - * \sa SDL_RenderClear - * \sa SDL_RenderFillRect - * \sa SDL_RenderFillRects - * \sa SDL_RenderLine - * \sa SDL_RenderLines - * \sa SDL_RenderPoint - * \sa SDL_RenderPoints - * \sa SDL_RenderRect - * \sa SDL_RenderRects * \sa SDL_SetRenderDrawColor */ extern DECLSPEC int SDLCALL SDL_SetRenderDrawColorFloat(SDL_Renderer *renderer, float r, float g, float b, float a); @@ -1667,14 +1646,6 @@ extern DECLSPEC int SDLCALL SDL_GetRenderColorScale(SDL_Renderer *renderer, floa * \since This function is available since SDL 3.0.0. * * \sa SDL_GetRenderDrawBlendMode - * \sa SDL_RenderLine - * \sa SDL_RenderLines - * \sa SDL_RenderPoint - * \sa SDL_RenderPoints - * \sa SDL_RenderRect - * \sa SDL_RenderRects - * \sa SDL_RenderFillRect - * \sa SDL_RenderFillRects */ extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode blendMode); @@ -1717,6 +1688,8 @@ extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer *renderer); * \returns 0 on success, or -1 on error * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderPoints */ extern DECLSPEC int SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, float x, float y); @@ -1730,6 +1703,8 @@ extern DECLSPEC int SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, float x, flo * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderPoint */ extern DECLSPEC int SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, const SDL_FPoint *points, int count); @@ -1744,6 +1719,8 @@ extern DECLSPEC int SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, const SDL_F * \returns 0 on success, or -1 on error * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderLines */ extern DECLSPEC int SDLCALL SDL_RenderLine(SDL_Renderer *renderer, float x1, float y1, float x2, float y2); @@ -1758,6 +1735,8 @@ extern DECLSPEC int SDLCALL SDL_RenderLine(SDL_Renderer *renderer, float x1, flo * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderLine */ extern DECLSPEC int SDLCALL SDL_RenderLines(SDL_Renderer *renderer, const SDL_FPoint *points, int count); @@ -1770,6 +1749,8 @@ extern DECLSPEC int SDLCALL SDL_RenderLines(SDL_Renderer *renderer, const SDL_FP * \returns 0 on success, or -1 on error * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderRects */ extern DECLSPEC int SDLCALL SDL_RenderRect(SDL_Renderer *renderer, const SDL_FRect *rect); @@ -1784,6 +1765,8 @@ extern DECLSPEC int SDLCALL SDL_RenderRect(SDL_Renderer *renderer, const SDL_FRe * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderRect */ extern DECLSPEC int SDLCALL SDL_RenderRects(SDL_Renderer *renderer, const SDL_FRect *rects, int count); @@ -1797,6 +1780,8 @@ extern DECLSPEC int SDLCALL SDL_RenderRects(SDL_Renderer *renderer, const SDL_FR * \returns 0 on success, or -1 on error * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderFillRects */ extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, const SDL_FRect *rect); @@ -1811,6 +1796,8 @@ extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, const SDL * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderFillRect */ extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, const SDL_FRect *rects, int count); @@ -1827,6 +1814,8 @@ extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, const SD * \returns 0 on success, or -1 on error * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderTextureRotated */ extern DECLSPEC int SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, const SDL_FRect *dstrect); @@ -1851,6 +1840,8 @@ extern DECLSPEC int SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, SDL_Textur * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_RenderTexture */ extern DECLSPEC int SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, const SDL_FRect *dstrect, @@ -1875,7 +1866,6 @@ extern DECLSPEC int SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer, SDL * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGeometryRaw - * \sa SDL_Vertex */ extern DECLSPEC int SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer, SDL_Texture *texture, @@ -1906,7 +1896,6 @@ extern DECLSPEC int SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer, * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGeometry - * \sa SDL_Vertex */ extern DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer, SDL_Texture *texture, @@ -1940,7 +1929,7 @@ extern DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer, * \since This function is available since SDL 3.0.0. * * \sa SDL_RenderGeometry - * \sa SDL_Vertex + * \sa SDL_RenderGeometryRaw */ extern DECLSPEC int SDLCALL SDL_RenderGeometryRawFloat(SDL_Renderer *renderer, SDL_Texture *texture, @@ -2144,6 +2133,8 @@ extern DECLSPEC int SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *renderer * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetRenderVSync */ extern DECLSPEC int SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, int vsync); @@ -2157,6 +2148,8 @@ extern DECLSPEC int SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, int vsync * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_SetRenderVSync */ extern DECLSPEC int SDLCALL SDL_GetRenderVSync(SDL_Renderer *renderer, int *vsync); diff --git a/include/SDL3/SDL_storage.h b/include/SDL3/SDL_storage.h index 4f79ca86e..b714a3628 100644 --- a/include/SDL3/SDL_storage.h +++ b/include/SDL3/SDL_storage.h @@ -87,15 +87,10 @@ typedef struct SDL_Storage SDL_Storage; * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_TitleStorageReady * \sa SDL_CloseStorage - * \sa SDL_StorageReady * \sa SDL_GetStorageFileSize + * \sa SDL_OpenUserStorage * \sa SDL_ReadStorageFile - * \sa SDL_WriteStorageFile - * \sa SDL_GetStorageSpaceRemaining */ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenTitleStorage(const char *override, SDL_PropertiesID props); @@ -115,14 +110,13 @@ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenTitleStorage(const char *override, * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenStorage * \sa SDL_CloseStorage - * \sa SDL_StorageReady * \sa SDL_GetStorageFileSize - * \sa SDL_ReadStorageFile - * \sa SDL_WriteStorageFile * \sa SDL_GetStorageSpaceRemaining + * \sa SDL_OpenTitleStorage + * \sa SDL_ReadStorageFile + * \sa SDL_StorageReady + * \sa SDL_WriteStorageFile */ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenUserStorage(const char *org, const char *app, SDL_PropertiesID props); @@ -140,13 +134,13 @@ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenUserStorage(const char *org, const * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenStorage * \sa SDL_CloseStorage - * \sa SDL_StorageReady * \sa SDL_GetStorageFileSize + * \sa SDL_GetStorageSpaceRemaining + * \sa SDL_OpenTitleStorage + * \sa SDL_OpenUserStorage * \sa SDL_ReadStorageFile * \sa SDL_WriteStorageFile - * \sa SDL_GetStorageSpaceRemaining */ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenFileStorage(const char *path); @@ -165,14 +159,12 @@ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenFileStorage(const char *path); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenUserStorage * \sa SDL_CloseStorage - * \sa SDL_StorageReady * \sa SDL_GetStorageFileSize - * \sa SDL_ReadStorageFile - * \sa SDL_WriteStorageFile * \sa SDL_GetStorageSpaceRemaining + * \sa SDL_ReadStorageFile + * \sa SDL_StorageReady + * \sa SDL_WriteStorageFile */ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenStorage(const SDL_StorageInterface *iface, void *userdata); @@ -187,14 +179,10 @@ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenStorage(const SDL_StorageInterface * * \since This function is available since SDL 3.0.0. * + * \sa SDL_OpenFileStorage + * \sa SDL_OpenStorage * \sa SDL_OpenTitleStorage * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_StorageReady - * \sa SDL_GetStorageFileSize - * \sa SDL_ReadStorageFile - * \sa SDL_WriteStorageFile - * \sa SDL_GetStorageSpaceRemaining */ extern DECLSPEC int SDLCALL SDL_CloseStorage(SDL_Storage *storage); @@ -209,15 +197,6 @@ extern DECLSPEC int SDLCALL SDL_CloseStorage(SDL_Storage *storage); * \returns SDL_TRUE if the container is ready, SDL_FALSE otherwise * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_CloseStorage - * \sa SDL_GetStorageFileSize - * \sa SDL_ReadStorageFile - * \sa SDL_WriteStorageFile - * \sa SDL_GetStorageSpaceRemaining */ extern DECLSPEC SDL_bool SDLCALL SDL_StorageReady(SDL_Storage *storage); @@ -232,14 +211,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_StorageReady(SDL_Storage *storage); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_CloseStorage - * \sa SDL_StorageReady * \sa SDL_ReadStorageFile - * \sa SDL_WriteStorageFile - * \sa SDL_GetStorageSpaceRemaining + * \sa SDL_StorageReady */ extern DECLSPEC int SDLCALL SDL_GetStorageFileSize(SDL_Storage *storage, const char *path, Uint64 *length); @@ -256,14 +229,9 @@ extern DECLSPEC int SDLCALL SDL_GetStorageFileSize(SDL_Storage *storage, const c * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_CloseStorage - * \sa SDL_StorageReady * \sa SDL_GetStorageFileSize + * \sa SDL_StorageReady * \sa SDL_WriteStorageFile - * \sa SDL_GetStorageSpaceRemaining */ extern DECLSPEC int SDLCALL SDL_ReadStorageFile(SDL_Storage *storage, const char *path, void *destination, Uint64 length); @@ -279,14 +247,9 @@ extern DECLSPEC int SDLCALL SDL_ReadStorageFile(SDL_Storage *storage, const char * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_CloseStorage - * \sa SDL_StorageReady - * \sa SDL_GetStorageFileSize - * \sa SDL_ReadStorageFile * \sa SDL_GetStorageSpaceRemaining + * \sa SDL_ReadStorageFile + * \sa SDL_StorageReady */ extern DECLSPEC int SDL_WriteStorageFile(SDL_Storage *storage, const char *path, const void *source, Uint64 length); @@ -299,6 +262,8 @@ extern DECLSPEC int SDL_WriteStorageFile(SDL_Storage *storage, const char *path, * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_StorageReady */ extern DECLSPEC int SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage, const char *path); @@ -313,6 +278,8 @@ extern DECLSPEC int SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage, con * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_StorageReady */ extern DECLSPEC int SDLCALL SDL_EnumerateStorageDirectory(SDL_Storage *storage, const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata); @@ -325,6 +292,8 @@ extern DECLSPEC int SDLCALL SDL_EnumerateStorageDirectory(SDL_Storage *storage, * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_StorageReady */ extern DECLSPEC int SDLCALL SDL_RemoveStoragePath(SDL_Storage *storage, const char *path); @@ -338,6 +307,8 @@ extern DECLSPEC int SDLCALL SDL_RemoveStoragePath(SDL_Storage *storage, const ch * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_StorageReady */ extern DECLSPEC int SDLCALL SDL_RenameStoragePath(SDL_Storage *storage, const char *oldpath, const char *newpath); @@ -351,6 +322,8 @@ extern DECLSPEC int SDLCALL SDL_RenameStoragePath(SDL_Storage *storage, const ch * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_StorageReady */ extern DECLSPEC int SDLCALL SDL_GetStoragePathInfo(SDL_Storage *storage, const char *path, SDL_PathInfo *info); @@ -362,13 +335,7 @@ extern DECLSPEC int SDLCALL SDL_GetStoragePathInfo(SDL_Storage *storage, const c * * \since This function is available since SDL 3.0.0. * - * \sa SDL_OpenTitleStorage - * \sa SDL_OpenUserStorage - * \sa SDL_OpenStorage - * \sa SDL_CloseStorage * \sa SDL_StorageReady - * \sa SDL_GetStorageFileSize - * \sa SDL_ReadStorageFile * \sa SDL_WriteStorageFile */ extern DECLSPEC Uint64 SDLCALL SDL_GetStorageSpaceRemaining(SDL_Storage *storage); diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h index 6ff5e6da3..779d45790 100644 --- a/include/SDL3/SDL_surface.h +++ b/include/SDL3/SDL_surface.h @@ -103,7 +103,6 @@ typedef enum * * \note This structure should be treated as read-only, except for \c pixels, * which, if not NULL, contains the raw pixel data for the surface. - * \sa SDL_CreateSurfaceFrom */ typedef struct SDL_Surface { @@ -152,8 +151,7 @@ typedef int (SDLCALL *SDL_blit) (struct SDL_Surface *src, const SDL_Rect *srcrec * \sa SDL_CreateSurfaceFrom * \sa SDL_DestroySurface */ -extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateSurface - (int width, int height, SDL_PixelFormatEnum format); +extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateSurface(int width, int height, SDL_PixelFormatEnum format); /** * Allocate a new RGB surface with a specific pixel format and existing pixel @@ -181,8 +179,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateSurface * \sa SDL_CreateSurface * \sa SDL_DestroySurface */ -extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateSurfaceFrom - (void *pixels, int width, int height, int pitch, SDL_PixelFormatEnum format); +extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateSurfaceFrom(void *pixels, int width, int height, int pitch, SDL_PixelFormatEnum format); /** * Free an RGB surface. @@ -195,8 +192,6 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateSurfaceFrom * * \sa SDL_CreateSurface * \sa SDL_CreateSurfaceFrom - * \sa SDL_LoadBMP - * \sa SDL_LoadBMP_IO */ extern DECLSPEC void SDLCALL SDL_DestroySurface(SDL_Surface *surface); @@ -457,8 +452,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SurfaceHasRLE(SDL_Surface *surface); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_BlitSurface * \sa SDL_GetSurfaceColorKey + * \sa SDL_SurfaceHasColorKey */ extern DECLSPEC int SDLCALL SDL_SetSurfaceColorKey(SDL_Surface *surface, int flag, Uint32 key); @@ -492,8 +487,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SurfaceHasColorKey(SDL_Surface *surface); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_BlitSurface * \sa SDL_SetSurfaceColorKey + * \sa SDL_SurfaceHasColorKey */ extern DECLSPEC int SDLCALL SDL_GetSurfaceColorKey(SDL_Surface *surface, Uint32 *key); @@ -622,7 +617,6 @@ extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface *surface, SDL_Bl * * \since This function is available since SDL 3.0.0. * - * \sa SDL_BlitSurface * \sa SDL_GetSurfaceClipRect */ extern DECLSPEC SDL_bool SDLCALL SDL_SetSurfaceClipRect(SDL_Surface *surface, const SDL_Rect *rect); @@ -642,7 +636,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetSurfaceClipRect(SDL_Surface *surface, co * * \since This function is available since SDL 3.0.0. * - * \sa SDL_BlitSurface * \sa SDL_SetSurfaceClipRect */ extern DECLSPEC int SDLCALL SDL_GetSurfaceClipRect(SDL_Surface *surface, SDL_Rect *rect); @@ -669,6 +662,8 @@ extern DECLSPEC int SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipMode f * more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_DestroySurface */ extern DECLSPEC SDL_Surface *SDLCALL SDL_DuplicateSurface(SDL_Surface *surface); @@ -688,9 +683,10 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_DuplicateSurface(SDL_Surface *surface); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreatePixelFormat * \sa SDL_ConvertSurfaceFormat - * \sa SDL_CreateSurface + * \sa SDL_ConvertSurfaceFormatAndColorspace + * \sa SDL_CreatePixelFormat + * \sa SDL_DestroySurface */ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface(SDL_Surface *surface, const SDL_PixelFormat *format); @@ -709,9 +705,9 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface(SDL_Surface *surface, co * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreatePixelFormat * \sa SDL_ConvertSurface - * \sa SDL_CreateSurface + * \sa SDL_ConvertSurfaceFormatAndColorspace + * \sa SDL_DestroySurface */ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormat(SDL_Surface *surface, SDL_PixelFormatEnum pixel_format); @@ -732,9 +728,9 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormat(SDL_Surface *surfa * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreatePixelFormat * \sa SDL_ConvertSurface - * \sa SDL_CreateSurface + * \sa SDL_ConvertSurfaceFormat + * \sa SDL_DestroySurface */ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormatAndColorspace(SDL_Surface *surface, SDL_PixelFormatEnum pixel_format, SDL_Colorspace colorspace, SDL_PropertiesID props); @@ -753,6 +749,8 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormatAndColorspace(SDL_S * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_ConvertPixelsAndColorspace */ extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height, SDL_PixelFormatEnum src_format, const void *src, int src_pitch, SDL_PixelFormatEnum dst_format, void *dst, int dst_pitch); @@ -780,6 +778,8 @@ extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height, SDL_PixelFo * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_ConvertPixels */ extern DECLSPEC int SDLCALL SDL_ConvertPixelsAndColorspace(int width, int height, SDL_PixelFormatEnum src_format, SDL_Colorspace src_colorspace, SDL_PropertiesID src_properties, const void *src, int src_pitch, SDL_PixelFormatEnum dst_format, SDL_Colorspace dst_colorspace, SDL_PropertiesID dst_properties, void *dst, int dst_pitch); @@ -969,7 +969,7 @@ extern DECLSPEC int SDLCALL SDL_BlitSurfaceUnchecked(SDL_Surface *src, const SDL extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, const SDL_Rect *dstrect, SDL_ScaleMode scaleMode); /** - * Perform a scaled surface copy to a destination surface. + * Perform a scaled blit to a destination surface, which may be of a different format. * * \param src the SDL_Surface structure to be copied from * \param srcrect the SDL_Rect structure representing the rectangle to be diff --git a/include/SDL3/SDL_thread.h b/include/SDL3/SDL_thread.h index 1e70f971d..ad16fc25c 100644 --- a/include/SDL3/SDL_thread.h +++ b/include/SDL3/SDL_thread.h @@ -190,8 +190,7 @@ SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, * \sa SDL_CreateThreadWithStackSize * \sa SDL_WaitThread */ -extern DECLSPEC SDL_Thread *SDLCALL -SDL_CreateThread(SDL_ThreadFunction fn, const char *name, void *data); +extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(SDL_ThreadFunction fn, const char *name, void *data); /** * Create a new thread with a specific stack size. @@ -230,10 +229,10 @@ SDL_CreateThread(SDL_ThreadFunction fn, const char *name, void *data); * * \since This function is available since SDL 3.0.0. * + * \sa SDL_CreateThread * \sa SDL_WaitThread */ -extern DECLSPEC SDL_Thread *SDLCALL -SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, const char *name, const size_t stacksize, void *data); +extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, const char *name, const size_t stacksize, void *data); #endif @@ -248,8 +247,6 @@ SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, const char *name, const siz * NULL if it doesn't have a name. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_CreateThread */ extern DECLSPEC const char *SDLCALL SDL_GetThreadName(SDL_Thread *thread); @@ -398,7 +395,6 @@ extern DECLSPEC SDL_TLSID SDLCALL SDL_CreateTLS(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateTLS * \sa SDL_SetTLS */ extern DECLSPEC void * SDLCALL SDL_GetTLS(SDL_TLSID id); @@ -423,7 +419,6 @@ extern DECLSPEC void * SDLCALL SDL_GetTLS(SDL_TLSID id); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_CreateTLS * \sa SDL_GetTLS */ extern DECLSPEC int SDLCALL SDL_SetTLS(SDL_TLSID id, const void *value, void (SDLCALL *destructor)(void*)); diff --git a/include/SDL3/SDL_touch.h b/include/SDL3/SDL_touch.h index 081ba60b8..a83060054 100644 --- a/include/SDL3/SDL_touch.h +++ b/include/SDL3/SDL_touch.h @@ -131,6 +131,8 @@ extern DECLSPEC int SDLCALL SDL_GetNumTouchFingers(SDL_TouchID touchID); * given ID and index could be found. * * \since This function is available since SDL 3.0.0. + * + * \sa SDL_GetNumTouchFingers */ extern DECLSPEC SDL_Finger * SDLCALL SDL_GetTouchFinger(SDL_TouchID touchID, int index); diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index eff00923d..c4ecdaf6f 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -104,35 +104,6 @@ typedef enum /** * The type used to identify a window - * - * \sa SDL_CreateWindow - * \sa SDL_CreateWindowWithProperties - * \sa SDL_DestroyWindow - * \sa SDL_FlashWindow - * \sa SDL_GetWindowFlags - * \sa SDL_GetWindowGrab - * \sa SDL_GetWindowKeyboardGrab - * \sa SDL_GetWindowMouseGrab - * \sa SDL_GetWindowPosition - * \sa SDL_GetWindowSize - * \sa SDL_GetWindowTitle - * \sa SDL_HideWindow - * \sa SDL_MaximizeWindow - * \sa SDL_MinimizeWindow - * \sa SDL_RaiseWindow - * \sa SDL_RestoreWindow - * \sa SDL_SetWindowFullscreen - * \sa SDL_SetWindowGrab - * \sa SDL_SetWindowKeyboardGrab - * \sa SDL_SetWindowMouseGrab - * \sa SDL_SetWindowIcon - * \sa SDL_SetWindowPosition - * \sa SDL_SetWindowSize - * \sa SDL_SetWindowBordered - * \sa SDL_SetWindowResizable - * \sa SDL_SetWindowTitle - * \sa SDL_ShowWindow - * \sa SDL_ShowWindowSystemMenu */ typedef struct SDL_Window SDL_Window; @@ -952,6 +923,7 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, in * * \since This function is available since SDL 3.0.0. * + * \sa SDL_CreateProperties * \sa SDL_CreateWindow * \sa SDL_DestroyWindow */