Microsoft DirectX 9.0

IDirectSound3DBuffer8::GetMinDistance

The GetMinDistance method retrieves the minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.

Syntax

HRESULT GetMinDistance(
  D3DVALUE * pflMinDistance 
);

Parameters

pflMinDistance

Address of a variable that receives the minimum distance, in meters by default. D3DVALUE is defined as float.

Return Values

If the method succeeds, the return value is DS_OK.

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

Remarks

By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).

Requirements

  Header: Declared in dsound.h.

See Also