Class: FMOD::ChannelControl::DistanceFilter

Inherits:

Struct

• Object
• Struct
• FMOD::ChannelControl::DistanceFilter

Defined in:

lib/fmod/channel_control.rb

Overview

The settings for the 3D distance filter properties.

Instance Attribute Summary

• #custom ⇒ Boolean

  The enabled/disabled state of the FMOD distance rolloff calculation.

• #frequency ⇒ Float

  The center frequency in Hz for the high-pass filter used to simulate distance attenuation, from 10.0 to 22050.0.

• #level ⇒ Float

  The manual user attenuation, where 1.0 is no attenuation and 0.0 is complete attenuation.

Instance Attribute Details

#custom ⇒ Boolean

The enabled/disabled state of the FMOD distance rolloff calculation. Default is false.

Returns:

• (Boolean) —

  the current value of custom

# File 'lib/fmod/channel_control.rb', line 191

def custom
  @custom
end

#frequency ⇒ Float

The center frequency in Hz for the high-pass filter used to simulate distance attenuation, from 10.0 to 22050.0. Default is 1500.0.

Returns:

• (Float) —

  the current value of frequency

# File 'lib/fmod/channel_control.rb', line 191

def frequency
  @frequency
end

#level ⇒ Float

The manual user attenuation, where 1.0 is no attenuation and 0.0 is complete attenuation. Default is 1.0.

Returns:

• (Float) —

  the current value of level

# File 'lib/fmod/channel_control.rb', line 191

def level
  @level
end