improve effects doc

This commit is contained in:
Felix Roos 2023-01-06 21:14:19 +01:00
parent d4518f7a6e
commit ebb1bbc966
3 changed files with 84 additions and 24 deletions

View file

@ -12,54 +12,85 @@ import { JsDoc } from '../../docs/JsDoc';
Wether you're using a synth or a sample, you can apply any of the following built-in audio effects.
As you might suspect, the effects can be chained together, and they accept a pattern string as their argument.
# bandf
## bandf
<JsDoc client:idle name="bandf" h={0} />
# bandq
## bandq
<JsDoc client:idle name="bandq" h={0} />
# coarse
## coarse
<JsDoc client:idle name="coarse" h={0} />
# crush
## crush
<JsDoc client:idle name="crush" h={0} />
# cutoff
## cutoff
<JsDoc client:idle name="cutoff" h={0} />
# gain
## gain
<JsDoc client:idle name="gain" h={0} />
# hcutoff
## hcutoff
<JsDoc client:idle name="hcutoff" h={0} />
# hresonance
## hresonance
<JsDoc client:idle name="hresonance" h={0} />
# pan
## pan
<JsDoc client:idle name="pan" h={0} />
# resonance
## resonance
<JsDoc client:idle name="resonance" h={0} />
# shape
## shape
<JsDoc client:idle name="shape" h={0} />
# velocity
## velocity
<JsDoc client:idle name="velocity" h={0} />
# vowel
## vowel
<JsDoc client:idle name="vowel" h={0} />
# Global Effects
## Local vs Global Effects
While the above listed "local" effects will always create a separate effects chain for each event,
global effects use the same chain for all events of the same orbit:
## orbit
<JsDoc client:idle name="orbit" h={0} />
## delay
<JsDoc client:idle name="delay" h={0} />
## delaytime
<JsDoc client:idle name="delaytime" h={0} />
## delayfeedback
<JsDoc client:idle name="delayfeedback" h={0} />
## room
<JsDoc client:idle name="room" h={0} />
## size / roomsize
<JsDoc client:idle name="size" h={0} />

View file

@ -217,6 +217,10 @@ Almost everything in Tidal can be patterned using strings!
<JsDoc client:idle name="Pattern.end" h={0} />
### `cut`
<JsDoc client:idle name="cut" h={0} />
### `loopAt`
<JsDoc client:idle name="Pattern.loopAt" h={0} />
@ -225,4 +229,6 @@ Almost everything in Tidal can be patterned using strings!
<JsDoc client:idle name="Pattern.chop" h={0} />
<br />
### `speed`
<JsDoc client:idle name="speed" h={0} />