Microsoft DirectX 9.0 SDK Update (October 2004)

Listener3D.RolloffFactor Property

Language:

Note: This documentation is preliminary and is subject to change.

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

Definition

Visual Basic .NET Public Property RolloffFactor As Single
C# public float RolloffFactor { get; set; }
Managed C++ public: __property float get_RolloffFactor();
public: __property void set_RolloffFactor(float);
JScript .NET 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
ArgumentException Leave Site An invalid parameter was passed to the called method.


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center