DIPERIODIC

The DIPERIODIC structure contains type-specific information for effects that are marked as DIEFT_PERIODIC.

The structure describes a periodic effect.

A pointer to a single DIPERIODIC structure for an effect is passed in the lpvTypeSpecificParams member of the DIEFFECT structure.

typedef struct { 
    DWORD dwMagnitude; 
    LONG lOffset; 
    DWORD dwPhase; 
    DWORD dwPeriod; 
} DIPERIODIC, *LPDIPERIODIC; 
 
typedef const DIPERIODIC *LPCDIPERIODIC;
 

Members

dwMagnitude

The magnitude of the effect, in the range 0 to 10,000. If an envelope is applied to this effect, then the value represents the magnitude of the sustain. If no envelope is applied, then the value represents the amplitude of the entire effect.

lOffset

The offset of the effect. The range of forces generated by the effect will be lOffset - dwMagnitude to lOffset + dwMagnitude. The value of the lOffset member is also the baseline for any envelope that is applied to the effect.

dwPhase

The position in the cycle of the periodic effect at which playback begins, in the range 0 to 35,999. See Remarks.

dwPeriod

The period of the effect in microseconds.

Remarks

A device driver may not provide support for all values in the dwPhase member. In this case the value will be rounded off to the nearest supported value.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in dinput.h.