Microsoft DirectX 8.1 (Visual Basic)

DIPERIODICFORCE

Describes parameters for a periodic force in the DIEFFECT type.

Type DIPERIODICFORCE
    lOffset As Long
    lMagnitude As Long
    lPeriod As Long
    lPhase As Long
End Type

Members

lOffset
The offset of the effect. The range of forces generated by the effect will be lOffset - lMagnitude to lOffset + lMagnitude. The value of the lOffset member is also the baseline for any envelope that is applied to the effect.
lMagnitude
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.
lPeriod
The period of the effect, in microseconds.
lPhase
The position in the cycle of the periodic effect at which playback begins, in the range 0 to 35,999. See Remarks.

Remarks

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