SDL_CreateHapticEffect(3)

SDL_CreateHapticEffect3

Create a new haptic effect on a specified device.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_haptic.h

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.