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

Clarified documentation for the trigger rumble API 

Fixes https://github.com/libsdl-org/SDL/issues/5372
main
Sam Lantinga 2022-03-04 09:27:46 -08:00
parent 13756b5c72
commit ae73ea9c07
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/SDL_gamecontroller.h
View File

@ -869,8 +869,9 @@ extern DECLSPEC int SDLCALL SDL_GameControllerRumble(SDL_GameController *gamecon
* calling it with 0 intensity stops any rumbling. * calling it with 0 intensity stops any rumbling.
* *
* Note that this is rumbling of the _triggers_ and not the game controller as * Note that this is rumbling of the _triggers_ and not the game controller as
* a whole. The first controller to offer this feature was the PlayStation 5's * a whole. This is currently only supported on Xbox One controllers. If you
* DualShock 5. * want the (more common) whole-controller rumble, use SDL_GameControllerRumble()
* instead.
* *
* \param gamecontroller The controller to vibrate * \param gamecontroller The controller 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

6
include/SDL_joystick.h
View File

@ -829,9 +829,9 @@ extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 lo
* Each call to this function cancels any previous trigger rumble effect, and * Each call to this function cancels any previous trigger rumble effect, and
* calling it with 0 intensity stops any rumbling. * calling it with 0 intensity stops any rumbling.
* *
* Note that this function is for _trigger_ rumble; the first joystick to * Note that this is rumbling of the _triggers_ and not the game controller as
* support this was the PlayStation 5's DualShock 5 controller. If you want * a whole. This is currently only supported on Xbox One controllers. If you
* the (more common) whole-controller rumble, use SDL_JoystickRumble() * want the (more common) whole-controller rumble, use SDL_JoystickRumble()
* instead. * instead.
* *
* \param joystick The joystick to vibrate * \param joystick The joystick to vibrate