Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XY-osc doc #1588

Merged
merged 2 commits into from
Nov 13, 2023
Merged

XY-osc doc #1588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7befd2
fix osc.md
tildearrow Nov 13, 2023
5c19931
X-Y osc documentation
tildearrow Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/8-advanced/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/8-advanced/osc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
17 changes: 17 additions & 0 deletions doc/8-advanced/xyosc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.