docs/envvars.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html lang="en">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   5   <title>Environment Variables</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   <h1>The Mesa 3D Graphics Library</h1>
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Environment Variables</h1>
  18
  19 <p>
  20 Normally, no environment variables need to be set.  Most of the environment
  21 variables used by Mesa/Gallium are for debugging purposes, but they can
  22 sometimes be useful for debugging end-user issues.
  23 </p>
  24
  25
  26 <h2>LibGL environment variables</h2>
  27
  28 <ul>
  29 <li>LIBGL_DEBUG - If defined debug information will be printed to stderr.
  30    If set to 'verbose' additional information will be printed.
  31 <li>LIBGL_DRIVERS_PATH - colon-separated list of paths to search for DRI drivers
  32 <li>LIBGL_ALWAYS_INDIRECT - forces an indirect rendering context/connection.
  33 <li>LIBGL_ALWAYS_SOFTWARE - if set, always use software rendering
  34 <li>LIBGL_NO_DRAWARRAYS - if set do not use DrawArrays GLX protocol (for debugging)
  35 <li>LIBGL_SHOW_FPS - print framerate to stdout based on the number of glXSwapBuffers
  36     calls per second.
  37 <li>LIBGL_DRI3_DISABLE - disable DRI3 if set (the value does not matter)
  38 </ul>
  39
  40
  41
  42 <h2>Core Mesa environment variables</h2>
  43
  44 <ul>
  45 <li>MESA_NO_ASM - if set, disables all assembly language optimizations
  46 <li>MESA_NO_MMX - if set, disables Intel MMX optimizations
  47 <li>MESA_NO_3DNOW - if set, disables AMD 3DNow! optimizations
  48 <li>MESA_NO_SSE - if set, disables Intel SSE optimizations
  49 <li>MESA_DEBUG - if set, error messages are printed to stderr.  For example,
  50    if the application generates a GL_INVALID_ENUM error, a corresponding error
  51    message indicating where the error occurred, and possibly why, will be
  52    printed to stderr.<br>
  53    If the value of MESA_DEBUG is 'FP' floating point arithmetic errors will
  54    generate exceptions.
  55 <li>MESA_LOG_FILE - specifies a file name for logging all errors, warnings,
  56 etc., rather than stderr
  57 <li>MESA_TEX_PROG - if set, implement conventional texture env modes with
  58 fragment programs (intended for developers only)
  59 <li>MESA_TNL_PROG - if set, implement conventional vertex transformation
  60 operations with vertex programs (intended for developers only).
  61 Setting this variable automatically sets the MESA_TEX_PROG variable as well.
  62 <li>MESA_EXTENSION_OVERRIDE - can be used to enable/disable extensions.
  63 A value such as "GL_EXT_foo -GL_EXT_bar" will enable the GL_EXT_foo extension
  64 and disable the GL_EXT_bar extension.
  65 <li>MESA_EXTENSION_MAX_YEAR - The GL_EXTENSIONS string returned by Mesa is sorted
  66 by extension year.
  67 If this variable is set to year X, only extensions defined on or before year
  68 X will be reported.
  69 This is to work-around a bug in some games where the extension string is
  70 copied into a fixed-size buffer without truncating.
  71 If the extension string is too long, the buffer overrun can cause the game
  72 to crash.
  73 This is a work-around for that.
  74 <li>MESA_GL_VERSION_OVERRIDE - changes the value returned by
  75 glGetString(GL_VERSION) and possibly the GL API type.
  76 <ul>
  77 <li> The format should be MAJOR.MINOR[FC]
  78 <li> FC is an optional suffix that indicates a forward compatible context.
  79 This is only valid for versions &gt;= 3.0.
  80 <li> GL versions &lt; 3.0 are set to a compatibility (non-Core) profile
  81 <li> GL versions = 3.0, see below
  82 <li> GL versions &gt; 3.0 are set to a Core profile
  83 <li> Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC
  84 <ul>
  85 <li> 2.1 - select a compatibility (non-Core) profile with GL version 2.1
  86 <li> 3.0 - select a compatibility (non-Core) profile with GL version 3.0
  87 <li> 3.0FC - select a Core+Forward Compatible profile with GL version 3.0
  88 <li> 3.1 - select a Core profile with GL version 3.1
  89 <li> 3.1FC - select a Core+Forward Compatible profile with GL version 3.1
  90 </ul>
  91 <li> Mesa may not really implement all the features of the given version.
  92 (for developers only)
  93 </ul>
  94 <li>MESA_GLES_VERSION_OVERRIDE - changes the value returned by
  95 glGetString(GL_VERSION) for OpenGL ES.
  96 <ul>
  97 <li> The format should be MAJOR.MINOR
  98 <li> Examples: 2.0, 3.0, 3.1
  99 <li> Mesa may not really implement all the features of the given version.
 100 (for developers only)
 101 </ul>
 102 <li>MESA_GLSL_VERSION_OVERRIDE - changes the value returned by
 103 glGetString(GL_SHADING_LANGUAGE_VERSION). Valid values are integers, such as
 104 "130".  Mesa will not really implement all the features of the given language version
 105 if it's higher than what's normally reported. (for developers only)
 106 <li>MESA_GLSL - <a href="shading.html#envvars">shading language compiler options</a>
 107 <li>MESA_NO_MINMAX_CACHE - when set, the minmax index cache is globally disabled.
 108 </ul>
 109
 110
 111 <h2>Mesa Xlib driver environment variables</h2>
 112
 113 <p>
 114 The following are only applicable to the Mesa Xlib software driver.
 115 See the <a href="xlibdriver.html">Xlib software driver page</a> for details.
 116 </p>
 117 <ul>
 118 <li>MESA_RGB_VISUAL - specifies the X visual and depth for RGB mode
 119 <li>MESA_CI_VISUAL - specifies the X visual and depth for CI mode
 120 <li>MESA_BACK_BUFFER - specifies how to implement the back color buffer,
 121     either "pixmap" or "ximage"
 122 <li>MESA_GAMMA - gamma correction coefficients for red, green, blue channels
 123 <li>MESA_XSYNC - enable synchronous X behavior (for debugging only)
 124 <li>MESA_GLX_FORCE_CI - if set, force GLX to treat 8bpp visuals as CI visuals
 125 <li>MESA_GLX_FORCE_ALPHA - if set, forces RGB windows to have an alpha channel.
 126 <li>MESA_GLX_DEPTH_BITS - specifies default number of bits for depth buffer.
 127 <li>MESA_GLX_ALPHA_BITS - specifies default number of bits for alpha channel.
 128 </ul>
 129
 130
 131 <h2>i945/i965 driver environment variables (non-Gallium)</h2>
 132
 133 <ul>
 134 <li>INTEL_NO_HW - if set to 1, prevents batches from being submitted to the hardware.
 135    This is useful for debugging hangs, etc.</li>
 136 <li>INTEL_DEBUG - a comma-separated list of named flags, which do various things:
 137 <ul>
 138    <li>tex - emit messages about textures.</li>
 139    <li>state - emit messages about state flag tracking</li>
 140    <li>blit - emit messages about blit operations</li>
 141    <li>miptree - emit messages about miptrees</li>
 142    <li>perf - emit messages about performance issues</li>
 143    <li>perfmon - emit messages about AMD_performance_monitor</li>
 144    <li>bat - emit batch information</li>
 145    <li>pix - emit messages about pixel operations</li>
 146    <li>buf - emit messages about buffer objects</li>
 147    <li>reg - emit messages about regions</li>
 148    <li>fbo - emit messages about framebuffers</li>
 149    <li>fs - dump shader assembly for fragment shaders</li>
 150    <li>gs - dump shader assembly for geometry shaders</li>
 151    <li>sync - emit messages about synchronization</li>
 152    <li>prim - emit messages about drawing primitives</li>
 153    <li>vert - emit messages about vertex assembly</li>
 154    <li>dri - emit messages about the DRI interface</li>
 155    <li>sf - emit messages about the strips &amp; fans unit (for old gens, includes the SF program)</li>
 156    <li>stats - enable statistics counters. you probably actually want perfmon or intel_gpu_top instead.</li>
 157    <li>urb - emit messages about URB setup</li>
 158    <li>vs - dump shader assembly for vertex shaders</li>
 159    <li>clip - emit messages about the clip unit (for old gens, includes the CLIP program)</li>
 160    <li>aub - dump batches into an AUB trace for use with simulation tools</li>
 161    <li>shader_time - record how much GPU time is spent in each shader</li>
 162    <li>no16 - suppress generation of 16-wide fragment shaders. useful for debugging broken shaders</li>
 163    <li>blorp - emit messages about the blorp operations (blits &amp; clears)</li>
 164    <li>nodualobj - suppress generation of dual-object geometry shader code</li>
 165    <li>optimizer - dump shader assembly to files at each optimization pass and iteration that make progress</li>
 166 </ul>
 167 </ul>
 168
 169
 170 <h2>Radeon driver environment variables (radeon, r200, and r300g)</h2>
 171
 172 <ul>
 173 <li>RADEON_NO_TCL - if set, disable hardware-accelerated Transform/Clip/Lighting.
 174 </ul>
 175
 176
 177 <h2>EGL environment variables</h2>
 178
 179 <p>
 180 Mesa EGL supports different sets of environment variables.  See the
 181 <a href="egl.html">Mesa EGL</a> page for the details.
 182 </p>
 183
 184
 185 <h2>Gallium environment variables</h2>
 186
 187 <ul>
 188 <li>GALLIUM_HUD - draws various information on the screen, like framerate,
 189     cpu load, driver statistics, performance counters, etc.
 190     Set GALLIUM_HUD=help and run e.g. glxgears for more info.
 191 <li>GALLIUM_HUD_PERIOD - sets the hud update rate in seconds (float). Use zero
 192     to update every frame. The default period is 1/2 second.
 193 <li>GALLIUM_HUD_VISIBLE - control default visibility, defaults to true.
 194 <li>GALLIUM_HUD_TOGGLE_SIGNAL - toggle visibility via user specified signal.
 195     Especially useful to toggle hud at specific points of application and
 196     disable for unencumbered viewing the rest of the time. For example, set
 197     GALLIUM_HUD_VISIBLE to false and GALLIUM_HUD_SIGNAL_TOGGLE to 10 (SIGUSR1).
 198     Use kill -10 <pid> to toggle the hud as desired.
 199 <li>GALLIUM_LOG_FILE - specifies a file for logging all errors, warnings, etc.
 200     rather than stderr.
 201 <li>GALLIUM_PRINT_OPTIONS - if non-zero, print all the Gallium environment
 202     variables which are used, and their current values.
 203 <li>GALLIUM_DUMP_CPU - if non-zero, print information about the CPU on start-up
 204 <li>TGSI_PRINT_SANITY - if set, do extra sanity checking on TGSI shaders and
 205     print any errors to stderr.
 206 <LI>DRAW_FSE - ???
 207 <LI>DRAW_NO_FSE - ???
 208 <li>DRAW_USE_LLVM - if set to zero, the draw module will not use LLVM to execute
 209     shaders, vertex fetch, etc.
 210 <li>ST_DEBUG - controls debug output from the Mesa/Gallium state tracker.
 211 Setting to "tgsi", for example, will print all the TGSI shaders.
 212 See src/mesa/state_tracker/st_debug.c for other options.
 213 </ul>
 214
 215 <h3>Softpipe driver environment variables</h3>
 216 <ul>
 217 <li>SOFTPIPE_DUMP_FS - if set, the softpipe driver will print fragment shaders
 218     to stderr
 219 <li>SOFTPIPE_DUMP_GS - if set, the softpipe driver will print geometry shaders
 220     to stderr
 221 <li>SOFTPIPE_NO_RAST - if set, rasterization is no-op'd.  For profiling purposes.
 222 <li>SOFTPIPE_USE_LLVM - if set, the softpipe driver will try to use LLVM JIT for
 223     vertex shading processing.
 224 </ul>
 225
 226
 227 <h3>LLVMpipe driver environment variables</h3>
 228 <ul>
 229 <li>LP_NO_RAST - if set LLVMpipe will no-op rasterization
 230 <li>LP_DEBUG - a comma-separated list of debug options is accepted.  See the
 231     source code for details.
 232 <li>LP_PERF - a comma-separated list of options to selectively no-op various
 233     parts of the driver.  See the source code for details.
 234 <li>LP_NUM_THREADS - an integer indicating how many threads to use for rendering.
 235     Zero turns of threading completely.  The default value is the number of CPU
 236     cores present.
 237 </ul>
 238
 239 <h3>VMware SVGA driver environment variables</h3>
 240 <ul>
 241 <li>SVGA_FORCE_SWTNL - force use of software vertex transformation
 242 <li>SVGA_NO_SWTNL - don't allow software vertex transformation fallbacks
 243 (will often result in incorrect rendering).
 244 <li>SVGA_DEBUG - for dumping shaders, constant buffers, etc.  See the code
 245 for details.
 246 <li>See the driver code for other, lesser-used variables.
 247 </ul>
 248
 249
 250 <h3>VA-API state tracker environment variables</h3>
 251 <ul>
 252 <li>VAAPI_MPEG4_ENABLED - enable MPEG4 for VA-API, disabled by default.
 253 </ul>
 254
 255
 256 <p>
 257 Other Gallium drivers have their own environment variables.  These may change
 258 frequently so the source code should be consulted for details.
 259 </p>
 260
 261 </div>
 262 </body>
 263 </html>