Microsoft DirectX 8.1 (C++)

IDirectSound3DListener8::GetDopplerFactor

The GetDopplerFactor method retrieves the Doppler effect factor.

Syntax

HRESULT GetDopplerFactor(
  D3DVALUE * pflDopplerFactor 
);

Parameters

pflDopplerFactor

Address of a variable that receives the Doppler factor value. D3DVALUE is defined as float in D3dtypes.h.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Remarks

The Doppler factor has a range of DS3D_MINDOPPLERFACTOR (no Doppler effects) to DS3D_MAXDOPPLERFACTOR (as currently defined, 10 times the Doppler effects found in the real world). The default value is DS3D_DEFAULTDOPPLERFACTOR (1.0). For more information, see Doppler Factor.

Requirements

  Header: Declared in dsound.h.

See Also