Effect Class Reference

The base class of ICSTDSP effects. More...

Inheritance diagram for Effect:

Public Member Functions
virtual void	prepareToPlay (double, int)
	Call this before calls to processBlock / processInplace to setup the effect. More...
virtual void	processBlock (const float *, float *, int)
	Processes the samples from input to output. More...
virtual void	processInplace (float *data, int numSamples)
	Processes the float data in place. More...

Protected Member Functions
void	enableInplaceProcessing (bool shouldBeEnabled, int numMaxSamplesToExpect)
	Call this in your subclasses prepareToPlay method and tell it to automatically use inplace processing. More...

Detailed Description

The base class of ICSTDSP effects.

Member Function Documentation

void enableInplaceProcessing ( bool  shouldBeEnabled, int  numMaxSamplesToExpect  )

inlineprotected

Call this in your subclasses prepareToPlay method and tell it to automatically use inplace processing.

virtual void prepareToPlay ( double  , int    )

inlinevirtual

Call this before calls to processBlock / processInplace to setup the effect.

Reimplemented in RingMod.

virtual void processBlock ( const float *  , float *  , int    )

inlinevirtual

Processes the samples from input to output.

Both arrays must be at have numSamples elements.

Reimplemented in Noise.

void processInplace ( float *  data, int  numSamples  )

virtual

Processes the float data in place.

The default behaviour copies the input data into an internal buffer and calls processBlock.

Reimplemented in Noise.