Struct web_audio_api::node::PeriodicWave

pub struct PeriodicWave { /* fields omitted */ }

PeriodicWave is a setup struct required to build custom periodic waveform oscillator type.

Implementations

impl PeriodicWave

pub fn new<C: AsBaseAudioContext>(
    _context: &C,
    options: Option<PeriodicWaveOptions>
) -> Self

Returns a PeriodicWave

Arguments

• real - The real parameter represents an array of cosine terms of Fourrier series.
• imag - The imag parameter represents an array of sine terms of Fourrier series.
• constraints - The constraints parameter specifies the normalization mode of the PeriodicWave

Panics

Will panic if:

• real is defined and its length is less than 2
• imag is defined and its length is less than 2
• real and imag are defined and theirs lengths are not equal
• PeriodicWave is more than 8192 components

Example

   use web_audio_api::context::{AudioContext, AsBaseAudioContext};
   use web_audio_api::node::{PeriodicWave, PeriodicWaveOptions};

   let context = AudioContext::new(None);

   let options = PeriodicWaveOptions {
   real: Some(vec![0.,1.,1.]),
   imag: Some(vec![0.,0.,0.]),
   disable_normalization: Some(false),
   };

   let periodic_wave = PeriodicWave::new(&context, Some(options));

Trait Implementations

impl Clone for PeriodicWave

fn clone(&self) -> PeriodicWave

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PeriodicWave

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.