cAudio::cFilter Class Reference

Inheritance diagram for cAudio::cFilter:
Inheritance graph
[legend]
Collaboration diagram for cAudio::cFilter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 cFilter (cEFXFunctions *oALFunctions)
virtual const FilterTypesgetType () const
 Returns the type of the filter.
virtual void setType (const FilterTypes &type)
 Sets the type of this filter.
virtual float getVolume () const
 Returns the master volume of this filter.
virtual void setVolume (const float &volume)
 Sets the master volume of this filter.
virtual float getLowFrequencyVolume () const
 Returns the volume for low frequencies.
virtual void setLowFrequencyVolume (const float &volumeLF)
 Sets the volume for low frequencies.
virtual float getHighFrequencyVolume () const
 Returns the volume for high frequencies.
virtual void setHighFrequencyVolume (const float &volumeHF)
 Sets the volume for high frequencies.
virtual unsigned int getLastUpdated () const
 Returns a timestamp indicating the last time settings on this filter were changed. Used internally by the engine to update attached sources or effects.
virtual bool isValid () const
 Returns if this filter is ready to be used or if it has encountered a fatal error.
ALuint getOpenALFilter () const

Protected Member Functions

bool UpdateFilter ()
bool CheckError ()
ALenum ConvertFilterEnum (FilterTypes type)

Protected Attributes

cEFXFunctionsEFX
cAudioMutex Mutex
FilterTypes Type
float Volume
float LowFreqVolume
float HighFreqVolume
unsigned int LastUpdated
bool Valid
ALuint Filter

Detailed Description

Definition at line 19 of file cFilter.h.


Member Function Documentation

void cAudio::cFilter::setHighFrequencyVolume ( const float &  volumeHF  )  [virtual]

Sets the volume for high frequencies.

This volume scales higher frequency audio that goes through it by this amount.

Parameters:
volume,: New volume amount. Range: 0.0f to 1.0.

Implements cAudio::IFilter.

Definition at line 82 of file cFilter.cpp.

void cAudio::cFilter::setLowFrequencyVolume ( const float &  volumeLF  )  [virtual]

Sets the volume for low frequencies.

This volume scales lower frequency audio that goes through it by this amount.

Parameters:
volume,: New volume amount. Range: 0.0f to 1.0.

Implements cAudio::IFilter.

Definition at line 70 of file cFilter.cpp.

void cAudio::cFilter::setType ( const FilterTypes type  )  [virtual]

Sets the type of this filter.

Parameters:
type,: Type of filter to set this filter up as.

Implements cAudio::IFilter.

Definition at line 46 of file cFilter.cpp.

void cAudio::cFilter::setVolume ( const float &  volume  )  [virtual]

Sets the master volume of this filter.

This volume scales all audio that goes through it by this amount.

Parameters:
volume,: New volume amount. Range: 0.0f to 1.0.

Implements cAudio::IFilter.

Definition at line 58 of file cFilter.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Enumerations

Generated on Sat Feb 20 22:55:34 2010 for cAudio by  doxygen 1.6.2