JUCE  v5.1.1-3-g1a0b28c73
JUCE API
WaveShaper< FloatType, Function > Struct Template Reference

Applies waveshaping to audio samples as single samples or AudioBlocks. More...

#include <juce_WaveShaper.h>

Collaboration diagram for WaveShaper< FloatType, Function >:

Public Member Functions

void prepare (const ProcessSpec &) noexcept
 Called before processing starts. More...
 
template<typename ProcessContext >
void process (const ProcessContext &context) const noexcept
 Processes the input and output buffers supplied in the processing context. More...
 
template<typename SampleType >
SampleType JUCE_VECTOR_CALLTYPE processSample (SampleType inputSample) const noexcept
 Returns the result of processing a single sample. More...
 
void reset () noexcept
 

Public Attributes

Function functionToUse
 

Detailed Description

template<typename FloatType, typename Function = FloatType (*) (FloatType)>
struct WaveShaper< FloatType, Function >

Applies waveshaping to audio samples as single samples or AudioBlocks.

Member Function Documentation

◆ prepare()

template<typename FloatType , typename Function = FloatType (*) (FloatType)>
void WaveShaper< FloatType, Function >::prepare ( const ProcessSpec )
inlinenoexcept

Called before processing starts.

◆ process()

template<typename FloatType , typename Function = FloatType (*) (FloatType)>
template<typename ProcessContext >
void WaveShaper< FloatType, Function >::process ( const ProcessContext context) const
inlinenoexcept

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

References WaveShaper< FloatType, Function >::functionToUse, jassert, and AudioBlock< SampleType >::process().

◆ processSample()

template<typename FloatType , typename Function = FloatType (*) (FloatType)>
template<typename SampleType >
SampleType JUCE_VECTOR_CALLTYPE WaveShaper< FloatType, Function >::processSample ( SampleType  inputSample) const
inlinenoexcept

Returns the result of processing a single sample.

References WaveShaper< FloatType, Function >::functionToUse.

◆ reset()

template<typename FloatType , typename Function = FloatType (*) (FloatType)>
void WaveShaper< FloatType, Function >::reset ( )
inlinenoexcept

Member Data Documentation

◆ functionToUse

template<typename FloatType , typename Function = FloatType (*) (FloatType)>
Function WaveShaper< FloatType, Function >::functionToUse

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