Function wave

wave(options: Partial<WaveOptions>): WaveModulator

Creates a wave modulator by name.

Defaults to 5-second sine wave.

import { wave } from '@ixfx/modulation.js';
// Triangle wave that has a single cycle over two seconds
const m = wave({ secs: 2, shape: `triangle`});

// Call m() to get current value of wave, eg in
// an animation loop
const v = m();

Parameters

options: Partial<WaveOptions>

Returns WaveModulator

Example

import { wave } from '@ixfx/modulation.js';
import { resolveFields } from '@ixfx/bundle.js';

const state = {
 intensity: wave({secs: 2, shape: `sine` }),
 someOtherState: 10
}

const use = async () {
 const { intensity } = await resolveFields(state);
 // Do something with intensity value...
}