OpenHarmony/third_party_mesa3d
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: use code-tags for envvars and options

Browse Source 
This makes it a bit easier to tell what's what.

Signed-off-by: Erik Faye-Lund <erik.faye-lund@collabora.com>
Reviewed-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Eric Engestrom <eric.engestrom@intel.com>
This commit is contained in:
Erik Faye-Lund
2019-06-04 12:19:51 +02:00
parent 5639f0d5ee
commit d311d8f424
1 changed files with 143 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

285
docs/envvars.html
View File

@@ -26,40 +26,40 @@ sometimes be useful for debugging end-user issues.
<h2>LibGL environment variables</h2> <h2>LibGL environment variables</h2>
<dl> <dl>
<dt>LIBGL_DEBUG</dt> <dt><code>LIBGL_DEBUG</code></dt>
<dd>If defined debug information will be printed to stderr. <dd>If defined debug information will be printed to stderr.
If set to 'verbose' additional information will be printed.</dd> If set to 'verbose' additional information will be printed.</dd>
<dt>LIBGL_DRIVERS_PATH</dt> <dt><code>LIBGL_DRIVERS_PATH</code></dt>
<dd>colon-separated list of paths to search for DRI drivers</dd> <dd>colon-separated list of paths to search for DRI drivers</dd>
<dt>LIBGL_ALWAYS_INDIRECT</dt> <dt><code>LIBGL_ALWAYS_INDIRECT</code></dt>
<dd>if set to `true`, forces an indirect rendering context/connection.</dd> <dd>if set to `true`, forces an indirect rendering context/connection.</dd>
<dt>LIBGL_ALWAYS_SOFTWARE</dt> <dt><code>LIBGL_ALWAYS_SOFTWARE</code></dt>
<dd>if set to `true`, always use software rendering</dd> <dd>if set to `true`, always use software rendering</dd>
<dt>LIBGL_NO_DRAWARRAYS</dt> <dt><code>LIBGL_NO_DRAWARRAYS</code></dt>
<dd>if set to `true`, do not use DrawArrays GLX protocol (for debugging)</dd> <dd>if set to `true`, do not use DrawArrays GLX protocol (for debugging)</dd>
<dt>LIBGL_SHOW_FPS</dt> <dt><code>LIBGL_SHOW_FPS</code></dt>
<dd>print framerate to stdout based on the number of glXSwapBuffers <dd>print framerate to stdout based on the number of glXSwapBuffers
calls per second.</dd> calls per second.</dd>
<dt>LIBGL_DRI3_DISABLE</dt> <dt><code>LIBGL_DRI3_DISABLE</code></dt>
<dd>disable DRI3 if set to `true`.</dd> <dd>disable DRI3 if set to `true`.</dd>
</dl> </dl>
<h2>Core Mesa environment variables</h2> <h2>Core Mesa environment variables</h2>
<dl> <dl>
<dt>MESA_NO_ASM</dt> <dt><code>MESA_NO_ASM</code></dt>
<dd>if set, disables all assembly language optimizations</dd> <dd>if set, disables all assembly language optimizations</dd>
<dt>MESA_NO_MMX</dt> <dt><code>MESA_NO_MMX</code></dt>
<dd>if set, disables Intel MMX optimizations</dd> <dd>if set, disables Intel MMX optimizations</dd>
<dt>MESA_NO_3DNOW</dt> <dt><code>MESA_NO_3DNOW</code></dt>
<dd>if set, disables AMD 3DNow! optimizations</dd> <dd>if set, disables AMD 3DNow! optimizations</dd>
<dt>MESA_NO_SSE</dt> <dt><code>MESA_NO_SSE</code></dt>
<dd>if set, disables Intel SSE optimizations</dd> <dd>if set, disables Intel SSE optimizations</dd>
<dt>MESA_NO_ERROR</dt> <dt><code>MESA_NO_ERROR</code></dt>
<dd>if set to 1, error checking is disabled as per KHR_no_error. <dd>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 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.</dd> can reduce CPU use for apps that are known to be error free.</dd>
<dt>MESA_DEBUG</dt> <dt><code>MESA_DEBUG</code></dt>
<dd>if set, error messages are printed to stderr. For example, <dd>if set, error messages are printed to stderr. For example,
if the application generates a GL_INVALID_ENUM error, a corresponding error if the application generates a GL_INVALID_ENUM error, a corresponding error
message indicating where the error occurred, and possibly why, will be message indicating where the error occurred, and possibly why, will be
@@ -67,34 +67,34 @@ sometimes be useful for debugging end-user issues.
output). MESA_DEBUG accepts the following comma-separated list of named output). MESA_DEBUG accepts the following comma-separated list of named
flags, which adds extra behaviour to just set MESA_DEBUG=1: flags, which adds extra behaviour to just set MESA_DEBUG=1:
<dl> <dl>
<dt>silent</dt> <dt><code>silent</code></dt>
<dd>turn off debug messages. Only useful for debug builds.</dd> <dd>turn off debug messages. Only useful for debug builds.</dd>
<dt>flush</dt> <dt><code>flush</code></dt>
<dd>flush after each drawing command</dd> <dd>flush after each drawing command</dd>
<dt>incomplete_tex</dt> <dt><code>incomplete_tex</code></dt>
<dd>extra debug messages when a texture is incomplete</dd> <dd>extra debug messages when a texture is incomplete</dd>
<dt>incomplete_fbo</dt> <dt><code>incomplete_fbo</code></dt>
<dd>extra debug messages when a fbo is incomplete</dd> <dd>extra debug messages when a fbo is incomplete</dd>
<dt>context</dt> <dt><code>context</code></dt>
<dd>create a debug context (see GLX_CONTEXT_DEBUG_BIT_ARB) and print <dd>create a debug context (see GLX_CONTEXT_DEBUG_BIT_ARB) and print
error and performance messages to stderr (or MESA_LOG_FILE).</dd> error and performance messages to stderr (or MESA_LOG_FILE).</dd>
</dl> </dl>
</dd> </dd>
<dt>MESA_LOG_FILE</dt> <dt><code>MESA_LOG_FILE</code></dt>
<dd>specifies a file name for logging all errors, warnings, <dd>specifies a file name for logging all errors, warnings,
etc., rather than stderr</dd> etc., rather than stderr</dd>
<dt>MESA_TEX_PROG</dt> <dt><code>MESA_TEX_PROG</code></dt>
<dd>if set, implement conventional texture env modes with <dd>if set, implement conventional texture env modes with
fragment programs (intended for developers only)</dd> fragment programs (intended for developers only)</dd>
<dt>MESA_TNL_PROG</dt> <dt><code>MESA_TNL_PROG</code></dt>
<dd>if set, implement conventional vertex transformation operations with <dd>if set, implement conventional vertex transformation operations with
vertex programs (intended for developers only). Setting this variable vertex programs (intended for developers only). Setting this variable
automatically sets the MESA_TEX_PROG variable as well.</dd> automatically sets the MESA_TEX_PROG variable as well.</dd>
<dt>MESA_EXTENSION_OVERRIDE</dt> <dt><code>MESA_EXTENSION_OVERRIDE</code></dt>
<dd>can be used to enable/disable extensions. A value such as <dd>can be used to enable/disable extensions. A value such as
"GL_EXT_foo -GL_EXT_bar" will enable the GL_EXT_foo extension and disable "GL_EXT_foo -GL_EXT_bar" will enable the GL_EXT_foo extension and disable
the GL_EXT_bar extension.</dd> the GL_EXT_bar extension.</dd>
<dt>MESA_EXTENSION_MAX_YEAR</dt> <dt><code>MESA_EXTENSION_MAX_YEAR</code></dt>
<dd>The GL_EXTENSIONS string returned by Mesa is sorted by extension year. <dd>The GL_EXTENSIONS string returned by Mesa is sorted by extension year.
If this variable is set to year X, only extensions defined on or before If this variable is set to year X, only extensions defined on or before
year X will be reported. This is to work-around a bug in some games where year X will be reported. This is to work-around a bug in some games where
@@ -102,7 +102,7 @@ sometimes be useful for debugging end-user issues.
truncating. If the extension string is too long, the buffer overrun can truncating. If the extension string is too long, the buffer overrun can
cause the game to crash. This is a work-around for that. cause the game to crash. This is a work-around for that.
</dd> </dd>
<dt>MESA_GL_VERSION_OVERRIDE</dt> <dt><code>MESA_GL_VERSION_OVERRIDE</code></dt>
<dd>changes the value returned by <dd>changes the value returned by
glGetString(GL_VERSION) and possibly the GL API type. glGetString(GL_VERSION) and possibly the GL API type.
<ul> <ul>
@@ -119,32 +119,32 @@ glGetString(GL_VERSION) and possibly the GL API type.
<li>GL versions &gt;= 3.2 are set to a Core profile <li>GL versions &gt;= 3.2 are set to a Core profile
<li>Examples: <li>Examples:
<dl> <dl>
<dt>2.1</dt> <dt><code>2.1</code></dt>
<dd>select a compatibility (non-Core) profile with GL version 2.1.</dd> <dd>select a compatibility (non-Core) profile with GL version 2.1.</dd>
<dt>3.0</dt> <dt><code>3.0</code></dt>
<dd>select a compatibility (non-Core) profile with GL version 3.0.</dd> <dd>select a compatibility (non-Core) profile with GL version 3.0.</dd>
<dt>3.0FC</dt> <dt><code>3.0FC</code></dt>
<dd>select a Core+Forward Compatible profile with GL version 3.0.</dd> <dd>select a Core+Forward Compatible profile with GL version 3.0.</dd>
<dt>3.1</dt> <dt><code>3.1</code></dt>
<dd>select GL version 3.1 with GL_ARB_compatibility enabled per the <dd>select GL version 3.1 with GL_ARB_compatibility enabled per the
driver default.</dd> driver default.</dd>
<dt>3.1FC</dt> <dt><code>3.1FC</code></dt>
<dd>select GL version 3.1 with forward compatibility and <dd>select GL version 3.1 with forward compatibility and
GL_ARB_compatibility disabled.</dd> GL_ARB_compatibility disabled.</dd>
<dt>3.1COMPAT</dt> <dt><code>3.1COMPAT</code></dt>
<dd>select GL version 3.1 with GL_ARB_compatibility enabled.</dd> <dd>select GL version 3.1 with GL_ARB_compatibility enabled.</dd>
<dt>X.Y</dt> <dt><code>X.Y</code></dt>
<dd>override GL version to X.Y without changing the profile.</dd> <dd>override GL version to X.Y without changing the profile.</dd>
<dt>X.YFC</dt> <dt><code>X.YFC</code></dt>
<dd>select a Core+Forward Compatible profile with GL version X.Y.</dd> <dd>select a Core+Forward Compatible profile with GL version X.Y.</dd>
<dt>X.YCOMPAT</dt> <dt><code>X.YCOMPAT</code></dt>
<dd>select a Compatibility profile with GL version X.Y.</dd> <dd>select a Compatibility profile with GL version X.Y.</dd>
</dl> </dl>
<li>Mesa may not really implement all the features of the given <li>Mesa may not really implement all the features of the given
version. (for developers only) version. (for developers only)
</ul> </ul>
</dd> </dd>
<dt>MESA_GLES_VERSION_OVERRIDE</dt> <dt><code>MESA_GLES_VERSION_OVERRIDE</code></dt>
<dd>changes the value returned by glGetString(GL_VERSION) for OpenGL ES. <dd>changes the value returned by glGetString(GL_VERSION) for OpenGL ES.
<ul> <ul>
<li> The format should be MAJOR.MINOR <li> The format should be MAJOR.MINOR
@@ -153,15 +153,15 @@ glGetString(GL_VERSION) and possibly the GL API type.
(for developers only) (for developers only)
</ul> </ul>
</dd> </dd>
<dt>MESA_GLSL_VERSION_OVERRIDE</dt> <dt><code>MESA_GLSL_VERSION_OVERRIDE</code></dt>
<dd>changes the value returned by glGetString(GL_SHADING_LANGUAGE_VERSION). <dd>changes the value returned by glGetString(GL_SHADING_LANGUAGE_VERSION).
Valid values are integers, such as "130". Mesa will not really implement 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 all the features of the given language version if it's higher than what's
normally reported. (for developers only) normally reported. (for developers only)
</dd> </dd>
<dt>MESA_GLSL_CACHE_DISABLE</dt> <dt><code>MESA_GLSL_CACHE_DISABLE</code></dt>
<dd>if set to `true`, disables the GLSL shader cache</dd> <dd>if set to `true`, disables the GLSL shader cache</dd>
<dt>MESA_GLSL_CACHE_MAX_SIZE</dt> <dt><code>MESA_GLSL_CACHE_MAX_SIZE</code></dt>
<dd>if set, determines the maximum size of the on-disk cache of compiled GLSL <dd>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 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, 'G' to specify a size in kilobytes, megabytes, or gigabytes. By default,
@@ -170,21 +170,21 @@ glGetString(GL_VERSION) and possibly the GL API type.
Mesa is installed for on your system. For example under the default 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 settings you may end up with a 1GB cache for x86_64 and another 1GB cache
for i386.</dd> for i386.</dd>
<dt>MESA_GLSL_CACHE_DIR</dt> <dt><code>MESA_GLSL_CACHE_DIR</code></dt>
<dd>if set, determines the directory to be used for the on-disk cache of <dd>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 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), 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. or else within .cache/mesa_shader_cache within the user's home directory.
</dd> </dd>
<dt>MESA_GLSL</dt> <dt><code>MESA_GLSL</code></dt>
<dd><a href="shading.html#envvars">shading language compiler options</a></dd> <dd><a href="shading.html#envvars">shading language compiler options</a></dd>
<dt>MESA_NO_MINMAX_CACHE</dt> <dt><code>MESA_NO_MINMAX_CACHE</code></dt>
<dd>when set, the minmax index cache is globally disabled.</dd> <dd>when set, the minmax index cache is globally disabled.</dd>
<dt>MESA_SHADER_CAPTURE_PATH</dt> <dt><code>MESA_SHADER_CAPTURE_PATH</code></dt>
<dd>see <a href="shading.html#capture">Capturing Shaders</a></dd> <dd>see <a href="shading.html#capture">Capturing Shaders</a></dd>
<dt>MESA_SHADER_DUMP_PATH and MESA_SHADER_READ_PATH</dt> <dt><code>MESA_SHADER_DUMP_PATH</code> and <code>MESA_SHADER_READ_PATH</code></dt>
<dd>see <a href="shading.html#replacement">Experimenting with Shader Replacements</a></dd> <dd>see <a href="shading.html#replacement">Experimenting with Shader Replacements</a></dd>
<dt>MESA_VK_VERSION_OVERRIDE</dt> <dt><code>MESA_VK_VERSION_OVERRIDE</code></dt>
<dd>changes the Vulkan physical device version <dd>changes the Vulkan physical device version
as returned in VkPhysicalDeviceProperties::apiVersion. as returned in VkPhysicalDeviceProperties::apiVersion.
<ul> <ul>
@@ -205,24 +205,24 @@ The following are only applicable to the Mesa Xlib software driver.
See the <a href="xlibdriver.html">Xlib software driver page</a> for details. See the <a href="xlibdriver.html">Xlib software driver page</a> for details.
</p> </p>
<dl> <dl>
<dt>MESA_RGB_VISUAL</dt> <dt><code>MESA_RGB_VISUAL</code></dt>
<dd>specifies the X visual and depth for RGB mode</dd> <dd>specifies the X visual and depth for RGB mode</dd>
<dt>MESA_CI_VISUAL</dt> <dt><code>MESA_CI_VISUAL</code></dt>
<dd>specifies the X visual and depth for CI mode</dd> <dd>specifies the X visual and depth for CI mode</dd>
<dt>MESA_BACK_BUFFER</dt> <dt><code>MESA_BACK_BUFFER</code></dt>
<dd>specifies how to implement the back color buffer, either "pixmap" or <dd>specifies how to implement the back color buffer, either "pixmap" or
"ximage"</dd> "ximage"</dd>
<dt>MESA_GAMMA</dt> <dt><code>MESA_GAMMA</code></dt>
<dd>gamma correction coefficients for red, green, blue channels</dd> <dd>gamma correction coefficients for red, green, blue channels</dd>
<dt>MESA_XSYNC</dt> <dt><code>MESA_XSYNC</code></dt>
<dd>enable synchronous X behavior (for debugging only)</dd> <dd>enable synchronous X behavior (for debugging only)</dd>
<dt>MESA_GLX_FORCE_CI</dt> <dt><code>MESA_GLX_FORCE_CI</code></dt>
<dd>if set, force GLX to treat 8bpp visuals as CI visuals</dd> <dd>if set, force GLX to treat 8bpp visuals as CI visuals</dd>
<dt>MESA_GLX_FORCE_ALPHA</dt> <dt><code>MESA_GLX_FORCE_ALPHA</code></dt>
<dd>if set, forces RGB windows to have an alpha channel.</dd> <dd>if set, forces RGB windows to have an alpha channel.</dd>
<dt>MESA_GLX_DEPTH_BITS</dt> <dt><code>MESA_GLX_DEPTH_BITS</code></dt>
<dd>specifies default number of bits for depth buffer.</dd> <dd>specifies default number of bits for depth buffer.</dd>
<dt>MESA_GLX_ALPHA_BITS</dt> <dt><code>MESA_GLX_ALPHA_BITS</code></dt>
<dd>specifies default number of bits for alpha channel.</dd> <dd>specifies default number of bits for alpha channel.</dd>
</dl> </dl>
@@ -230,99 +230,100 @@ See the <a href="xlibdriver.html">Xlib software driver page</a> for details.
<h2>i945/i965 driver environment variables (non-Gallium)</h2> <h2>i945/i965 driver environment variables (non-Gallium)</h2>
<dl> <dl>
<dt>INTEL_NO_HW</dt> <dt><code>INTEL_NO_HW</code></dt>
<dd>if set to 1, prevents batches from being submitted to the hardware. <dd>if set to 1, prevents batches from being submitted to the hardware.
This is useful for debugging hangs, etc.</dd> This is useful for debugging hangs, etc.</dd>
<dt>INTEL_DEBUG</dt> <dt><code>INTEL_DEBUG</code></dt>
<dd>a comma-separated list of named flags, which do various things: <dd>a comma-separated list of named flags, which do various things:
<dl> <dl>
<dt>ann</dt> <dt><code>ann</code></dt>
<dd>annotate IR in assembly dumps</dd> <dd>annotate IR in assembly dumps</dd>
<dt>aub</dt> <dt><code>aub</code></dt>
<dd>dump batches into an AUB trace for use with simulation tools</dd> <dd>dump batches into an AUB trace for use with simulation tools</dd>
<dt>bat</dt> <dt><code>bat</code></dt>
<dd>emit batch information</dd> <dd>emit batch information</dd>
<dt>blit</dt> <dt><code>blit</code></dt>
<dd>emit messages about blit operations</dd> <dd>emit messages about blit operations</dd>
<dt>blorp</dt> <dt><code>blorp</code></dt>
<dd>emit messages about the blorp operations (blits &amp; clears)</dd> <dd>emit messages about the blorp operations (blits &amp; clears)</dd>
<dt>buf</dt> <dt><code>buf</code></dt>
<dd>emit messages about buffer objects</dd> <dd>emit messages about buffer objects</dd>
<dt>clip</dt> <dt><code>clip</code></dt>
<dd>emit messages about the clip unit (for old gens, includes the CLIP program)</dd> <dd>emit messages about the clip unit (for old gens, includes the CLIP program)</dd>
<dt>color</dt> <dt><code>color</code></dt>
<dd>use color in output</dd> <dd>use color in output</dd>
<dt>cs</dt> <dt><code>cs</code></dt>
<dd>dump shader assembly for compute shaders</dd> <dd>dump shader assembly for compute shaders</dd>
<dt>do32</dt> <dt><code>do32</code></dt>
<dd>generate compute shader SIMD32 programs even if workgroup size doesn't exceed the SIMD16 limit</dd> <dd>generate compute shader SIMD32 programs even if workgroup size doesn't exceed the SIMD16 limit</dd>
<dt>dri</dt> <dt><code>dri</code></dt>
<dd>emit messages about the DRI interface</dd> <dd>emit messages about the DRI interface</dd>
<dt>fbo</dt> <dt><code>fbo</code></dt>
<dd>emit messages about framebuffers</dd> <dd>emit messages about framebuffers</dd>
<dt>fs</dt> <dt><code>fs</code></dt>
<dd>dump shader assembly for fragment shaders</dd> <dd>dump shader assembly for fragment shaders</dd>
<dt>gs</dt> <dt><code>gs</code></dt>
<dd>dump shader assembly for geometry shaders</dd> <dd>dump shader assembly for geometry shaders</dd>
<dt>hex</dt> <dt><code>hex</code></dt>
<dd>print instruction hex dump with the disassembly</dd> <dd>print instruction hex dump with the disassembly</dd>
<dt>l3</dt> <dt><code>l3</code></dt>
<dd>emit messages about the new L3 state during transitions</dd> <dd>emit messages about the new L3 state during transitions</dd>
<dt>miptree</dt> <dt><code>miptree</code></dt>
<dd>emit messages about miptrees</dd> <dd>emit messages about miptrees</dd>
<dt>no8</dt> <dt><code>no8</code></dt>
<dd>don't generate SIMD8 fragment shader</dd> <dd>don't generate SIMD8 fragment shader</dd>
<dt>no16</dt> <dt><code>no16</code></dt>
<dd>suppress generation of 16-wide fragment shaders. useful for debugging broken shaders</dd> <dd>suppress generation of 16-wide fragment shaders. useful for debugging broken shaders</dd>
<dt>nocompact</dt> <dt><code>nocompact</code></dt>
<dd>disable instruction compaction</dd> <dd>disable instruction compaction</dd>
<dt>nodualobj</dt> <dt><code>nodualobj</code></dt>
<dd>suppress generation of dual-object geometry shader code</dd> <dd>suppress generation of dual-object geometry shader code</dd>
<dt>norbc</dt> <dt><code>norbc</code></dt>
<dd>disable single sampled render buffer compression</dd> <dd>disable single sampled render buffer compression</dd>
<dt>optimizer</dt> <dt><code>optimizer</code></dt>
<dd>dump shader assembly to files at each optimization pass and iteration that make progress</dd> <dd>dump shader assembly to files at each optimization pass and iteration that make progress</dd>
<dt>perf</dt> <dt><code>perf</code></dt>
<dd>emit messages about performance issues</dd> <dd>emit messages about performance issues</dd>
<dt>perfmon</dt> <dt><code>perfmon</code></dt>
<dd>emit messages about AMD_performance_monitor</dd> <dd>emit messages about AMD_performance_monitor</dd>
<dt>pix</dt> <dt><code>pix</code></dt>
<dd>emit messages about pixel operations</dd> <dd>emit messages about pixel operations</dd>
<dt>prim</dt> <dt><code>prim</code></dt>
<dd>emit messages about drawing primitives</dd> <dd>emit messages about drawing primitives</dd>
<dt>reemit</dt> <dt><code>reemit</code></dt>
<dd>mark all state dirty on each draw call</dd> <dd>mark all state dirty on each draw call</dd>
<dt>sf</dt> <dt><code>sf</code></dt>
<dd>emit messages about the strips &amp; fans unit (for old gens, includes the SF program)</dd> <dd>emit messages about the strips &amp; fans unit (for old gens, includes the SF program)</dd>
<dt>shader_time</dt> <dt><code>shader_time</code></dt>
<dd>record how much GPU time is spent in each shader</dd> <dd>record how much GPU time is spent in each shader</dd>
<dt>spill_fs</dt> <dt><code>spill_fs</code></dt>
<dd>force spilling of all registers in the scalar backend (useful to debug spilling code)</dd> <dd>force spilling of all registers in the scalar backend (useful to debug spilling code)</dd>
<dt>spill_vec4</dt> <dt><code>spill_vec4</code></dt>
<dd>force spilling of all registers in the vec4 backend (useful to debug spilling code)</dd> <dd>force spilling of all registers in the vec4 backend (useful to debug spilling code)</dd>
<dt>state</dt> <dt><code>state</code></dt>
<dd>emit messages about state flag tracking</dd> <dd>emit messages about state flag tracking</dd>
<dt>submit</dt> <dt><code>submit</code></dt>
<dd>emit batchbuffer usage statistics</dd> <dd>emit batchbuffer usage statistics</dd>
<dt>sync</dt> <dt><code>sync</code></dt>
<dd>after sending each batch, emit a message and wait for that batch to finish rendering</dd> <dd>after sending each batch, emit a message and wait for that batch to finish rendering</dd>
<dt>tcs</dt> <dt><code>tcs</code></dt>
<dd>dump shader assembly for tessellation control shaders</dd> <dd>dump shader assembly for tessellation control shaders</dd>
<dt>tes</dt> <dt><code>tes</code></dt>
<dd>dump shader assembly for tessellation evaluation shaders</dd> <dd>dump shader assembly for tessellation evaluation shaders</dd>
<dt>tex</dt> <dt><code>tex</code></dt>
<dd>emit messages about textures.</dd> <dd>emit messages about textures.</dd>
<dt>urb</dt> <dt><code>urb</code></dt>
<dd>emit messages about URB setup</dd> <dd>emit messages about URB setup</dd>
<dt>vert</dt> <dt><code>vert</code></dt>
<dd>emit messages about vertex assembly</dd> <dd>emit messages about vertex assembly</dd>
<dt>vs</dt> <dt><code>vs</code></dt>
<dd>dump shader assembly for vertex shaders</dd> <dd>dump shader assembly for vertex shaders</dd>
</dl> </dl>
</dd> </dd>
<dt>INTEL_SCALAR_VS (or TCS, TES, GS)</dt> <dt><code>INTEL_SCALAR_VS</code> (or <code>TCS</code>, <code>TES</code>,
<code>GS</code>)</dt>
<dd>force scalar/vec4 mode for a shader stage (Gen8-9 only)</dd> <dd>force scalar/vec4 mode for a shader stage (Gen8-9 only)</dd>
<dt>INTEL_PRECISE_TRIG</dt> <dt><code>INTEL_PRECISE_TRIG</code></dt>
<dd>if set to 1, true or yes, then the driver prefers accuracy over <dd>if set to 1, true or yes, then the driver prefers accuracy over
performance in trig functions.</dd> performance in trig functions.</dd>
</dl> </dl>
@@ -331,7 +332,7 @@ See the <a href="xlibdriver.html">Xlib software driver page</a> for details.
<h2>Radeon driver environment variables (radeon, r200, and r300g)</h2> <h2>Radeon driver environment variables (radeon, r200, and r300g)</h2>
<dl> <dl>
<dt>RADEON_NO_TCL</dt> <dt><code>RADEON_NO_TCL</code></dt>
<dd>if set, disable hardware-accelerated Transform/Clip/Lighting.</dd> <dd>if set, disable hardware-accelerated Transform/Clip/Lighting.</dd>
</dl> </dl>
@@ -347,45 +348,45 @@ Mesa EGL supports different sets of environment variables. See the
<h2>Gallium environment variables</h2> <h2>Gallium environment variables</h2>
<dl> <dl>
<dt>GALLIUM_HUD</dt> <dt><code>GALLIUM_HUD</code></dt>
<dd>draws various information on the screen, like framerate, <dd>draws various information on the screen, like framerate,
cpu load, driver statistics, performance counters, etc. cpu load, driver statistics, performance counters, etc.
Set GALLIUM_HUD=help and run e.g. glxgears for more info.</dd> Set GALLIUM_HUD=help and run e.g. glxgears for more info.</dd>
<dt>GALLIUM_HUD_PERIOD</dt> <dt><code>GALLIUM_HUD_PERIOD</code></dt>
<dd>sets the hud update rate in seconds (float). Use zero <dd>sets the hud update rate in seconds (float). Use zero
to update every frame. The default period is 1/2 second.</dd> to update every frame. The default period is 1/2 second.</dd>
<dt>GALLIUM_HUD_VISIBLE</dt> <dt><code>GALLIUM_HUD_VISIBLE</code></dt>
<dd>control default visibility, defaults to true.</dd> <dd>control default visibility, defaults to true.</dd>
<dt>GALLIUM_HUD_TOGGLE_SIGNAL</dt> <dt><code>GALLIUM_HUD_TOGGLE_SIGNAL</code></dt>
<dd>toggle visibility via user specified signal. <dd>toggle visibility via user specified signal.
Especially useful to toggle hud at specific points of application and Especially useful to toggle hud at specific points of application and
disable for unencumbered viewing the rest of the time. For example, set disable for unencumbered viewing the rest of the time. For example, set
GALLIUM_HUD_VISIBLE to false and GALLIUM_HUD_TOGGLE_SIGNAL to 10 (SIGUSR1). GALLIUM_HUD_VISIBLE to false and GALLIUM_HUD_TOGGLE_SIGNAL to 10 (SIGUSR1).
Use kill -10 &lt;pid&gt; to toggle the hud as desired.</dd> Use kill -10 &lt;pid&gt; to toggle the hud as desired.</dd>
<dt>GALLIUM_HUD_DUMP_DIR</dt> <dt><code>GALLIUM_HUD_DUMP_DIR</code></dt>
<dd>specifies a directory for writing the displayed hud values into files.</dd> <dd>specifies a directory for writing the displayed hud values into files.</dd>
<dt>GALLIUM_DRIVER</dt> <dt><code>GALLIUM_DRIVER</code></dt>
<dd>useful in combination with LIBGL_ALWAYS_SOFTWARE=true for choosing one <dd>useful in combination with LIBGL_ALWAYS_SOFTWARE=true for choosing one
of the software renderers "softpipe", "llvmpipe" or "swr".</dd> of the software renderers "softpipe", "llvmpipe" or "swr".</dd>
<dt>GALLIUM_LOG_FILE</dt> <dt><code>GALLIUM_LOG_FILE</code></dt>
<dd>specifies a file for logging all errors, warnings, etc. <dd>specifies a file for logging all errors, warnings, etc.
rather than stderr.</dd> rather than stderr.</dd>
<dt>GALLIUM_PRINT_OPTIONS</dt> <dt><code>GALLIUM_PRINT_OPTIONS</code></dt>
<dd>if non-zero, print all the Gallium environment variables which are <dd>if non-zero, print all the Gallium environment variables which are
used, and their current values.</dd> used, and their current values.</dd>
<dt>GALLIUM_DUMP_CPU</dt> <dt><code>GALLIUM_DUMP_CPU</code></dt>
<dd>if non-zero, print information about the CPU on start-up</dd> <dd>if non-zero, print information about the CPU on start-up</dd>
<dt>TGSI_PRINT_SANITY</dt> <dt><code>TGSI_PRINT_SANITY</code></dt>
<dd>if set, do extra sanity checking on TGSI shaders and <dd>if set, do extra sanity checking on TGSI shaders and
print any errors to stderr.</dd> print any errors to stderr.</dd>
<dt>DRAW_FSE</dt> <dt><code>DRAW_FSE</code></dt>
<dd>???</dd> <dd>???</dd>
<dt>DRAW_NO_FSE</dt> <dt><code>DRAW_NO_FSE</code></dt>
<dd>???</dd> <dd>???</dd>
<dt>DRAW_USE_LLVM</dt> <dt><code>DRAW_USE_LLVM</code></dt>
<dd>if set to zero, the draw module will not use LLVM to execute <dd>if set to zero, the draw module will not use LLVM to execute
shaders, vertex fetch, etc.</dd> shaders, vertex fetch, etc.</dd>
<dt>ST_DEBUG</dt> <dt><code>ST_DEBUG</code></dt>
<dd>controls debug output from the Mesa/Gallium state tracker. <dd>controls debug output from the Mesa/Gallium state tracker.
Setting to "tgsi", for example, will print all the TGSI shaders. Setting to "tgsi", for example, will print all the TGSI shaders.
See src/mesa/state_tracker/st_debug.c for other options.</dd> See src/mesa/state_tracker/st_debug.c for other options.</dd>
@@ -394,15 +395,15 @@ Mesa EGL supports different sets of environment variables. See the
<h3>Clover state tracker environment variables</h3> <h3>Clover state tracker environment variables</h3>
<dl> <dl>
<dt>CLOVER_EXTRA_BUILD_OPTIONS</dt> <dt><code>CLOVER_EXTRA_BUILD_OPTIONS</code></dt>
<dd>allows specifying additional compiler and linker <dd>allows specifying additional compiler and linker
options. Specified options are appended after the options set by the OpenCL options. Specified options are appended after the options set by the OpenCL
program in clBuildProgram.</dd> program in clBuildProgram.</dd>
<dt>CLOVER_EXTRA_COMPILE_OPTIONS</dt> <dt><code>CLOVER_EXTRA_COMPILE_OPTIONS</code></dt>
<dd>allows specifying additional compiler <dd>allows specifying additional compiler
options. Specified options are appended after the options set by the OpenCL options. Specified options are appended after the options set by the OpenCL
program in clCompileProgram.</dd> program in clCompileProgram.</dd>
<dt>CLOVER_EXTRA_LINK_OPTIONS</dt> <dt><code>CLOVER_EXTRA_LINK_OPTIONS</code></dt>
<dd>allows specifying additional linker <dd>allows specifying additional linker
options. Specified options are appended after the options set by the OpenCL options. Specified options are appended after the options set by the OpenCL
program in clLinkProgram.</dd> program in clLinkProgram.</dd>
@@ -411,13 +412,13 @@ Mesa EGL supports different sets of environment variables. See the
<h3>Softpipe driver environment variables</h3> <h3>Softpipe driver environment variables</h3>
<dl> <dl>
<dt>SOFTPIPE_DUMP_FS</dt> <dt><code>SOFTPIPE_DUMP_FS</code></dt>
<dd>if set, the softpipe driver will print fragment shaders to stderr</dd> <dd>if set, the softpipe driver will print fragment shaders to stderr</dd>
<dt>SOFTPIPE_DUMP_GS</dt> <dt><code>SOFTPIPE_DUMP_GS</code></dt>
<dd>if set, the softpipe driver will print geometry shaders to stderr</dd> <dd>if set, the softpipe driver will print geometry shaders to stderr</dd>
<dt>SOFTPIPE_NO_RAST</dt> <dt><code>SOFTPIPE_NO_RAST</code></dt>
<dd>if set, rasterization is no-op'd. For profiling purposes.</dd> <dd>if set, rasterization is no-op'd. For profiling purposes.</dd>
<dt>SOFTPIPE_USE_LLVM</dt> <dt><code>SOFTPIPE_USE_LLVM</code></dt>
<dd>if set, the softpipe driver will try to use LLVM JIT for <dd>if set, the softpipe driver will try to use LLVM JIT for
vertex shading processing.</dd> vertex shading processing.</dd>
</dl> </dl>
@@ -425,15 +426,15 @@ Mesa EGL supports different sets of environment variables. See the
<h3>LLVMpipe driver environment variables</h3> <h3>LLVMpipe driver environment variables</h3>
<dl> <dl>
<dt>LP_NO_RAST</dt> <dt><code>LP_NO_RAST</code></dt>
<dd>if set LLVMpipe will no-op rasterization</dd> <dd>if set LLVMpipe will no-op rasterization</dd>
<dt>LP_DEBUG</dt> <dt><code>LP_DEBUG</code></dt>
<dd>a comma-separated list of debug options is accepted. See the <dd>a comma-separated list of debug options is accepted. See the
source code for details.</dd> source code for details.</dd>
<dt>LP_PERF</dt> <dt><code>LP_PERF</code></dt>
<dd>a comma-separated list of options to selectively no-op various <dd>a comma-separated list of options to selectively no-op various
parts of the driver. See the source code for details.</dd> parts of the driver. See the source code for details.</dd>
<dt>LP_NUM_THREADS</dt> <dt><code>LP_NUM_THREADS</code></dt>
<dd>an integer indicating how many threads to use for rendering. <dd>an integer indicating how many threads to use for rendering.
Zero turns off 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.</dd> cores present.</dd>
@@ -441,18 +442,18 @@ Mesa EGL supports different sets of environment variables. See the
<h3>VMware SVGA driver environment variables</h3> <h3>VMware SVGA driver environment variables</h3>
<dl> <dl>
<dt>SVGA_FORCE_SWTNL</dt> <dt><code>SVGA_FORCE_SWTNL</code></dt>
<dd>force use of software vertex transformation</dd> <dd>force use of software vertex transformation</dd>
<dt>SVGA_NO_SWTNL</dt> <dt><code>SVGA_NO_SWTNL</code></dt>
<dd>don't allow software vertex transformation fallbacks (will often result <dd>don't allow software vertex transformation fallbacks (will often result
in incorrect rendering).</dd> in incorrect rendering).</dd>
<dt>SVGA_DEBUG</dt> <dt><code>SVGA_DEBUG</code></dt>
<dd>for dumping shaders, constant buffers, etc. See the code for <dd>for dumping shaders, constant buffers, etc. See the code for
details.</dd> details.</dd>
<dt>SVGA_EXTRA_LOGGING</dt> <dt><code>SVGA_EXTRA_LOGGING</code></dt>
<dd>if set, enables extra logging to the vmware.log file, such as the <dd>if set, enables extra logging to the vmware.log file, such as the
OpenGL program's name and command line arguments.</dd> OpenGL program's name and command line arguments.</dd>
<dt>SVGA_NO_LOGGING</dt> <dt><code>SVGA_NO_LOGGING</code></dt>
<dd>if set, disables logging to the vmware.log file. This is useful when <dd>if set, disables logging to the vmware.log file. This is useful when
using Valgrind because it otherwise crashes when initializing the host using Valgrind because it otherwise crashes when initializing the host
log feature.</dd> log feature.</dd>
@@ -461,7 +462,7 @@ Mesa EGL supports different sets of environment variables. See the
<h3>WGL environment variables</h3> <h3>WGL environment variables</h3>
<dl> <dl>
<dt>WGL_SWAP_INTERVAL</dt> <dt><code>WGL_SWAP_INTERVAL</code></dt>
<dd>to set a swap interval, equivalent to calling wglSwapIntervalEXT() <dd>to set a swap interval, equivalent to calling wglSwapIntervalEXT()
in an application. If this environment variable is set, application in an application. If this environment variable is set, application
calls to wglSwapIntervalEXT() will have no effect.</dd> calls to wglSwapIntervalEXT() will have no effect.</dd>
@@ -469,37 +470,37 @@ Mesa EGL supports different sets of environment variables. See the
<h3>VA-API state tracker environment variables</h3> <h3>VA-API state tracker environment variables</h3>
<dl> <dl>
<dt>VAAPI_MPEG4_ENABLED</dt> <dt><code>VAAPI_MPEG4_ENABLED</code></dt>
<dd>enable MPEG4 for VA-API, disabled by default.</dd> <dd>enable MPEG4 for VA-API, disabled by default.</dd>
</dl> </dl>
<h3>VC4 driver environment variables</h3> <h3>VC4 driver environment variables</h3>
<dl> <dl>
<dt>VC4_DEBUG</dt> <dt><code>VC4_DEBUG</code></dt>
<dd>a comma-separated list of named flags, which do various things: <dd>a comma-separated list of named flags, which do various things:
<dl> <dl>
<dt>cl</dt> <dt><code>cl</code></dt>
<dd>dump command list during creation</dd> <dd>dump command list during creation</dd>
<dt>qpu</dt> <dt><code>qpu</code></dt>
<dd>dump generated QPU instructions</dd> <dd>dump generated QPU instructions</dd>
<dt>qir</dt> <dt><code>qir</code></dt>
<dd>dump QPU IR during program compile</dd> <dd>dump QPU IR during program compile</dd>
<dt>nir</dt> <dt><code>nir</code></dt>
<dd>dump NIR during program compile</dd> <dd>dump NIR during program compile</dd>
<dt>tgsi</dt> <dt><code>tgsi</code></dt>
<dd>dump TGSI during program compile</dd> <dd>dump TGSI during program compile</dd>
<dt>shaderdb</dt> <dt><code>shaderdb</code></dt>
<dd>dump program compile information for shader-db analysis</dd> <dd>dump program compile information for shader-db analysis</dd>
<dt>perf</dt> <dt><code>perf</code></dt>
<dd>print during performance-related events</dd> <dd>print during performance-related events</dd>
<dt>norast</dt> <dt><code>norast</code></dt>
<dd>skip actual hardware execution of commands</dd> <dd>skip actual hardware execution of commands</dd>
<dt>always_flush</dt> <dt><code>always_flush</code></dt>
<dd>flush after each draw call</dd> <dd>flush after each draw call</dd>
<dt>always_sync</dt> <dt><code>always_sync</code></dt>
<dd>wait for finish after each flush</dd> <dd>wait for finish after each flush</dd>
<dt>dump</dt> <dt><code>dump</code></dt>
<dd>write a GPU command stream trace file (VC4 simulator only)</dd> <dd>write a GPU command stream trace file (VC4 simulator only)</dd>
</dl> </dl>
</dd> </dd>