aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/optionsdialog.html8
-rw-r--r--doc/visualization.html13
2 files changed, 14 insertions, 7 deletions
diff --git a/doc/optionsdialog.html b/doc/optionsdialog.html
index 8d59dc2..efa5baf 100644
--- a/doc/optionsdialog.html
+++ b/doc/optionsdialog.html
@@ -44,12 +44,12 @@
<img src="../img/options2.png"><br>
<ul>
<li>Audio Driver**: specify the audio backend used by the internal synthesizer.</li>
- <li>Audio Buffer Size**: Size per buffer used by the fluidsynth engine.</li>
- <li>Audio Buffer Count**: Number of buffers used by the fluidsynth engine.</li>
+ <li>Audio Buffer Size**: Size per buffer used by the fluidsynth engine. Increase if experiencing audio interruption, decrease if audio is laggy or messed up.</li>
+ <li>Audio Buffer Count**: Number of buffers used by the fluidsynth engine. Increase if experiencing audio interruption or messy audio, decrease if audio is laggy.</li>
<li>Audio Format**: audio output format of the fluidsynth engine.</li>
<li>Audio Frequency**: audio output sampling frequency of the fluidsynth engine.</li>
- <li>Max Polyphony**: maximum simultaniously played voices of synthesizer.</li>
- <li>CPU Cores**: threads used by the internal synthesizer.</li>
+ <li>Max Polyphony**: maximum simultaniously played voices of synthesizer. High polyphony limit may cause lags. </li>
+ <li>CPU Cores**: threads used by the internal synthesizer. Too many threads may result in instability.</li>
<li>Auto bank select mode:<br>
If checked, the player will choose the appropriate bank selecting mode
according to the file standard. If the file doesn't specify the standard
diff --git a/doc/visualization.html b/doc/visualization.html
index 5ca7537..f482744 100644
--- a/doc/visualization.html
+++ b/doc/visualization.html
@@ -42,19 +42,26 @@ left | right ← → │ │
| Seek left/right └─────┘
backward (Hold shift to seek 5% instead of 1%)
</pre>
+ <h3>Known problems</h3>
+ <p>
+ In some systems closing and reopening the visualization results in a crash. This is
+ due to a dbus-related conflict in SDL and Qt.
+ </p>
<h3>Options</h3>
+ The options listed here are applied after closing and reopening the visualization.
<ul>
<li>
Visualization-Appearance
<ul>
- <li>Show Piano: Whether to show the virtual piano in the visualization scene.</li>
+ <li>Show Piano: Whether to show the virtual piano in the visualization scene. Currently drawing the piano is very expensive, so it is not recommended to enable this unless you have a beefy computer.</li>
<li>3D Notes: 2D notes are used when this is unchecked. Using 2D notes is less resource-hungry.</li>
<li>Arrange channels on a stair: If checked, virtual pianos will be arranged on a stair-like shape. This option has no effect if virtual piano is not shown.</li>
<li>Show channel labels: If checked, channel preset will be shown on the left side.</li>
<li>Show particles: Whether to draw particles. Very resource-intensive!</li>
<li>Horizontal Visualization: Uses a horizontal visualization style. Overrides everything above except 3D Notes.</li>
<li>2D Visualization: Tick this to use a simple 2D visualization instead. Much less resource-demanding.</li>
- <li>View distance: This option affects the maximum number of notes rendered on the screen. Only applies to 3D visualization.</li>
+ <li>Use spectrum instead of piano roll: Draw spectrum-like bars over the piano.</li>
+ <li>View distance: This option affects the maximum number of notes rendered on the screen. Only applies to the 3D visualization.</li>
<li>Note stretch: The length multiplier of notes.</li>
<li>Minimum note length: Avoid notes that are too short to be visible by adjusting this value.</li>
<li>Chequer board tint (AARRGGBB): change the color of the chequer board background.</li>
@@ -71,7 +78,7 @@ left | right ← → │ │
<li>Supersampling: Supersample anti-aliasing. 1 means no SSAA.</li>
<li>Multisampling: Multisample anti-aliasing. 0 means no MSAA.</li>
<li>FOV: Field of view.</li>
- <li>OSD Position: Change position of the on screen display, or just disable it.</li>
+ <li>OSD Position: Change position of the on screen display, or simply disable it.</li>
<li>Font size: Change font size used by the visualization. Useful for HiDPI screens.</li>
</ul>
</li>