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_HapticDirection	direction
Uint32	length
Uint16	delay
Uint16	button
Uint16	interval
Uint8	channels
Uint16	period
Uint16	samples
Uint16 *	data
Uint16	attack_length
Uint16	attack_level
Uint16	fade_length
Uint16	fade_level

---

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 it's 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

---

Field Documentation

Uint16 attack_length

Duration of the attack.

Uint16 attack_level

Level at the start of the attack.

Uint16 button

Button that triggers the effect.

Uint8 channels

Axes to use, minimum of one.

Uint16* data

Should contain channels*samples items.

Uint16 delay

Delay before starting the effect.

SDL_HapticDirection direction

Direction of the effect.

Uint16 fade_length

Duration of the fade.

Uint16 fade_level

Level at the end of the fade.

Uint16 interval

How soon it can be triggered again after button.

Uint32 length

Duration of the effect.

Uint16 period

Sample periods.

Uint16 samples

Amount of samples.

Uint16 type

SDL_HAPTIC_CUSTOM

---

The documentation for this struct was generated from the following file:

• /Users/hercules/trunk/SDL/include/SDL_haptic.h