(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_HapticEffectSupported

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

Header File

Defined in SDL_haptic.h

Syntax

int SDL_HapticEffectSupported(SDL_Haptic * haptic,
                              SDL_HapticEffect *
                              effect);

Function Parameters

SDL_Haptic *	haptic	the SDL_Haptic device to query.
SDL_HapticEffect *	effect	the desired effect to query.

Return Value

(int) Returns SDL_TRUE if effect is supported, SDL_FALSE if it isn't, or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_HapticNewEffect
• SDL_HapticQuery

---

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.