Microsoft DirectX 8.0 (C++)

IDirectSound3DListener8::SetDistanceFactor

Sets the distance factor, which is the number of meters in a vector unit.

HRESULT SetDistanceFactor(
  D3DVALUE flDistanceFactor, 
  DWORD dwApply 
);

Parameters

flDistanceFactor
Value that specifies the distance factor.
dwApply
Value that specifies when the setting should be applied. This value must be one of the following:
DS3D_DEFERRED
Settings are not applied until the application calls the IDirectSound3DListener8::CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.
DS3D_IMMEDIATE
Settings are applied immediately, causing the system to recalculate the 3-D coordinates for all 3-D sound buffers.

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 distance factor has a range of DS3D_MINDISTANCEFACTOR to DS3D_MAXDISTANCEFACTOR, defined in Dsound.h as FLT_MIN and FLT_MAX respectively. The default value is DS3D_DEFAULTDISTANCEFACTOR, or 1.0.

Requirements

  Header: Declared in dsound.h.

See Also

IDirectSound3DListener8::GetDistanceFactor, Distance Factor