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

Public Member Functions
	EchoParameters (Real delay=0.1f, Real lRDelay=0.1f, Real damping=0.5f, Real feedback=0.5f, Real spread=-1.0f)
	Struct constructor. More...

Public Attributes
Real	Damping
	This property controls the amount of high frequency damping applied to each echo. More...

Real	Delay
	This property controls the delay between the original sound and the first "tap", or echo instance. More...

Real	Feedback
	This property controls the amount of feedback the output signal fed back into the input. More...

Real	LRDelay
	This property controls the delay between the first "tap" and the second "tap". More...

Real	Spread
	This property controls how hard panned the individual echoes are. More...

Detailed Description

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

The echo effect generates discrete, delayed instances of the input signal.

Definition at line 453 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::EchoParameters::EchoParameters	(	Real	delay = `0.1f`,
		Real	lRDelay = `0.1f`,
		Real	damping = `0.5f`,
		Real	feedback = `0.5f`,
		Real	spread = `-1.0f`
	)

inline

Struct constructor.

Parameters

Definition at line 480 of file effectparameters.h.

Real Mezzanine::Audio::EchoParameters::Damping

This property controls the amount of high frequency damping applied to each echo.

Remarks: As the sound is subsequently fed back for further echoes, damping results in an echo which progressively gets softer in tone as well as intensity.

Range: 0.0 to 0.99

Definition at line 464 of file effectparameters.h.

Real Mezzanine::Audio::EchoParameters::Delay

This property controls the delay between the original sound and the first "tap", or echo instance.

Definition at line 457 of file effectparameters.h.

Real Mezzanine::Audio::EchoParameters::Feedback

This property controls the amount of feedback the output signal fed back into the input.

Remarks: Use this parameter to create "cascading" echoes. At full magnitude, the identical sample will repeat endlessly. Below full magnitude, the sample will repeat and fade.

Range: 0.0 to 1.0

Definition at line 468 of file effectparameters.h.

Real Mezzanine::Audio::EchoParameters::LRDelay

This property controls the delay between the first "tap" and the second "tap".

Definition at line 460 of file effectparameters.h.

Real Mezzanine::Audio::EchoParameters::Spread

This property controls how hard panned the individual echoes are.

Remarks: With a value of 1.0, the first "tap" will be panned hard left, and the second "tap" hard right. A value of -1.0 gives the opposite result. Settings nearer to 0.0 result in less emphasized panning.

Range: -1.0 to 1.0

Definition at line 472 of file effectparameters.h.

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