NAME

SDL_RumbleJoystickTriggers - Start a rumble effect in the joystick's triggers.

SYNOPSIS

#include <SDL3/SDL_joystick.h>

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

DESCRIPTION

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.

FUNCTION PARAMETERS

joystick

the joystick to vibrate.

left_rumble

the intensity of the left trigger rumble motor, from 0 to 0xFFFF.

right_rumble

the intensity of the right trigger rumble motor, from 0 to 0xFFFF.

duration_ms

the duration of the rumble effect, in milliseconds.

RETURN VALUE

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

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

SDL_RumbleJoystick(3)