#include <input.h>
Collaboration diagram for ff_periodic_effect:
Public Attributes | |
| __u16 | waveform |
| __u16 | period |
| __s16 | magnitude |
| __s16 | offset |
| __u16 | phase |
| struct ff_envelope | envelope |
| __u32 | custom_len |
| __s16 __user * | custom_data |
Detailed Description
struct ff_periodic_effect - defines parameters of a periodic force-feedback effect @waveform: kind of the effect (wave) @period: period of the wave (ms) @magnitude: peak value @offset: mean value of the wave (roughly) @phase: 'horizontal' shift @envelope: envelope data @custom_len: number of samples (FF_CUSTOM only) @custom_data: buffer of samples (FF_CUSTOM only)
Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined for the time being as no driver supports it yet.
Note: the data pointed by custom_data is copied by the driver. You can therefore dispose of the memory after the upload/update.
Member Data Documentation
◆ custom_data
◆ custom_len
| __u32 ff_periodic_effect::custom_len |
◆ envelope
| struct ff_envelope ff_periodic_effect::envelope |
◆ magnitude
| __s16 ff_periodic_effect::magnitude |
◆ offset
| __s16 ff_periodic_effect::offset |
◆ period
| __u16 ff_periodic_effect::period |
◆ phase
| __u16 ff_periodic_effect::phase |
◆ waveform
| __u16 ff_periodic_effect::waveform |
The documentation for this struct was generated from the following file:
- XenevaOS/BaseHdr/uapi/linux/input.h
