zink: document ZINK_DESCRIPTORS env var

Reviewed-by: Dave Airlie <airlied@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/12783>
2021-09-08 12:42:17 -04:00
parent 7c1b7ded7a
commit 7a03507f3c
1 changed files with 17 additions and 0 deletions
@@ -227,6 +227,23 @@ are required to be supported

  * `VK_KHR_draw_indirect_count`_

+Performance
+-----------
+
+If you notice poor performance and high CPU usage while running an application,
+changing the descriptor manager may improve performance:
+
+.. envvar:: ZINK_DESCRIPTORS <mode> ("auto")
+
+``auto``
+   Automatically detect best mode. This is the default.
+``lazy``
+   Disable caching and attempt to use the least amount of CPU.
+``nofallback``
+   Always use caching to try reducing GPU churn.
+``notemplates``
+   The same as `auto`, but disables the use of `VK_KHR_descriptor_templates`.
+
 Debugging
 ---------