docs: replace references to the deprecated VK_INSTANCE_LAYERS with the new VK_LOADER_LAYERS_ENABLE

Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/28516>
This commit is contained in:
Eric Engestrom
2024-04-01 17:06:34 +01:00
committed by Marge Bot
parent 5a8ce84c92
commit 96e8648b32
3 changed files with 8 additions and 8 deletions
+1 -1
View File
@@ -328,7 +328,7 @@ Another useful tool for debugging is the `Vulkan Validation Layers
The validation layers effectively insert extra checking between Zink and the
Vulkan driver, pointing out incorrect usage of the Vulkan API. The layers can
be enabled by setting the environment variable :envvar:`VK_INSTANCE_LAYERS` to
be enabled by setting the environment variable :envvar:`VK_LOADER_LAYERS_ENABLE` to
"VK_LAYER_KHRONOS_validation". You can read more about the Validation Layers
in the link above.
+1 -1
View File
@@ -2,4 +2,4 @@ A Vulkan layer to disable all rendering/compute commands.
To turn on the layer run :
VK_INSTANCE_LAYERS=VK_LAYER_INTEL_nullhw /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_INTEL_nullhw /path/to/my_vulkan_app
+6 -6
View File
@@ -20,27 +20,27 @@ Turn on the layer:
.. code-block:: sh
VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_overlay /path/to/my_vulkan_app
List the available statistics:
.. code-block:: sh
VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=help /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=help /path/to/my_vulkan_app
Turn on some statistics:
.. code-block:: sh
VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=submit,draw,pipeline_graphics /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=submit,draw,pipeline_graphics /path/to/my_vulkan_app
Position the overlay:
.. code-block:: sh
VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=submit,draw,pipeline_graphics,position=top-right /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=submit,draw,pipeline_graphics,position=top-right /path/to/my_vulkan_app
Logging Statistics
=======
@@ -49,7 +49,7 @@ Log statistics to a file:
.. code-block:: sh
VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=output_file=/tmp/output.txt /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=output_file=/tmp/output.txt /path/to/my_vulkan_app
Logging is enabled for the entire lifecycle of the process unless a control socket is specified (see below).
@@ -60,7 +60,7 @@ Log statistics to a file, controlling when such statistics will start to be capt
.. code-block:: sh
VK_INSTANCE_LAYERS=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=output_file=/tmp/output.txt,control=mesa_overlay /path/to/my_vulkan_app
VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_overlay VK_LAYER_MESA_OVERLAY_CONFIG=output_file=/tmp/output.txt,control=mesa_overlay /path/to/my_vulkan_app
The command above will open a Unix socket with the abstract path :code:`mesa_overlay`. When a control socket is specified,
logging must be explicitly enabled through the control socket. :code:`mesa-overlay-control.py` provides a convenient CLI: