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

SDL_HapticEffectSupported

Check to see if an effect is supported by a haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

SDL_bool SDL_HapticEffectSupported(SDL_Haptic *haptic, const SDL_HapticEffect *effect);

Function Parameters

haptic the SDL_Haptic device to query
effect the desired effect to query

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.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic