arsa
2.7
|
The generic template for any haptic effect. More...
#include <SDL_haptic.h>
Public Attributes | |
Uint16 | type |
SDL_HapticConstant | constant |
SDL_HapticPeriodic | periodic |
SDL_HapticCondition | condition |
SDL_HapticRamp | ramp |
SDL_HapticLeftRight | leftright |
SDL_HapticCustom | custom |
The generic template for any haptic effect.
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.
Additionally, the SDL_HAPTIC_RAMP effect does not support a duration of SDL_HAPTIC_INFINITY.
Button triggers may not be supported on all devices, it is advised to not use them if possible. Buttons start at index 1 instead of index 0 like the joystick.
If both attack_length and fade_level are 0, the envelope is not used, otherwise both values are used.
Common parts:
Here we have an example of a constant effect evolution in time:
Strength ^ | | effect level --> _________________ | / \ | / \ | / \ | / \ | attack_level --> | \ | | | <--- fade_level | +--------------------------------------------------> Time [--] [---] attack_length fade_length [------------------][-----------------------] delay length
Note either the attack_level or the fade_level may be above the actual effect level.
Definition at line 800 of file SDL_haptic.h.
SDL_HapticCondition SDL_HapticEffect::condition |
Condition effect.
Definition at line 806 of file SDL_haptic.h.
SDL_HapticConstant SDL_HapticEffect::constant |
Constant effect.
Definition at line 804 of file SDL_haptic.h.
SDL_HapticCustom SDL_HapticEffect::custom |
Custom effect.
Definition at line 809 of file SDL_haptic.h.
SDL_HapticLeftRight SDL_HapticEffect::leftright |
Left/Right effect.
Definition at line 808 of file SDL_haptic.h.
SDL_HapticPeriodic SDL_HapticEffect::periodic |
Periodic effect.
Definition at line 805 of file SDL_haptic.h.
SDL_HapticRamp SDL_HapticEffect::ramp |
Ramp effect.
Definition at line 807 of file SDL_haptic.h.
Uint16 SDL_HapticEffect::type |
Effect type.
Definition at line 803 of file SDL_haptic.h.