TSdlHapticCustom
A record containing a template for the TSdlHapticKind.Custom effect.
This record is exclusively for the TSdlHapticKind.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.
Definition
Unit: Neslib.Sdl3.Haptic
See Also
Properties
| Name | Description |
|---|---|
| AttackLength | Duration of the attack. |
| AttackLevel | Level at the start of the attack. |
| Button | Button that triggers the effect. |
| Channels | Axes to use, minimum of one. |
| Data | Should contain channels*samples items. |
| Delay | Delay before starting the effect. |
| Direction | Direction of the effect. |
| FadeLength | Duration of the fade. |
| FadeLevel | Level at the end of the fade. |
| Interval | How soon it can be triggered again after button. |
| Kind | TSdlHapticKind.Custom |
| Length | Duration of the effect in milliseconds. |
| Period | Sample periods. |
| Samples | Amount of samples. |
Property Descriptions
AttackLength
Duration of the attack.
property AttackLength: Word read FHandle.attack_length write FHandle.attack_length
Type: Word
AttackLevel
Level at the start of the attack.
property AttackLevel: Word read FHandle.attack_level write FHandle.attack_level
Type: Word
Button
Button that triggers the effect.
property Button: Word read FHandle.button write FHandle.button
Type: Word
Channels
Axes to use, minimum of one.
property Channels: Byte read FHandle.channels write FHandle.channels
Type: Byte
Data
Should contain channels*samples items.
property Data: PWord read FHandle.data write FHandle.data
Type: PWord
Delay
Delay before starting the effect.
property Delay: Word read FHandle.delay write FHandle.delay
Type: Word
Direction
Direction of the effect.
property Direction: PSdlHapticDirection read GetDirection
Type: PSdlHapticDirection
FadeLength
Duration of the fade.
property FadeLength: Word read FHandle.fade_length write FHandle.fade_length
Type: Word
FadeLevel
Level at the end of the fade.
property FadeLevel: Word read FHandle.fade_level write FHandle.fade_level
Type: Word
Interval
How soon it can be triggered again after button.
property Interval: Word read FHandle.interval write FHandle.interval
Type: Word
Kind
TSdlHapticKind.Custom
property Kind: TSdlHapticKind read GetKind write SetKind
Type: TSdlHapticKind
Length
Duration of the effect in milliseconds.
property Length: Cardinal read FHandle.length write FHandle.length
Type: Cardinal
Period
Sample periods.
property Period: Word read FHandle.period write FHandle.period
Type: Word
Samples
Amount of samples.
property Samples: Word read FHandle.samples write FHandle.samples
Type: Word