Listener3D.RolloffFactor Property (Microsoft.DirectX.DirectSound)

  • Article

Retrieves and sets the rolloff factor, which determines the rate of attenuation over distance.

Definition

Visual Basic Public Property RolloffFactor As Single
C# public float RolloffFactor { get; set; }
C++ public:
property float RolloffFactor {
        float get();
        void set(float value);
}
JScript public function get RolloffFactor() : float
public function set RolloffFactor(float);

Property Value

System.Single
The rolloff factor, which determines the rate of attenuation over distance.

This property is read/write. 

Remarks

The rolloff factor has a range of 0.0 (no rolloff) to 10.0 (ten times the rolloff found in the real world). The default value is 1.0.

The rolloff factor is global. To change the effect of distance for an individual sound buffer, you can set the minimum distance for the buffer.

Exceptions

ArgumentExceptionLeave Site

An invalid parameter was passed to the called method.