The environmental reverberation effect. More...

#include <soundeffect.h>

Inheritance diagram for FIFE::Reverb:

Collaboration diagram for FIFE::Reverb:

Public Member Functions
	Reverb ()
	Constructor. More...

void	setDensity (float value)
	Sets density, controls the coloration of the late reverb. More...

float	getDensity () const
	Return density value. More...

void	setDiffusion (float value)
	Sets diffusion, controls the echo density in the reverberation decay. More...

float	getDiffusion () const
	Return diffusion value. More...

void	setGain (float value)
	Sets gain, is the master volume control for the reflected sound. More...

float	getGain () const
	Return gain value. More...

void	setGainHf (float value)
	Sets gain hf, tweaks reflected sound by attenuating it at high frequencies. More...

float	getGainHf () const
	Return hf gain. More...

void	setDecayTime (float value)
	The reverberation decay time. More...

float	getDecayTime () const
	Return decay time. More...

void	setDecayHfRatio (float value)
	Sets decay hf ratio, the spectral quality of the Decay Time parameter. More...

float	getDecayHfRatio () const
	Return decay hf ratio. More...

void	setReflectionsGain (float value)
	Sets reflections gain, the overall amount of initial reflections relative to the Gain property. More...

float	getReflectionsGain () const
	Return reflections gain. More...

void	setReflectionsDelay (float value)
	Sets the reflections delay, the amount of delay between the arrival time of the direct path from the source to the first reflection from the source. More...

float	getReflectionsDelay () const
	Return reflections delay. More...

void	setLateReverbGain (float value)
	Sets late reverb gain, the overall amount of later reverberation relative to gain. More...

float	getLateReverbGain () const
	Return late reverb gain. More...

void	setLateReverbDelay (float value)
	Sets late reverb delay, the begin time of the late reverberation relative to the time of the initial reflection. More...

float	getLateReverbDelay () const
	Return late reverb delay. More...

void	setAirAbsorptionGainHf (float value)
	Sets air absorption gain hf, the distance-dependent attenuation at high frequencies caused by the propagation medium. More...

float	getAirAbsorptionGainHf () const
	Return air absorption gain hf. More...

void	setRoomRolloffFactor (float value)
	Sets room rolloff factor, similar to rolloff factor it attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance. More...

float	getRoomRolloffFactor () const
	Return room rolloff factor. More...

void	setDecayHfLimit (bool value)
	If decay hf limit is enabled, the high-frequency decay time automatically stays below a limit value that�s derived from the setting of Air Absorption HF. More...

bool	isDecayHfLimit () const
	Return if decay hf limit is enabled. 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_density

float	m_diffusion

float	m_gain

float	m_gainHf

float	m_decayTime

float	m_decayHfRatio

float	m_reflectionsGain

float	m_reflectionsDelay

float	m_lateReverbGain

float	m_lateReverbDelay

float	m_airAbsorptionGainHf

float	m_roomRolloffFactor

bool	m_decayHfLimit

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 environmental reverberation effect.

Definition at line 106 of file soundeffect.h.

Constructor & Destructor Documentation

◆ Reverb()

FIFE::Reverb::Reverb ( )

Constructor.

Definition at line 92 of file soundeffect.cpp.

References FIFE::alEffecti, FIFE::SoundEffect::m_effect, FIFE::SoundEffect::m_effectType, and FIFE::SE_EFFECT_REVERB.

Member Function Documentation

◆ getAirAbsorptionGainHf()

float FIFE::Reverb::getAirAbsorptionGainHf ( ) const

Return air absorption gain hf.

Definition at line 228 of file soundeffect.cpp.

References m_airAbsorptionGainHf.

◆ getDecayHfRatio()

float FIFE::Reverb::getDecayHfRatio ( ) const

Return decay hf ratio.

Definition at line 173 of file soundeffect.cpp.

References m_decayHfRatio.

◆ getDecayTime()

float FIFE::Reverb::getDecayTime ( ) const

Return decay time.

Definition at line 162 of file soundeffect.cpp.

References m_decayTime.

◆ getDensity()

float FIFE::Reverb::getDensity ( ) const

Return density value.

Definition at line 118 of file soundeffect.cpp.

References m_density.

◆ getDiffusion()

float FIFE::Reverb::getDiffusion ( ) const

Return diffusion value.

Definition at line 129 of file soundeffect.cpp.

References m_diffusion.

◆ getGain()

float FIFE::Reverb::getGain ( ) const

Return gain value.

Definition at line 140 of file soundeffect.cpp.

References m_gain.

◆ getGainHf()

float FIFE::Reverb::getGainHf ( ) const

Return hf gain.

Definition at line 151 of file soundeffect.cpp.

References m_gainHf.

◆ getLateReverbDelay()

float FIFE::Reverb::getLateReverbDelay ( ) const

Return late reverb delay.

Definition at line 217 of file soundeffect.cpp.

References m_reflectionsDelay.

◆ getLateReverbGain()

float FIFE::Reverb::getLateReverbGain ( ) const

Return late reverb gain.

Definition at line 206 of file soundeffect.cpp.

References m_lateReverbGain.

◆ getReflectionsDelay()

float FIFE::Reverb::getReflectionsDelay ( ) const

Return reflections delay.

Definition at line 195 of file soundeffect.cpp.

References m_reflectionsDelay.

◆ getReflectionsGain()

float FIFE::Reverb::getReflectionsGain ( ) const

Return reflections gain.

Definition at line 184 of file soundeffect.cpp.

References m_reflectionsGain.

◆ getRoomRolloffFactor()

float FIFE::Reverb::getRoomRolloffFactor ( ) const

Return room rolloff factor.

Definition at line 239 of file soundeffect.cpp.

References m_roomRolloffFactor.

◆ isDecayHfLimit()

bool FIFE::Reverb::isDecayHfLimit ( ) const

Return if decay hf limit is enabled.

Definition at line 248 of file soundeffect.cpp.

References m_decayHfLimit.

◆ setAirAbsorptionGainHf()

void FIFE::Reverb::setAirAbsorptionGainHf ( float value )

Sets air absorption gain hf, the distance-dependent attenuation at high frequencies caused by the propagation medium.

Parameters

value Range 0.892 to 1.0, default 0.994.

Definition at line 221 of file soundeffect.cpp.

References FIFE::alEffectf, m_airAbsorptionGainHf, and FIFE::SoundEffect::m_effect.

◆ setDecayHfLimit()

void FIFE::Reverb::setDecayHfLimit ( bool value )

If decay hf limit is enabled, the high-frequency decay time automatically stays below a limit value that�s derived from the setting of Air Absorption HF.

Parameters

value True or false. Default is true.

Definition at line 243 of file soundeffect.cpp.

References FIFE::alEffecti, m_decayHfLimit, and FIFE::SoundEffect::m_effect.

◆ setDecayHfRatio()

void FIFE::Reverb::setDecayHfRatio ( float value )

Sets decay hf ratio, the spectral quality of the Decay Time parameter.

It is the ratio of high-frequency decay time relative to the time set by Decay Time.

Parameters

value Range 0.1 to 2.0, default 0.83.

Definition at line 166 of file soundeffect.cpp.

References FIFE::alEffectf, m_decayHfRatio, and FIFE::SoundEffect::m_effect.

◆ setDecayTime()

void FIFE::Reverb::setDecayTime ( float value )

The reverberation decay time.

Parameters

value Range 0.0 to 20.0, default 1.49 seconds.

Definition at line 155 of file soundeffect.cpp.

References FIFE::alEffectf, m_decayTime, and FIFE::SoundEffect::m_effect.

◆ setDensity()

void FIFE::Reverb::setDensity ( float value )

Sets density, controls the coloration of the late reverb.

Lowering the value adds more coloration.

Parameters

value Range 0.0 to 1.0, default 1.0.

Definition at line 111 of file soundeffect.cpp.

References FIFE::alEffectf, m_density, and FIFE::SoundEffect::m_effect.

◆ setDiffusion()

void FIFE::Reverb::setDiffusion ( float value )

Sets diffusion, controls the echo density in the reverberation decay.

Parameters

value Range 0.0 to 1.0, default 1.0.

Definition at line 122 of file soundeffect.cpp.

References FIFE::alEffectf, m_diffusion, and FIFE::SoundEffect::m_effect.

◆ setGain()

void FIFE::Reverb::setGain ( float value )

Sets gain, is the master volume control for the reflected sound.

Parameters

value Range 0.0 to 1.0, default 0.32.

Definition at line 133 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_gain.

◆ setGainHf()

void FIFE::Reverb::setGainHf ( float value )

Sets gain hf, tweaks reflected sound by attenuating it at high frequencies.

Parameters

value Range 0.0 to 1.0, default 0.89.

Definition at line 144 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_gainHf.

◆ setLateReverbDelay()

void FIFE::Reverb::setLateReverbDelay ( float value )

Sets late reverb delay, the begin time of the late reverberation relative to the time of the initial reflection.

Parameters

value Range 0.0 to 0.1, default 0.011 seconds.

Definition at line 210 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_reflectionsDelay.

◆ setLateReverbGain()

void FIFE::Reverb::setLateReverbGain ( float value )

Sets late reverb gain, the overall amount of later reverberation relative to gain.

Parameters

value Range 0.0 to 10.0, default 1.26.

Definition at line 199 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_lateReverbGain.

◆ setReflectionsDelay()

void FIFE::Reverb::setReflectionsDelay ( float value )

Sets the reflections delay, the amount of delay between the arrival time of the direct path from the source to the first reflection from the source.

Parameters

value Range 0.0 to 0.3, default 0.007.

Definition at line 188 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_reflectionsDelay.

◆ setReflectionsGain()

void FIFE::Reverb::setReflectionsGain ( float value )

Sets reflections gain, the overall amount of initial reflections relative to the Gain property.

Parameters

value Range 0.0 to 3.16, default 0.05.

Definition at line 177 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_reflectionsGain.

◆ setRoomRolloffFactor()

void FIFE::Reverb::setRoomRolloffFactor ( float value )

Sets room rolloff factor, similar to rolloff factor it attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance.

Parameters

value Range 0.0 to 10.0, default 0.0.

Definition at line 232 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_roomRolloffFactor.

Member Data Documentation

◆ m_airAbsorptionGainHf

float FIFE::Reverb::m_airAbsorptionGainHf

private

Definition at line 248 of file soundeffect.h.

Referenced by getAirAbsorptionGainHf(), and setAirAbsorptionGainHf().

◆ m_decayHfLimit

bool FIFE::Reverb::m_decayHfLimit

private

Definition at line 250 of file soundeffect.h.

Referenced by isDecayHfLimit(), and setDecayHfLimit().

◆ m_decayHfRatio

float FIFE::Reverb::m_decayHfRatio

private

Definition at line 243 of file soundeffect.h.

Referenced by getDecayHfRatio(), and setDecayHfRatio().

◆ m_decayTime

float FIFE::Reverb::m_decayTime

private

Definition at line 242 of file soundeffect.h.

Referenced by getDecayTime(), and setDecayTime().

◆ m_density

float FIFE::Reverb::m_density

private

Definition at line 238 of file soundeffect.h.

Referenced by getDensity(), and setDensity().

◆ m_diffusion

float FIFE::Reverb::m_diffusion

private

Definition at line 239 of file soundeffect.h.

Referenced by getDiffusion(), and setDiffusion().

◆ m_gain

float FIFE::Reverb::m_gain

private

Definition at line 240 of file soundeffect.h.

Referenced by getGain(), and setGain().

◆ m_gainHf

float FIFE::Reverb::m_gainHf

private

Definition at line 241 of file soundeffect.h.

Referenced by getGainHf(), and setGainHf().

◆ m_lateReverbDelay

float FIFE::Reverb::m_lateReverbDelay

private

Definition at line 247 of file soundeffect.h.

◆ m_lateReverbGain

float FIFE::Reverb::m_lateReverbGain

private

Definition at line 246 of file soundeffect.h.

Referenced by getLateReverbGain(), and setLateReverbGain().

◆ m_reflectionsDelay

float FIFE::Reverb::m_reflectionsDelay

private

Definition at line 245 of file soundeffect.h.

Referenced by getLateReverbDelay(), getReflectionsDelay(), setLateReverbDelay(), and setReflectionsDelay().

◆ m_reflectionsGain

float FIFE::Reverb::m_reflectionsGain

private

Definition at line 244 of file soundeffect.h.

Referenced by getReflectionsGain(), and setReflectionsGain().

◆ m_roomRolloffFactor

float FIFE::Reverb::m_roomRolloffFactor

private

Definition at line 249 of file soundeffect.h.

Referenced by getRoomRolloffFactor(), and setRoomRolloffFactor().

The documentation for this class was generated from the following files:

engine/core/audio/effects/soundeffect.h
engine/core/audio/effects/soundeffect.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Reverb()

Member Function Documentation

◆ getAirAbsorptionGainHf()

◆ getDecayHfRatio()

◆ getDecayTime()

◆ getDensity()

◆ getDiffusion()

◆ getGain()

◆ getGainHf()

◆ getLateReverbDelay()

◆ getLateReverbGain()

◆ getReflectionsDelay()

◆ getReflectionsGain()

◆ getRoomRolloffFactor()

◆ isDecayHfLimit()

◆ setAirAbsorptionGainHf()

◆ setDecayHfLimit()

◆ setDecayHfRatio()

◆ setDecayTime()

◆ setDensity()

◆ setDiffusion()

◆ setGain()

◆ setGainHf()

◆ setLateReverbDelay()

◆ setLateReverbGain()

◆ setReflectionsDelay()

◆ setReflectionsGain()

◆ setRoomRolloffFactor()

Member Data Documentation

◆ m_airAbsorptionGainHf

◆ m_decayHfLimit

◆ m_decayHfRatio

◆ m_decayTime

◆ m_density

◆ m_diffusion

◆ m_gain

◆ m_gainHf

◆ m_lateReverbDelay

◆ m_lateReverbGain

◆ m_reflectionsDelay

◆ m_reflectionsGain

◆ m_roomRolloffFactor