vulkan: add an overlay layer
[mesa.git] / src / vulkan / overlay-layer / README
1 A Vulkan layer to display information about the running application
2 using an overlay.
3
4 To turn on the layer run :
5 ```
6 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay /path/to/my_vulkan_app
7 ```
8
9 List the available statistics :
10 ```
11 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_STATS=help /path/to/my_vulkan_app
12 ```
13
14 Turn on some statistics :
15 ```
16 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_STATS=submit,draw,pipeline-graphics /path/to/my_vulkan_app
17 ```
18
19 Position the layer :
20 ```
21 VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_STATS=submit,draw,pipeline-graphics VK_LAYER_MESA_OVERLAY_POSITION=top-right /path/to/my_vulkan_app
22 ```