cAudio::IFilter Class Reference

Interface for a filter in cAudio. More...

#include <IFilter.h>

Inheritance diagram for cAudio::IFilter:

[legend]

Collaboration diagram for cAudio::IFilter:

Public Member Functions
virtual const FilterTypes &	getType () const =0
	Returns the type of the filter.
virtual void	setType (const FilterTypes &type)=0
	Sets the type of this filter.
virtual float	getVolume () const =0
	Returns the master volume of this filter.
virtual void	setVolume (const float &volume)=0
	Sets the master volume of this filter.
virtual float	getLowFrequencyVolume () const =0
	Returns the volume for low frequencies.
virtual void	setLowFrequencyVolume (const float &volumeLF)=0
	Sets the volume for low frequencies.
virtual float	getHighFrequencyVolume () const =0
	Returns the volume for high frequencies.
virtual void	setHighFrequencyVolume (const float &volumeHF)=0
	Sets the volume for high frequencies.
virtual unsigned int	getLastUpdated () const =0
	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 =0
	Returns if this filter is ready to be used or if it has encountered a fatal error.

Detailed Description

Interface for a filter in cAudio.

Definition at line 26 of file IFilter.h.

virtual void cAudio::IFilter::setHighFrequencyVolume ( const float & volumeHF ) [pure 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.

Implemented in cAudio::cFilter.

virtual void cAudio::IFilter::setLowFrequencyVolume ( const float & volumeLF ) [pure 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.

Implemented in cAudio::cFilter.

virtual void cAudio::IFilter::setType ( const FilterTypes & type ) [pure virtual]

Sets the type of this filter.

Parameters:

type,:

Type of filter to set this filter up as.

Implemented in cAudio::cFilter.

virtual void cAudio::IFilter::setVolume ( const float & volume ) [pure 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.

Implemented in cAudio::cFilter.

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