| Andreas Boll | ecd5c7c | 2012-06-12 09:05:03 +0200 | [diff] [blame] | 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> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 9 | |
| Andreas Boll | b5da52a | 2012-09-18 18:57:02 +0200 | [diff] [blame] | 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 | |
| Andreas Boll | ecd5c7c | 2012-06-12 09:05:03 +0200 | [diff] [blame] | 17 | <h1>Environment Variables</h1> |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 18 | |
| 19 | <p> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 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. |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 23 | </p> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 24 | |
| 25 | |
| Andreas Boll | 210a27d | 2012-06-12 09:05:36 +0200 | [diff] [blame] | 26 | <h2>LibGL environment variables</h2> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 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) |
| Marek Olšák | dd6152b | 2013-03-26 03:19:10 +0100 | [diff] [blame] | 35 | <li>LIBGL_SHOW_FPS - print framerate to stdout based on the number of glXSwapBuffers |
| 36 | calls per second. |
| Martin Peres | e4b2973 | 2015-05-07 16:57:48 +0300 | [diff] [blame] | 37 | <li>LIBGL_DRI3_DISABLE - disable DRI3 if set (the value does not matter) |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 38 | </ul> |
| 39 | |
| 40 | |
| 41 | |
| Andreas Boll | 210a27d | 2012-06-12 09:05:36 +0200 | [diff] [blame] | 42 | <h2>Core Mesa environment variables</h2> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 43 | |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 44 | <ul> |
| Brian Paul | b07d6a8 | 2004-02-02 22:35:55 +0000 | [diff] [blame] | 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 |
| Timothy Arceri | a0ed0eb | 2017-04-12 15:08:01 +1000 | [diff] [blame] | 49 | <li>MESA_NO_ERROR - if set error checking is disabled as per KHR_no_error. |
| 50 | This will result in undefined behaviour for invalid use of the api, but |
| 51 | can reduce CPU use for apps that are known to be error free.</li> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 52 | <li>MESA_DEBUG - if set, error messages are printed to stderr. For example, |
| 53 | if the application generates a GL_INVALID_ENUM error, a corresponding error |
| Nathan Kidd | 0691b37 | 2014-01-03 16:44:00 -0700 | [diff] [blame] | 54 | message indicating where the error occurred, and possibly why, will be |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 55 | printed to stderr.<br> |
| Alejandro Piñeiro | a97ee60 | 2016-06-27 10:00:58 +0200 | [diff] [blame] | 56 | |
| 57 | For release builds, MESA_DEBUG defaults to off (no debug output). |
| 58 | |
| 59 | MESA_DEBUG accepts the following comma-separated list of named |
| 60 | flags, which adds extra behaviour to just set MESA_DEBUG=1: |
| 61 | <ul> |
| 62 | <li>silent - turn off debug messages. Only useful for debug builds.</li> |
| 63 | <li>flush - flush after each drawing command</li> |
| 64 | <li>incomplete_tex - extra debug messages when a texture is incomplete</li> |
| 65 | <li>incomplete_fbo - extra debug messages when a fbo is incomplete</li> |
| Brian Paul | 2acfd36 | 2016-11-17 07:20:32 -0700 | [diff] [blame] | 66 | <li>context - create a debug context (see GLX_CONTEXT_DEBUG_BIT_ARB) and |
| 67 | print error and performance messages to stderr (or MESA_LOG_FILE).</li> |
| Alejandro Piñeiro | a97ee60 | 2016-06-27 10:00:58 +0200 | [diff] [blame] | 68 | </ul> |
| Brian Paul | 9ccf5bf | 2012-06-25 11:43:03 -0600 | [diff] [blame] | 69 | <li>MESA_LOG_FILE - specifies a file name for logging all errors, warnings, |
| 70 | etc., rather than stderr |
| Brian Paul | 4d3ab19 | 2006-06-01 20:22:30 +0000 | [diff] [blame] | 71 | <li>MESA_TEX_PROG - if set, implement conventional texture env modes with |
| 72 | fragment programs (intended for developers only) |
| 73 | <li>MESA_TNL_PROG - if set, implement conventional vertex transformation |
| 74 | operations with vertex programs (intended for developers only). |
| 75 | Setting this variable automatically sets the MESA_TEX_PROG variable as well. |
| Brian Paul | cc26e27 | 2009-06-08 10:56:51 -0600 | [diff] [blame] | 76 | <li>MESA_EXTENSION_OVERRIDE - can be used to enable/disable extensions. |
| 77 | A value such as "GL_EXT_foo -GL_EXT_bar" will enable the GL_EXT_foo extension |
| 78 | and disable the GL_EXT_bar extension. |
| Brian Paul | 82dd62f | 2011-03-24 11:39:21 -0600 | [diff] [blame] | 79 | <li>MESA_EXTENSION_MAX_YEAR - The GL_EXTENSIONS string returned by Mesa is sorted |
| 80 | by extension year. |
| 81 | If this variable is set to year X, only extensions defined on or before year |
| 82 | X will be reported. |
| 83 | This is to work-around a bug in some games where the extension string is |
| 84 | copied into a fixed-size buffer without truncating. |
| 85 | If the extension string is too long, the buffer overrun can cause the game |
| 86 | to crash. |
| 87 | This is a work-around for that. |
| Chad Versace | 0527c11 | 2011-09-26 11:48:46 -0700 | [diff] [blame] | 88 | <li>MESA_GL_VERSION_OVERRIDE - changes the value returned by |
| Jordan Justen | 00905db | 2012-09-01 01:38:08 -0700 | [diff] [blame] | 89 | glGetString(GL_VERSION) and possibly the GL API type. |
| 90 | <ul> |
| 91 | <li> The format should be MAJOR.MINOR[FC] |
| 92 | <li> FC is an optional suffix that indicates a forward compatible context. |
| 93 | This is only valid for versions >= 3.0. |
| 94 | <li> GL versions < 3.0 are set to a compatibility (non-Core) profile |
| 95 | <li> GL versions = 3.0, see below |
| 96 | <li> GL versions > 3.0 are set to a Core profile |
| 97 | <li> Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC |
| 98 | <ul> |
| 99 | <li> 2.1 - select a compatibility (non-Core) profile with GL version 2.1 |
| 100 | <li> 3.0 - select a compatibility (non-Core) profile with GL version 3.0 |
| 101 | <li> 3.0FC - select a Core+Forward Compatible profile with GL version 3.0 |
| 102 | <li> 3.1 - select a Core profile with GL version 3.1 |
| 103 | <li> 3.1FC - select a Core+Forward Compatible profile with GL version 3.1 |
| 104 | </ul> |
| 105 | <li> Mesa may not really implement all the features of the given version. |
| 106 | (for developers only) |
| 107 | </ul> |
| Alejandro Piñeiro | a150101 | 2016-02-13 19:05:49 +0100 | [diff] [blame] | 108 | <li>MESA_GLES_VERSION_OVERRIDE - changes the value returned by |
| 109 | glGetString(GL_VERSION) for OpenGL ES. |
| 110 | <ul> |
| 111 | <li> The format should be MAJOR.MINOR |
| 112 | <li> Examples: 2.0, 3.0, 3.1 |
| 113 | <li> Mesa may not really implement all the features of the given version. |
| 114 | (for developers only) |
| 115 | </ul> |
| Chad Versace | a1eff55 | 2011-09-27 13:53:11 -0700 | [diff] [blame] | 116 | <li>MESA_GLSL_VERSION_OVERRIDE - changes the value returned by |
| 117 | glGetString(GL_SHADING_LANGUAGE_VERSION). Valid values are integers, such as |
| 118 | "130". Mesa will not really implement all the features of the given language version |
| 119 | if it's higher than what's normally reported. (for developers only) |
| Timothy Arceri | 41ad178 | 2016-09-28 08:56:26 +1000 | [diff] [blame] | 120 | <li>MESA_GLSL_CACHE_DISABLE - if set, disables the GLSL shader cache |
| 121 | <li>MESA_GLSL_CACHE_MAX_SIZE - if set, determines the maximum size of |
| 122 | the on-disk cache of compiled GLSL programs. Should be set to a number |
| 123 | optionally followed by 'K', 'M', or 'G' to specify a size in |
| 124 | kilobytes, megabytes, or gigabytes. By default, gigabytes will be |
| Timothy Arceri | ee8d2e2 | 2017-03-02 17:08:34 +1100 | [diff] [blame] | 125 | assumed. And if unset, a maximum size of 1GB will be used. Note: A separate |
| 126 | cache might be created for each architecture that Mesa is installed for on |
| 127 | your system. For example under the default settings you may end up with a 1GB |
| 128 | cache for x86_64 and another 1GB cache for i386. |
| Timothy Arceri | 41ad178 | 2016-09-28 08:56:26 +1000 | [diff] [blame] | 129 | <li>MESA_GLSL_CACHE_DIR - if set, determines the directory to be used |
| 130 | for the on-disk cache of compiled GLSL programs. If this variable is |
| 131 | not set, then the cache will be stored in $XDG_CACHE_HOME/mesa (if |
| 132 | that variable is set), or else within .cache/mesa within the user's |
| 133 | home directory. |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 134 | <li>MESA_GLSL - <a href="shading.html#envvars">shading language compiler options</a> |
| Nicolai Hähnle | bc8a684 | 2016-01-11 15:56:22 -0500 | [diff] [blame] | 135 | <li>MESA_NO_MINMAX_CACHE - when set, the minmax index cache is globally disabled. |
| Brian Paul | b07d6a8 | 2004-02-02 22:35:55 +0000 | [diff] [blame] | 136 | </ul> |
| 137 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 138 | |
| Andreas Boll | 210a27d | 2012-06-12 09:05:36 +0200 | [diff] [blame] | 139 | <h2>Mesa Xlib driver environment variables</h2> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 140 | |
| Brian Paul | b07d6a8 | 2004-02-02 22:35:55 +0000 | [diff] [blame] | 141 | <p> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 142 | The following are only applicable to the Mesa Xlib software driver. |
| Andreas Boll | 210a27d | 2012-06-12 09:05:36 +0200 | [diff] [blame] | 143 | See the <a href="xlibdriver.html">Xlib software driver page</a> for details. |
| Brian Paul | b07d6a8 | 2004-02-02 22:35:55 +0000 | [diff] [blame] | 144 | </p> |
| 145 | <ul> |
| Brian Paul | 5e9d731 | 2006-01-27 20:12:06 +0000 | [diff] [blame] | 146 | <li>MESA_RGB_VISUAL - specifies the X visual and depth for RGB mode |
| 147 | <li>MESA_CI_VISUAL - specifies the X visual and depth for CI mode |
| 148 | <li>MESA_BACK_BUFFER - specifies how to implement the back color buffer, |
| 149 | either "pixmap" or "ximage" |
| 150 | <li>MESA_GAMMA - gamma correction coefficients for red, green, blue channels |
| 151 | <li>MESA_XSYNC - enable synchronous X behavior (for debugging only) |
| 152 | <li>MESA_GLX_FORCE_CI - if set, force GLX to treat 8bpp visuals as CI visuals |
| Brian Paul | 4f6b1ad | 2004-07-23 15:49:12 +0000 | [diff] [blame] | 153 | <li>MESA_GLX_FORCE_ALPHA - if set, forces RGB windows to have an alpha channel. |
| Brian Paul | dfa5c2b | 2004-07-23 23:32:15 +0000 | [diff] [blame] | 154 | <li>MESA_GLX_DEPTH_BITS - specifies default number of bits for depth buffer. |
| Brian Paul | 8894a55 | 2005-11-05 03:12:06 +0000 | [diff] [blame] | 155 | <li>MESA_GLX_ALPHA_BITS - specifies default number of bits for alpha channel. |
| Brian Paul | 0b27ace | 2003-03-08 17:38:57 +0000 | [diff] [blame] | 156 | </ul> |
| 157 | |
| 158 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 159 | <h2>i945/i965 driver environment variables (non-Gallium)</h2> |
| 160 | |
| Brian Paul | 1d8b308 | 2010-01-26 09:12:32 -0700 | [diff] [blame] | 161 | <ul> |
| Chris Forbes | 90d1855 | 2013-11-24 18:12:49 +1300 | [diff] [blame] | 162 | <li>INTEL_NO_HW - if set to 1, prevents batches from being submitted to the hardware. |
| 163 | This is useful for debugging hangs, etc.</li> |
| 164 | <li>INTEL_DEBUG - a comma-separated list of named flags, which do various things: |
| 165 | <ul> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 166 | <li>ann - annotate IR in assembly dumps</li> |
| 167 | <li>aub - dump batches into an AUB trace for use with simulation tools</li> |
| Chris Forbes | 90d1855 | 2013-11-24 18:12:49 +1300 | [diff] [blame] | 168 | <li>bat - emit batch information</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 169 | <li>blit - emit messages about blit operations</li> |
| 170 | <li>blorp - emit messages about the blorp operations (blits & clears)</li> |
| Chris Forbes | 90d1855 | 2013-11-24 18:12:49 +1300 | [diff] [blame] | 171 | <li>buf - emit messages about buffer objects</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 172 | <li>clip - emit messages about the clip unit (for old gens, includes the CLIP program)</li> |
| 173 | <li>color - use color in output</li> |
| 174 | <li>cs - dump shader assembly for compute shaders</li> |
| 175 | <li>do32 - generate compute shader SIMD32 programs even if workgroup size doesn't exceed the SIMD16 limit</li> |
| 176 | <li>dri - emit messages about the DRI interface</li> |
| Chris Forbes | 90d1855 | 2013-11-24 18:12:49 +1300 | [diff] [blame] | 177 | <li>fbo - emit messages about framebuffers</li> |
| 178 | <li>fs - dump shader assembly for fragment shaders</li> |
| 179 | <li>gs - dump shader assembly for geometry shaders</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 180 | <li>hex - print instruction hex dump with the disassembly</li> |
| 181 | <li>l3 - emit messages about the new L3 state during transitions</li> |
| 182 | <li>miptree - emit messages about miptrees</li> |
| Grazvydas Ignotas | 2343235 | 2016-06-28 01:33:21 +0300 | [diff] [blame] | 183 | <li>no8 - don't generate SIMD8 fragment shader</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 184 | <li>no16 - suppress generation of 16-wide fragment shaders. useful for debugging broken shaders</li> |
| 185 | <li>nocompact - disable instruction compaction</li> |
| 186 | <li>nodualobj - suppress generation of dual-object geometry shader code</li> |
| 187 | <li>norbc - disable single sampled render buffer compression</li> |
| 188 | <li>optimizer - dump shader assembly to files at each optimization pass and iteration that make progress</li> |
| 189 | <li>perf - emit messages about performance issues</li> |
| 190 | <li>perfmon - emit messages about AMD_performance_monitor</li> |
| 191 | <li>pix - emit messages about pixel operations</li> |
| 192 | <li>prim - emit messages about drawing primitives</li> |
| 193 | <li>sf - emit messages about the strips & fans unit (for old gens, includes the SF program)</li> |
| 194 | <li>shader_time - record how much GPU time is spent in each shader</li> |
| Iago Toral Quiroga | 8f45691 | 2016-03-18 08:39:23 +0100 | [diff] [blame] | 195 | <li>spill_fs - force spilling of all registers in the scalar backend (useful to debug spilling code)</li> |
| 196 | <li>spill_vec4 - force spilling of all registers in the vec4 backend (useful to debug spilling code)</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 197 | <li>state - emit messages about state flag tracking</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 198 | <li>sync - after sending each batch, emit a message and wait for that batch to finish rendering</li> |
| Grazvydas Ignotas | 2343235 | 2016-06-28 01:33:21 +0300 | [diff] [blame] | 199 | <li>tcs - dump shader assembly for tessellation control shaders</li> |
| 200 | <li>tes - dump shader assembly for tessellation evaluation shaders</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 201 | <li>tex - emit messages about textures.</li> |
| 202 | <li>urb - emit messages about URB setup</li> |
| Samuel Iglesias Gonsálvez | 2beff74 | 2017-04-20 14:02:44 +0200 | [diff] [blame] | 203 | <li>vert - emit messages about vertex assembly</li> |
| 204 | <li>vs - dump shader assembly for vertex shaders</li> |
| Chris Forbes | 90d1855 | 2013-11-24 18:12:49 +1300 | [diff] [blame] | 205 | </ul> |
| Kenneth Graunke | 9cd6902 | 2017-06-03 12:26:29 -0700 | [diff] [blame^] | 206 | <li>INTEL_SCALAR_VS (or TCS, TES, GS) - force scalar/vec4 mode for a shader stage (Gen8-9 only)</li> |
| Juan A. Suarez Romero | 883ca59 | 2017-01-11 18:51:35 +0100 | [diff] [blame] | 207 | <li>INTEL_PRECISE_TRIG - if set to 1, true or yes, then the driver prefers |
| 208 | accuracy over performance in trig functions.</li> |
| Brian Paul | 1d8b308 | 2010-01-26 09:12:32 -0700 | [diff] [blame] | 209 | </ul> |
| 210 | |
| 211 | |
| Matt Turner | ef3cec5 | 2012-01-30 13:58:10 -0500 | [diff] [blame] | 212 | <h2>Radeon driver environment variables (radeon, r200, and r300g)</h2> |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 213 | |
| Brian Paul | 1d8b308 | 2010-01-26 09:12:32 -0700 | [diff] [blame] | 214 | <ul> |
| Matt Turner | ef3cec5 | 2012-01-30 13:58:10 -0500 | [diff] [blame] | 215 | <li>RADEON_NO_TCL - if set, disable hardware-accelerated Transform/Clip/Lighting. |
| Brian Paul | 1d8b308 | 2010-01-26 09:12:32 -0700 | [diff] [blame] | 216 | </ul> |
| 217 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 218 | |
| 219 | <h2>EGL environment variables</h2> |
| 220 | |
| Chia-I Wu | 7fc3581 | 2010-02-02 11:05:19 +0800 | [diff] [blame] | 221 | <p> |
| 222 | Mesa EGL supports different sets of environment variables. See the |
| 223 | <a href="egl.html">Mesa EGL</a> page for the details. |
| 224 | </p> |
| Brian Paul | 1d8b308 | 2010-01-26 09:12:32 -0700 | [diff] [blame] | 225 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 226 | |
| 227 | <h2>Gallium environment variables</h2> |
| 228 | |
| 229 | <ul> |
| Marek Olšák | dd6152b | 2013-03-26 03:19:10 +0100 | [diff] [blame] | 230 | <li>GALLIUM_HUD - draws various information on the screen, like framerate, |
| 231 | cpu load, driver statistics, performance counters, etc. |
| 232 | Set GALLIUM_HUD=help and run e.g. glxgears for more info. |
| Jimmy Berry | 09d6107 | 2015-11-03 23:24:47 -0600 | [diff] [blame] | 233 | <li>GALLIUM_HUD_PERIOD - sets the hud update rate in seconds (float). Use zero |
| 234 | to update every frame. The default period is 1/2 second. |
| Jimmy Berry | 56a1c10 | 2015-11-09 23:20:37 -0600 | [diff] [blame] | 235 | <li>GALLIUM_HUD_VISIBLE - control default visibility, defaults to true. |
| 236 | <li>GALLIUM_HUD_TOGGLE_SIGNAL - toggle visibility via user specified signal. |
| 237 | Especially useful to toggle hud at specific points of application and |
| 238 | disable for unencumbered viewing the rest of the time. For example, set |
| Christoph Haag | 7b414bc | 2016-09-07 01:13:39 +0200 | [diff] [blame] | 239 | GALLIUM_HUD_VISIBLE to false and GALLIUM_HUD_TOGGLE_SIGNAL to 10 (SIGUSR1). |
| Jimmy Berry | 56a1c10 | 2015-11-09 23:20:37 -0600 | [diff] [blame] | 240 | Use kill -10 <pid> to toggle the hud as desired. |
| Edmondo Tommasina | 3f5fba8 | 2016-12-21 22:58:14 +0100 | [diff] [blame] | 241 | <li>GALLIUM_HUD_DUMP_DIR - specifies a directory for writing the displayed |
| 242 | hud values into files. |
| Christoph Haag | 55ba5fa | 2016-09-08 21:32:04 +0200 | [diff] [blame] | 243 | <li>GALLIUM_DRIVER - useful in combination with LIBGL_ALWAYS_SOFTWARE=1 for |
| 244 | choosing one of the software renderers "softpipe", "llvmpipe" or "swr". |
| Brian Paul | 75e6202 | 2012-06-25 11:44:44 -0600 | [diff] [blame] | 245 | <li>GALLIUM_LOG_FILE - specifies a file for logging all errors, warnings, etc. |
| 246 | rather than stderr. |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 247 | <li>GALLIUM_PRINT_OPTIONS - if non-zero, print all the Gallium environment |
| 248 | variables which are used, and their current values. |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 249 | <li>GALLIUM_DUMP_CPU - if non-zero, print information about the CPU on start-up |
| 250 | <li>TGSI_PRINT_SANITY - if set, do extra sanity checking on TGSI shaders and |
| 251 | print any errors to stderr. |
| 252 | <LI>DRAW_FSE - ??? |
| 253 | <LI>DRAW_NO_FSE - ??? |
| 254 | <li>DRAW_USE_LLVM - if set to zero, the draw module will not use LLVM to execute |
| 255 | shaders, vertex fetch, etc. |
| Brian Paul | 90fa71b | 2013-06-07 10:12:28 -0600 | [diff] [blame] | 256 | <li>ST_DEBUG - controls debug output from the Mesa/Gallium state tracker. |
| 257 | Setting to "tgsi", for example, will print all the TGSI shaders. |
| 258 | See src/mesa/state_tracker/st_debug.c for other options. |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 259 | </ul> |
| 260 | |
| Vedran Miletić | 2fba720 | 2016-09-28 16:18:24 +0200 | [diff] [blame] | 261 | <h3>Clover state tracker environment variables</h3> |
| 262 | |
| 263 | <ul> |
| 264 | <li>CLOVER_EXTRA_BUILD_OPTIONS - allows specifying additional compiler and linker |
| 265 | options. Specified options are appended after the options set by the OpenCL |
| 266 | program in clBuildProgram. |
| 267 | <li>CLOVER_EXTRA_COMPILE_OPTIONS - allows specifying additional compiler |
| 268 | options. Specified options are appended after the options set by the OpenCL |
| 269 | program in clCompileProgram. |
| 270 | <li>CLOVER_EXTRA_LINK_OPTIONS - allows specifying additional linker |
| 271 | options. Specified options are appended after the options set by the OpenCL |
| 272 | program in clLinkProgram. |
| 273 | </ul> |
| 274 | |
| 275 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 276 | <h3>Softpipe driver environment variables</h3> |
| 277 | <ul> |
| 278 | <li>SOFTPIPE_DUMP_FS - if set, the softpipe driver will print fragment shaders |
| 279 | to stderr |
| 280 | <li>SOFTPIPE_DUMP_GS - if set, the softpipe driver will print geometry shaders |
| 281 | to stderr |
| 282 | <li>SOFTPIPE_NO_RAST - if set, rasterization is no-op'd. For profiling purposes. |
| Jakob Bornecrantz | 6afa7cd | 2012-01-09 21:37:50 +0100 | [diff] [blame] | 283 | <li>SOFTPIPE_USE_LLVM - if set, the softpipe driver will try to use LLVM JIT for |
| Nathan Kidd | 0691b37 | 2014-01-03 16:44:00 -0700 | [diff] [blame] | 284 | vertex shading processing. |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 285 | </ul> |
| 286 | |
| 287 | |
| 288 | <h3>LLVMpipe driver environment variables</h3> |
| 289 | <ul> |
| 290 | <li>LP_NO_RAST - if set LLVMpipe will no-op rasterization |
| Nathan Kidd | 0691b37 | 2014-01-03 16:44:00 -0700 | [diff] [blame] | 291 | <li>LP_DEBUG - a comma-separated list of debug options is accepted. See the |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 292 | source code for details. |
| 293 | <li>LP_PERF - a comma-separated list of options to selectively no-op various |
| 294 | parts of the driver. See the source code for details. |
| 295 | <li>LP_NUM_THREADS - an integer indicating how many threads to use for rendering. |
| Rhys Kidd | a0f55e9 | 2016-02-20 16:15:35 +0100 | [diff] [blame] | 296 | Zero turns off threading completely. The default value is the number of CPU |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 297 | cores present. |
| 298 | </ul> |
| 299 | |
| Brian Paul | 90fa71b | 2013-06-07 10:12:28 -0600 | [diff] [blame] | 300 | <h3>VMware SVGA driver environment variables</h3> |
| 301 | <ul> |
| 302 | <li>SVGA_FORCE_SWTNL - force use of software vertex transformation |
| 303 | <li>SVGA_NO_SWTNL - don't allow software vertex transformation fallbacks |
| 304 | (will often result in incorrect rendering). |
| 305 | <li>SVGA_DEBUG - for dumping shaders, constant buffers, etc. See the code |
| 306 | for details. |
| Brian Paul | cf1adb7 | 2017-05-23 07:45:12 -0600 | [diff] [blame] | 307 | <li>SVGA_EXTRA_LOGGING - if set, enables extra logging to the vmware.log file, |
| 308 | such as the OpenGL program's name and command line arguments. |
| Brian Paul | 90fa71b | 2013-06-07 10:12:28 -0600 | [diff] [blame] | 309 | <li>See the driver code for other, lesser-used variables. |
| 310 | </ul> |
| 311 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 312 | |
| Christian König | a2c5200 | 2015-11-23 15:21:19 +0100 | [diff] [blame] | 313 | <h3>VA-API state tracker environment variables</h3> |
| 314 | <ul> |
| 315 | <li>VAAPI_MPEG4_ENABLED - enable MPEG4 for VA-API, disabled by default. |
| 316 | </ul> |
| 317 | |
| 318 | |
| Rhys Kidd | 76e2af3 | 2016-02-13 16:03:02 -0500 | [diff] [blame] | 319 | <h3>VC4 driver environment variables</h3> |
| 320 | <ul> |
| 321 | <li>VC4_DEBUG - a comma-separated list of named flags, which do various things: |
| 322 | <ul> |
| 323 | <li>cl - dump command list during creation</li> |
| 324 | <li>qpu - dump generated QPU instructions</li> |
| 325 | <li>qir - dump QPU IR during program compile</li> |
| 326 | <li>nir - dump NIR during program compile</li> |
| 327 | <li>tgsi - dump TGSI during program compile</li> |
| 328 | <li>shaderdb - dump program compile information for shader-db analysis</li> |
| 329 | <li>perf - print during performance-related events</li> |
| 330 | <li>norast - skip actual hardware execution of commands</li> |
| 331 | <li>always_flush - flush after each draw call</li> |
| 332 | <li>always_sync - wait for finish after each flush</li> |
| 333 | <li>dump - write a GPU command stream trace file (VC4 simulator only)</li> |
| 334 | </ul> |
| 335 | </ul> |
| 336 | |
| 337 | |
| Brian Paul | 1bf9954 | 2011-02-17 07:29:20 -0700 | [diff] [blame] | 338 | <p> |
| 339 | Other Gallium drivers have their own environment variables. These may change |
| 340 | frequently so the source code should be consulted for details. |
| 341 | </p> |
| 342 | |
| Andreas Boll | b5da52a | 2012-09-18 18:57:02 +0200 | [diff] [blame] | 343 | </div> |
| Andreas Boll | ecd5c7c | 2012-06-12 09:05:03 +0200 | [diff] [blame] | 344 | </body> |
| 345 | </html> |