mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-21 09:11:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarified documentation for the trigger rumble API

Browse Source 
Fixes https://github.com/libsdl-org/SDL/issues/5372
This commit is contained in:
Sam Lantinga
2022-03-04 09:27:46 -08:00
parent 13756b5c72
commit ae73ea9c07
2 changed files with 6 additions and 5 deletions
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.
*
* 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
* DualShock 5.
* a whole. This is currently only supported on Xbox One controllers. If you
* want the (more common) whole-controller rumble, use SDL_GameControllerRumble()
* instead.
*
* \param gamecontroller The controller to vibrate
* \param left_rumble The intensity of the left trigger rumble motor, from 0