STRUCT FF_EFFECT

Section: Input Subsystem (9)
Updated: February 2011
Index Return to Main Contents

NAME

struct_ff_effect - defines force feedback effect

SYNOPSIS

struct ff_effect {
  __u16 type;
  __s16 id;
  __u16 direction;
  struct ff_trigger trigger;
  struct ff_replay replay;
  union u;
};

MEMBERS

type

: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING, FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)

: 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)

: effect-specific structure (one of ff_constant_effect, ff_ramp_effect, ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further defining effect parameters

DESCRIPTION

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