EffectInformation Structure (Microsoft.DirectX.DirectInput)

Article
06/29/2006

Used by the Inputdevice9Enumeffects and Inputdevice9Geteffectinfo methods to return information about a particular effect supported by a device.

Definition

Visual Basic Public Structure EffectInformation

C# public struct EffectInformation

C++ public value class EffectInformation sealed

JScript In JScript, you can use structures, but you cannot define your own.

Members Table

The following table lists the members exposed by the object.

Methods

Method Description

EffectInformation Initializes a new instance of the object.

ToString Obtains a string representation of the current instance.

Properties

Property Description

DynamicParams Zero or more DIEP_* values denoting parameters of the effect that can be modified while the effect is playing. For a list of possible values, see InputeffectGetparameters. If an application attempts to change a parameter while the effect is playing and the driver does not support modifying that effect dynamically, the driver is permitted to stop the effect, update the parameters, then restart it. For more information, see InputeffectSetparameters.

EffectGuid Identifier of the effect.

EffectType Zero or more of the following values:

Name Name of the effect, for example, 'Sawtooth up' or 'Constant force'.

StaticParams Zero or more DIEP_* values describing the parameters supported by the effect. For example, if DIEP_ENVELOPE is set, the effect supports an envelope. For a list of possible values, see InputeffectGetparameters. It is not an error for an application to attempt to use effect parameters that are not supported by the device. The unsupported parameters are ignored.This information is provided to enable the application to tailor its use of force feedback to the capabilities of the specific device.

Method	Description
EffectInformation	Initializes a new instance of the object.
ToString	Obtains a string representation of the current instance.

Property	Description
DynamicParams	Zero or more DIEP_* values denoting parameters of the effect that can be modified while the effect is playing. For a list of possible values, see InputeffectGetparameters. If an application attempts to change a parameter while the effect is playing and the driver does not support modifying that effect dynamically, the driver is permitted to stop the effect, update the parameters, then restart it. For more information, see InputeffectSetparameters.
EffectGuid	Identifier of the effect.
EffectType	Zero or more of the following values:
Name	Name of the effect, for example, 'Sawtooth up' or 'Constant force'.
StaticParams	Zero or more DIEP_* values describing the parameters supported by the effect. For example, if DIEP_ENVELOPE is set, the effect supports an envelope. For a list of possible values, see InputeffectGetparameters. It is not an error for an application to attempt to use effect parameters that are not supported by the device. The unsupported parameters are ignored.This information is provided to enable the application to tailor its use of force feedback to the capabilities of the specific device.

Structure Information

Namespace Microsoft.DirectX.DirectInput

Assembly Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)

Strong Name Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Visual Basic	Public Structure EffectInformation
C#	public struct EffectInformation
C++	public value class EffectInformation sealed
JScript	In JScript, you can use structures, but you cannot define your own.

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

EffectInformation Structure (Microsoft.DirectX.DirectInput)

Additional resources