SDL_PlayHapticRumble(3)

SDL_PlayHapticRumble3

Run a simple rumble effect on a haptic device.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_haptic.h

Function parameters

haptic

the haptic device to play the rumble effect on.

strength

strength of the rumble to play as a 0-1 float value.

length

length of the rumble to play 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.