From 8ef9703ee2a4b22395935030606fcf69e3acad86 Mon Sep 17 00:00:00 2001
From: Chris Xiong <chirs241097@gmail.com>
Date: Wed, 18 May 2016 23:58:40 +0800
Subject: Finally finish the particle system integration. Add std::wstring
 version APIs to avoid wrong encoding. Update documentation.

---
 doc/optionsdialog.html |  1 +
 doc/visualization.html | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 46 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/optionsdialog.html b/doc/optionsdialog.html
index ed38f35..8d59dc2 100644
--- a/doc/optionsdialog.html
+++ b/doc/optionsdialog.html
@@ -75,6 +75,7 @@
 	</ul>
 	<img src="../img/options5.png"><br>
 	Plugin manager. View details of plugins, enable or disable them here.<br>
+	Enabled plugin list is applied after a restart.<br>
 	Plugin scanning follows the order below:
 	<ul>
 		<li>(*nix) /usr/lib/qmidiplayer</li>
diff --git a/doc/visualization.html b/doc/visualization.html
index 8870e0c..33c6977 100644
--- a/doc/visualization.html
+++ b/doc/visualization.html
@@ -27,7 +27,51 @@
 		<img src="../img/visualizationss.png"><br>
 		The default visualization comes as a plugin of QMidiPlayer. So before using it you
 		have to enable it first in the plugin manager.<br>
-		To use the visualization, click the Visualization button in the main window.
+		To use the visualization, click the Visualization button in the main window.<br>
+		The visualization plugin adds two new option tabs.
+		<h3>Controls</h3>
+		<pre>
+   forward
+      |              ↱Press and hold left mouse button:
+   up |  down       ┌──┬──┐ Adjust camera direction.
+   ↓  ↓  ↓          │  │  │
+   Q  W  E          ├──┴──┤
+   A  S  D          │     │
+   ↑  ↑  ↑          │     │
+left  |  right      │     │
+      |             └─────┘
+   backward
+		</pre>
+		<h3>Options</h3>
+		<ul>
+			<li>
+				Visualization-Appearance
+				<ul>
+					<li>Show Piano: Whether to show the virtual piano in the visualization scene.</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>View distance: This option affects the maximum number of notes rendered on the screen.</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: change the color of the chequer board background.</li>
+					<li>Background Image: Use a background image instead of the default dull grey color.</li>
+				</ul>
+			</li>
+			<li>
+				Visualization-Video
+				<ul>
+					<li>Enable VSync: Enable vertical synchronization.</li>
+					<li>Save Viewport: Restore last camera configuration when the visualization is started.</li>
+					<li>Window Width/Height: Change the window size. If the size equals to your screen size, the visualization will start in fullscreen mode.</li>
+					<li>FPS: FPS limit of the visualization.</li>
+					<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>
+				</ul>
+			</li>
+		</ul>
 	</div>
 </body>
 </html>
\ No newline at end of file
-- 
cgit v1.2.3