This is a struct containing all the parameters needed to describe an equalizer effect. More...

#include <effectparameters.h>

Public Member Functions
	EqualizerParameters (Real lowGain=1.0f, Real lowCutoff=200.0f, Real mid1Gain=1.0f, Real mid1Center=500.0f, Real mid1Width=1.0f, Real mid2Gain=1.0f, Real mid2Center=3000.0f, Real mid2Width=1.0f, Real highGain=1.0f, Real highCutoff=6000.0f)
	Struct constructor. More...

Public Attributes
Real	HighCutoff
	This property controls the high frequency above which signal will be cut off. More...

Real	HighGain
	This property allows you to cut / boost the signal at high frequencies. More...

Real	LowCutoff
	This property controls the low frequency below which signal will be cut off. More...

Real	LowGain
	This property controls amount of cut or boost on the low frequency range. More...

Real	Mid1Center
	This property sets the center frequency for the "mid1" range. More...

Real	Mid1Gain
	This property allows you to cut / boost signal on the "mid1" range. More...

Real	Mid1Width
	This property controls the width of the "mid1" range. More...

Real	Mid2Center
	This property sets the center frequency for the "mid2" range. More...

Real	Mid2Gain
	This property allows you to cut / boost signal on the "mid2" range. More...

Real	Mid2Width
	This property controls the width of the "mid2" range. More...

Detailed Description

This is a struct containing all the parameters needed to describe an equalizer effect.

The OpenAL Effects Extension EQ is very flexible, providing tonal control over four different adjustable frequency ranges.

Definition at line 783 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::EqualizerParameters::EqualizerParameters	(	Real	lowGain = `1.0f`,
		Real	lowCutoff = `200.0f`,
		Real	mid1Gain = `1.0f`,
		Real	mid1Center = `500.0f`,
		Real	mid1Width = `1.0f`,
		Real	mid2Gain = `1.0f`,
		Real	mid2Center = `3000.0f`,
		Real	mid2Width = `1.0f`,
		Real	highGain = `1.0f`,
		Real	highCutoff = `6000.0f`
	)

inline

Struct constructor.

Parameters

lowGain@copybrief	EqualizerParameters::LowGain
lowCutoff@copybrief	EqualizerParameters::LowCutoff
mid1Gain@copybrief	EqualizerParameters::Mid1Gain
mid1Center@copybrief	EqualizerParameters::Mid1Center
mid1Width@copybrief	EqualizerParameters::Mid1Width
mid2Gain@copybrief	EqualizerParameters::Mid2Gain
mid2Center@copybrief	EqualizerParameters::Mid2Center
mid2Width@copybrief	EqualizerParameters::Mid2Width
highGain@copybrief	EqualizerParameters::HighGain
highCutoff@copybrief	EqualizerParameters::HighCutoff

Definition at line 827 of file effectparameters.h.

Member Data Documentation

Real Mezzanine::Audio::EqualizerParameters::HighCutoff

This property controls the high frequency above which signal will be cut off.

Remarks: Range: 4000.0 to 16000.0

Definition at line 814 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::HighGain

This property allows you to cut / boost the signal at high frequencies.

Remarks: Range: 0.126 to 7.943

Definition at line 811 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::LowCutoff

This property controls the low frequency below which signal will be cut off.

Remarks: Range: 50.0 to 800.0

Definition at line 790 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::LowGain

This property controls amount of cut or boost on the low frequency range.

Remarks: Range: 0.126 to 7.943

Definition at line 787 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::Mid1Center

This property sets the center frequency for the "mid1" range.

Remarks: Range: 200.0 to 3000.0

Definition at line 796 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::Mid1Gain

This property allows you to cut / boost signal on the "mid1" range.

Remarks: Range: 0.126 to 7.943

Definition at line 793 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::Mid1Width

This property controls the width of the "mid1" range.

Remarks: Range: 0.01 to 1.0

Definition at line 799 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::Mid2Center

This property sets the center frequency for the "mid2" range.

Remarks: Range: 1000.0 to 8000.0

Definition at line 805 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::Mid2Gain

This property allows you to cut / boost signal on the "mid2" range.

Remarks: Range: 0.126 to 7.943

Definition at line 802 of file effectparameters.h.

Real Mezzanine::Audio::EqualizerParameters::Mid2Width

This property controls the width of the "mid2" range.

Remarks: Range: 0.01 to 1.0

Definition at line 808 of file effectparameters.h.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/Audio/effectparameters.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation