Microsoft DirectX 9.0 SDK Update (October 2004)

EffectsDistortion Structure

Language:

Note: This documentation is preliminary and is subject to change.
How Do I...?

Contains parameters for a distortion effect.

Definition

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

Members Table

Method Description
EffectsDistortion Initializes a new instance of the EffectsDistortion structure.
ToString Obtains a string representation of the current instance.
Property Description
Edge Retrieves and sets the percentage of distortion intensity, in the EffectsDistortion structure.
Gain Retrieves and sets the amount of signal change after distortion, in the EffectsDistortion structure.
PostEqBandwidth Retrieves and sets the width of frequency band that determines range of harmonic content addition, in the EffectsDistortion structure.
PostEqCenterFrequency Retrieves and sets the center frequency of harmonic content addition, in the EffectsDistortion structure.
PreLowpassCutoff Retrieves and sets the filter cutoff for high-frequency harmonics attenuation, in the EffectsDistortion structure.

How Do I...?

Use Effect Parameters

This C# example demonstrates how to use the parameters of an effect object from a SecondaryBuffer object.

The buffer object in this code snippet is assumed to be the SecondaryBuffer from the code in Add Effects to a SecondaryBuffer Object.

              [C#]
              
//Retrieve the effects object and //the effect param sturctures and edit parameters. EchoEffect echo = (EchoEffect)buffer.GetEffects(0); EffectsEcho echo_params = echo.AllParameters; echo_params.LeftDelay = 250.0f; echo_params.RightDelay = 100.0f; echo_params.Feedback = 85.0f; echo_params.PanDelay = 1; echo_params.WetDryMix = 50.0f; ChorusEffect chorus = (ChorusEffect)buffer.GetEffects(1); EffectsChorus chorus_params = chorus.AllParameters; chorus_params.Delay = 15.0f; chorus_params.Depth = ChorusEffect.DepthMax; chorus_params.Phase = ChorusEffect.PhaseNegative90; chorus_params.Waveform = ChorusEffect.WaveSin; chorus_params.WetDryMix = 50.0f; //Set the new parameters and play the buffer. echo.AllParameters = echo_params; chorus.AllParameters = chorus_params; buffer.Play(0,BufferPlayFlags.Default);

Structure Information

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

See Also


© 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