Microsoft DirectX 9.0

DSFXFlanger

The DSFXFlanger structure contains parameters for a flange effect.

Syntax

typedef struct _DSFXFlanger {
  FLOAT  fWetDryMix;
  FLOAT  fDepth;
  FLOAT  fFeedback;
  FLOAT  fFrequency;
  LONG   lWaveform;
  FLOAT  fDelay;
  LONG   lPhase;
} DSFXFlanger, *LPDSFXFlanger;
 
typedef const DSFXFlanger *LPCDSFXFlanger;

Members

fWetDryMix

Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from DSFXFLANGER_WETDRYMIX_MIN through DSFXFLANGER_WETDRYMIX_MAX (all wet). The default value is 50.

fDepth

Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from DSFXFLANGER_DEPTH_MIN through DSFXFLANGER_DEPTH_MAX. The default value is 100.

fFeedback

Percentage of output signal to feed back into the effect's input, in the range from DSFXFLANGER_FEEDBACK_MIN to DSFXFLANGER_FEEDBACK_MAX. The default value is -50.

fFrequency

Frequency of the LFO, in the range from DSFXFLANGER_FREQUENCY_MIN to DSFXFLANGER_FREQUENCY_MAX. The default value is 0.25.

lWaveform

Waveform shape of the LFO. By default, the waveform is a sine. Possible values are defined in the following table.

Value Description
DSFXFLANGER_WAVE_TRIANGLE Triangle.
DSFXFLANGER_WAVE_SIN Sine.

fDelay

Number of milliseconds the input is delayed before it is played back, in the range from DSFXFLANGER_DELAY_MIN to DSFXFLANGER_DELAY_MAX. The default value is 2 ms.

lPhase

Phase differential between left and right LFOs, in the range from DSFXFLANGER_PHASE_MIN through DSFXFLANGER_PHASE_MAX. Possible values are defined in the following table.

Value
DSFXFLANGER_PHASE_NEG_180
DSFXFLANGER_PHASE_NEG_90
DSFXFLANGER_PHASE_ZERO
DSFXFLANGER_PHASE_90
DSFXFLANGER_PHASE_180

The default value is DSFXFLANGER_PHASE_ZERO.

Requirements

  Header: Declared in Dsound.h.

See Also