From 14c6640cee10eb99a4d1caabbca547befd9b9024 Mon Sep 17 00:00:00 2001 From: Tomi Korpipaa Date: Mon, 19 Oct 2020 13:24:30 +0300 Subject: Update documentation for viewer Task-number: QT3DS-4191 Change-Id: Icd5bc406c247a78cf80b94fca475fc0902a33c86 Reviewed-by: Tony Leinonen Reviewed-by: Janne Koskinen --- doc/src/04-viewer/0-menu.qdoc | 62 ++++++++++++++++----- doc/src/04-viewer/1-keyboard.qdoc | 49 ++++++++--------- doc/src/04-viewer/2-commandline.qdoc | 88 +++++++++++++++++++++++------- doc/src/04-viewer/3-remote-deployment.qdoc | 18 +++--- 4 files changed, 147 insertions(+), 70 deletions(-) diff --git a/doc/src/04-viewer/0-menu.qdoc b/doc/src/04-viewer/0-menu.qdoc index 253e59ca..6075b8fe 100644 --- a/doc/src/04-viewer/0-menu.qdoc +++ b/doc/src/04-viewer/0-menu.qdoc @@ -36,30 +36,64 @@ \list \li - \b{Open...} - Open a \c{.uip} presentation or - \c{.uia} application file to view. + \uicontrol {Open...} - Open a \c {.uip} presentation or \c {.uia} project file to view. \li - \b{Open Without Profiling...} - Same as \uicontrol Open but with certain profiling related - features disabled in order to improve performance. + \uicontrol {Connect...} - Open the remote deployment port setting dialog. \li - \b{Remote Setup} - Switches to the remote deployment settings screen with - instructions on how to remotely send presentations to this viewer. + \uicontrol {Reload} - Restart the presentation from the beginning. \li - \b{Reload} - Restart the presentation/application from the - beginning. -\li - \b{Exit} - Quit the Viewer. + \uicontrol {Quit} - Quit the Viewer. \endlist \section1 View \list \li - \b{Toggle Full Screen} - Switches to fullscreen mode. The menu bar may still - be visible, depending on the windowing system. + \uicontrol {Show Matte} - Toggle matte on or off. If this is disabled, the whole screen will be + filled with the background color. +\li + \uicontrol {Scale Mode} - Open the scale mode sub menu. + \list + \li + \uicontrol {Center} - Center the presentation inside the window without scaling. + \li + \uicontrol {Scale to Fit} - Scale the presentation to fit the window without extending the + background. + \li + \uicontrol {Scale to Fill} - Scale the presentation to fit the window while extending the + background to fill the window. + \endlist +\li + \uicontrol {Stereo Mode} - Open the stereo mode sub menu. + \list + \li + \uicontrol {Mono} - Disable stereo mode. + \li + \uicontrol {Top-Bottom} - Switch to top-bottom stereo mode. In this mode image for left + eye is rendered on top and image for right eye is rendered at the bottom. + \li + \uicontrol {Left-Right} - Switch to left-right stereo mode. In this mode images for left + and right eye are rendered side-by-side. + \li + \uicontrol {Anaglyph (Red - Cyan)} - Switch to red-cyan anaglyph stereo mode. + \note Anaglyph modes do not support all features. + \li + \uicontrol {Anaglyph (Green - Magenta)} - Switch to green-magenta anaglyph stereo mode. + \note Anaglyph modes do not support all features. + \li + \uicontrol {Progressive Rendering} - Toggle progressive rendering on or off. + \li + \uicontrol {Increase Separation} - Increase the eye separation. + \li + \uicontrol {Decrease Separation} - Decrease the eye separation. +\endlist +\li + \uicontrol {Show Render Statistics} - Switch the render statistics on or off. Render + statistics include information of the FPS, frame time, and init time of the whole presentation, + as well as time taken by different passes for each layer. \li - \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. + \uicontrol {Full Screen} - Switch to fullscreen mode. The menu bar may still be visible, + depending on the windowing system. \endlist */ diff --git a/doc/src/04-viewer/1-keyboard.qdoc b/doc/src/04-viewer/1-keyboard.qdoc index 10296605..a0e61e40 100644 --- a/doc/src/04-viewer/1-keyboard.qdoc +++ b/doc/src/04-viewer/1-keyboard.qdoc @@ -45,13 +45,18 @@ \li \c{Ctrl + O} \li \c{Ctrl + O} \li \c{Cmd + O} + \row + \li Connect + \li \c{F9} + \li \c{F9} + \li \c{F9} \row \li Reload \li \c{F5} \li \c{Ctrl + R} \li \c{F5} \row - \li Exit + \li Quit \li \c{Ctrl + Q} \li \c{Ctrl + Q} \li \c{Cmd + Q} @@ -66,58 +71,48 @@ \li Linux \li macOS \row - \li Show matte + \li Show Matte \li \c{Ctrl + D} \li \c{Ctrl + D} \li \c{Cmd + D} \row - \li Scale mode (toggle) + \li Scale Mode (toggle) \li \c{Ctrl + Shift + S} \li \c{Ctrl + Shift + S} \li \c{Cmd + Shift + S} \row - \li Stereo mode (toggle) + \li Stereo Mode (toggle) \li \c{Ctrl + Shift + T} \li \c{Ctrl + Shift + T} \li \c{Cmd + Shift + T} \row - \li Increase separation (in stereo mode) + \li Progressive Rendering (in stereo mode) + \li \c{Ctrl + Shift + P} + \li \c{Ctrl + Shift + P} + \li \c{Cmd + Shift + P} + \row + \li Increase Separation (in stereo mode) \li \c{Ctrl + Shift + +} \li \c{Ctrl + Shift + +} \li \c{Cmd + Shift + +} \row - \li Decrease separation (in stereo mode) + \li Decrease Separation (in stereo mode) \li \c{Ctrl + Shift + -} \li \c{Ctrl + Shift + -} \li \c{Cmd + Shift + -} \row - \li Full screen + \li Show Render Statistics + \li \c{F7} + \li \c{F7} + \li \c{F7} + \row + \li Full Screen \li \c{F11} \li \c{Ctrl + F11} \li \c{F11} \row \li \li {3, 1} To exit full screen, \c {F11}, \c {ESC} or swipe down gesture can be used. - \row - \li Toggle in-scene debug view - \li \c{F10} - \li \c{F10} - \li \c{F10} - \row - \li Toggle console - \li \c{`} - \li \c{`} - \li \c{`} - \row - \li Scale in-scene debug up - \li \c{Ctrl + F10} - \li \c{Ctrl + F10} - \li \c{Cmd + F10} - \row - \li Scale in-scene debug down - \li \c{Alt + F10} - \li \c{Alt + F10} - \li \c{Option + F10} \endtable */ diff --git a/doc/src/04-viewer/2-commandline.qdoc b/doc/src/04-viewer/2-commandline.qdoc index 3c78a29a..4469cff3 100644 --- a/doc/src/04-viewer/2-commandline.qdoc +++ b/doc/src/04-viewer/2-commandline.qdoc @@ -49,29 +49,77 @@ The following command line options are supported: \li Option \li Description \row - \li -?, -h, --help + \li -h, --help \li Displays help for command line usage. \row - \li -f, --fullscreen + \li --sequence + \li Generates an image sequence. The file argument must be specified. Specifying any of + the \c {seq-*} arguments implies setting this option. + \row + \li --seq-start + \li Start time of the sequence in milliseconds. The default value is \c {0}. + \row + \li --seq-end + \li End time of the sequence in milliseconds. The default value is \c {1000}. + \row + \li --seq-fps + \li Frames per second for the sequence. The default value is \c {60}. + \row + \li --seq-interval + \li Time interval between frames in the sequence in milliseconds. The \c {seq-fps} argument + is ignored if this argument is used. + \row + \li --seq-width + \li Width of the image sequence. The default value is \c {1920}. + \row + \li --seq-height + \li Height of the image sequence. The default value is \c {1080}. + \row + \li --seq-outpath + \li Output path of the image sequence. The default value is the current directory. + \row + \li --seq-outfile + \li Output filename base for the image sequence. The default value is derived from the + presentation filename. + \row + \li --connect + \li If this parameter is specified, the viewer is started in connection mode. The default + value is \c {36000}. + \row + \li --fullscreen \li Starts the viewer in fullscreen mode. \row - \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 - \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}. + \li --maximized + \li Starts the viewer in maximized mode. + \row + \li --windowgeometry + \li Specifies the initial window geometry using the X11-syntax. For example: + \c {1000x800+50+50} + \row + \li --mattecolor + \li Specifies custom matte color using #RRGGBB syntax. For example, white matte: + \c {#ffffff} + \row + \li --showstats + \li Show render statistics on screen. + \row + \li --scalemode + \li Specifies scaling mode. The default value is \c {center}. + \row + \li --stereomode + \li Specifies stereo mode. The default value is \c {mono}. + \row + \li --stereoeyeseparation + \li Specifies stereo eye separation. The default value is \c {0.4}. + \row + \li --enableprogressivestereo + \li Enables progressive stereoscopic rendering. + \row + \li --convert-shader-cache + \li Convert base64 dump to shader cache file. + \row + \li -v, --variants + \li Gives list of variant groups and variants to be loaded from the presentation. For + example \c {VarGroupA:var1,VarGroupB:var4}. \endtable - */ diff --git a/doc/src/04-viewer/3-remote-deployment.qdoc b/doc/src/04-viewer/3-remote-deployment.qdoc index b9da5e8f..544658df 100644 --- a/doc/src/04-viewer/3-remote-deployment.qdoc +++ b/doc/src/04-viewer/3-remote-deployment.qdoc @@ -34,7 +34,7 @@ Qt 3D Studio supports remote deployment to Qt 3D Studio Viewer. This enables seeing design changes live in the target device, for example an Android tablet. -\note For supported devices and operating systems see the \l{Requirements} page. +\note For supported devices and operating systems see the \l {Requirements} page. \section1 Setting Up the Target Device @@ -65,33 +65,33 @@ Qt3DViewer When you run the Viewer in connection mode it will display connection details, IP address and port, right away. -For full usage, see the \l{Viewer: Command Line Usage}{Command line usage documentation}. +For full usage, see the \l {Viewer: Command Line Usage}{Command line usage documentation}. \section1 Connecting to the Target Device To connect to the target device Viewer from Qt 3D Studio, follow the steps below. \list 1 - \li From the file menu, select \uicontrol {File > Connect to Device}. + \li From the menu, select \uicontrol {Edit > Connect to Device}. \li Enter the connection information displaying in the Viewer on the target device, then press - \uicontrol{OK}. + \uicontrol {OK}. \note Previous used IP and port is automatically inserted when you click \uicontrol {Connect to Device}. - \li You are now connected. The Viewer on the target device should display \e{Remote Connected}. + \li You are now connected. The Viewer on the target device should display \e {Remote Connected}. \endlist \section1 Preview Presentation -To preview the presentation on the target device, press the \uicontrol{Remote Preview} button +To preview the presentation on the target device, press the \uicontrol {Remote Preview} button \inlineimage remote-preview-button.png in the Studio toolbar. -After making changes to your presentation, press the \uicontrol{Remote Preview} button to see the +After making changes to your presentation, press the \uicontrol {Remote Preview} button to see the changes on the target device. \section1 Disconnecting from the Target Device -You can disconnect from the target device by selecting \uicontrol{File > Connect to Device} -from the Studio file menu. +You can disconnect from the target device by selecting \uicontrol {Edit > Connect to Device} +from the Studio menu. */ -- cgit v1.2.3