X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fenvvars.html;h=6d79398e1dfb41f42a620d158d4d30422c6afa43;hb=04d93ea61968b5f163ad37048f07929c55c278e9;hp=bdfe9991a6c86e630e927de20092221b309bf7b7;hpb=005c8e01062e8e88a86904b955d5422742bd32e7;p=mesa.git
diff --git a/docs/envvars.html b/docs/envvars.html
index bdfe9991a6c..6d79398e1df 100644
--- a/docs/envvars.html
+++ b/docs/envvars.html
@@ -50,8 +50,17 @@ sometimes be useful for debugging end-user issues.
if the application generates a GL_INVALID_ENUM error, a corresponding error
message indicating where the error occurred, and possibly why, will be
printed to stderr.
- If the value of MESA_DEBUG is 'FP' floating point arithmetic errors will
- generate exceptions.
+
+ For release builds, MESA_DEBUG defaults to off (no debug output).
+
+ MESA_DEBUG accepts the following comma-separated list of named
+ flags, which adds extra behaviour to just set MESA_DEBUG=1:
+
+ - silent - turn off debug messages. Only useful for debug builds.
+ - flush - flush after each drawing command
+ - incomplete_tex - extra debug messages when a texture is incomplete
+ - incomplete_fbo - extra debug messages when a fbo is incomplete
+
MESA_LOG_FILE - specifies a file name for logging all errors, warnings,
etc., rather than stderr
MESA_TEX_PROG - if set, implement conventional texture env modes with
@@ -91,11 +100,20 @@ This is only valid for versions >= 3.0.
Mesa may not really implement all the features of the given version.
(for developers only)
+MESA_GLES_VERSION_OVERRIDE - changes the value returned by
+glGetString(GL_VERSION) for OpenGL ES.
+
+- The format should be MAJOR.MINOR
+
- Examples: 2.0, 3.0, 3.1
+
- Mesa may not really implement all the features of the given version.
+(for developers only)
+
MESA_GLSL_VERSION_OVERRIDE - changes the value returned by
glGetString(GL_SHADING_LANGUAGE_VERSION). Valid values are integers, such as
"130". Mesa will not really implement all the features of the given language version
if it's higher than what's normally reported. (for developers only)
MESA_GLSL - shading language compiler options
+MESA_NO_MINMAX_CACHE - when set, the minmax index cache is globally disabled.
@@ -135,11 +153,10 @@ See the Xlib software driver page for details.
bat - emit batch information
pix - emit messages about pixel operations
buf - emit messages about buffer objects
- reg - emit messages about regions
fbo - emit messages about framebuffers
fs - dump shader assembly for fragment shaders
gs - dump shader assembly for geometry shaders
- sync - emit messages about synchronization
+ sync - after sending each batch, emit a message and wait for that batch to finish rendering
prim - emit messages about drawing primitives
vert - emit messages about vertex assembly
dri - emit messages about the DRI interface
@@ -154,6 +171,19 @@ See the Xlib software driver page for details.
blorp - emit messages about the blorp operations (blits & clears)
nodualobj - suppress generation of dual-object geometry shader code
optimizer - dump shader assembly to files at each optimization pass and iteration that make progress
+ ann - annotate IR in assembly dumps
+ no8 - don't generate SIMD8 fragment shader
+ vec4 - force vec4 mode in vertex shader
+ spill_fs - force spilling of all registers in the scalar backend (useful to debug spilling code)
+ spill_vec4 - force spilling of all registers in the vec4 backend (useful to debug spilling code)
+ cs - dump shader assembly for compute shaders
+ hex - print instruction hex dump with the disassembly
+ nocompact - disable instruction compaction
+ tcs - dump shader assembly for tessellation control shaders
+ tes - dump shader assembly for tessellation evaluation shaders
+ l3 - emit messages about the new L3 state during transitions
+ do32 - generate compute shader SIMD32 programs even if workgroup size doesn't exceed the SIMD16 limit
+ norbc - disable single sampled render buffer compression
@@ -179,6 +209,14 @@ Mesa EGL supports different sets of environment variables. See the
GALLIUM_HUD - draws various information on the screen, like framerate,
cpu load, driver statistics, performance counters, etc.
Set GALLIUM_HUD=help and run e.g. glxgears for more info.
+GALLIUM_HUD_PERIOD - sets the hud update rate in seconds (float). Use zero
+ to update every frame. The default period is 1/2 second.
+GALLIUM_HUD_VISIBLE - control default visibility, defaults to true.
+GALLIUM_HUD_TOGGLE_SIGNAL - toggle visibility via user specified signal.
+ Especially useful to toggle hud at specific points of application and
+ disable for unencumbered viewing the rest of the time. For example, set
+ GALLIUM_HUD_VISIBLE to false and GALLIUM_HUD_SIGNAL_TOGGLE to 10 (SIGUSR1).
+ Use kill -10 to toggle the hud as desired.
GALLIUM_LOG_FILE - specifies a file for logging all errors, warnings, etc.
rather than stderr.
GALLIUM_PRINT_OPTIONS - if non-zero, print all the Gallium environment
@@ -215,7 +253,7 @@ See src/mesa/state_tracker/st_debug.c for other options.
LP_PERF - a comma-separated list of options to selectively no-op various
parts of the driver. See the source code for details.
LP_NUM_THREADS - an integer indicating how many threads to use for rendering.
- Zero turns of threading completely. The default value is the number of CPU
+ Zero turns off threading completely. The default value is the number of CPU
cores present.
@@ -230,6 +268,31 @@ for details.
+VA-API state tracker environment variables
+
+- VAAPI_MPEG4_ENABLED - enable MPEG4 for VA-API, disabled by default.
+
+
+
+VC4 driver environment variables
+
+- VC4_DEBUG - a comma-separated list of named flags, which do various things:
+
+ - cl - dump command list during creation
+ - qpu - dump generated QPU instructions
+ - qir - dump QPU IR during program compile
+ - nir - dump NIR during program compile
+ - tgsi - dump TGSI during program compile
+ - shaderdb - dump program compile information for shader-db analysis
+ - perf - print during performance-related events
+ - norast - skip actual hardware execution of commands
+ - always_flush - flush after each draw call
+ - always_sync - wait for finish after each flush
+ - dump - write a GPU command stream trace file (VC4 simulator only)
+
+
+
+
Other Gallium drivers have their own environment variables. These may change
frequently so the source code should be consulted for details.