SDL_HapticCustom

A structure containing a template for the SDL_HAPTIC_CUSTOM effect.

This struct is exclusively for the SDL_HAPTIC_CUSTOM effect.

A custom force feedback effect is much like a periodic effect, where the application can define its exact shape. You will have to allocate the data yourself. Data should consist of channels* samples Uint16 samples.

If channels is one, the effect is rotated using the defined direction. Otherwise it uses the samples in data for the different axes.

\since This struct is available since SDL 3.2.0.

\sa SDL_HAPTIC_CUSTOM \sa SDL_HapticEffect

Members

Variables

attack_length
Uint16 attack_length;

Duration of the attack.

attack_level
Uint16 attack_level;

Level at the start of the attack.

button
Uint16 button;

Button that triggers the effect.

channels
Uint8 channels;

Axes to use, minimum of one.

data
Uint16* data;

Should contain channels*samples items.

delay
Uint16 delay;

Delay before starting the effect.

direction
SDL_HapticDirection direction;

Direction of the effect.

fade_length
Uint16 fade_length;

Duration of the fade.

fade_level
Uint16 fade_level;

Level at the end of the fade.

interval
Uint16 interval;

How soon it can be triggered again after button.

length
Uint32 length;

Duration of the effect.

period
Uint16 period;

Sample periods.

samples
Uint16 samples;

Amount of samples.

type
SDL_HapticEffectType type;

SDL_HAPTIC_CUSTOM

Meta