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 </ul>
  38
  39
  40
  41 <h2>Core Mesa environment variables</h2>
  42
  43 <ul>
  44 <li>MESA_NO_ASM - if set, disables all assembly language optimizations
  45 <li>MESA_NO_MMX - if set, disables Intel MMX optimizations
  46 <li>MESA_NO_3DNOW - if set, disables AMD 3DNow! optimizations
  47 <li>MESA_NO_SSE - if set, disables Intel SSE optimizations
  48 <li>MESA_DEBUG - if set, error messages are printed to stderr.  For example,
  49    if the application generates a GL_INVALID_ENUM error, a corresponding error
  50    message indicating where the error occurred, and possibly why, will be
  51    printed to stderr.<br>
  52    If the value of MESA_DEBUG is 'FP' floating point arithmetic errors will
  53    generate exceptions.
  54 <li>MESA_LOG_FILE - specifies a file name for logging all errors, warnings,
  55 etc., rather than stderr
  56 <li>MESA_TEX_PROG - if set, implement conventional texture env modes with
  57 fragment programs (intended for developers only)
  58 <li>MESA_TNL_PROG - if set, implement conventional vertex transformation
  59 operations with vertex programs (intended for developers only).
  60 Setting this variable automatically sets the MESA_TEX_PROG variable as well.
  61 <li>MESA_EXTENSION_OVERRIDE - can be used to enable/disable extensions.
  62 A value such as "GL_EXT_foo -GL_EXT_bar" will enable the GL_EXT_foo extension
  63 and disable the GL_EXT_bar extension.
  64 <li>MESA_EXTENSION_MAX_YEAR - The GL_EXTENSIONS string returned by Mesa is sorted
  65 by extension year.
  66 If this variable is set to year X, only extensions defined on or before year
  67 X will be reported.
  68 This is to work-around a bug in some games where the extension string is
  69 copied into a fixed-size buffer without truncating.
  70 If the extension string is too long, the buffer overrun can cause the game
  71 to crash.
  72 This is a work-around for that.
  73 <li>MESA_GL_VERSION_OVERRIDE - changes the value returned by
  74 glGetString(GL_VERSION) and possibly the GL API type.
  75 <ul>
  76 <li> The format should be MAJOR.MINOR[FC]
  77 <li> FC is an optional suffix that indicates a forward compatible context.
  78 This is only valid for versions &gt;= 3.0.
  79 <li> GL versions &lt; 3.0 are set to a compatibility (non-Core) profile
  80 <li> GL versions = 3.0, see below
  81 <li> GL versions &gt; 3.0 are set to a Core profile
  82 <li> Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC
  83 <ul>
  84 <li> 2.1 - select a compatibility (non-Core) profile with GL version 2.1
  85 <li> 3.0 - select a compatibility (non-Core) profile with GL version 3.0
  86 <li> 3.0FC - select a Core+Forward Compatible profile with GL version 3.0
  87 <li> 3.1 - select a Core profile with GL version 3.1
  88 <li> 3.1FC - select a Core+Forward Compatible profile with GL version 3.1
  89 </ul>
  90 <li> Mesa may not really implement all the features of the given version.
  91 (for developers only)
  92 </ul>
  93 <li>MESA_GLSL_VERSION_OVERRIDE - changes the value returned by
  94 glGetString(GL_SHADING_LANGUAGE_VERSION). Valid values are integers, such as
  95 "130".  Mesa will not really implement all the features of the given language version
  96 if it's higher than what's normally reported. (for developers only)
  97 <li>MESA_GLSL - <a href="shading.html#envvars">shading language compiler options</a>
  98 </ul>
  99
 100
 101 <h2>Mesa Xlib driver environment variables</h2>
 102
 103 <p>
 104 The following are only applicable to the Mesa Xlib software driver.
 105 See the <a href="xlibdriver.html">Xlib software driver page</a> for details.
 106 </p>
 107 <ul>
 108 <li>MESA_RGB_VISUAL - specifies the X visual and depth for RGB mode
 109 <li>MESA_CI_VISUAL - specifies the X visual and depth for CI mode
 110 <li>MESA_BACK_BUFFER - specifies how to implement the back color buffer,
 111     either "pixmap" or "ximage"
 112 <li>MESA_GAMMA - gamma correction coefficients for red, green, blue channels
 113 <li>MESA_XSYNC - enable synchronous X behavior (for debugging only)
 114 <li>MESA_GLX_FORCE_CI - if set, force GLX to treat 8bpp visuals as CI visuals
 115 <li>MESA_GLX_FORCE_ALPHA - if set, forces RGB windows to have an alpha channel.
 116 <li>MESA_GLX_DEPTH_BITS - specifies default number of bits for depth buffer.
 117 <li>MESA_GLX_ALPHA_BITS - specifies default number of bits for alpha channel.
 118 </ul>
 119
 120
 121 <h2>i945/i965 driver environment variables (non-Gallium)</h2>
 122
 123 <ul>
 124 <li>INTEL_NO_HW - if set to 1, prevents batches from being submitted to the hardware.
 125    This is useful for debugging hangs, etc.</li>
 126 <li>INTEL_DEBUG - a comma-separated list of named flags, which do various things:
 127 <ul>
 128    <li>tex - emit messages about textures.</li>
 129    <li>state - emit messages about state flag tracking</li>
 130    <li>blit - emit messages about blit operations</li>
 131    <li>miptree - emit messages about miptrees</li>
 132    <li>perf - emit messages about performance issues</li>
 133    <li>perfmon - emit messages about AMD_performance_monitor</li>
 134    <li>bat - emit batch information</li>
 135    <li>pix - emit messages about pixel operations</li>
 136    <li>buf - emit messages about buffer objects</li>
 137    <li>reg - emit messages about regions</li>
 138    <li>fbo - emit messages about framebuffers</li>
 139    <li>fs - dump shader assembly for fragment shaders</li>
 140    <li>gs - dump shader assembly for geometry shaders</li>
 141    <li>sync - emit messages about synchronization</li>
 142    <li>prim - emit messages about drawing primitives</li>
 143    <li>vert - emit messages about vertex assembly</li>
 144    <li>dri - emit messages about the DRI interface</li>
 145    <li>sf - emit messages about the strips &amp; fans unit (for old gens, includes the SF program)</li>
 146    <li>stats - enable statistics counters. you probably actually want perfmon or intel_gpu_top instead.</li>
 147    <li>urb - emit messages about URB setup</li>
 148    <li>vs - dump shader assembly for vertex shaders</li>
 149    <li>clip - emit messages about the clip unit (for old gens, includes the CLIP program)</li>
 150    <li>aub - dump batches into an AUB trace for use with simulation tools</li>
 151    <li>shader_time - record how much GPU time is spent in each shader</li>
 152    <li>no16 - suppress generation of 16-wide fragment shaders. useful for debugging broken shaders</li>
 153    <li>blorp - emit messages about the blorp operations (blits &amp; clears)</li>
 154    <li>nodualobj - suppress generation of dual-object geometry shader code</li>
 155 </ul>
 156 </ul>
 157
 158
 159 <h2>Radeon driver environment variables (radeon, r200, and r300g)</h2>
 160
 161 <ul>
 162 <li>RADEON_NO_TCL - if set, disable hardware-accelerated Transform/Clip/Lighting.
 163 </ul>
 164
 165
 166 <h2>EGL environment variables</h2>
 167
 168 <p>
 169 Mesa EGL supports different sets of environment variables.  See the
 170 <a href="egl.html">Mesa EGL</a> page for the details.
 171 </p>
 172
 173
 174 <h2>Gallium environment variables</h2>
 175
 176 <ul>
 177 <li>GALLIUM_HUD - draws various information on the screen, like framerate,
 178     cpu load, driver statistics, performance counters, etc.
 179     Set GALLIUM_HUD=help and run e.g. glxgears for more info.
 180 <li>GALLIUM_LOG_FILE - specifies a file for logging all errors, warnings, etc.
 181     rather than stderr.
 182 <li>GALLIUM_PRINT_OPTIONS - if non-zero, print all the Gallium environment
 183     variables which are used, and their current values.
 184 <li>GALLIUM_DUMP_CPU - if non-zero, print information about the CPU on start-up
 185 <li>TGSI_PRINT_SANITY - if set, do extra sanity checking on TGSI shaders and
 186     print any errors to stderr.
 187 <LI>DRAW_FSE - ???
 188 <LI>DRAW_NO_FSE - ???
 189 <li>DRAW_USE_LLVM - if set to zero, the draw module will not use LLVM to execute
 190     shaders, vertex fetch, etc.
 191 <li>ST_DEBUG - controls debug output from the Mesa/Gallium state tracker.
 192 Setting to "tgsi", for example, will print all the TGSI shaders.
 193 See src/mesa/state_tracker/st_debug.c for other options.
 194 </ul>
 195
 196 <h3>Softpipe driver environment variables</h3>
 197 <ul>
 198 <li>SOFTPIPE_DUMP_FS - if set, the softpipe driver will print fragment shaders
 199     to stderr
 200 <li>SOFTPIPE_DUMP_GS - if set, the softpipe driver will print geometry shaders
 201     to stderr
 202 <li>SOFTPIPE_NO_RAST - if set, rasterization is no-op'd.  For profiling purposes.
 203 <li>SOFTPIPE_USE_LLVM - if set, the softpipe driver will try to use LLVM JIT for
 204     vertex shading processing.
 205 </ul>
 206
 207
 208 <h3>LLVMpipe driver environment variables</h3>
 209 <ul>
 210 <li>LP_NO_RAST - if set LLVMpipe will no-op rasterization
 211 <li>LP_DEBUG - a comma-separated list of debug options is accepted.  See the
 212     source code for details.
 213 <li>LP_PERF - a comma-separated list of options to selectively no-op various
 214     parts of the driver.  See the source code for details.
 215 <li>LP_NUM_THREADS - an integer indicating how many threads to use for rendering.
 216     Zero turns of threading completely.  The default value is the number of CPU
 217     cores present.
 218 </ul>
 219
 220 <h3>VMware SVGA driver environment variables</h3>
 221 <ul>
 222 <li>SVGA_FORCE_SWTNL - force use of software vertex transformation
 223 <li>SVGA_NO_SWTNL - don't allow software vertex transformation fallbacks
 224 (will often result in incorrect rendering).
 225 <li>SVGA_DEBUG - for dumping shaders, constant buffers, etc.  See the code
 226 for details.
 227 <li>See the driver code for other, lesser-used variables.
 228 </ul>
 229
 230
 231 <p>
 232 Other Gallium drivers have their own environment variables.  These may change
 233 frequently so the source code should be consulted for details.
 234 </p>
 235
 236 </div>
 237 </body>
 238 </html>