SDL_RumbleGamepad - Man Page
Start a rumble effect on a gamepad.
Header File
Defined in SDL3/SDL_gamepad.h
Synopsis
#include "SDL3/SDL.h" bool SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
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
- gamepad
the gamepad 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.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Availability
This function is available since SDL 3.2.0.
Referenced By
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS