add all filter envelope examples to doc

packages/core/controls.mjs

@@ -397,8 +397,17 @@ const generic_params = [
    * @param {number | Pattern} modulation depth of the highpass filter envelope between 0 and _n_
    * @synonyms hpe
    * @example
-   * note("c2 c3").fast(2).sound("sawtooth")
+   * note("<c2 e2 f2 g2>")
-   *  .hcutoff(500).hpenv("<1 2 3 4 5 6 7 8>")
+   * .sound('sawtooth')
+   * .hpf(500)
+   * .hpa(.1).hpd(.1).hps(.5)
+   * .hpenv("<8 4 2 0>/4")
+   * @example
+   * note("<c2 e2 f2 g2>")
+   * .sound('sawtooth')
+   * .hpf(500)
+   * .hpa(.5)
+   * .hpenv("<2 -2>/4")
    */
   ['hpenv', 'hpe'],
   /**
@@ -407,8 +416,11 @@ const generic_params = [
    * @param {number | Pattern} modulation depth of the bandpass filter envelope between 0 and _n_
    * @synonyms bpe
    * @example
-   * note("c2 c3").fast(2).sound("sawtooth")
+   * note("<c2 e2 f2 g2>")
-   *  .bandf(500).bpenv("<1 2 3 4 5 6 7 8>")
+   * .sound('sawtooth')
+   * .bpf(500)
+   * .bpa(.1).bpd(.1).bps(.5)
+   * .bpenv("<8 4 2 0>/4")
    */
   ['bpenv', 'bpe'],
   /**
@@ -430,22 +442,24 @@ const generic_params = [
    * @param {number | Pattern} attack time of the highpass filter envelope
    * @synonyms hpa
    * @example
-   * note("c3 e3 f3 g3 ab3 bb3")
+   * note("<c2 e2 f2 g2>")
-   *  .sound('square').hcutoff(1000)
+   * .sound('sawtooth')
-   *  .hpattack("<0.5 0.25 0.1 0.01>/2").ftype("12db")
+   * .hpf(500)
-   *  .release(0.2).attack(0)
+   * .hpa("<.5 .25 .1 .01>/4")
+   * .hpenv(4)
    */
   ['hpattack', 'hpa'],
   /**
    * Sets the attack duration for the bandpass filter envelope.
-   * @name hpattack
+   * @name bpattack
    * @param {number | Pattern} attack time of the bandpass filter envelope
    * @synonyms bpa
    * @example
-   * note("c3 e3 f3 g3 ab3 bb3")
+   * note("<c2 e2 f2 g2>")
-   *  .sound('square').bandf(1000)
+   * .sound('sawtooth')
-   *  .bpattack("<0.05 0.1 0.25 0.5>/2").ftype("12db")
+   * .bpf(500)
-   *  .release(0.2).attack(0)
+   * .bpa("<.5 .25 .1 .01>/4")
+   * .bpenv(4)
    */
   ['bpattack', 'bpa'],
   /**
@@ -468,11 +482,12 @@ const generic_params = [
    * @param {number | Pattern} decay time of the highpass filter envelope
    * @synonyms hpd
    * @example
-   * "baba"
+   * note("<c2 e2 f2 g2>")
-   * note("c3 e3 f3 g3 ab3 bb3")
+   * .sound('sawtooth')
-   *  .sound('square').hcutoff(1000)
+   * .hpf(500)
-   *  .hpdecay("<0.05 0.1 0.125>/2")
+   * .hpd("<.5 .25 .1 0>/4")
-   *  .ftype("12db").hps(0).hpr(0)
+   * .hps(0.2)
+   * .hpenv(4)
    */
   ['hpdecay', 'hpd'],
   /**
@@ -481,11 +496,12 @@ const generic_params = [
    * @param {number | Pattern} decay time of the bandpass filter envelope
    * @synonyms bpd
    * @example
-   * "baba"
+   * note("<c2 e2 f2 g2>")
-   * note("c3 e3 f3 g3 ab3 bb3")
+   * .sound('sawtooth')
-   *  .sound('square').bandf(1000)
+   * .bpf(500)
-   *  .bpdecay("<0.05 0.1 0.125>/2")
+   * .bpd("<.5 .25 .1 0>/4")
-   *  .ftype("12db").bps(0).bpr(0)
+   * .bps(0.2)
+   * .bpenv(4)
    */
   ['bpdecay', 'bpd'],
   /**
@@ -508,22 +524,26 @@ const generic_params = [
    * @param {number | Pattern} sustain amplitude of the highpass filter envelope
    * @synonyms hps
    * @example
-   * note("c3 e3 f3 g3 ab3 bb3")
+   * note("<c2 e2 f2 g2>")
-   *  .sound('square').hcutoff(200)
+   * .sound('sawtooth')
-   *  .hpd(0.1).hpsustain("<0.1 0.5 0.75 1>")
+   * .hpf(0)
-   *  .ftype("12db")
+   * .hpd(.5)
+   * .hps("<0 .25 .5 1>/4")
+   * .hpenv(4)
    */
   ['hpsustain', 'hps'],
   /**
    * Sets the sustain amplitude for the bandpass filter envelope.
-   * @name hpsustain
+   * @name bpsustain
    * @param {number | Pattern} sustain amplitude of the bandpass filter envelope
    * @synonyms bps
    * @example
-   * note("c3 e3 f3 g3 ab3 bb3")
+   * note("<c2 e2 f2 g2>")
-   *  .sound('square').bandf(200)
+   * .sound('sawtooth')
-   *  .bpd(0.1).bpsustain("<0.1 0.5 0.75 1>")
+   * .bpf(0)
-   *  .ftype("12db")
+   * .bpd(.5)
+   * .bps("<0 .25 .5 1>/4")
+   * .bpenv(4)
    */
   ['bpsustain', 'bps'],
   /**
@@ -547,7 +567,13 @@ 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("<c2 e2 f2 g2>")
+   * .sound('sawtooth')
+   * .clip(.5)
+   * .hpf(0)
+   * .hpenv(4)
+   * .hpr("<.5 .25 .1 0>/4")
+   * .release(.5)
    */
   ['hprelease', 'hpr'],
   /**
@@ -556,7 +582,13 @@ 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("<c2 e2 f2 g2>")
+   * .sound('sawtooth')
+   * .clip(.5)
+   * .bpf(0)
+   * .bpenv(4)
+   * .bpr("<.5 .25 .1 0>/4")
+   * .release(.5)
    */
   ['bprelease', 'bpr'],
   ['ftype'],

website/src/pages/learn/effects.mdx

@@ -93,32 +93,85 @@ There is one filter envelope for each filter type and thus one set of envelope f
 
 ## lpattack
 
-- Also `hpattack` and `bpattack`.
-
 <JsDoc client:idle name="lpattack" h={0} />
 
 ## lpdecay
 
-- Also `hpdecay` and `bpdecay`.
-
 <JsDoc client:idle name="lpdecay" h={0} />
 
 ## lpsustain
 
-- Also `hpsustain` and `bpsustain`.
-
 <JsDoc client:idle name="lpsustain" h={0} />
 
 ## lprelease
 
-- Also `hprelease` and `bprelease`.
-
 <JsDoc client:idle name="lprelease" h={0} />
 
 ## lpenv
 
 <JsDoc client:idle name="lpenv" h={0} />
 
+## hpattack
+
+<JsDoc client:idle name="hpattack" h={0} />
+
+## hpdecay
+
+<JsDoc client:idle name="hpdecay" h={0} />
+
+## hpsustain
+
+<JsDoc client:idle name="hpsustain" h={0} />
+
+## hprelease
+
+<JsDoc client:idle name="hprelease" h={0} />
+
+## hpenv
+
+<JsDoc client:idle name="hpenv" h={0} />
+
+## hpattack
+
+<JsDoc client:idle name="hpattack" h={0} />
+
+## hpdecay
+
+<JsDoc client:idle name="hpdecay" h={0} />
+
+## hpsustain
+
+<JsDoc client:idle name="hpsustain" h={0} />
+
+## hprelease
+
+<JsDoc client:idle name="hprelease" h={0} />
+
+## hpenv
+
+<JsDoc client:idle name="hpenv" h={0} />
+
+## bpattack
+
+<JsDoc client:idle name="bpattack" h={0} />
+
+## bpdecay
+
+<JsDoc client:idle name="bpdecay" h={0} />
+
+## bpsustain
+
+<JsDoc client:idle name="bpsustain" h={0} />
+
+## bprelease
+
+<JsDoc client:idle name="bprelease" h={0} />
+
+## bpenv
+
+<JsDoc client:idle name="bpenv" h={0} />
+
+
 # Dynamics
 
 ## gain