Skip to content

Commit

Permalink
Documentation: Updating SawLFO
Browse files Browse the repository at this point in the history
Updating sawlfo.md to fit with latest documentation specs.
  • Loading branch information
gregwht committed Dec 4, 2023
1 parent e580339 commit abc1717
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/library/oscillators/sawlfo.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
title: SawLFO node documentation
description: SawLFO: Produces a sawtooth LFO at the fiven `frequency` and `phase` offset, with output ranging from `min` to `max`.

[Reference library](../index.md) > [Oscillators](index.md) > [SawLFO](sawlfo.md)

# SawLFO

Produces a sawtooth LFO, with output ranging from min to max.

Signature:
```python
SawLFO(frequency=1.0, min=0.0, max=1.0, phase=0.0)
```

Produces a sawtooth LFO at the fiven `frequency` and `phase` offset, with output ranging from `min` to `max`.

### Examples

```python

# Siren effect, using a sawtooth LFO to modulate a sine wave's frequency
lfo = SawLFO(1, 200, 1000)
sine = SineOscillator(lfo)
sine.play()
```

0 comments on commit abc1717

Please sign in to comment.