SDL_CreateHapticEffect

Create a new haptic effect on a specified device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

SDL_HapticEffectID SDL_CreateHapticEffect(SDL_Haptic *haptic, const SDL_HapticEffect *effect);

Function Parameters

SDL_Haptic * haptic an SDL_Haptic device to create the effect on.
const SDL_HapticEffect * effect an SDL_HapticEffect structure containing the properties of the effect to create.

Return Value

(SDL_HapticEffectID) Returns the ID of the effect on success or -1 on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.2.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic