SDL_RumbleJoystickTriggers - Start a rumble effect in the joystick's triggers.
Contents
Availability
This function is available since SDL 3.2.0.
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.
Header File
Defined in SDL3/SDL_joystick.h
Name
SDL_RumbleJoystickTriggers - Start a rumble effect in the joystick's triggers.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
See Also
âĸ(3), SDL_RumbleJoystick(3) Simple Directmedia Layer SDL 3.2.10 SDL_RumbleJoystickTriggers(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_RumbleJoystickTriggers(SDL_Joystick*joystick,Uint16left_rumble,Uint16right_rumble,Uint32duration_ms);
