Man page - sdl_rumblegamepad(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

SDL_RumbleGamepad - Start a rumble effect on a gamepad.

Defined in SDL3/SDL_gamepad.h

#include "SDL3/SDL.h"

bool SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);

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.

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.

Returns true on success or false on failure; call

SDL_GetError () for more information.

This function is available since SDL 3.2.0.