Microsoft DirectX 9.0 SDK Update (October 2004)

Periodic Structure

Language:

Note: This documentation is preliminary and is subject to change.

Contains type-specific information for effects that are marked as DIEFT_PERIODIC.The structure describes a periodic effect.A reference to a single Diperiodic structure for an effect is passed in the lpvTypeSpecificParams member of the Dieffect structure.

Definition

Visual Basic .NET Public Structure Periodic
C# public struct Periodic
Managed C++ public __value struct Periodic
JScript .NET In JScript .NET, you can use structures, but you cannot define your own.

Members Table

Method Description
Periodic Initializes a new instance of the object.
ToString Obtains a string representation of the current instance.
Property Description
Magnitude Magnitude of the effect, in the range from 0 through 10,000. If an TermEnvelope is applied to this effect, the value represents the magnitude of the TermSustain. If no envelope is applied, the value represents the amplitude of the entire effect.
Offset Offset of the effect. The range of forces generated by the effect is LOffset minus DwMagnitude to LOffset plus DwMagnitude. The value of the LOffset member is also the baseline for any envelope that is applied to the effect.
Period Period of the effect, in microseconds.
Phase Position in the cycle of the periodic effect at which playback begins, in the range from 0 through 35,999. See Remarks.

Structure Information

Namespace Microsoft.DirectX.DirectInput
Assembly Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)
Strong Name Microsoft.DirectX.DirectInput,  Version=1.0.2902.0,  Culture=neutral,  PublicKeyToken=31bf3856ad364e35

© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center