Vital
Loading...
Searching...
No Matches
vital::PredefinedWaveFrames Class Reference

Holds a set of predefined WaveFrame shapes that can be used as basic building blocks. More...

#include <wave_frame.h>

Public Types

enum  Shape {
  kSin , kSaturatedSin , kTriangle , kSquare ,
  kPulse , kSaw , kNumShapes
}
 Supported predefined shapes. More...
 

Public Member Functions

 PredefinedWaveFrames ()
 Constructs the PredefinedWaveFrames, initializing all predefined shapes.
 

Static Public Member Functions

static const WaveFramegetWaveFrame (Shape shape)
 Retrieves a pointer to a WaveFrame representing a predefined shape.
 

Detailed Description

Holds a set of predefined WaveFrame shapes that can be used as basic building blocks.

PredefinedWaveFrames generates standard wave shapes (sin, square, saw, etc.) in a WaveFrame format that can be used for initializing or shaping other wavetables.

Member Enumeration Documentation

◆ Shape

Supported predefined shapes.

Enumerator
kSin 
kSaturatedSin 
kTriangle 
kSquare 
kPulse 
kSaw 
kNumShapes 

Constructor & Destructor Documentation

◆ PredefinedWaveFrames()

vital::PredefinedWaveFrames::PredefinedWaveFrames ( )

Constructs the PredefinedWaveFrames, initializing all predefined shapes.

Constructs predefined wave frames for each shape using helper methods.

Member Function Documentation

◆ getWaveFrame()

static const WaveFrame * vital::PredefinedWaveFrames::getWaveFrame ( Shape shape)
inlinestatic

Retrieves a pointer to a WaveFrame representing a predefined shape.

Parameters
shapeThe shape enumerated by Shape.
Returns
A pointer to the corresponding predefined WaveFrame.

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