flimFilter

Objects used with flimSounds to configure filtering effects. More...

Collaboration diagram for flimFilter:

Classes
class	flimFilter
	A flim filter. More...

Enumerations
enum	FilterType { FilterType::HiPass, FilterType::LoPass, FilterType::BandPass }
	Values that represent filter types. More...

Functions
snd_err	flimFilter::setSound (SoundCall *sound)
	Sets a sound. More...
snd_err	flimFilter::ActivateFilter (FilterType type)
	Activates the filter described by type. More...
snd_err	flimFilter::DeactivateFilter (FilterType type)
	Deactivate filter. More...
snd_err	flimFilter::SetCutoff (float cutoff)
	Sets a cutoff. More...
snd_err	flimFilter::GetCutoff (float &cutoff)
	Gets a cutoff. More...

Detailed Description

Objects used with flimSounds to configure filtering effects.

Enumeration Type Documentation

FilterType

enum FilterType

strong

Values that represent filter types.

Enumerator
HiPass
LoPass
BandPass

Function Documentation

ActivateFilter()

snd_err flimFilter::ActivateFilter

(

FilterType

type

)

Activates the filter described by type.

Author

Jack Campbell

Date

6/1/2017

Parameters

type

The type.

Returns

A snd_err.

DeactivateFilter()

snd_err flimFilter::DeactivateFilter

(

FilterType

type

)

Deactivate filter.

Author

Jack Campbell

Date

6/1/2017

Parameters

type

The type.

Returns

A snd_err.

GetCutoff()

snd_err flimFilter::GetCutoff

(

float &

cutoff

)

Gets a cutoff.

Author

Jack Campbell

Date

6/1/2017

Parameters

[in,out]

cutoff

The cutoff.

Returns

The cutoff.

SetCutoff()

snd_err flimFilter::SetCutoff

(

float

cutoff

)

Sets a cutoff.

Author

Jack Campbell

Date

6/1/2017

Parameters

cutoff

The cutoff.

Returns

A snd_err.

setSound()

snd_err flimFilter::setSound ( SoundCall *  sound )

inline

Sets a sound.

Author

Jack Campbell

Date

6/1/2017

Parameters

[in,out]

sound

If non-null, the sound.

Returns

A snd_err.