summaryrefslogtreecommitdiff
path: root/docs/envvars.html
diff options
context:
space:
mode:
authorMarek Olšák <marek.olsak@amd.com>2018-03-06 18:27:30 -0500
committerAndres Gomez <agomez@igalia.com>2018-04-09 13:47:40 +0300
commit806ab42c0f53064a774f002e311cfbb7ff10a667 (patch)
treeffaf689800de1578acd391b6422c3e45b2b835d2 /docs/envvars.html
parentc6067fcd0747c85dee333b9b5726fc7fec998c1b (diff)
mesa: simplify MESA_GL_VERSION_OVERRIDE behavior of API override
v2: - Provide a correct explanation on the envvars documentation (Ian). - Provide a more correct explanation on the function comments (Andres). v3: - Homogenize documentation and inline comments (Emil). - Correct a typo (Emil). Fixes: 2599b92eb97 ("mesa: allow forcing >=3.1 compatibility contexts with MESA_GL_VERSION_OVERRIDE") Cc: Jordan Justen <jordan.l.justen@intel.com> Cc: Ian Romanick <ian.d.romanick@intel.com> Cc: Eric Engestrom <eric.engestrom@imgtec.com> Cc: Emil Velikov <emil.velikov@collabora.com> Reviewed-by: Emil Velikov <emil.velikov@collabora.com>
Diffstat (limited to 'docs/envvars.html')
-rw-r--r--docs/envvars.html50
1 files changed, 34 insertions, 16 deletions
diff --git a/docs/envvars.html b/docs/envvars.html
index 08c259cc7b9..24bdc5bcb8f 100644
--- a/docs/envvars.html
+++ b/docs/envvars.html
@@ -88,22 +88,40 @@ This is a work-around for that.
<li>MESA_GL_VERSION_OVERRIDE - changes the value returned by
glGetString(GL_VERSION) and possibly the GL API type.
<ul>
-<li> The format should be MAJOR.MINOR[FC]
-<li> FC is an optional suffix that indicates a forward compatible context.
-This is only valid for versions &gt;= 3.0.
-<li> GL versions &lt; 3.0 are set to a compatibility (non-Core) profile
-<li> GL versions = 3.0, see below
-<li> GL versions &gt; 3.0 are set to a Core profile
-<li> Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC
-<ul>
-<li> 2.1 - select a compatibility (non-Core) profile with GL version 2.1
-<li> 3.0 - select a compatibility (non-Core) profile with GL version 3.0
-<li> 3.0FC - select a Core+Forward Compatible profile with GL version 3.0
-<li> 3.1 - select a Core profile with GL version 3.1
-<li> 3.1FC - select a Core+Forward Compatible profile with GL version 3.1
-</ul>
-<li> Mesa may not really implement all the features of the given version.
-(for developers only)
+ <li>The format should be MAJOR.MINOR[FC|COMPAT]
+ <li>FC is an optional suffix that indicates a forward compatible
+ context. This is only valid for versions &gt;= 3.0.
+ <li>COMPAT is an optional suffix that indicates a compatibility
+ context or GL_ARB_compatibility support. This is only valid for
+ versions &gt;= 3.1.
+ <li>GL versions &lt;= 3.0 are set to a compatibility (non-Core)
+ profile
+ <li>GL versions = 3.1, depending on the driver, it may or may not
+ have the ARB_compatibility extension enabled.
+ <li>GL versions &gt;= 3.2 are set to a Core profile
+ <li>Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC, 3.1COMPAT, X.Y, X.YFC,
+ X.YCOMPAT.
+ <ul>
+ <li>2.1 - select a compatibility (non-Core) profile with GL
+ version 2.1.
+ <li>3.0 - select a compatibility (non-Core) profile with GL
+ version 3.0.
+ <li>3.0FC - select a Core+Forward Compatible profile with GL
+ version 3.0.
+ <li>3.1 - select GL version 3.1 with GL_ARB_compatibility enabled
+ per the driver default.
+ <li>3.1FC - select GL version 3.1 with forward compatibility and
+ GL_ARB_compatibility disabled.
+ <li>3.1COMPAT - select GL version 3.1 with GL_ARB_compatibility
+ enabled.
+ <li>X.Y - override GL version to X.Y without changing the profile.
+ <li>X.YFC - select a Core+Forward Compatible profile with GL
+ version X.Y.
+ <li>X.YCOMPAT - select a Compatibility profile with GL version
+ X.Y.
+ </ul>
+ <li>Mesa may not really implement all the features of the given
+ version. (for developers only)
</ul>
<li>MESA_GLES_VERSION_OVERRIDE - changes the value returned by
glGetString(GL_VERSION) for OpenGL ES.