IIRFilter Class Reference

This sound creates a IIR filter reader. More...

#include <IIRFilter.h>

Inheritance diagram for IIRFilter:

Public Member Functions
	IIRFilter (std::shared_ptr< ISound > sound, const std::vector< float > &b, const std::vector< float > &a)
	Creates a new IIR filter sound.
virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.
Public Member Functions inherited from Effect
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound.
virtual	~Effect ()
	Destroys the sound.
std::shared_ptr< ISound >	getSound () const
	Returns the saved sound.
Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Additional Inherited Members
Protected Member Functions inherited from Effect
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound.
Protected Attributes inherited from Effect
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Detailed Description

This sound creates a IIR filter reader.

Constructor & Destructor Documentation

IIRFilter()

IIRFilter::IIRFilter	(	std::shared_ptr< ISound >	sound,
		const std::vector< float > &	b,
		const std::vector< float > &	a )

Creates a new IIR filter sound.

Parameters

sound	The input sound.
b	The input filter coefficients.
a	The output filter coefficients.

Member Function Documentation

createReader()

virtual std::shared_ptr< IReader > IIRFilter::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns

A pointer to an IReader object or nullptr if there has been an error.

Exceptions

Exception

An exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

---

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

• fx/IIRFilter.h