IDirectSound3DListener8::GetRolloffFactor Method
[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetRolloffFactor method retrieves the rolloff factor, which determines the rate of attenuation over distance.
Syntax
HRESULT GetRolloffFactor(
D3DVALUE * pflRolloffFactor
)
Parameters
- pflRolloffFactor
Address of a variable that receives the rolloff factor. D3DVALUE is defined as float.
Return Value
If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.
Remarks
The rolloff factor has a range of DS3D_MINROLLOFFFACTOR (no rolloff) to DS3D_MAXROLLOFFFACTOR (defined as 10 times the rolloff found in the real world). The default value is DS3D_DEFAULTROLLOFFFACTOR (1.0). For more information, see Rolloff Factor.
Requirements
Header: Declared in DSound.h.
Library: Use Dsound3d.dll.