summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@qt.io>2018-05-15 12:19:21 +0200
committerLaszlo Agocs <laszlo.agocs@qt.io>2018-05-15 11:54:50 +0000
commit488e042cae1a296cc338ce5cd1433fe6c7004224 (patch)
tree12e8e794078ca3fb07a60f4cb229cbacf9ed4e25
parent35b12a4edfda4d40d9215de90d2a84945fe01ef0 (diff)
docs: update Viewer section
Change-Id: I2f9b6576a52c539e16a9be6d33cf31e7e1ff03ba Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Andy Nichols <andy.nichols@qt.io>
-rw-r--r--doc/src/04-viewer/0-menu.qdoc30
-rw-r--r--doc/src/04-viewer/1-keyboard.qdoc35
-rw-r--r--doc/src/04-viewer/2-commandline.qdoc85
-rw-r--r--doc/src/04-viewer/3-remote-deployment.qdoc6
4 files changed, 51 insertions, 105 deletions
diff --git a/doc/src/04-viewer/0-menu.qdoc b/doc/src/04-viewer/0-menu.qdoc
index 6d105d66..253e59ca 100644
--- a/doc/src/04-viewer/0-menu.qdoc
+++ b/doc/src/04-viewer/0-menu.qdoc
@@ -39,37 +39,27 @@
\b{Open...} - Open a \c{.uip} presentation or
\c{.uia} application file to view.
\li
- \b{Connect...} - Show connection dialog to set up remote deployment connection.
+ \b{Open Without Profiling...} - Same as \uicontrol Open but with certain profiling related
+ features disabled in order to improve performance.
+\li
+ \b{Remote Setup} - Switches to the remote deployment settings screen with
+ instructions on how to remotely send presentations to this viewer.
\li
\b{Reload} - Restart the presentation/application from the
beginning.
\li
- \b{Quit} - Quit the Viewer.
+ \b{Exit} - Quit the Viewer.
\endlist
\section1 View
\list
\li
- \b{Show Matte} - Toggle the display of any letterboxed regions
- (areas outside the initial presentation) as a gray matte. When
- disabled, the clear color for the initial presentation is displayed
- instead.
-\li
- \b{Scale Mode} - Override the scale mode set by the
- \l{file-formats-uia.html#application}{application}:
- \image Runtime-ApplicationScaleMode.png
-\li
- \b{Show Render Statistics} - Display debug information on top of
- the viewer with information for recent average frame rate/frame time.
+ \b{Toggle Full Screen} - Switches to fullscreen mode. The menu bar may still
+ be visible, depending on the windowing system.
\li
- \b{Full Screen} - Remove the window for the viewer and use the
- full screen for the application. (Whether or not the initial
- presentation fills the screen or not depends on the
- \l{studio-menu.html#project-settings}{presentation size}
- and the scale mode, which is set via the application
- \l{file-formats-uia.html#application}{scale mode setting}, or
- Viewer override command (see \e{Scale Mode} above).
+ \b{Profile and Debug} - Submenu with options to show/hide the built-in, in-scene
+ profiling and information pane, and to control its scale factor.
\endlist
*/
diff --git a/doc/src/04-viewer/1-keyboard.qdoc b/doc/src/04-viewer/1-keyboard.qdoc
index 2a804bb8..eb2ba03f 100644
--- a/doc/src/04-viewer/1-keyboard.qdoc
+++ b/doc/src/04-viewer/1-keyboard.qdoc
@@ -37,22 +37,22 @@
\table
\header
\li Function
- \li Windows/Linux
+ \li Windows
+ \li Linux
\li macOS
\row
\li Open
\li \c{Ctrl + O}
+ \li \c{Ctrl + O}
\li \c{Cmd + O}
\row
- \li Connect
- \li \c{F9}
- \li \c{F9}
- \row
\li Reload
\li \c{F5}
+ \li \c{Ctrl + R}
\li \c{F5}
\row
- \li Quit
+ \li Exit
+ \li \c{Ctrl + Q}
\li \c{Ctrl + Q}
\li \c{Cmd + Q}
\endtable
@@ -62,27 +62,22 @@
\table
\header
\li Function
- \li Windows/Linux
+ \li Windows
+ \li Linux
\li macOS
\row
- \li Show Matte
- \li \c{Ctrl + D}
- \li \c{Cmd + D}
- \row
- \li Scale Modes (cycle through)
- \li \c{Ctrl + Shift + S}
- \li \c{Cmd + Shift + S}
- \row
- \li Show Render Statistics
- \li \c{F7}
- \li \c{F7}
- \row
\li Full Screen
\li \c{F11}
+ \li \c{Ctrl + F11}
\li \c{F11}
\row
\li
- \li {2, 1} To exit full screen, \c {F11}, \c {ESC} or swipe down gesture can be used.
+ \li {3, 1} To exit full screen, \c {F11}, \c {ESC} or swipe down gesture can be used.
+ \row
+ \li Toggle debug view
+ \li \c{F10}
+ \li \c{F10}
+ \li \c{F10}
\endtable
*/
diff --git a/doc/src/04-viewer/2-commandline.qdoc b/doc/src/04-viewer/2-commandline.qdoc
index bd15896d..e45a0e78 100644
--- a/doc/src/04-viewer/2-commandline.qdoc
+++ b/doc/src/04-viewer/2-commandline.qdoc
@@ -31,15 +31,17 @@
\page viewer-commandline.html
\ingroup qt3dstudio-viewer
-The Qt 3D Studio Viewer supports launching a specific presentation and generating image
-sequences using command line arguments.
+The Qt 3D Studio Viewer supports launching a specific presentation or waiting
+for incoming connections with a presentation sent remotely.
\section1 Usage
\badcode
- Qt3DViewer [options] [presentation file]
+ q3dsviewer [options] [presentation file]
\endcode
+When no filename is given, the viewer is launched in remote connection mode.
+
The following command line options are supported:
\table
@@ -50,67 +52,26 @@ The following command line options are supported:
\li -?, -h, --help
\li Displays help for command line usage.
\row
- \li --sequence
- \li Generates an image sequence. The \c{presentation file} argument must be specified.
- Specifying any of the seq-* options implies setting this option.
- \row
- \li --seq-start <ms>
- \li Start time of the sequence in milliseconds. The default value is \c{0}.
- \row
- \li --seq-end <ms>
- \li End time of the sequence in milliseconds. The default value is \c{1000}.
- \row
- \li --seq-fps <fps>
- \li Frames per second for the sequence. The default value is \c{60}.
- \row
- \li --seq-interval <ms>
- \li Time interval between frames in the sequence in milliseconds.
- The \c{seq-fps} option is ignored if this option is used.
- \row
- \li --seq-width <pixels>
- \li Width of the image sequence. The default value is \c{1920}.
- \row
- \li --seq-height <pixels>
- \li Height of the image sequence. The default value is \c{1080}.
- \row
- \li --seq-outpath <path>
- \li Output path of the image sequence. The default value is the current directory.
- \row
- \li --seq-outfile <file>
- \li Output file name base for the image sequence.
- The default value is derived from the presentation file name.
- \row
- \li --connect <port>
- \li If this parameter is specified, the viewer is started in connection mode.
- The default value is \c{36000}.
- \row
- \li --fullscreen
+ \li -f, --fullscreen
\li Starts the viewer in fullscreen mode.
\row
- \li --maximized
- \li Starts the viewer in maximized mode.
- \row
- \li --windowgeometry <geometry>
- \li Specifies the initial window geometry using the X11-syntax.
- For example: \c{1000x800+50+50}
- \row
- \li --mattecolor <color>
- \li Specifies custom matte color using \c{#000000} syntax.
- For example, white matte: \c{#ffffff}
- \row
- \li --showstats
- \li Show render statistics on screen.
- \row
- \li --scalemode <center|fit|fill>
- \li Specifies scaling mode. The default value is \c{center}.
+ \li -w, --no-main-window
+ \li Disables the widget-based user interface, such as the menu bar.
+ This mode simulates the operating mode typical on embedded devices:
+ using a Qt platform plugin like \c eglfs, there will only be a single,
+ fullscreen QWindow (or, with Qt Quick applications, QQuickWindow or
+ QQuickView) present. This argument achieves the same even when running
+ on a desktop operating system. Combined with \c{-f} (going fullscreen)
+ this allows seeing the presentation in real full screen (no menu bar).
+ \row
+ \li -p, --no-profile
+ \li Loads the presentation with some profiling options disabled. This
+ provides minimal performance improvements.
+ \row
+ \li --port <port_number>
+ \li Sets the port on which the viewer listens for remote connections.
+ The remote connection mode is active either when launching with no
+ presentation file specified, or when choosing \uicontrol{File > Remote Setup}.
\endtable
-\section1 Example
-
-Creating a one minute 4k image sequence of a presentation:
-
-\badcode
- Qt3DViewer --seq-end 60000 --seq-width 3840 --seq-height 2160 MyPresentation.uip
-\endcode
-
*/
diff --git a/doc/src/04-viewer/3-remote-deployment.qdoc b/doc/src/04-viewer/3-remote-deployment.qdoc
index 3f58fc9e..d2379546 100644
--- a/doc/src/04-viewer/3-remote-deployment.qdoc
+++ b/doc/src/04-viewer/3-remote-deployment.qdoc
@@ -59,7 +59,7 @@ For embedded systems you will have to compile the application on the target devi
You can run the Viewer from the command line. The default mode is connection mode. To start the
Viewer, use the following command:
\badcode
-Qt3DViewer
+q3dsviewer
\endcode
When you run the Viewer in connection mode it will display connection details, IP address and port,
@@ -91,7 +91,7 @@ changes on the target device.
\section1 Disconnecting from the Target Device
-You can disconnect from the target device either by selecting \uicontrol{File > Connect to Device}
-from the Studio file menu, or by selecting \uicontrol{File > Disconnect} from the Viewer file menu.
+You can disconnect from the target device by selecting \uicontrol{File > Connect to Device}
+from the Studio file menu.
*/