DICUSTOMFORCE

Contains type-specific information for effects that are marked as DIEFT_CUSTOMFORCE.

The structure describes a custom or user-defined force.

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

typedef struct DICUSTOMFORCE { 
    DWORD  cChannels; 
    DWORD  dwSamplePeriod; 
    DWORD  cSamples; 
    LPLONG rglForceData; 
} DICUSTOMFORCE, *LPDICUSTOMFORCE; 
 
typedef const DICUSTOMFORCE *LPCDICUSTOMFORCE;

Members

cChannels

Number of channels (axes) affected by this force.

The first channel is applied to the first axis associated with the effect, the second to the second, and so on. If there are fewer channels than axes, nothing is associated with the extra axes.

If there is only a single channel, the effect is rotated in the direction specified by the rglDirection member of the DIEFFECT structure. If there is more than one channel, rotation is not allowed.

Not all devices support rotation of custom effects.

dwSamplePeriod

Sample period, in microseconds.

cSamples

Total number of samples in the rglForceData. It must be an integral multiple of the cChannels.

rglForceData

Pointer to an array of force values representing the custom force. If multiple channels are provided, the values are interleaved. For example, if cChannels is 3, the first element of the array belongs to the first channel, the second to the second, and the third to the third.

Requirements

  Windows NT/2000/XP: Requires Windows 2000.
  Windows 98/Me: Requires Windows 98 or later. Available as a redistributable for Windows 98.
  Header: Declared in Dinput.h.