NAME¶

SDL_PlayHapticRumble - Run a simple rumble effect on a haptic device.

SYNOPSIS¶

#include "SDL3/SDL.h"

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

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 0 on success or a negative error code on failure; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_InitHapticRumble(3), SDL_StopHapticRumble(3)