wavelength 1.0.0
Loading...
Searching...
No Matches
SoftFxFilter Struct Reference

Settings of the software effect, read from the filter entry of the first effect bus. More...

#include <softfxfilter.h>

Collaboration diagram for SoftFxFilter:

Classes

struct  Tap
 One delay tap of a kTypeChorus effect, read from an entry of taps. More...

Public Types

enum  Type {
  kTypeOff = 0 , kTypeStream = 1 , kTypeSweptFilter = 2 , kTypeStutter = 3 ,
  kTypeBypass = 4 , kTypeFilter = 5 , kTypeChorus = 6 , kTypeFilterVariant = 7 ,
  kTypeDistort = 8 , kTypeDistortedFilter = 9 , kTypeCount = 10
}
 The kinds of software effect, the values of mType. More...

Public Attributes

int mType
float mFrequency
int mFreqCeiling
int mFreqFloor
union { 
   int   mInitFreq 
   float   mAttenuation 
   float   mDistortion 
} mParam
 The first parameter of the effect.
union { 
   float   mResonance 
   float   mFeedback 
} mMix
 The second parameter of the effect.
Tap mTaps [kNumTaps]

Static Public Attributes

static constexpr int kNumTaps = 2
 The number of delay taps of a kTypeChorus effect.

Detailed Description

Settings of the software effect, read from the filter entry of the first effect bus.

The structure has no RTTI. The name is inferred. Synth::SetSoftFxFilter() sends it to the sound output. The meaning of mParam and mMix depends on mType.

Member Enumeration Documentation

◆ Type

The kinds of software effect, the values of mType.

Enumerator
kTypeOff 

No software effect.

kTypeStream 

The stream a StreamPlayer plays.

kTypeSweptFilter 

A resonant filter that sweeps.

kTypeStutter 

A gate on the input that the sweep speeds up.

kTypeBypass 

The input unchanged.

kTypeFilter 

A resonant filter that sweeps.

kTypeChorus 

Two modulated delay taps, with feedback and taps.

kTypeFilterVariant 

A resonant filter per channel that sweeps.

kTypeDistort 

Distortion, with distortion and feedback.

kTypeDistortedFilter 

A clipped resonant filter per channel that sweeps.

kTypeCount 

The number of types the reader accepts.

Member Data Documentation

◆ kNumTaps

int SoftFxFilter::kNumTaps = 2
staticconstexpr

The number of delay taps of a kTypeChorus effect.

◆ mType

int SoftFxFilter::mType

type, one of Type.

◆ mFrequency

float SoftFxFilter::mFrequency

The frequency a sweeping filter reached, recorded by the sound output.

◆ mFreqCeiling

int SoftFxFilter::mFreqCeiling

freq_ceiling of a sweeping filter.

◆ mFreqFloor

int SoftFxFilter::mFreqFloor

freq_floor of a sweeping filter.

◆ mInitFreq

int SoftFxFilter::mInitFreq

init_freq of a sweeping filter.

◆ mAttenuation

float SoftFxFilter::mAttenuation

attenuation of a kTypeChorus effect.

◆ mDistortion

float SoftFxFilter::mDistortion

distortion of a kTypeDistort effect.

◆ [union]

union { ... } SoftFxFilter::mParam

The first parameter of the effect.

◆ mResonance

float SoftFxFilter::mResonance

resonance of a sweeping filter.

◆ mFeedback

float SoftFxFilter::mFeedback

feedback of a kTypeChorus or kTypeDistort effect.

◆ [union]

union { ... } SoftFxFilter::mMix

The second parameter of the effect.

◆ mTaps

Tap SoftFxFilter::mTaps[kNumTaps]

The taps of a kTypeChorus effect.


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