Mesa (main): docs: document RADV_THREAD_TRACE_* envvars

[GitLab Mirror]

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

Author: Samuel Pitoiset <samuel.pitoiset at gmail.com>
Date:   Fri Oct 22 09:41:56 2021 +0200

docs: document RADV_THREAD_TRACE_* envvars

Signed-off-by: Samuel Pitoiset <samuel.pitoiset at gmail.com>
Reviewed-by: Bas Nieuwenhuizen <bas at basnieuwenhuizen.nl>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13477>

---

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

diff --git a/docs/envvars.rst b/docs/envvars.rst
index 92e568715e2..d3321fd4556 100644
--- a/docs/envvars.rst
+++ b/docs/envvars.rst
@@ -725,6 +725,22 @@ RADV driver environment variables
 :envvar:`RADV_TEX_ANISO`
    force anisotropy filter (up to 16)
 
+:envvar:`RADV_THREAD_TRACE`
+   enable frame based SQTT/RGP captures (eg. `export RADV_THREAD_TRACE=100`
+   will capture the frame #100)
+
+:envvar:`RADV_THREAD_TRACE_BUFFER_SIZE`
+   set the SQTT/RGP buffer size in bytes (default value is 32MiB, the buffer is
+   automatically resized if too small)
+
+:envvar:`RADV_THREAD_TRACE_INSTRUCTION_TIMING`
+   enable/disable SQTT/RGP instruction timing (enabled by default)
+
+:envvar:`RADV_THREAD_TRACE_TRIGGER`
+   enable trigger file based SQTT/RGP captures (eg.
+   `export RADV_THREAD_TRACE_TRIGGER=/tmp/radv_sqtt_trigger` and then
+   `touch /tmp/radv_sqtt_trigger` to capture a frame)
+
 :envvar:`ACO_DEBUG`
    a comma-separated list of named flags, which do various things: