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 structures in this union contain the following common parts:

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

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

Ramp sentence combined into this paragraph, separate in header. The last sentence about Fade (from line 698 version f3c34d321289 SDL_haptic.h) is awkward and potentially confusing. How could it be revised to make it more clear?

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 joystick. Does this mean that the joystick itself is index 0 and the buttons are index >=1?

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

Here 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.

Note that some minor edits to the verbatim text in the header have been made and not noted above.

Related Structures

• SDL_HapticCondition

• SDL_HapticConstant

• SDL_HapticCustom

• SDL_HapticLeftRight

• SDL_HapticPeriodic

• SDL_HapticRamp

Related Functions

• SDL_HapticEffectSupported

• SDL_HapticNewEffect

• SDL_HapticUpdateEffect

CategoryStruct, CategoryForceFeedback