1STRUCT FF_EFFECT(9)             Input Subsystem            STRUCT FF_EFFECT(9)
2
3
4

NAME

6       struct_ff_effect - defines force feedback effect
7

SYNOPSIS

9       struct ff_effect {
10         __u16 type;
11         __s16 id;
12         __u16 direction;
13         struct ff_trigger trigger;
14         struct ff_replay replay;
15         union u;
16       };
17

MEMBERS

19       type
20           type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
21           FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
22
23       id
24           an unique id assigned to an effect
25
26       direction
27           direction of the effect
28
29       trigger
30           trigger conditions (struct ff_trigger)
31
32       replay
33           scheduling of the effect (struct ff_replay)
34
35       u
36           effect-specific structure (one of ff_constant_effect,
37           ff_ramp_effect, ff_periodic_effect, ff_condition_effect,
38           ff_rumble_effect) further defining effect parameters
39

DESCRIPTION

41       This structure is sent through ioctl from the application to the
42       driver. To create a new effect application should set its id to -1; the
43       kernel will return assigned id which can later be used to update or
44       delete this effect.
45

DIRECTION OF THE EFFECT IS ENCODED AS FOLLOWS

47       0 deg -> 0x0000 (down) 90 deg -> 0x4000 (left) 180 deg -> 0x8000 (up)
48       270 deg -> 0xC000 (right)
49
51Kernel Hackers Manual 2.6.         June 2019               STRUCT FF_EFFECT(9)
Impressum