EffectObject Class

Language:

Applications use the methods of the EffectObject to manage effects of force-feedback devices.

Definition

Visual Basic Public Class EffectObject
Inherits MarshalByRefObject
Implements IDisposable

C# public class EffectObject : MarshalByRefObject, IDisposable

C++ public ref class EffectObject : MarshalByRefObject, IDisposable

JScript public class EffectObject extends MarshalByRefObject implements IDisposable

Visual Basic	Public Class EffectObject Inherits MarshalByRefObject Implements IDisposable
C#	public class EffectObject : MarshalByRefObject, IDisposable
C++	public ref class EffectObject : MarshalByRefObject, IDisposable
JScript	public class EffectObject extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Methods

Method Description

Dispose Immediately releases the unmanaged resources used by an object.

Download Places the effect on the device. If the effect is already on the device, the existing effect is updated to match the values set by the method.

EffectObject Initializes a new instance of the object.

Equals Returns a value that indicates whether the current instance is equal to a specified object.

Finalize Called during garbage collection. If implemented, allows an object to free resources before it is destroyed by the garbage collector.

GetHashCode Returns the hash code for the current instance.

GetParameters Retrieves information about an effect.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different.

SendHardwareCommand Sends a hardware-specific command to the driver.

SetParameters Sets the characteristics of an effect.

Start Begins playing an effect. If the effect is already playing, it is restarted from the beginning. If the effect has not been downloaded or has been modified since its last download, it is downloaded before being started. This default behavior can be suppressed by passing the DIES_NODOWNLOAD flag.

Stop Stops playing an effect.

Unload Removes the effect from the device. If the effect is playing, it is automatically stopped before it is unloaded.

Properties

Property Description

EffectGuid Retrieves the GUID for the effect represented by the Inputeffect object.

EffectStatus Retrieves the status of an effect.

Method	Description
Dispose	Immediately releases the unmanaged resources used by an object.
Download	Places the effect on the device. If the effect is already on the device, the existing effect is updated to match the values set by the method.
EffectObject	Initializes a new instance of the object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Called during garbage collection. If implemented, allows an object to free resources before it is destroyed by the garbage collector.
GetHashCode	Returns the hash code for the current instance.
GetParameters	Retrieves information about an effect.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
SendHardwareCommand	Sends a hardware-specific command to the driver.
SetParameters	Sets the characteristics of an effect.
Start	Begins playing an effect. If the effect is already playing, it is restarted from the beginning. If the effect has not been downloaded or has been modified since its last download, it is downloaded before being started. This default behavior can be suppressed by passing the DIES_NODOWNLOAD flag.
Stop	Stops playing an effect.
Unload	Removes the effect from the device. If the effect is playing, it is automatically stopped before it is unloaded.

Property	Description
EffectGuid	Retrieves the GUID for the effect represented by the Inputeffect object.
EffectStatus	Retrieves the status of an effect.

Inheritance Hierarchy

Object
MarshalByRefObject
EffectObject

Class 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

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

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