Public Types | Public Member Functions | List of all members
dsp::Panner< SampleType > Class Template Reference

A processor to perform panning operations on stereo buffers. More...

Public Types

using Rule = PannerRule
 

Public Member Functions

 Panner ()
 Constructor. More...
 
void setRule (Rule newRule)
 Sets the panning rule. More...
 
void setPan (SampleType newPan)
 Sets the current panning value, between -1 (full left) and 1 (full right). More...
 
void prepare (const ProcessSpec &spec)
 Initialises the processor. More...
 
void reset ()
 Resets the internal state variables of the processor. More...
 
template<typename ProcessContext >
void process (const ProcessContext &context) noexcept
 Processes the input and output samples supplied in the processing context. More...
 

Detailed Description

template<typename SampleType>
class dsp::Panner< SampleType >

A processor to perform panning operations on stereo buffers.

Member Typedef Documentation

◆ Rule

template<typename SampleType >
using dsp::Panner< SampleType >::Rule = PannerRule

Constructor & Destructor Documentation

◆ Panner()

template<typename SampleType >
dsp::Panner< SampleType >::Panner ( )

Constructor.

Member Function Documentation

◆ setRule()

template<typename SampleType >
void dsp::Panner< SampleType >::setRule ( Rule  newRule)

Sets the panning rule.

◆ setPan()

template<typename SampleType >
void dsp::Panner< SampleType >::setPan ( SampleType  newPan)

Sets the current panning value, between -1 (full left) and 1 (full right).

◆ prepare()

template<typename SampleType >
void dsp::Panner< SampleType >::prepare ( const ProcessSpec spec)

Initialises the processor.

◆ reset()

template<typename SampleType >
void dsp::Panner< SampleType >::reset ( )

Resets the internal state variables of the processor.

◆ process()

template<typename SampleType >
template<typename ProcessContext >
void dsp::Panner< SampleType >::process ( const ProcessContext &  context)
noexcept

Processes the input and output samples supplied in the processing context.

References ignoreUnused(), and jassert.


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