Class DirectInputEffect

Inheritance

object

DXComObject

DirectInputEffect

Implements

IDisposable

Inherited Members

DXComObject.Handle

DXComObject.Dispose()

DXComObject.AddRef()

DXComObject.Release()

DXComObject.QueryInterface(in Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.DirectInput

Assembly: JeremyAnsel.DirectX.DirectInput.dll

Syntax

[SecurityCritical]
public class DirectInputEffect : DXComObject, IDisposable

Constructors

| Edit this page View Source

DirectInputEffect(nint, DirectInputEffectInfo)

Initializes a new instance of the DirectInputEffect class.

Declaration

public DirectInputEffect(nint comPtr, DirectInputEffectInfo infos)

Parameters

Type	Name	Description
nint	comPtr
DirectInputEffectInfo	infos

Fields

| Edit this page View Source

DirectInputEffectGuid

The interface GUID.

Declaration

public static readonly Guid DirectInputEffectGuid

Field Value

Type	Description
Guid

Properties

| Edit this page View Source

Infos

Declaration

public DirectInputEffectInfo Infos { get; }

Property Value

Type	Description
DirectInputEffectInfo

Methods

| Edit this page View Source

Download()

Declaration

public void Download()

| Edit this page View Source

GetEffectGuid()

Declaration

public Guid GetEffectGuid()

Returns

Type	Description
Guid

| Edit this page View Source

GetEffectStatus()

Declaration

public DirectInputEffectStatus GetEffectStatus()

Returns

Type	Description
DirectInputEffectStatus

Exceptions

Type	Condition
ObjectDisposedException

| Edit this page View Source

GetParameters(DirectInputEffectParameterOptions)

Declaration

public DirectInputEffectParametersData GetParameters(DirectInputEffectParameterOptions options)

Parameters

Type	Name	Description
DirectInputEffectParameterOptions	options

Returns

Type	Description
DirectInputEffectParametersData

| Edit this page View Source

SetParameters(DirectInputEffectParametersData, DirectInputEffectParameterOptions)

Declaration

public void SetParameters(DirectInputEffectParametersData peff, DirectInputEffectParameterOptions options)

Parameters

Type	Name	Description
DirectInputEffectParametersData	peff
DirectInputEffectParameterOptions	options

Exceptions

Type	Condition
ObjectDisposedException

| Edit this page View Source

Start(int, DirectInputEffectStartOptions)

Declaration

public void Start(int iterations, DirectInputEffectStartOptions options)

Parameters

Type	Name	Description
int	iterations
DirectInputEffectStartOptions	options

Exceptions

Type	Condition
ObjectDisposedException

| Edit this page View Source

Stop()

Declaration

public void Stop()

| Edit this page View Source

Unload()

Declaration

public void Unload()

Exceptions

Type	Condition
ObjectDisposedException

Implements

IDisposable