1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
|
.TH @APPNAME@ "1" "January 2023" "@appname@ @appversion@"
.SH NAME
@appname@ \- OpenGL (ES) 2.0 benchmark suite
.SH SYNOPSIS
.B @appname@ [options]
.SH DESCRIPTION
\fB@appname@\fP is a benchmark for OpenGL (ES) 2.0. It only uses the subset of
the OpenGL 2.0 API that is compatible with OpenGL ES 2.0.
.SH OPTIONS
.TP
\fB\-b\fR, \fB\-\-benchmark\fR BENCH
A benchmark to run: 'scene(:opt1=val1)*'
(the option can be used multiple times)
.TP
\fB\-f\fR, \fB\-\-benchmark-file\fR FILE
Load benchmarks to run from a file containing a
list of benchmark descriptions (one per line)
(the option can be used multiple times)
.TP
\fB\-\-validate\fR
Run a quick output validation test instead of
running the benchmarks
.TP
\fB\-\-data-path\fR PATH
Path to glmark2 models, shaders and textures
.TP
\fB\-\-frame-end\fR METHOD
How to end a frame [default,none,swap,finish,readpixels]
.TP
\fB\-\-swap-mode\fR MODE
How to swap a frame, all modes supported only in the DRM flavor, 'fifo'
available in all flavors to force vsync [default,immediate,mailbox,fifo]
.TP
\fB\-\-off-screen\fR
Render to an off-screen surface
.TP
\fB--visual-config\fR
The visual configuration to use for the rendering target:
\'id=ID:red=R:green=G:blue=B:alpha=A:buffer=BUF:stencil=STENCIL:samples=SAMPLES'.
The parameters may be defined in any order, and any omitted parameters assume a
default value of '0' (id, stencil, samples) or '1' (red, green, blue, alpha, buffer).
If 'id' is set to a non-zero value, all other parameters are ignored
.TP
\fB\-\-reuse\-context\fR
Use a single context for all scenes
(by default, each scene gets its own context)
.TP
\fB\-s\fR, \fB\-\-size\fR WxH
Size of the output window (default: 800x600)
.TP
\fB\-\-fullscreen\fR
Run in fullscreen mode (equivalent to \-\-size \-1x\-1)
.TP
\fB\-\-results\fR RESULTS
The types of results to report for each benchmark, as a ':' separated list [fps,cpu,shader]
.TP
\fB\-\-results-file\fR RESULTS-FILE
The file to save the results to, in the format determined by the file extension [csv,xml]
.TP
\fB\-\-winsys-options\fR OPTS
A list of 'opt=value' pairs for window system specific options, separated by ':'
.TP
\fB\-l\fR, \fB\-\-list\-scenes\fR
Display information about the available scenes
and their options
.TP
\fB\-\-show-all-options\fR
Show all scene option values used for benchmarks
(only explicitly set options are shown by default)
.TP
\fB\-\-run-forever\fR
Run indefinitely, looping from the last benchmark
back to the first
.TP
\fB\-\-annotate\fR
Annotate the benchmarks with on-screen information
(same as \-b :show-fps=true:title=#info#)
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display debug messages
.TP
\fB\-\-version\fR
Display program version
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help
.SH BENCHMARKS
@appname@ offers a suite of scenes that can be used to measure many aspects
of OpenGL (ES) 2.0 performance. The way in which each scene is rendered is
configurable through a set of options. To get the available scenes and their
acceptable options you can use the \fB\-l\fR, \fB\-\-list\-scenes\fR command
line option.
In @appname@, a benchmark is defined as a scene plus a set of option values.
You can specify the list and order of the benchmarks to run by using the
\fB\-b\fR, \fB\-\-benchmark\fR command line option (possibly multiple times).
If no benchmarks are specified, a default set of benchmarks is used. If a
benchmark option is not specified it assumes its default value (listed with
\fB\-l\fR, \fB\-\-list\-scenes\fR).
As a special case, a benchmark description string is allowed to not contain a
scene name (i.e. to start with ':'). In this case, any specified option values
are used as the default values for benchmarks following this description
string.
.SH EXAMPLES
To run the default benchmarks:
.PP
.RS
\fB@appname@\fR
.RE
.PP
To run a benchmark using scene 'shading' with a 'duration' of '5.0' seconds and
'shading' of type 'phong':
.PP
.RS
\fB@appname@ \-b shading:duration=5.0:shading=phong\fR
.RE
.PP
To run a series of benchmarks use the \fB\-b\fR, \fB\-\-benchmark\fR command
line option multiple times:
.PP
.RS
\fB@appname@ \-b shading:duration=5.0 \-b build:use-vbo=false \-b texture\fR
.RE
.PP
To set default option values for benchmarks:
.PP
.RS
\fB@appname@ \-b :duration=2.0 \-b shading \-b build \-b :duration=5.0 \-b texture\fR
.RE
.PP
.SH AUTHOR
@appname@ was written by Alexandros Frantzis and Jesse Barker based on the original
glmark by Ben Smith.
|