This is the base class for Superpowered effects. More...

#include "SuperpoweredFX.h"

Inheritance diagram for Superpowered::FX:

[legend]

Public Member Functions
virtual	~FX ()

virtual bool	process (float input, float output, unsigned int numberOfFrames)=0
	Processes the audio. More...

Public Attributes
bool	enabled = false
	Turns the effect on/off. The actual switch will happen on the next process() call for smooth, audio-artifact free operation. More...

unsigned int	samplerate = 0
	Sample rate in Hz. More...

Detailed Description

This is the base class for Superpowered effects.

Constructor & Destructor Documentation

◆ ~FX()

virtual Superpowered::FX::~FX ( )

inlinevirtual

Member Function Documentation

◆ process()

virtual bool Superpowered::FX::process	(	float *	input,
		float *	output,
		unsigned int	numberOfFrames
	)

pure virtual

Processes the audio.

Check the process() documentation of each derived class for the minimum number of samples and an optional vector size limitation. For maximum compatibility with all Superpowered effects, numberOfSamples should be minimum 32 and a multiply of 8.

Returns: If process() returns with true, the contents of output are replaced with the audio output. If process() returns with false, it indicates silence. The contents of output are not changed in this case (not overwritten with zeros).

Parameters

input	32-bit input buffer.
output	32-bit output buffer.
numberOfFrames	Number of frames to process.

Implemented in Superpowered::CompressorProto, Superpowered::Filter, Superpowered::GuitarDistortion, Superpowered::Compressor, Superpowered::Echo, Superpowered::Flanger, Superpowered::Reverb, Superpowered::Limiter, SuperpoweredNBandEQ, Superpowered::Roll, Superpowered::ThreeBandEQ, Superpowered::Gate, Superpowered::Bitcrusher, and Superpowered::Whoosh.

Member Data Documentation

◆ enabled

bool Superpowered::FX::enabled = false

Turns the effect on/off. The actual switch will happen on the next process() call for smooth, audio-artifact free operation.

◆ samplerate

unsigned int Superpowered::FX::samplerate = 0

Sample rate in Hz.

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

latest/Superpowered/SuperpoweredFX.h

Public Member Functions

Public Attributes