Listener3D.DistanceFactor Property (Microsoft.DirectX.DirectSound)

  • Article

Retrieves or sets the distance factor, which is the number of meters in a vector unit.

Definition

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

Property Value

System.Single
The distance factor, which is the number of meters in a vector unit.

This property is read/write. 

Remarks

Can range from Listener3D.DistanceFactorMin to Listener3D.DistanceFactorMax.

The default value is 1 meter or Listener3D.DistanceFactorDefault.

Exceptions

ArgumentExceptionLeave Site

An invalid parameter was passed to the called method.