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

Public Member Functions
	DistortionParameters (Real edge=0.2f, Real gain=0.05f, Real lowpassCutoff=8000.0f, Real eqCenter=3600.0f, Real eqBandwidth=3600.0f)
	Struct constructor. More...

Public Attributes
Real	Edge
	This property controls the shape of the distortion. More...

Real	EqBandwidth
	This property controls the bandwidth of the post-distortion attenuation. More...

Real	EqCenter
	This property controls the frequency at which the post-distortion attenuation (Gain) is active. More...

Real	Gain
	This property allows you to attenuate the distorted sound. More...

Real	LowpassCutoff
	Input signal can have a low pass filter applied, to limit the amount of high frequency signal feeding into the distortion effect. More...

Detailed Description

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

The distortion effect simulates turning up (overdriving) the gain stage on a guitar amplifier or adding a distortion pedal to an instrument's output.

Definition at line 415 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::DistortionParameters::DistortionParameters	(	Real	edge = `0.2f`,
		Real	gain = `0.05f`,
		Real	lowpassCutoff = `8000.0f`,
		Real	eqCenter = `3600.0f`,
		Real	eqBandwidth = `3600.0f`
	)

inline

Struct constructor.

Parameters

edge@copybrief	DistortionParameters::Edge
gain@copybrief	DistortionParameters::Gain
lowpassCutoff@copybrief	DistortionParameters::LowpassCutoff
eqCenter@copybrief	DistortionParameters::EqCenter
eqBandwidth@copybrief	DistortionParameters::EqBandwidth

Definition at line 439 of file effectparameters.h.

Real Mezzanine::Audio::DistortionParameters::Edge

This property controls the shape of the distortion.

Remarks: The higher the value for Edge, the "dirtier" and "fuzzier" the effect.

Range: 0.0 to 1.0

Definition at line 419 of file effectparameters.h.

Real Mezzanine::Audio::DistortionParameters::EqBandwidth

This property controls the bandwidth of the post-distortion attenuation.

Definition at line 431 of file effectparameters.h.

Real Mezzanine::Audio::DistortionParameters::EqCenter

This property controls the frequency at which the post-distortion attenuation (Gain) is active.

Definition at line 428 of file effectparameters.h.

Real Mezzanine::Audio::DistortionParameters::Gain

This property allows you to attenuate the distorted sound.

Definition at line 422 of file effectparameters.h.

Real Mezzanine::Audio::DistortionParameters::LowpassCutoff

Input signal can have a low pass filter applied, to limit the amount of high frequency signal feeding into the distortion effect.

Definition at line 425 of file effectparameters.h.

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