Class: FMOD::Effects::ITLowPass

Inherits:
Dsp
  • Object
show all
Defined in:
lib/fmod/effects/it_lowpass.rb

Overview

Note:

This filter actually has a limited cutoff frequency below the specified maximum, due to its limited design, so for a more open range filter use LowPass or if you don’t mind not having resonance, LowPassSimple.

The effective maximum cutoff is about 8060hz.

This unit filters sound using a resonant low-pass filter algorithm that is used in Impulse Tracker, but with limited cutoff range (0 to 8060hz).

This is different to the default LowPass filter in that it uses a different quality algorithm and is the filter used to produce the correct sounding playback in .IT files.

FMOD Studio’s .IT playback uses this filter.

Instance Attribute Summary collapse

Attributes inherited from Dsp

#active, #bypass, #channel_format, #input_count, #output_count, #parameter_count, #parent, #type, #wet_dry_mix

Attributes inherited from Handle

#user_data

Method Summary

Methods inherited from Dsp

#[], #[]=, #add_input, bool_param, data_param, #disconnect, #disconnect_from, #enable_metering, float_param, from_handle, #get_bool, #get_data, #get_float, #get_integer, #idle?, #info, #input, #input_connection, #input_metering?, integer_param, #name, #output, #output_connection, #output_format, #output_metering?, #param_info, #play, #reset, #set_bool, #set_data, #set_float, #set_integer, #set_wet_dry_mix, #show_dialog, #to_s, type_map, #version

Methods inherited from Handle

#initialize, #int_ptr, #release, #to_s

Constructor Details

This class inherits a constructor from FMOD::Handle

Instance Attribute Details

#cutoff ⇒ Float

Low-pass cutoff frequency in Hz.

  • Minimum: 1.0

  • Maximum: 22000.0

  • Default: 5000.0

Returns:

  • (Float) —

    the current value of cutoff



31
32
33
 
# File 'lib/fmod/effects/it_lowpass.rb', line 31

def cutoff
  @cutoff
end

#resonance ⇒ Float

Low-pass resonance Q value.

  • Minimum: 0.0

  • Maximum: 127.0

  • Default: 1.0

Returns:

  • (Float) —

    the current value of resonance



31
32
33
 
# File 'lib/fmod/effects/it_lowpass.rb', line 31

def resonance
  @resonance
end