1vkmark(1)                   General Commands Manual                  vkmark(1)
2
3
4

NAME

6       vkmark - Vulkan benchmark suite
7

SYNOPSIS

9       vkmark [options]
10

DESCRIPTION

12       vkmark  is  an extensible Vulkan benchmarking suite with targeted, con‐
13       figurable scenes.
14

OPTIONS

16       -b, --benchmark BENCH
17              A benchmark to run: 'scene(:opt1=val1)*' (the option can be used
18              multiple times)
19
20       -s, --size WxH
21              Size of the output window (default: 800x600)
22
23       --fullscreen
24              Run in fullscreen mode (equivalent to --size -1x-1)
25
26       -p, --present-mode PM
27              Vulkan  present  mode  (default:  mailbox)  [immediate, mailbox,
28              fifo, fiforelaxed]
29
30       --pixel-format PF
31              Vulkan pixel format (default: choose best)
32
33       -l, --list-scenes
34              Display information about the available scenes and their options
35
36       --show-all-options
37              Show all scene option values used for benchmarks  (only  explic‐
38              itly set options are shown by default)
39
40       --winsys-dir DIR
41              Directory to search in for window system plugins
42
43       --data-dir DIR
44              Directory to search in for scene data files
45
46       --winsys WS
47              Window  system  plugin  to use (default: choose best) [xcb, way‐
48              land, kms]
49
50       --winsys-options OPTS
51              Window system options as 'opt1=val1(:opt2=val2)*'
52
53       --run-forever
54              Run indefinitely, looping from the last benchmark  back  to  the
55              first
56
57       -d, --debug
58              Display debug messages
59
60       -h, --help
61              Display help
62

BENCHMARKS

64       vkmark  offers  a  suite  of scenes that can be used to measure various
65       aspects of Vulkan performance. The way in which each scene is  rendered
66       is  configurable  through a set of options. To get the available scenes
67       and their acceptable options you can use the -l, --list-scenes  command
68       line option.
69
70       In  vkmark, a benchmark is defined as a scene plus a set of option val‐
71       ues.  You can specify the list and order of the benchmarks  to  run  by
72       using  the  -b,  --benchmark  command  line  option  (possibly multiple
73       times).  If no benchmarks are specified, a default set of benchmarks is
74       used.  If  a  benchmark  option is not specified it assumes its default
75       value (listed with -l, --list-scenes).
76
77       As a special case, a benchmark description string  is  allowed  to  not
78       contain a scene name (i.e. to start with ':'). In this case, any speci‐
79       fied option values are used as the default values for  benchmarks  fol‐
80       lowing this description string.
81
82

EXAMPLES

84       To run the default benchmarks:
85
86              vkmark
87
88       To run a benchmark using scene 'vertex' with a 'duration' of '5.0' sec‐
89       onds and 'interleave' set to 'false':
90
91              vkmark -b vertex:duration=5.0:interleave=false
92
93       To run a series of benchmarks use  the  -b,  --benchmark  command  line
94       option multiple times:
95
96              vkmark -b vertex:duration=5.0 -b clear:color=1.0,0.5,0 -b cube
97
98       To set default option values for benchmarks and run them:
99
100              vkmark  -b  :duration=2.0 -b vertex -b clear -b :duration=5.0 -b
101              cube
102
103       To set default option values for the default benchmarks and run them:
104
105              vkmark -b :duration=2.0
106

AUTHOR

108       vkmark was written by Alexandros Frantzis
109
110
111
112vkmark 2017.08                    August 2017                        vkmark(1)