(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_RumbleJoystickTriggers

Start a rumble effect in the joystick's triggers.

Header File

Syntax

bool SDL_RumbleJoystickTriggers(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms);

Function Parameters

SDL_Joystick *	joystick	the joystick to vibrate.
Uint16	left_rumble	the intensity of the left trigger rumble motor, from 0 to 0xFFFF.
Uint16	right_rumble	the intensity of the right trigger rumble motor, from 0 to 0xFFFF.
Uint32	duration_ms	the duration of the rumble effect, in milliseconds.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Each call to this function cancels any previous trigger rumble effect, and calling it with 0 intensity stops any rumbling.

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_RumbleJoystick() instead.

This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.

Version

This function is available since SDL 3.1.3.