ff_effect Struct Reference

#include <input.h>

Collaboration diagram for ff_effect:

Public Attributes
__u16	type
__s16	id
__u16	direction
struct ff_trigger	trigger
struct ff_replay	replay
union {
struct ff_constant_effect   constant
struct ff_ramp_effect   ramp
struct ff_periodic_effect   periodic
struct ff_condition_effect   condition [2]
struct ff_rumble_effect   rumble
struct ff_haptic_effect   haptic
}	u

Detailed Description

struct ff_effect - defines force feedback effect @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING, FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM) @id: an unique id assigned to an effect @direction: direction of the effect @trigger: trigger conditions (struct ff_trigger) @replay: scheduling of the effect (struct ff_replay) @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect, ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further defining effect parameters

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

Direction of the effect is encoded as follows: 0 deg -> 0x0000 (down) 90 deg -> 0x4000 (left) 180 deg -> 0x8000 (up) 270 deg -> 0xC000 (right)

Member Data Documentation

condition

struct ff_condition_effect ff_effect::condition[2]

constant

struct ff_constant_effect ff_effect::constant

direction

__u16 ff_effect::direction

haptic

struct ff_haptic_effect ff_effect::haptic

id

__s16 ff_effect::id

periodic

struct ff_periodic_effect ff_effect::periodic

ramp

struct ff_ramp_effect ff_effect::ramp

replay

struct ff_replay ff_effect::replay

rumble

struct ff_rumble_effect ff_effect::rumble

trigger

struct ff_trigger ff_effect::trigger

type

__u16 ff_effect::type

[union]

union { ... } ff_effect::u

---

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

• XenevaOS/BaseHdr/uapi/linux/input.h