(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_RumbleGamepad

Start a rumble effect on a gamepad.

Header File

Defined in <SDL3/SDL_gamepad.h>

Syntax

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

Function Parameters

SDL_Gamepad *	gamepad	the gamepad to vibrate.
Uint16	low_frequency_rumble	the intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF.
Uint16	high_frequency_rumble	the intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF.
Uint32	duration_ms	the duration of the rumble effect, in milliseconds.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryGamepad

[ 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.