Microsoft DirectX 9.0 SDK Update (October 2004)

CustomForce Structure

Language:

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

Contains type-specific information for effects that are marked as DIEFT_CUSTOMFORCE.The structure describes a custom or user-defined force.A reference to a Dicustomforce structure for an effect is passed in the lpvTypeSpecificParams member of the Dieffect structure.

Definition

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

Members Table

Method Description
CustomForce Initializes a new instance of the object.
GetForceData
SetForceData
ToString Obtains a string representation of the current instance.
Property Description
Channels 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.
SamplePeriod Sample period, in microseconds.
Samples Total number of samples in the RglForceData. It must be an integral multiple of the CChannels.

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