Public Member Functions | |
| cEffect (cEFXFunctions *oALFunctions) | |
| virtual const EffectTypes & | getType () const |
| Returns the current type this effect object is set to. | |
| virtual void | setType (const EffectTypes &type) |
| Sets the type of this effect object. | |
|
virtual const sEAXReverbParameters & | getEAXReverbParameters () const |
| Returns the current parameters for the EAX Reverb Effect. | |
| virtual void | setEAXReverbParameters (const sEAXReverbParameters ¶m) |
| Sets the parameters for the EAX Reverb Effect. | |
| virtual const sReverbParameters & | getReverbParameters () const |
| Returns the current parameters for the Reverb Effect. | |
| virtual void | setReverbParameters (const sReverbParameters ¶m) |
| Sets the parameters for the Reverb Effect. | |
| virtual const sChorusParameters & | getChorusParameters () const |
| Returns the current parameters for the Chorus Effect. | |
| virtual void | setChorusParameters (const sChorusParameters ¶m) |
| Sets the parameters for the Chorus Effect. | |
|
virtual const sDistortionParameters & | getDistortionParameters () const |
| Returns the current parameters for the Distortion Effect. | |
| virtual void | setDistortionParameters (const sDistortionParameters ¶m) |
| Sets the parameters for the Distortion Effect. | |
| virtual const sEchoParameters & | getEchoParameters () const |
| Returns the current parameters for the Echo Effect. | |
| virtual void | setEchoParameters (const sEchoParameters ¶m) |
| Sets the parameters for the Echo Effect. | |
| virtual const sFlangerParameters & | getFlangerParameters () const |
| Returns the current parameters for the Flanger Effect. | |
| virtual void | setFlangerParameters (const sFlangerParameters ¶m) |
| Sets the parameters for the Flanger Effect. | |
|
virtual const sFrequencyShiftParameters & | getFrequencyShiftParameters () const |
| Returns the current parameters for the Frequency Shift Effect. | |
| virtual void | setFrequencyShiftParameters (const sFrequencyShiftParameters ¶m) |
| Sets the parameters for the Frequency Shift Effect. | |
|
virtual const sVocalMorpherParameters & | getVocalMorpherParameters () const |
| Returns the current parameters for the Vocal Morpher Effect. | |
| virtual void | setVocalMorpherParameters (const sVocalMorpherParameters ¶m) |
| Sets the parameters for the Vocal Morpher Effect. | |
|
virtual const sPitchShifterParameters & | getPitchShifterParameters () const |
| Returns the current parameters for the Pitch Shifter Effect. | |
| virtual void | setPitchShifterParameters (const sPitchShifterParameters ¶m) |
| Sets the parameters for the Pitch Shifter Effect. | |
|
virtual const sRingModulatorParameters & | getRingModulatorParameters () const |
| Returns the current parameters for the Ring Modulator Effect. | |
| virtual void | setRingModulatorParameters (const sRingModulatorParameters ¶m) |
| Sets the parameters for the Ring Modulator Effect. | |
| virtual const sAutowahParameters & | getAutowahParameters () const |
| Returns the current parameters for the Autowah Effect. | |
| virtual void | setAutowahParameters (const sAutowahParameters ¶m) |
| Sets the parameters for the Autowah Effect. | |
|
virtual const sCompressorParameters & | getCompressorParameters () const |
| Returns the current parameters for the Compressor Effect. | |
| virtual void | setCompressorParameters (const sCompressorParameters ¶m) |
| Sets the parameters for the Compressor Effect. | |
|
virtual const sEqualizerParameters & | getEqualizerParameters () const |
| Returns the current parameters for the Equalizer Effect. | |
| virtual void | setEqualizerParameters (const sEqualizerParameters ¶m) |
| Sets the parameters for the Equalizer Effect. | |
| virtual float | getMasterVolume () const |
| Returns the master volume for this effect. | |
| virtual void | setMasterVolume (const float &volume) |
| Sets the master volume for this effect. | |
| virtual bool | isIgnoringAttenuation () const |
| Returns if the effect for each attached source is attenuated by distance. | |
| virtual void | ignoreAttenuation (const bool &ignore) |
| Sets whether the effect for each attached source is attenuated by distance. | |
| virtual IFilter * | getFilter () const |
| Returns the attached filter to this audio effect. | |
| virtual void | attachFilter (IFilter *filter) |
| Attaches a filter to this effect. | |
| virtual void | removeFilter () |
| Removes the currently attached filter. | |
| virtual unsigned int | getLastUpdated () const |
| Returns a timestamp indicating the last time settings on this effect were changed. Used internally by the engine to update attached sources. | |
| virtual bool | isValid () const |
| Returns if this effect is ready to be used or if it has encountered a fatal error. | |
| ALuint | getOpenALEffect () const |
| ALuint | getOpenALEffectSlot () const |
Definition at line 19 of file cEffect.h.
| void cAudio::cEffect::attachFilter | ( | IFilter * | filter | ) | [virtual] |
Attaches a filter to this effect.
| filter,: | A Pointer to the filter to attach. |
Implements cAudio::IEffect.
Definition at line 279 of file cEffect.cpp.
| float cAudio::cEffect::getMasterVolume | ( | ) | const [virtual] |
Returns the master volume for this effect.
This volume scales the amount of effect audible from all attached sources.
Implements cAudio::IEffect.
Definition at line 250 of file cEffect.cpp.
| void cAudio::cEffect::ignoreAttenuation | ( | const bool & | ignore | ) | [virtual] |
Sets whether the effect for each attached source is attenuated by distance.
If set to true, can cause some interesting and non-realistic effects, so be careful with it.
| ignore,: | Whether to ignore attenuation. |
Implements cAudio::IEffect.
Definition at line 267 of file cEffect.cpp.
| void cAudio::cEffect::setAutowahParameters | ( | const sAutowahParameters & | param | ) | [virtual] |
Sets the parameters for the Autowah Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 219 of file cEffect.cpp.
| void cAudio::cEffect::setChorusParameters | ( | const sChorusParameters & | param | ) | [virtual] |
Sets the parameters for the Chorus Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 123 of file cEffect.cpp.
| void cAudio::cEffect::setCompressorParameters | ( | const sCompressorParameters & | param | ) | [virtual] |
Sets the parameters for the Compressor Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 231 of file cEffect.cpp.
| void cAudio::cEffect::setDistortionParameters | ( | const sDistortionParameters & | param | ) | [virtual] |
Sets the parameters for the Distortion Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 135 of file cEffect.cpp.
| void cAudio::cEffect::setEAXReverbParameters | ( | const sEAXReverbParameters & | param | ) | [virtual] |
Sets the parameters for the EAX Reverb Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 99 of file cEffect.cpp.
| void cAudio::cEffect::setEchoParameters | ( | const sEchoParameters & | param | ) | [virtual] |
Sets the parameters for the Echo Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 147 of file cEffect.cpp.
| void cAudio::cEffect::setEqualizerParameters | ( | const sEqualizerParameters & | param | ) | [virtual] |
Sets the parameters for the Equalizer Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 243 of file cEffect.cpp.
| void cAudio::cEffect::setFlangerParameters | ( | const sFlangerParameters & | param | ) | [virtual] |
Sets the parameters for the Flanger Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 159 of file cEffect.cpp.
| void cAudio::cEffect::setFrequencyShiftParameters | ( | const sFrequencyShiftParameters & | param | ) | [virtual] |
Sets the parameters for the Frequency Shift Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 171 of file cEffect.cpp.
| void cAudio::cEffect::setMasterVolume | ( | const float & | volume | ) | [virtual] |
Sets the master volume for this effect.
This volume scales the amount of effect audible from all attached sources.
| volume,: | Volume to set the master volume to. 1.0f equal no volume change. Range: 0.0f to 1.0. |
Implements cAudio::IEffect.
Definition at line 255 of file cEffect.cpp.
| void cAudio::cEffect::setPitchShifterParameters | ( | const sPitchShifterParameters & | param | ) | [virtual] |
Sets the parameters for the Pitch Shifter Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 195 of file cEffect.cpp.
| void cAudio::cEffect::setReverbParameters | ( | const sReverbParameters & | param | ) | [virtual] |
Sets the parameters for the Reverb Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 111 of file cEffect.cpp.
| void cAudio::cEffect::setRingModulatorParameters | ( | const sRingModulatorParameters & | param | ) | [virtual] |
Sets the parameters for the Ring Modulator Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 207 of file cEffect.cpp.
| void cAudio::cEffect::setType | ( | const EffectTypes & | type | ) | [virtual] |
Sets the type of this effect object.
| type,: | Type of effect to switch to. |
Implements cAudio::IEffect.
Definition at line 87 of file cEffect.cpp.
| void cAudio::cEffect::setVocalMorpherParameters | ( | const sVocalMorpherParameters & | param | ) | [virtual] |
Sets the parameters for the Vocal Morpher Effect.
| param,: | Parameter struct to set this effect to. |
Implements cAudio::IEffect.
Definition at line 183 of file cEffect.cpp.
1.6.2
