SDL Library

Dependents:   H261_decoder

Embed: (wiki syntax)

« Back to documentation index

SDL_HapticCustom Struct Reference

SDL_HapticCustom Struct Reference

A structure containing a template for the SDL_HAPTIC_CUSTOM effect. More...

#include <SDL_haptic.h>

Data Fields

Uint16 type
 SDL_HAPTIC_CUSTOM
SDL_HapticDirection direction
 Direction of the effect.
Uint32 length
 Duration of the effect.
Uint16 delay
 Delay before starting the effect.
Uint16 button
 Button that triggers the effect.
Uint16 interval
 How soon it can be triggered again after button.
Uint8 channels
 Axes to use, minimum of one.
Uint16 period
 Sample periods.
Uint16 samples
 Amount of samples.
Uint16data
 Should contain channels*samples items.
Uint16 attack_length
 Duration of the attack.
Uint16 attack_level
 Level at the start of the attack.
Uint16 fade_length
 Duration of the fade.
Uint16 fade_level
 Level at the end of the fade.

Detailed Description

A structure containing a template 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.

See also:
SDL_HAPTIC_CUSTOM
SDL_HapticEffect

Definition at line 691 of file SDL_haptic.h.


Field Documentation

Duration of the attack.

Definition at line 712 of file SDL_haptic.h.

Level at the start of the attack.

Definition at line 713 of file SDL_haptic.h.

Button that triggers the effect.

Definition at line 702 of file SDL_haptic.h.

Axes to use, minimum of one.

Definition at line 706 of file SDL_haptic.h.

Should contain channels*samples items.

Definition at line 709 of file SDL_haptic.h.

Delay before starting the effect.

Definition at line 699 of file SDL_haptic.h.

Direction of the effect.

Definition at line 695 of file SDL_haptic.h.

Duration of the fade.

Definition at line 714 of file SDL_haptic.h.

Level at the end of the fade.

Definition at line 715 of file SDL_haptic.h.

How soon it can be triggered again after button.

Definition at line 703 of file SDL_haptic.h.

Duration of the effect.

Definition at line 698 of file SDL_haptic.h.

Sample periods.

Definition at line 707 of file SDL_haptic.h.

Amount of samples.

Definition at line 708 of file SDL_haptic.h.

SDL_HAPTIC_CUSTOM

Definition at line 694 of file SDL_haptic.h.