Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioEffectFilter

Inherits: AudioEffect < Resource < RefCounted < Object

Inherited By: AudioEffectBandLimitFilter, AudioEffectBandPassFilter, AudioEffectHighPassFilter, AudioEffectHighShelfFilter, AudioEffectLowPassFilter, AudioEffectLowShelfFilter, AudioEffectNotchFilter

Adds a filter to the audio bus.

描述

Allows frequencies other than the cutoff_hz to pass.

教程

属性

float

cutoff_hz

2000.0

FilterDB

db

0

float

gain

1.0

float

resonance

0.5

Enumerations

enum FilterDB:

FilterDB FILTER_6DB = 0

FilterDB FILTER_12DB = 1

FilterDB FILTER_18DB = 2

FilterDB FILTER_24DB = 3

Property Descriptions

float cutoff_hz = 2000.0

  • void set_cutoff ( float value )

  • float get_cutoff ( )

Threshold frequency for the filter, in Hz.

FilterDB db = 0

There is currently no description for this property. Please help us by contributing one!

float gain = 1.0

  • void set_gain ( float value )

  • float get_gain ( )

Gain amount of the frequencies after the filter.

float resonance = 0.5

  • void set_resonance ( float value )

  • float get_resonance ( )

Amount of boost in the frequency range near the cutoff frequency.