Man page - sdl_runhapticeffect(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_RunHapticEffect

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

NAME

SDL_RunHapticEffect - Run the haptic effect on its associated haptic device.

HEADER FILE

Defined in SDL3/SDL_haptic.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_RunHapticEffect(SDL_Haptic *haptic, int effect, Uint32 iterations);

DESCRIPTION

To repeat the effect over and over indefinitely, set iterations to

SDL_HAPTIC_INFINITY . (Repeats the envelope - attack and fade.) To make one instance of the effect last indefinitely (so the effect does not fade), set the effect’s length in its structure/union to SDL_HAPTIC_INFINITY instead.

FUNCTION PARAMETERS

haptic

the SDL_Haptic

device to run the effect on.

effect

the ID of the haptic effect to run.

iterations

the number of iterations to run the effect; use SDL_HAPTIC_INFINITY to repeat forever.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.2.0.