carta
struct_ff_periodic_effect(9)

struct_ff_periodic_effect9

Defines parameters of a periodic force-feedback effect

Usage

__u16 waveform;

__u16 period;

__s16 magnitude;

__s16 offset;

__u16 phase;

struct ff_envelope envelope;

__u32 custom_len;

__s16 __user * custom_data;

Members

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)

Overview

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.

History

  • Debian 7 (Wheezy): the text shown here
  • Debian 6.0 (Squeeze)
  • Debian 5.0 (Lenny)
  • Debian 4.0 (Etch)

From linux-manual-3.2 3.2.78-1 in Debian 7 (Wheezy). Parsed by carta from the page's man source.