ff_periodic_effect Struct Reference

#include <input.h>

Data Fields
__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 : kind of the effect (wave) : period of the wave (ms) : peak value : mean value of the wave (roughly) : 'horizontal' shift : envelope data : number of samples (FF_CUSTOM only) : 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.

Definition at line 1046 of file input.h.

Field Documentation

__s16 __user* custom_data

Definition at line 1056 of file input.h.

__u32 custom_len

Definition at line 1055 of file input.h.

struct ff_envelope envelope

Definition at line 1053 of file input.h.

__s16 magnitude

Definition at line 1049 of file input.h.

__s16 offset

Definition at line 1050 of file input.h.

__u16 period

Definition at line 1048 of file input.h.

__u16 phase

Definition at line 1051 of file input.h.

__u16 waveform

Definition at line 1047 of file input.h.

---

The documentation for this struct was generated from the following file:

• include/uapi/linux/input.h