BGC Tools
Public Member Functions | Data Fields
BGC.Audio.CarrierTone Struct Reference

Float-based description of a single carrier tone, for tone composition More...

Collaboration diagram for BGC.Audio.CarrierTone:
Collaboration graph
[legend]

Public Member Functions

 CarrierTone (float frequency, float amplitude=1f, float phase=0f)
 
CarrierTone WithNewPhase (float newPhase)
 
CarrierTone RotatePhase (float rotator)
 

Data Fields

readonly float frequency
 
readonly float amplitude
 
readonly float phase
 

Detailed Description

Float-based description of a single carrier tone, for tone composition

Definition at line 10 of file CarrierTone.cs.

Constructor & Destructor Documentation

◆ CarrierTone()

BGC.Audio.CarrierTone.CarrierTone ( float  frequency,
float  amplitude = 1f,
float  phase = 0f 
)
inline

Definition at line 16 of file CarrierTone.cs.

References BGC.Mathematics.GeneralMath.Repeat().

17  {
18  this.frequency = frequency;
19  this.amplitude = amplitude;
20  this.phase = phase;
21  }
readonly float frequency
Definition: CarrierTone.cs:12
readonly float amplitude
Definition: CarrierTone.cs:13
readonly float phase
Definition: CarrierTone.cs:14
Here is the call graph for this function:

Member Function Documentation

◆ RotatePhase()

CarrierTone BGC.Audio.CarrierTone.RotatePhase ( float  rotator)

◆ WithNewPhase()

CarrierTone BGC.Audio.CarrierTone.WithNewPhase ( float  newPhase)

Field Documentation

◆ amplitude

readonly float BGC.Audio.CarrierTone.amplitude

Definition at line 13 of file CarrierTone.cs.

◆ frequency

readonly float BGC.Audio.CarrierTone.frequency

Definition at line 12 of file CarrierTone.cs.

◆ phase

readonly float BGC.Audio.CarrierTone.phase

Definition at line 14 of file CarrierTone.cs.


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