X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fenvvars.html;h=e4d929ebd14ffd90164babc2d84c600be56504a7;hb=f53ebfb4503a1ae054539df1c414b86c3b1966d9;hp=ed957bd1999a5e027065fcdfaa4683c3800e3274;hpb=6ca118d2f402495e88e5d534773007ac680885a2;p=mesa.git
diff --git a/docs/envvars.html b/docs/envvars.html
index ed957bd1999..e4d929ebd14 100644
--- a/docs/envvars.html
+++ b/docs/envvars.html
@@ -8,7 +8,7 @@
@@ -29,12 +29,12 @@ sometimes be useful for debugging end-user issues.
LIBGL_DEBUG - If defined debug information will be printed to stderr.
If set to 'verbose' additional information will be printed.
LIBGL_DRIVERS_PATH - colon-separated list of paths to search for DRI drivers
-LIBGL_ALWAYS_INDIRECT - forces an indirect rendering context/connection.
-LIBGL_ALWAYS_SOFTWARE - if set, always use software rendering
-LIBGL_NO_DRAWARRAYS - if set do not use DrawArrays GLX protocol (for debugging)
+LIBGL_ALWAYS_INDIRECT - if set to `true`, forces an indirect rendering context/connection.
+LIBGL_ALWAYS_SOFTWARE - if set to `true`, always use software rendering
+LIBGL_NO_DRAWARRAYS - if set to `true`, do not use DrawArrays GLX protocol (for debugging)
LIBGL_SHOW_FPS - print framerate to stdout based on the number of glXSwapBuffers
calls per second.
-LIBGL_DRI3_DISABLE - disable DRI3 if set (the value does not matter)
+LIBGL_DRI3_DISABLE - disable DRI3 if set to `true`.
@@ -46,12 +46,26 @@ sometimes be useful for debugging end-user issues.
MESA_NO_MMX - if set, disables Intel MMX optimizations
MESA_NO_3DNOW - if set, disables AMD 3DNow! optimizations
MESA_NO_SSE - if set, disables Intel SSE optimizations
+MESA_NO_ERROR - if set to 1, error checking is disabled as per KHR_no_error.
+ This will result in undefined behaviour for invalid use of the api, but
+ can reduce CPU use for apps that are known to be error free.
MESA_DEBUG - if set, error messages are printed to stderr. For example,
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
+ - context - create a debug context (see GLX_CONTEXT_DEBUG_BIT_ARB) and
+ print error and performance messages to stderr (or MESA_LOG_FILE).
+
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
@@ -74,22 +88,40 @@ This is a work-around for that.
MESA_GL_VERSION_OVERRIDE - changes the value returned by
glGetString(GL_VERSION) and possibly the GL API type.
-- The format should be MAJOR.MINOR[FC]
-
- FC is an optional suffix that indicates a forward compatible context.
-This is only valid for versions >= 3.0.
-
- GL versions < 3.0 are set to a compatibility (non-Core) profile
-
- GL versions = 3.0, see below
-
- GL versions > 3.0 are set to a Core profile
-
- Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC
-
-- 2.1 - select a compatibility (non-Core) profile with GL version 2.1
-
- 3.0 - select a compatibility (non-Core) profile with GL version 3.0
-
- 3.0FC - select a Core+Forward Compatible profile with GL version 3.0
-
- 3.1 - select a Core profile with GL version 3.1
-
- 3.1FC - select a Core+Forward Compatible profile with GL version 3.1
-
- - Mesa may not really implement all the features of the given version.
-(for developers only)
+
- The format should be MAJOR.MINOR[FC|COMPAT]
+
- FC is an optional suffix that indicates a forward compatible
+ context. This is only valid for versions >= 3.0.
+
- COMPAT is an optional suffix that indicates a compatibility
+ context or GL_ARB_compatibility support. This is only valid for
+ versions >= 3.1.
+
- GL versions <= 3.0 are set to a compatibility (non-Core)
+ profile
+
- GL versions = 3.1, depending on the driver, it may or may not
+ have the ARB_compatibility extension enabled.
+
- GL versions >= 3.2 are set to a Core profile
+
- Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC, 3.1COMPAT, X.Y, X.YFC,
+ X.YCOMPAT.
+
+ - 2.1 - select a compatibility (non-Core) profile with GL
+ version 2.1.
+
- 3.0 - select a compatibility (non-Core) profile with GL
+ version 3.0.
+
- 3.0FC - select a Core+Forward Compatible profile with GL
+ version 3.0.
+
- 3.1 - select GL version 3.1 with GL_ARB_compatibility enabled
+ per the driver default.
+
- 3.1FC - select GL version 3.1 with forward compatibility and
+ GL_ARB_compatibility disabled.
+
- 3.1COMPAT - select GL version 3.1 with GL_ARB_compatibility
+ enabled.
+
- X.Y - override GL version to X.Y without changing the profile.
+
- X.YFC - select a Core+Forward Compatible profile with GL
+ version X.Y.
+
- X.YCOMPAT - select a Compatibility profile with GL version
+ X.Y.
+
+ - 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.
@@ -103,8 +135,34 @@ glGetString(GL_VERSION) for OpenGL ES.
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_CACHE_DISABLE - if set to `true`, disables the GLSL shader cache
+MESA_GLSL_CACHE_MAX_SIZE - if set, determines the maximum size of
+the on-disk cache of compiled GLSL programs. Should be set to a number
+optionally followed by 'K', 'M', or 'G' to specify a size in
+kilobytes, megabytes, or gigabytes. By default, gigabytes will be
+assumed. And if unset, a maximum size of 1GB will be used. Note: A separate
+cache might be created for each architecture that Mesa is installed for on
+your system. For example under the default settings you may end up with a 1GB
+cache for x86_64 and another 1GB cache for i386.
+MESA_GLSL_CACHE_DIR - if set, determines the directory to be used
+for the on-disk cache of compiled GLSL programs. If this variable is
+not set, then the cache will be stored in $XDG_CACHE_HOME/mesa_shader_cache (if
+that variable is set), or else within .cache/mesa_shader_cache within the user's
+home directory.
MESA_GLSL - shading language compiler options
MESA_NO_MINMAX_CACHE - when set, the minmax index cache is globally disabled.
+MESA_SHADER_CAPTURE_PATH - see Capturing Shaders
+MESA_SHADER_DUMP_PATH and MESA_SHADER_READ_PATH - see Experimenting with Shader Replacements
+MESA_VK_VERSION_OVERRIDE - changes the Vulkan physical device version
+ as returned in VkPhysicalDeviceProperties::apiVersion.
+
+ - The format should be MAJOR.MINOR[.PATCH]
+ - This will not let you force a version higher than the driver's
+ instance versionas advertised by vkEnumerateInstanceVersion
+ - This can be very useful for debugging but some features may not be
+ implemented correctly. (For developers only)
+
+
@@ -135,39 +193,51 @@ See the Xlib software driver page for details.
This is useful for debugging hangs, etc.
INTEL_DEBUG - a comma-separated list of named flags, which do various things:
- - tex - emit messages about textures.
- - state - emit messages about state flag tracking
- - blit - emit messages about blit operations
- - miptree - emit messages about miptrees
- - perf - emit messages about performance issues
- - perfmon - emit messages about AMD_performance_monitor
+ - ann - annotate IR in assembly dumps
+ - aub - dump batches into an AUB trace for use with simulation tools
- bat - emit batch information
- - pix - emit messages about pixel operations
+ - blit - emit messages about blit operations
+ - blorp - emit messages about the blorp operations (blits & clears)
- buf - emit messages about buffer objects
- - reg - emit messages about regions
+ - clip - emit messages about the clip unit (for old gens, includes the CLIP program)
+ - color - use color in output
+ - cs - dump shader assembly for compute shaders
+ - do32 - generate compute shader SIMD32 programs even if workgroup size doesn't exceed the SIMD16 limit
+ - dri - emit messages about the DRI interface
- fbo - emit messages about framebuffers
- fs - dump shader assembly for fragment shaders
- gs - dump shader assembly for geometry shaders
- - sync - emit messages about synchronization
- - prim - emit messages about drawing primitives
- - vert - emit messages about vertex assembly
- - dri - emit messages about the DRI interface
- - sf - emit messages about the strips & fans unit (for old gens, includes the SF program)
- - stats - enable statistics counters. you probably actually want perfmon or intel_gpu_top instead.
- - urb - emit messages about URB setup
- - vs - dump shader assembly for vertex shaders
- - clip - emit messages about the clip unit (for old gens, includes the CLIP program)
- - aub - dump batches into an AUB trace for use with simulation tools
- - shader_time - record how much GPU time is spent in each shader
+ - hex - print instruction hex dump with the disassembly
+ - l3 - emit messages about the new L3 state during transitions
+ - miptree - emit messages about miptrees
+ - no8 - don't generate SIMD8 fragment shader
- no16 - suppress generation of 16-wide fragment shaders. useful for debugging broken shaders
- - blorp - emit messages about the blorp operations (blits & clears)
+ - nocompact - disable instruction compaction
- nodualobj - suppress generation of dual-object geometry shader code
+ - norbc - disable single sampled render buffer compression
- optimizer - dump shader assembly to files at each optimization pass and iteration that make progress
- - vec4 - force vec4 mode in vertex shader
+ - perf - emit messages about performance issues
+ - perfmon - emit messages about AMD_performance_monitor
+ - pix - emit messages about pixel operations
+ - prim - emit messages about drawing primitives
+ - reemit - mark all state dirty on each draw call
+ - sf - emit messages about the strips & fans unit (for old gens, includes the SF program)
+ - shader_time - record how much GPU time is spent in each 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)
- - norbc - disable single sampled render buffer compression
+ - state - emit messages about state flag tracking
+ - submit - emit batchbuffer usage statistics
+ - sync - after sending each batch, emit a message and wait for that batch to finish rendering
+ - tcs - dump shader assembly for tessellation control shaders
+ - tes - dump shader assembly for tessellation evaluation shaders
+ - tex - emit messages about textures.
+ - urb - emit messages about URB setup
+ - vert - emit messages about vertex assembly
+ - vs - dump shader assembly for vertex shaders
+INTEL_SCALAR_VS (or TCS, TES, GS) - force scalar/vec4 mode for a shader stage (Gen8-9 only)
+INTEL_PRECISE_TRIG - if set to 1, true or yes, then the driver prefers
+ accuracy over performance in trig functions.
@@ -198,8 +268,12 @@ Mesa EGL supports different sets of environment variables. See the
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_HUD_VISIBLE to false and GALLIUM_HUD_TOGGLE_SIGNAL to 10 (SIGUSR1).
+ Use kill -10 <pid> to toggle the hud as desired.
+GALLIUM_HUD_DUMP_DIR - specifies a directory for writing the displayed
+ hud values into files.
+GALLIUM_DRIVER - useful in combination with LIBGL_ALWAYS_SOFTWARE=true for
+ choosing one of the software renderers "softpipe", "llvmpipe" or "swr".
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
@@ -216,6 +290,21 @@ Setting to "tgsi", for example, will print all the TGSI shaders.
See src/mesa/state_tracker/st_debug.c for other options.
+Clover state tracker environment variables
+
+
+- CLOVER_EXTRA_BUILD_OPTIONS - allows specifying additional compiler and linker
+ options. Specified options are appended after the options set by the OpenCL
+ program in clBuildProgram.
+
- CLOVER_EXTRA_COMPILE_OPTIONS - allows specifying additional compiler
+ options. Specified options are appended after the options set by the OpenCL
+ program in clCompileProgram.
+
- CLOVER_EXTRA_LINK_OPTIONS - allows specifying additional linker
+ options. Specified options are appended after the options set by the OpenCL
+ program in clLinkProgram.
+
+
+
Softpipe driver environment variables
- SOFTPIPE_DUMP_FS - if set, the softpipe driver will print fragment shaders
@@ -247,9 +336,20 @@ See src/mesa/state_tracker/st_debug.c for other options.
(will often result in incorrect rendering).
- SVGA_DEBUG - for dumping shaders, constant buffers, etc. See the code
for details.
+
- SVGA_EXTRA_LOGGING - if set, enables extra logging to the vmware.log file,
+such as the OpenGL program's name and command line arguments.
+
- SVGA_NO_LOGGING - if set, disables logging to the vmware.log file.
+This is useful when using Valgrind because it otherwise crashes when
+initializing the host log feature.
- See the driver code for other, lesser-used variables.
+WGL environment variables
+
+- WGL_SWAP_INTERVAL - to set a swap interval, equivalent to calling
+wglSwapIntervalEXT() in an application. If this environment variable
+is set, application calls to wglSwapIntervalEXT() will have no effect.
+
VA-API state tracker environment variables