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

SDL_JoystickRumble

Start a rumble effect.

Header File

Defined in SDL_joystick.h

Syntax

int SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);

Function Parameters

SDL_Joystick *	joystick	The joystick 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

(int) Returns 0, or -1 if rumble isn't supported on this joystick.

Remarks

Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.

Version

This function is available since SDL 2.0.9.

See Also

• SDL_JoystickHasRumble

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

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