SDL_CreateHapticEffect - Man Page

Create a new haptic effect on a specified device.

Synopsis

#include <SDL3/SDL_haptic.h>

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

Function Parameters

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

Return Value

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

Availability

This function is available since SDL 3.2.0.

See Also

SDL_DestroyHapticEffect(3), SDL_RunHapticEffect(3), SDL_UpdateHapticEffect(3)

Referenced By

SDL_DestroyHapticEffect(3), SDL_HapticEffectID.3type(3), SDL_HapticEffectSupported(3), SDL_UpdateHapticEffect(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS