Mesa (main): docs/envvars: document MESA_VK_WSI_PRESENT_MODE

[GitLab Mirror]

Module: Mesa
Branch: main
Commit: ae2b7a29d20546e494d8d10dfcf5880b54e5b999
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=ae2b7a29d20546e494d8d10dfcf5880b54e5b999

Author: Simon Ser <contact at emersion.fr>
Date:   Thu Jun 17 10:23:24 2021 +0200

docs/envvars: document MESA_VK_WSI_PRESENT_MODE

This env var was introduced in a182adfd83ad ("wsi: allow to override the
present mode with MESA_VK_WSI_PRESENT_MODE").

Signed-off-by: Simon Ser <contact at emersion.fr>
Reviewed-by: Samuel Pitoiset <samuel.pitoiset at gmail.com>
Reviewed-by: Adam Jackson <ajax at redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11441>

---

 docs/envvars.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/envvars.rst b/docs/envvars.rst
index a3b2e7eb5b6..d8b0ac29130 100644
--- a/docs/envvars.rst
+++ b/docs/envvars.rst
@@ -184,6 +184,10 @@ Core Mesa environment variables
       instance version as advertised by ``vkEnumerateInstanceVersion``
    -  This can be very useful for debugging but some features may not be
       implemented correctly. (For developers only)
+:envvar:`MESA_VK_WSI_PRESENT_MODE`
+   overrides the WSI present mode clients specify in
+   ``VkSwapchainCreateInfoKHR::presentMode``. Values can be ``fifo``,
+   ``relaxed``, ``mailbox`` or ``immediate``.
 :envvar:`MESA_LOADER_DRIVER_OVERRIDE`
    chooses a different driver binary such as ``etnaviv`` or ``zink``.