Merge pull request #1588 from tildearrow/doc-xyosc

XY-osc doc
This commit is contained in:
tildearrow 2023-11-12 23:07:01 -05:00 committed by GitHub
commit a9180009a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 1 deletions

View file

@ -18,6 +18,7 @@ as listed in the "Window" menu:
- [piano](piano.md)
- [oscilloscope](osc.md)
- [oscilloscope (X-Y)](xyosc.md)
- [oscilloscopes (per-channel)](chanosc.md)
- [clock](clock.md)
- [register view](regview.md)

View file

@ -1,6 +1,6 @@
# oscilloscope
the Oscilloscope shows the waveform of the mix of all currently playing sounds.
the Oscilloscope shows the audio output as a waveform.
![oscilloscope view](osc.png)

17
doc/8-advanced/xyosc.md Normal file
View file

@ -0,0 +1,17 @@
# oscilloscope (X-Y)
also called "vectorscope", this is similar to the normal oscilloscope in that it draws audio output as a waveform, but instead of being one-dimensional and going from left to right, it is plotted in two dimensions (usually X represents left output and Y represents right output).
(TODO: image)
right-clicking the X-Y oscilloscope window displays settings:
- **X Channel**: the output channel which will affect the X (left-right) axis. 1 is left.
- **Invert**: flips the axis.
- **Y Channel**: the output channel which will affect the Y (up-down) axis. 2 is right.
- **Invert**: flips the axis.
- **Zoom**: changes amplitude, making the plot bigger or smaller.
- **Samples**: the maximum number of samples to use for plotting.
- this setting may be replaced by another or removed in a future version.
- **Decay Time (ms)**: sets how long it takes for the points/lines to fade away.
- **Intensity**: changes the brightness of the dots/lines.
- **Line Thickness**: sets how thick lines are.