diff options
Diffstat (limited to 'doc/src/04-viewer/2-commandline.qdoc')
| -rw-r--r-- | doc/src/04-viewer/2-commandline.qdoc | 90 |
1 files changed, 69 insertions, 21 deletions
diff --git a/doc/src/04-viewer/2-commandline.qdoc b/doc/src/04-viewer/2-commandline.qdoc index e45a0e78..4469cff3 100644 --- a/doc/src/04-viewer/2-commandline.qdoc +++ b/doc/src/04-viewer/2-commandline.qdoc @@ -37,7 +37,7 @@ for incoming connections with a presentation sent remotely. \section1 Usage \badcode - q3dsviewer [options] [presentation file] + Qt3DViewer [options] [presentation file] \endcode When no filename is given, the viewer is launched in remote connection mode. @@ -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 <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} argument + is ignored if this argument 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 filename base for the image sequence. The default value is derived from the + presentation filename. + \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 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 <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}. + \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 #RRGGBB 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}. + \row + \li --stereomode <mono|topbottom|leftright> + \li Specifies stereo mode. The default value is \c {mono}. + \row + \li --stereoeyeseparation <separation> + \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 <filename> + \li Convert base64 dump to shader cache file. + \row + \li -v, --variants <variants> + \li Gives list of variant groups and variants to be loaded from the presentation. For + example \c {VarGroupA:var1,VarGroupB:var4}. \endtable - */ |