JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::dsp::Panner< SampleType > Class Template Reference

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

#include <juce_Panner.h>

Collaboration diagram for juce::dsp::Panner< SampleType >:

Public Types

using Rule = PannerRule
 

Public Member Functions

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

Private Member Functions

void update ()
 

Private Attributes

Rule currentRule = Rule::balanced
 
SmoothedValue< SampleType > leftVolume
 
SampleType pan = 0.0
 
SmoothedValue< SampleType > rightVolume
 
double sampleRate = 44100.0
 

Detailed Description

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

A processor to perform panning operations on stereo buffers.

@tags{DSP}

Member Typedef Documentation

◆ Rule

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

Constructor & Destructor Documentation

◆ Panner()

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

Constructor.

Member Function Documentation

◆ prepare()

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

Initialises the processor.

◆ process()

template<typename SampleType >
template<typename ProcessContext >
void juce::dsp::Panner< SampleType >::process ( const ProcessContext context)
inlinenoexcept

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

References jassertquiet, juce::dsp::Panner< SampleType >::leftVolume, and juce::dsp::Panner< SampleType >::rightVolume.

◆ reset()

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

Resets the internal state variables of the processor.

◆ setPan()

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

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

◆ setRule()

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

Sets the panning rule.

◆ update()

template<typename SampleType >
void juce::dsp::Panner< SampleType >::update ( )
private

Member Data Documentation

◆ currentRule

template<typename SampleType >
Rule juce::dsp::Panner< SampleType >::currentRule = Rule::balanced
private

◆ leftVolume

template<typename SampleType >
SmoothedValue<SampleType> juce::dsp::Panner< SampleType >::leftVolume
private

◆ pan

template<typename SampleType >
SampleType juce::dsp::Panner< SampleType >::pan = 0.0
private

◆ rightVolume

template<typename SampleType >
SmoothedValue<SampleType> juce::dsp::Panner< SampleType >::rightVolume
private

◆ sampleRate

template<typename SampleType >
double juce::dsp::Panner< SampleType >::sampleRate = 44100.0
private

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