Fade Filter Class. More...
#include <fadefilter.h>
Public Member Functions | |
FadeFilter (float initial_volume) | |
Fade Filter Constructor. | |
virtual | ~FadeFilter () |
Fade Filter Destructor. | |
void | fade_to_volume (float new_volume, int duration=1000) |
Fade to volume, from 0.0f (no volume) to 1.0f (full volume). | |
FadeFilterProvider * | get_provider () const |
Retrieves the provider. | |
float | get_volume () const |
Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume). | |
void | set_volume (float new_volume) |
Sets the volume instant. | |
![]() | |
SoundFilter () | |
Constructs a NULL instance. | |
SoundFilter (SoundFilterProvider *provider) | |
Constructs a sound filter. | |
~SoundFilter () | |
void | filter (float **sample_data, int num_samples, int channels) |
Filter callback. | |
SoundFilterProvider * | get_provider () const |
Retrieves the provider. | |
bool | is_null () const |
Returns true if this object is invalid. | |
bool | operator!= (const SoundFilter &other) const |
Inequality operator. | |
bool | operator== (const SoundFilter &other) const |
Equality operator. | |
void | throw_if_null () const |
Throw an exception if this object is invalid. | |
Additional Inherited Members | |
![]() | |
std::shared_ptr< SoundFilter_Impl > | impl |
Fade Filter Class.
clan::FadeFilter::FadeFilter | ( | float | initial_volume | ) |
Fade Filter Constructor.
|
virtual |
Fade Filter Destructor.
void clan::FadeFilter::fade_to_volume | ( | float | new_volume, |
int | duration = 1000 ) |
Fade to volume, from 0.0f (no volume) to 1.0f (full volume).
FadeFilterProvider * clan::FadeFilter::get_provider | ( | ) | const |
Retrieves the provider.
float clan::FadeFilter::get_volume | ( | ) | const |
Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume).
void clan::FadeFilter::set_volume | ( | float | new_volume | ) |
Sets the volume instant.