Updating documentation

This commit is contained in:
Raphael Forment 2023-09-10 09:59:18 +02:00
commit 7a95bafa54
2 changed files with 15 additions and 15 deletions

View File

@ -416,7 +416,7 @@ const generic_params = [
* @example
* note("c3 e3 f3 g3 ab3 bb3")
* .sound('square').cutoff(1000)
* .lpattack("<0.05 0.1 0.25 0.5>/2").ftype('12db')
* .lpattack("<0.05 0.1 0.25 0.5>/2").ftype("12db")
* .release(0.2).attack(0)
*/
['lpattack', 'lpa'],
@ -428,7 +428,7 @@ const generic_params = [
* @example
* note("c3 e3 f3 g3 ab3 bb3")
* .sound('square').hcutoff(1000)
* .hpattack("<0.05 0.1 0.25 0.5>/2").ftype('12db')
* .hpattack("<0.05 0.1 0.25 0.5>/2").ftype("12db")
* .release(0.2).attack(0)
*/
['hpattack', 'hpa'],
@ -440,7 +440,7 @@ const generic_params = [
* @example
* note("c3 e3 f3 g3 ab3 bb3")
* .sound('square').bandf(1000)
* .bpattack("<0.05 0.1 0.25 0.5>/2").ftype('12db')
* .bpattack("<0.05 0.1 0.25 0.5>/2").ftype("12db")
* .release(0.2).attack(0)
*/
['bpattack', 'bpa'],
@ -525,7 +525,7 @@ const generic_params = [
* @param {number | Pattern} release time of the filter envelope
* @synonyms lpr
* @example
* note("c3 e3 g3 c4").lpr("<0.1 0.25 0.5>").ftype('12db')
* note("c3 e3 g3 c4").lpr("<0.1 0.25 0.5>").ftype("12db")
*/
['lprelease', 'lpr'],
/**
@ -534,7 +534,7 @@ const generic_params = [
* @param {number | Pattern} release time of the highpass filter envelope
* @synonyms hpr
* @example
* note("c3 e3 g3 c4").hpr("<0.1 0.25 0.5>").ftype('12db')
* note("c3 e3 g3 c4").hpr("<0.1 0.25 0.5>").ftype("12db")
*/
['hprelease', 'hpr'],
/**
@ -543,7 +543,7 @@ const generic_params = [
* @param {number | Pattern} release time of the bandpass filter envelope
* @synonyms bpr
* @example
* note("c3 e3 g3 c4").bpr("<0.1 0.25 0.5>").ftype('12db')
* note("c3 e3 g3 c4").bpr("<0.1 0.25 0.5>").ftype("12db")
*/
['bprelease', 'bpr'],
['ftype'],

View File

@ -80,16 +80,16 @@ Strudel uses ADSR envelopes, which are probably the most common way to describe
# Filter Envelope
Each filter can receive an additional filter envelope controlling the cutoff value dynamically. It uses an ADSR envelope similar to the one used for amplitude. There is an additional parameter to control the depth of the filter modulation: `fenv`. This allows you to play subtle or huge filter modulations just the same by only increasing or decreasing the depth.
Each filter can receive an additional filter envelope controlling the cutoff value dynamically. It uses an ADSR envelope similar to the one used for amplitude. There is an additional parameter to control the depth of the filter modulation: `lpenv`|`hpenv`|`bpenv`. This allows you to play subtle or huge filter modulations just the same by only increasing or decreasing the depth.
There is one filter envelope for each filter type and thus one set of envelope filter parameters preceded either by `lp`, `hp` or `bp`:
- `lpattack`, `lpdecay`, `lpsustain`, `lprelease`: filter envelope for the lowpass filter.
- alternatively: `lpa`, `lpd`, `lps` and `lpr`.
- `hpattack`, `hpdecay`, `hpsustain`, `hprelease`: filter envelope for the highpass filter.
- alternatively: `hpa`, `hpd`, `hps` and `hpr`.
- `bpattack`, `bpdecay`, `bpsustain`, `bprelease`: filter envelope for the bandpass filter.
- alternatively: `bpa`, `bpd`, `bps` and `bpr`.
- `lpattack`, `lpdecay`, `lpsustain`, `lprelease`, `lpenv`: filter envelope for the lowpass filter.
- alternatively: `lpa`, `lpd`, `lps`, `lpr` and `lpe`.
- `hpattack`, `hpdecay`, `hpsustain`, `hprelease`, `hpenv`: filter envelope for the highpass filter.
- alternatively: `hpa`, `hpd`, `hps`, `hpr` and `hpe`.
- `bpattack`, `bpdecay`, `bpsustain`, `bprelease`, `bpenv`: filter envelope for the bandpass filter.
- alternatively: `bpa`, `bpd`, `bps`, `bpr` and `bpe`.
## lpattack
@ -115,9 +115,9 @@ There is one filter envelope for each filter type and thus one set of envelope f
<JsDoc client:idle name="lprelease" h={0} />
## fenv
## lpenv
<JsDoc client:idle name="fenv" h={0} />
<JsDoc client:idle name="lpenv" h={0} />
# Dynamics