SDL_HapticEffect

A union that contains the generic template for any haptic effect.

Data Fields

Code Examples

You can add your code example here

Remarks

^{All structs in this union contain the following} common parts:

All values max at 32767 (0x7FFF). Signed values _also can be negative. Time values, unless specified otherwise, are in milliseconds.

You can _also pass SDL_HAPTIC_INFINITY to length instead of a 0-32767 value. Neither delay, interval, attack_length nor fade_length support SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends. green

_{Additionally,} the SDL_HAPTIC_RAMP effect does not support a duration of SDL_HAPTIC_INFINITY. green

Button triggers may not be supported on all devices; it is advised not to use them if possible. Buttons start at index 1 instead of index 0 like the_y joystick. <<Color2: execution failed [No argument named "Does this mean that the joystick itself is index 0 and the buttons are index >"] (see also the log)>>

If both attack_length and fade_level are 0, the envelope is not used, otherwise both values are used.

Here _{we have} ^is an example of a constant effect evolution in time:

Strength
^
|
|    effect level -->  _________________
|                     /                 \
|                    /                   \
|                   /                     \
|                  /                       \ 
| attack_level --> |                        \
|                  |                        |  <---  fade_level
|
+--------------------------------------------------> Time

                   [--]                 [---]
               attack_length          fade_length

[------------------][-----------------------]
       delay                 length

Note ^that either the attack_level or the fade_level may be above the actual effect level.

green

Related Structures

• SDL_HapticCondition

• SDL_HapticConstant

• SDL_HapticCustom

• SDL_HapticDirection ??? (from header but not referenced in the union)

• SDL_HapticPeriodic

• SDL_HapticRamp

Related Functions

• SDL_HapticEffectSupported

• SDL_HapticNewEffect

• SDL_HapticUpdateEffect

CategoryStruct, CategoryForceFeedbackStruct