CL_FadeFilter Class Reference
[clanSound Filters]

Fade Filter Class. More...

#include <fadefilter.h>

Inheritance diagram for CL_FadeFilter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_FadeFilter (float initial_volume)
 Fade Filter Constructor.
virtual ~CL_FadeFilter ()
 Fade Filter Destructor.
Attributes

float get_volume () const
 Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume).
Operations

CL_FadeFilterProvider * get_provider () const
 Retrieves the provider.
void set_volume (float new_volume)
 Sets the volume instant.
void fade_to_volume (float new_volume, int duration=1000)
 Fade to volume, from 0.0f (no volume) to 1.0f (full volume).
Operators

bool operator== (const CL_SoundFilter &other) const
 Equality operator.
bool operator!= (const CL_SoundFilter &other) const
 Inequality operator.
Operations

bool is_null () const
 Returns true if this object is invalid.
void throw_if_null () const
 Throw an exception if this object is invalid.
void filter (float **sample_data, int num_samples, int channels)
 Filter callback.

Public Attributes

Implementation

CL_SharedPtr< CL_SoundFilter_Impl > impl

Detailed Description

Fade Filter Class.


Constructor & Destructor Documentation

CL_FadeFilter::CL_FadeFilter ( float  initial_volume  ) 

Fade Filter Constructor.

virtual CL_FadeFilter::~CL_FadeFilter (  )  [virtual]

Fade Filter Destructor.


Member Function Documentation

void CL_FadeFilter::fade_to_volume ( float  new_volume,
int  duration = 1000 
)

Fade to volume, from 0.0f (no volume) to 1.0f (full volume).

void CL_SoundFilter::filter ( float **  sample_data,
int  num_samples,
int  channels 
) [inherited]

Filter callback.

All sound data is passed through this function, which modifies the sample data accordingly to the function of the filter.

The format of the sample data is always 16 bit stereo.

CL_FadeFilterProvider* CL_FadeFilter::get_provider (  )  const

Retrieves the provider.

Reimplemented from CL_SoundFilter.

float CL_FadeFilter::get_volume (  )  const

Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume).

bool CL_SoundFilter::is_null (  )  const [inline, inherited]

Returns true if this object is invalid.

bool CL_SoundFilter::operator!= ( const CL_SoundFilter other  )  const [inline, inherited]

Inequality operator.

References CL_SoundFilter::impl.

bool CL_SoundFilter::operator== ( const CL_SoundFilter other  )  const [inline, inherited]

Equality operator.

References CL_SoundFilter::impl.

void CL_FadeFilter::set_volume ( float  new_volume  ) 

Sets the volume instant.

void CL_SoundFilter::throw_if_null (  )  const [inherited]

Throw an exception if this object is invalid.


Member Data Documentation

CL_SharedPtr<CL_SoundFilter_Impl> CL_SoundFilter::impl [inherited]

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