SDL_RumbleJoystick - Start a rumble effect.
Contents
Availability
This function is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.20 SDL_RumbleJoystick(3)
Description
Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any
rumbling.
This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.
Function Parameters
joystick
the joystick to vibrate.
low_frequency_rumble
the intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF.
high_frequency_rumble
the intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF.
duration_ms
the duration of the rumble effect, in milliseconds.
Name
SDL_RumbleJoystick - Start a rumble effect.
Return Value
Returns true, or false if rumble isn't supported on this joystick.
Synopsis
#include<SDL3/SDL_joystick.h>boolSDL_RumbleJoystick(SDL_Joystick*joystick,Uint16low_frequency_rumble,Uint16high_frequency_rumble,Uint32duration_ms);
