geemili
/
SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document that SDL_UpdateJoysticks() needs to be called to handle rumble processing 

Related: https://github.com/libsdl-org/SDL/issues/4300
main
Sam Lantinga 2024-02-08 10:43:00 -08:00
parent d777becd9d
commit 4ce7ae31d4
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL3/SDL_gamepad.h
View File

@ -1199,6 +1199,8 @@ extern DECLSPEC int SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamepad, SDL_S
* Each call to this function cancels any previous rumble effect, and calling * Each call to this function cancels any previous rumble effect, and calling
* it with 0 intensity stops any rumbling. * it with 0 intensity stops any rumbling.
* *
* This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
*
* \param gamepad The gamepad to vibrate * \param gamepad The gamepad to vibrate
* \param low_frequency_rumble The intensity of the low frequency (left) * \param low_frequency_rumble The intensity of the low frequency (left)
* rumble motor, from 0 to 0xFFFF * rumble motor, from 0 to 0xFFFF
@ -1221,6 +1223,8 @@ extern DECLSPEC int SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_f
* whole. This is currently only supported on Xbox One gamepads. If you want * whole. This is currently only supported on Xbox One gamepads. If you want
* the (more common) whole-gamepad rumble, use SDL_RumbleGamepad() instead. * the (more common) whole-gamepad rumble, use SDL_RumbleGamepad() instead.
* *
* This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
*
* \param gamepad The gamepad to vibrate * \param gamepad The gamepad to vibrate
* \param left_rumble The intensity of the left trigger rumble motor, from 0 * \param left_rumble The intensity of the left trigger rumble motor, from 0
* to 0xFFFF * to 0xFFFF

4
include/SDL3/SDL_joystick.h
View File

@ -905,6 +905,8 @@ extern DECLSPEC Uint8 SDLCALL SDL_GetJoystickButton(SDL_Joystick *joystick,
* Each call to this function cancels any previous rumble effect, and calling * Each call to this function cancels any previous rumble effect, and calling
* it with 0 intensity stops any rumbling. * it with 0 intensity stops any rumbling.
* *
* This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
*
* \param joystick The joystick to vibrate * \param joystick The joystick to vibrate
* \param low_frequency_rumble The intensity of the low frequency (left) * \param low_frequency_rumble The intensity of the low frequency (left)
* rumble motor, from 0 to 0xFFFF * rumble motor, from 0 to 0xFFFF
@ -928,6 +930,8 @@ extern DECLSPEC int SDLCALL SDL_RumbleJoystick(SDL_Joystick *joystick, Uint16 lo
* want the (more common) whole-controller rumble, use SDL_RumbleJoystick() * want the (more common) whole-controller rumble, use SDL_RumbleJoystick()
* instead. * instead.
* *
* This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
*
* \param joystick The joystick to vibrate * \param joystick The joystick to vibrate
* \param left_rumble The intensity of the left trigger rumble motor, from 0 * \param left_rumble The intensity of the left trigger rumble motor, from 0
* to 0xFFFF * to 0xFFFF