summaryrefslogtreecommitdiff
path: root/QMidiPlayer/doc/visualization.html
diff options
context:
space:
mode:
authorGravatar Chris Xiong <chirs241097@gmail.com> 2019-02-10 11:16:07 +0800
committerGravatar Chris Xiong <chirs241097@gmail.com> 2019-02-10 11:16:07 +0800
commit9d3c8c0e6e1a7ba43bf3dc19350d1dca68b657a3 (patch)
tree339de0698c13e1763d3361d70fb1266621025c91 /QMidiPlayer/doc/visualization.html
downloadweb-9d3c8c0e6e1a7ba43bf3dc19350d1dca68b657a3.tar.xz
Initial commit.
Diffstat (limited to 'QMidiPlayer/doc/visualization.html')
-rw-r--r--QMidiPlayer/doc/visualization.html97
1 files changed, 97 insertions, 0 deletions
diff --git a/QMidiPlayer/doc/visualization.html b/QMidiPlayer/doc/visualization.html
new file mode 100644
index 0000000..f482744
--- /dev/null
+++ b/QMidiPlayer/doc/visualization.html
@@ -0,0 +1,97 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+ <div id="panel">
+ <ul>
+ <li><a href="index.html">Overview</a></li>
+ <li><a href="mainwindow.html">Main Window</a></li>
+ <li><a href="channeldialog.html">Channels Dialog</a></li>
+ <li><a href="channeleditor.html">Channel Editor</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a class="active" href="visualization.html">Visualization</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="miscellaneous.html">Miscellaneous</a></li>
+ <li><a href="version.html">Version Info.</a></li>
+ <li><a href="license.html">License</a></li>
+ </ul>
+ </div>
+ <div id="content">
+ <h1>Visualization</h1>
+ <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.<br>
+ The visualization plugin adds two new option tabs.
+ <h3>Controls</h3>
+<pre>
+ forward
+ | ↱Hold left mouse button and drag:
+ up | down ┌──┬──┐ Adjust viewport.
+ ↓ ↓ ↓ │ │ │
+ Q W E R←reset viewport ├──┴──┤
+ A S D │ │
+ ↑ ↑ ↑ │ │
+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. 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>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>
+ <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>
+ <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>
+ <li>
+ Key-only options<br>
+ Options listed here does not provide an entry in the option GUI. You have to add them to the configuration file manually if they don't exist in it.
+ <ul>
+ <li>px py pz rx ry rz (automatically created if save viewport is set to true): Doubles. Saves the last viewport. (px,py,pz): Position of the camera. (rx,ry,rz): Orientation of the camera.</li>
+ <li>chActiveColor&lt;channel id 0..15&gt; : Unsigned 32-bit integers. Colors of sounding notes.</li>
+ <li>chInactiveColor&lt;channel id 0..15&gt; : Unsigned 32-bit integers. Colors of normal notes.</li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+</body>
+</html>