From ae73ea9c0712c0ed4be1cd54556dd676743a8559 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Fri, 4 Mar 2022 09:27:46 -0800 Subject: [PATCH] Clarified documentation for the trigger rumble API Fixes https://github.com/libsdl-org/SDL/issues/5372 --- include/SDL_gamecontroller.h | 5 +++-- include/SDL_joystick.h | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/include/SDL_gamecontroller.h b/include/SDL_gamecontroller.h index bdd9b8993..9f5307f1c 100644 --- a/include/SDL_gamecontroller.h +++ b/include/SDL_gamecontroller.h @@ -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 diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h index e80c0057f..07e2b1561 100644 --- a/include/SDL_joystick.h +++ b/include/SDL_joystick.h @@ -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 * calling it with 0 intensity stops any rumbling. * - * Note that this function is for _trigger_ rumble; the first joystick to - * support this was the PlayStation 5's DualShock 5 controller. If you want - * the (more common) whole-controller rumble, use SDL_JoystickRumble() + * Note that this is rumbling of the _triggers_ and not the game controller as + * a whole. This is currently only supported on Xbox One controllers. If you + * want the (more common) whole-controller rumble, use SDL_JoystickRumble() * instead. * * \param joystick The joystick to vibrate