From 52667f990ec2ed67dc02c9631395cfcfaedda223 Mon Sep 17 00:00:00 2001 From: Erik Faye-Lund Date: Tue, 4 Jun 2019 12:50:23 +0200 Subject: [PATCH] docs: use more code-tags in envvars.html This wraps code, identifiers, values and paths in code-tags, which makes them appear in a monospace-font for readability. Signed-off-by: Erik Faye-Lund Reviewed-by: Emil Velikov Reviewed-by: Eric Engestrom --- docs/envvars.html | 149 ++++++++++++++++++++++++++-------------------- 1 file changed, 83 insertions(+), 66 deletions(-) diff --git a/docs/envvars.html b/docs/envvars.html index b22c180b499..c41820b8d39 100644 --- a/docs/envvars.html +++ b/docs/envvars.html @@ -28,20 +28,23 @@ 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.
+ 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
-
if set to `true`, forces an indirect rendering context/connection.
+
if set to true, forces an indirect rendering + context/connection.
LIBGL_ALWAYS_SOFTWARE
-
if set to `true`, always use software rendering
+
if set to true, always use software rendering
LIBGL_NO_DRAWARRAYS
-
if set to `true`, do not use DrawArrays GLX protocol (for debugging)
+
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.
+
print framerate to stdout based on the number of + glXSwapBuffers calls per second.
LIBGL_DRI3_DISABLE
-
disable DRI3 if set to `true`.
+
disable DRI3 if set to true.

Core Mesa environment variables

@@ -56,16 +59,18 @@ sometimes be useful for debugging end-user issues.
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. +
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. 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: + 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. 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.
@@ -76,8 +81,9 @@ sometimes be useful for debugging end-user issues.
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).
+
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
@@ -89,33 +95,34 @@ sometimes be useful for debugging end-user issues.
MESA_TNL_PROG
if set, implement conventional vertex transformation operations with vertex programs (intended for developers only). Setting this variable - automatically sets the MESA_TEX_PROG variable as well.
+ automatically sets the MESA_TEX_PROG variable as well.
MESA_EXTENSION_OVERRIDE
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 - the GL_EXT_bar extension.
+ GL_EXT_foo -GL_EXT_bar will enable the + GL_EXT_foo extension and disable the + GL_EXT_bar extension.
MESA_EXTENSION_MAX_YEAR
-
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 - year X will be reported. This is to work-around a bug in some games where - the extension string is copied into a fixed-size buffer without - truncating. If the extension string is too long, the buffer overrun can - cause the game to crash. This is a work-around for that. -
+
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 year X will be reported. This is to work-around a + bug in some games where the extension string is copied into a fixed-size + buffer without truncating. If the extension string is too long, the + buffer overrun can cause the game to crash. 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. +glGetString(GL_VERSION) and possibly the GL API type.
    -
  • 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. +
  • 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. + have the ARB_compatibility extension enabled.
  • GL versions >= 3.2 are set to a Core profile
  • Examples:
    @@ -145,36 +152,39 @@ glGetString(GL_VERSION) and possibly the GL API type.
MESA_GLES_VERSION_OVERRIDE
-
changes the value returned by glGetString(GL_VERSION) for OpenGL ES. +
changes the value returned by glGetString(GL_VERSION) + for OpenGL ES.
    -
  • The format should be MAJOR.MINOR -
  • Examples: 2.0, 3.0, 3.1 +
  • The format should be MAJOR.MINOR +
  • Examples: 2.0, 3.0, 3.1
  • Mesa may not really implement all the features of the given version. (for developers only)
MESA_GLSL_VERSION_OVERRIDE
-
changes the value returned by glGetString(GL_SHADING_LANGUAGE_VERSION). +
changes the value returned by + 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
+
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.
+ 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. + 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
@@ -186,11 +196,12 @@ glGetString(GL_VERSION) and possibly the GL API type.
see Experimenting with Shader Replacements
MESA_VK_VERSION_OVERRIDE
changes the Vulkan physical device version - as returned in VkPhysicalDeviceProperties::apiVersion. + as returned in VkPhysicalDeviceProperties::apiVersion.
    -
  • The format should be MAJOR.MINOR[.PATCH]
    • +
  • 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
    • + instance versionas advertised by + vkEnumerateInstanceVersion
  • This can be very useful for debugging but some features may not be implemented correctly. (For developers only)
@@ -210,8 +221,8 @@ See the Xlib software driver page for details.
MESA_CI_VISUAL
specifies the X visual and depth for CI mode
MESA_BACK_BUFFER
-
specifies how to implement the back color buffer, either "pixmap" or - "ximage"
+
specifies how to implement the back color buffer, either + pixmap or ximage
MESA_GAMMA
gamma correction coefficients for red, green, blue channels
MESA_XSYNC
@@ -285,7 +296,7 @@ See the Xlib software driver page for details.
perf
emit messages about performance issues
perfmon
-
emit messages about AMD_performance_monitor
+
emit messages about AMD_performance_monitor
pix
emit messages about pixel operations
prim
@@ -351,7 +362,8 @@ Mesa EGL supports different sets of environment variables. See the
GALLIUM_HUD
draws various information on the screen, like framerate, cpu load, driver statistics, performance counters, etc. - Set GALLIUM_HUD=help and run e.g. glxgears for more info.
+ Set GALLIUM_HUD=help and run e.g. glxgears for more + info.
GALLIUM_HUD_PERIOD
sets the hud update rate in seconds (float). Use zero to update every frame. The default period is 1/2 second.
@@ -361,13 +373,16 @@ Mesa EGL supports different sets of environment variables. See the
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_TOGGLE_SIGNAL to 10 (SIGUSR1). - Use kill -10 <pid> 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".
+
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.
@@ -388,8 +403,9 @@ Mesa EGL supports different sets of environment variables. See the shaders, vertex fetch, etc.
ST_DEBUG
controls debug output from the Mesa/Gallium state tracker. - Setting to "tgsi", for example, will print all the TGSI shaders. - See src/mesa/state_tracker/st_debug.c for other options.
+ 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

@@ -398,15 +414,15 @@ Mesa EGL supports different sets of environment variables. See the
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.
+ 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.
+ 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.
+ program in clLinkProgram. @@ -463,9 +479,10 @@ Mesa EGL supports different sets of environment variables. See the

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.
+
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

-- 2.30.2