The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument. More...
#include <soundeffect.h>
Inheritance diagram for FIFE::Autowah:
Collaboration diagram for FIFE::Autowah:
Public Member Functions | |
| Autowah () | |
| Constructor. More... | |
| void | setAttackTime (float value) |
| Sets attack time, the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal. More... | |
| float | getAttackTime () const |
| Return attack time. More... | |
| void | setReleaseTime (float value) |
| Sets relase time, the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends. More... | |
| float | getReleaseTime () const |
| Return release time. More... | |
| void | setResonance (float value) |
| Sets resonance, the peak, some times known as emphasis or Q, of the auto-wah band-pass filter. More... | |
| float | getResonance () const |
| Return resonance. More... | |
| void | setPeakGain (float value) |
| Sets peak gain, the input signal level at which the band-pass filter will be fully opened. More... | |
| float | getPeakGain () const |
| Return peak gain. More... | |
| Public Member Functions inherited from FIFE::SoundEffect | |
| SoundEffect () | |
| Constructor. More... | |
| virtual | ~SoundEffect () |
| Destructor. More... | |
| ALuint | getEffectId () const |
| Return the OpenAL effect handle. More... | |
| void | setSlotId (ALuint slot) |
| Sets the OpenAL auxiliary slot handle. More... | |
| ALuint | getSlotId () |
| Return the OpenAL auxiliary slot handle. More... | |
| SoundEffectType | getEffectType () const |
| Return sound effect type. More... | |
| void | setEnabled (bool enabled) |
| Enables or disables the effect. More... | |
| bool | isEnabled () const |
| Return true if the effect is enabled, false otherwise. More... | |
| void | setFilter (SoundFilter *filter) |
| Sets the additional sound filter. More... | |
| SoundFilter * | getFilter () |
| Return sound filter or NULL. More... | |
Private Attributes | |
| float | m_attackTime |
| float | m_releaseTime |
| float | m_resonance |
| float | m_peakGain |
Additional Inherited Members | |
| Protected Attributes inherited from FIFE::SoundEffect | |
| ALuint | m_effect |
| Effect object id. More... | |
| ALuint | m_slot |
| Effect slot id;. More... | |
| SoundEffectType | m_effectType |
| Sound effect type. More... | |
| bool | m_enabled |
| Effect enabled. More... | |
| SoundFilter * | m_filter |
| Additional filter effect. More... | |
Detailed Description
The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument.
Definition at line 732 of file soundeffect.h.
Constructor & Destructor Documentation
◆ Autowah()
| FIFE::Autowah::Autowah | ( | ) |
Constructor.
Definition at line 737 of file soundeffect.cpp.
References FIFE::alEffecti, FIFE::SoundEffect::m_effect, FIFE::SoundEffect::m_effectType, and FIFE::SE_EFFECT_AUTOWAH.
Member Function Documentation
◆ getAttackTime()
| float FIFE::Autowah::getAttackTime | ( | ) | const |
◆ getPeakGain()
| float FIFE::Autowah::getPeakGain | ( | ) | const |
◆ getReleaseTime()
| float FIFE::Autowah::getReleaseTime | ( | ) | const |
◆ getResonance()
| float FIFE::Autowah::getResonance | ( | ) | const |
◆ setAttackTime()
| void FIFE::Autowah::setAttackTime | ( | float | value | ) |
Sets attack time, the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal.
- Parameters
-
value Range 0.0001 to 1.0, default 0.06.
Definition at line 746 of file soundeffect.cpp.
References FIFE::alEffectf, m_attackTime, and FIFE::SoundEffect::m_effect.
◆ setPeakGain()
| void FIFE::Autowah::setPeakGain | ( | float | value | ) |
Sets peak gain, the input signal level at which the band-pass filter will be fully opened.
- Parameters
-
value Range 0.00003 to 31621.0, default 11.22.
Definition at line 779 of file soundeffect.cpp.
References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_peakGain.
◆ setReleaseTime()
| void FIFE::Autowah::setReleaseTime | ( | float | value | ) |
Sets relase time, the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends.
- Parameters
-
value Range 0.0001 to 1.0, default 0.06.
Definition at line 757 of file soundeffect.cpp.
References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_releaseTime.
◆ setResonance()
| void FIFE::Autowah::setResonance | ( | float | value | ) |
Sets resonance, the peak, some times known as emphasis or Q, of the auto-wah band-pass filter.
- Parameters
-
value Range 2.0 to 1000.0, default 1000.0.
Definition at line 768 of file soundeffect.cpp.
References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_resonance.
Member Data Documentation
◆ m_attackTime
|
private |
Definition at line 779 of file soundeffect.h.
Referenced by getAttackTime(), and setAttackTime().
◆ m_peakGain
|
private |
Definition at line 782 of file soundeffect.h.
Referenced by getPeakGain(), and setPeakGain().
◆ m_releaseTime
|
private |
Definition at line 780 of file soundeffect.h.
Referenced by getReleaseTime(), and setReleaseTime().
◆ m_resonance
|
private |
Definition at line 781 of file soundeffect.h.
Referenced by getResonance(), and setResonance().
The documentation for this class was generated from the following files:
- engine/core/audio/effects/soundeffect.h
- engine/core/audio/effects/soundeffect.cpp
