Microsoft DirectX 9.0

IDirectSound3DBuffer8::GetMaxDistance

The GetMaxDistance method retrieves the maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.

Syntax

HRESULT GetMaxDistance(
  D3DVALUE * pflMaxDistance 
);

Parameters

pflMaxDistance

Address of a variable that receives the maximum 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

The default maximum distance, defined as DS3D_DEFAULTMAXDISTANCE, is effectively infinite.

Requirements

  Header: Declared in dsound.h.

See Also