ape  0.5.0
Audio Programming Environment
Protected Member Functions | List of all members
ape::Generator Class Reference

A generator is a processor that only creates sounds (so it has no inputs).

See also
GlobalData, Effect
More...

#include <generator.h>

Inheritance diagram for ape::Generator:
ape::Processor ape::UIObject

Protected Member Functions

 Generator ()
 
virtual void process (umatrix< float > buffer, size_t frames)
 Override this to emit sound. More...
 
- Protected Member Functions inherited from ape::Processor
 Processor ()
 
virtual void processingHook ()
 Internal use only More...
 
void setTriggeringChannel (int channel)
 Request the oscilloscope to trigger on a specific channel (default is the first output channel from the plugin). More...
 
void defaultProcess (umatrix< const float > inputs, umatrix< float > outputs, size_t frames)
 Copy the number of shared channels from inputs to outputs , clearing any extra outputs in outputs .

See also
sharedChannels, clear()
More...
 
virtual void start (const IOConfig &config)
 Start processing with a certain configuration. Resources can be allocated here. More...
 
virtual void stop ()
 Stop processing. Here's a good place to release any large resources. More...
 

Additional Inherited Members

- Public Member Functions inherited from ape::Processor
void init ()
 Called after every constructor in the inheritance chain has run More...
 
void close ()
 Called just before any destructor is run. More...
 
void processFrames (umatrix< const float > inputs, umatrix< float > outputs, size_t frames)
 Trigger processing of the inputs into the outputs .

See also
EmbeddedEffect::process, EmbeddedGenerator::process
More...
 
virtual Status onEvent (Event *e)
 Send an event to this processor. More...
 
virtual ~Processor ()
 Polymorphically destruct this processor More...
 
const IOConfigconfig () const
 Return the configuration this processor is initialized with. More...
 
std::size_t sharedChannels () const noexcept
 Returns the minimum number of shared channels between inputs and outputs. More...
 

Detailed Description

A generator is a processor that only creates sounds (so it has no inputs).

See also
GlobalData, Effect

Constructor & Destructor Documentation

◆ Generator()

ape::Generator::Generator ( )
inlineprotected

Member Function Documentation

◆ process()

virtual void ape::Generator::process ( umatrix< float >  buffer,
size_t  frames 
)
inlineprotectedvirtual

Override this to emit sound.

Parameters
framesThe number of sample frames to be processed.

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