Microsoft DirectX 8.1 (C++)

DSEFFECTDESC

The DSEFFECTDESC structure describes an effect associated with a buffer.

Syntax

typedef struct _DSEFFECTDESC {
  DWORD      dwSize;
  DWORD      dwFlags;
  GUID       guidDSFXClass;
  DWORD_PTR  dwReserved1;
  DWORD_PTR  dwReserved2
} DSEFFECTDESC, *LPDSEFFECTDESC;
 
typedef const DSEFFECTDESC *LPCDSEFFECTDESC;

Members

dwSize

Size of the structure, in bytes.

dwFlags

Flags. Can be zero or one of the following values.

Value Description
DSFX_LOCHARDWARE Effect must be in hardware. If the effect is not available in hardware, IDirectSoundBuffer8::SetFX raises an error. Because DirectX 8.0 does not support hardware acceleration of effects, this flag should not be used.
DSFX_LOCSOFTWARE Effect must be in software, even if the hardware supports acceleration of guidDSFXClass. If the effect is not available in software, SetFX raises an error. In DirectX 8.0, all effects are in software regardless of whether this flag is set.

guidDSFXClass

Class identifier of the effect. The following standard effect classes are defined.

Value
GUID_DSFX_STANDARD_CHORUS
GUID_DSFX_STANDARD_COMPRESSOR
GUID_DSFX_STANDARD_DISTORTION
GUID_DSFX_STANDARD_ECHO
GUID_DSFX_STANDARD_FLANGER
GUID_DSFX_STANDARD_GARGLE
GUID_DSFX_STANDARD_I3DL2REVERB
GUID_DSFX_STANDARD_PARAMEQ
GUID_DSFX_WAVES_REVERB

dwReserved1

Reserved for future use.

dwReserved2

Reserved for future use.

Remarks

If dwFlags is zero, the effect is placed in hardware if possible. If the hardware does not support the effect, software is used. If the effect is not available at all, the call to SetFX fails.

An effect of class GUID_DSFX_WAVES_REVERB can be set only on a buffer that has a 16-bit audio format.

Requirements

  Header: Declared in Dsound.h.

See Also