SDL_PlayHapticRumble - Man Page

Run a simple rumble effect on a haptic device.

Header File

Defined in SDL3/SDL_haptic.h

Synopsis

#include "SDL3/SDL.h"

bool 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 true on success or false on failure; call

SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_InitHapticRumble(3), ·(3), SDL_StopHapticRumble(3)

Referenced By

SDL_InitHapticRumble(3), SDL_StopHapticRumble(3).

SDL 3.2.8 Simple Directmedia Layer SDL3 FUNCTIONS