Platform SDK: DirectX

DirectSound3DListener.GetRolloffFactor

The DirectSound3DListener.GetRolloffFactor method retrieves the rolloff factor, which controls the rate of attenuation over distance.

object.GetRolloffFactor() As Single

Parameters

object
Object expression that resolves to a DirectSound3DListener object.

Return Values

If the method succeeds, the rolloff factor value is returned.

Error Codes

If the method fails, an error is raised and Err.Number may be set to DSERR_INVALIDPARAM.

Remarks

The rolloff factor has a range of DS3D_MINROLLOFFFACTOR (no rolloff) to DS3D_MAXROLLOFFFACTOR (10 times the rolloff found in the real world). The default value is DS3D_DEFAULTROLLOFFFACTOR (1.0).

See Also

DirectSound3DListener.SetRolloffFactor