Write some amount of documentation

This commit is contained in:
2026-01-31 01:46:18 +01:00
parent e1c4987db5
commit 8cd0ec92c0
57 changed files with 2096 additions and 198 deletions

44
docs/pitch_envelope.md Normal file
View File

@@ -0,0 +1,44 @@
# Pitch Envelope
Control pitch modulation over time with a dedicated ADSR envelope.
## Envelope Amount
```forth
"bass" s 0.5 penv . ( pitch envelope depth )
"bass" s -0.5 penv . ( negative envelope )
```
## Envelope Shape
```forth
"kick" s
1.0 penv ( full envelope depth )
0.001 patt ( instant attack )
0.1 pdec ( fast decay )
0 psus ( no sustain )
0.1 prel ( short release )
.
```
## Classic Kick Drum
```forth
"sine" s
40 note
2.0 penv
0.001 patt
0.05 pdec
0 psus
.
```
## Words
| Word | Stack | Description |
|------|-------|-------------|
| `penv` | (f --) | Set pitch envelope amount |
| `patt` | (f --) | Set pitch attack time |
| `pdec` | (f --) | Set pitch decay time |
| `psus` | (f --) | Set pitch sustain level |
| `prel` | (f --) | Set pitch release time |