Type Alias WaveOptions

WaveOptions: ModSettableOptions & {
    hertz: number;
    invert: boolean;
    millis: number;
    period: number;
    secs: number;
    shape: Waveforms;
    source: (() => number);
    ticks: number;
}

Options for the wave function. Defaults to a sine wave of one cycle per-second.

Type declaration

  • hertz: number

    Number of cycles per second (Set either ticks, hertz, secs or millis)

  • invert: boolean

    If true, shape is inverted

  • millis: number

    Number of milliseconds per cycle (Set either ticks, hertz, secs or millis)

  • period: number
  • secs: number

    Number of seconds per cycle. Defaults to one second. (Set either ticks, hertz, secs or millis)

  • shape: Waveforms

    Waveshape. Default 'sine'

  • source: (() => number)

    Clock source. Set this or ticks, hertz, secs or millis

      • (): number

      • Returns number

  • ticks: number

    Number of ticks per cycle (Set either ticks, hertz, secs or millis)

Settings

Member Visibility