(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_HapticRumbleSupported

Check whether rumble is supported on a haptic device.

Header File

Syntax

SDL_bool SDL_HapticRumbleSupported(SDL_Haptic *haptic);

Function Parameters

haptic

haptic device to check for rumble support

Return Value

Returns SDL_TRUE if the effect is supported or SDL_FALSE if it isn't.

Version

This function is available since SDL 3.0.0.

Code Examples

extern SDL_Haptic* dev;
if (SDL_HapticRumbleSupported(dev)) {
    SDL_InitHapticRumble(dev);
    SDL_PlayHapticRumble(dev, 1.0f, 3000);
    SDL_Delay(3000);
}