1 A Vulkan layer to display information about the running application
4 To turn on the layer run :
6 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay /path/to/my_vulkan_app
8 List the available statistics :
10 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=help /path/to/my_vulkan_app
12 Turn on some statistics :
13 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=submit,draw,pipeline_graphics /path/to/my_vulkan_app
17 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=submit,draw,pipeline_graphics,position=top-right /path/to/my_vulkan_app
19 Dump statistics into a file:
21 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=position=top-right,output_file=/tmp/output.txt /path/to/my_vulkan_app
23 Dump statistics into a file, controlling when such statistics will start
26 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=position=top-right,output_file=/tmp/output.txt,control=mesa_overlay /path/to/my_vulkan_app
28 The above command will open a unix socket with abstract path
29 'mesa_overlay'. Once a client connects to the socket, the overlay layer
30 will immediately send the following commands to the client:
32 :MesaOverlayControlVersion=1;
33 :DeviceName=<device name>;
34 :MesaVersion=<mesa version>;
36 The client connected to the overlay layer can enable statistics
37 capturing by sending the command:
41 And disable it by emitting
45 By default, capture is enabled when an output_file is specified, but it
46 will be disabled by default when a control socket is in use. In the
47 latter case, it needs to be explicitly enabled through the sockets, by
48 using the commands above.
50 The provided script overlay-control.py can be used to start/stop
51 capture. The --path option can be used to specify the socket path. By
52 default, it will try to connect to a path named "mesa_overlay".