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

Sync SDL wiki -> header

Browse source
This commit is contained in:
SDL Wiki Bot 2022-11-22 22:40:14 +00:00
parent 8b18b09027
commit 290bd8b910
45 changed files with 730 additions and 730 deletions
Download patch file Download diff file Expand all files Collapse all files

60
include/SDL_haptic.h
View file

@ -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