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

SDL_PlayHapticRumble

Run a simple rumble effect on a haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

bool SDL_PlayHapticRumble(SDL_Haptic *haptic, float strength, Uint32 length);

Function Parameters

SDL_Haptic *	haptic	the haptic device to play the rumble effect on.
float	strength	strength of the rumble to play as a 0-1 float value.
Uint32	length	length of the rumble to play in milliseconds.

Return Value

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

Version

This function is available since SDL 3.1.3.

See Also

• SDL_InitHapticRumble
• SDL_StopHapticRumble

---

CategoryAPI, CategoryAPIFunction, CategoryHaptic

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