SDL Wiki
(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)


Start a rumble effect in the joystick's triggers


int SDL_JoystickRumbleTriggers(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms);

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 0, or -1 if trigger rumble isn't supported on this joystick


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


This function is available since SDL 2.0.14.


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.