draw: Work around an invalid write.

[mesa.git] / docs / egl.html

diff --git a/docs/egl.html b/docs/egl.html
index ad3b850f2ad2e9be87d6d81f965f525675639df7..b2198e931d078035bd1f075c68150c283a2ddbde 100644 (file)
--- a/docs/egl.html
+++ b/docs/egl.html
@@ -69,14 +69,18 @@ drivers will be installed to <code>${libdir}/egl</code>.</p>
 
 </li>
 
-<li><code>--with-egl-displays</code>
+<li><code>--with-egl-platforms</code>
 
-<p>List the window system(s) to support.  It is by default <code>x11</code>,
-which supports the X Window System.  Its argument is a comma separated string
-like, for example, <code>--with-egl-displays=x11,kms</code>.  Because an EGL
-driver decides which window system to support, this example will enable two
-(sets of) EGL drivers.  One supports the X window system and the other supports
-bare KMS (kernel modesetting).</p>
+<p>List the native platform window system(s) to support.  It is by default
+<code>x11</code>, which supports the X Window System.  Its argument is a comma
+separated string like, for example, <code>--with-egl-platforms=x11,kms</code>.
+Because an EGL driver decides which window system to support, this example will
+enable two (sets of) EGL drivers.  One supports the X window system and the
+other supports bare KMS (kernel modesetting).</p>
+
+<p>The available platforms are <code>x11</code>, <code>kms</code>,
+<code>fbdev</code>, and <code>gdi</code>.  The <code>gdi</code> platform can
+only be built with SCons.</p>
 
 </li>
 
@@ -118,16 +122,10 @@ software rendering automatically.</p>
 
 <h2>Use EGL</h2>
 
-<p>There are demos for the client APIs supported by EGL.  They can be found in
-<code>progs/egl/</code>, You can use them to test your build.  For example,</p>
+<h3>Demos</h3>
 
-<pre>
-  $ cd progs/egl/eglut
-  $ make
-  $ cd ../opengles1
-  $ make
-  $ ./torus_x11
-</pre>
+<p>There are demos for the client APIs supported by EGL.  They can be found in
+mesa/demos repository.</p>
 
 <h3>Environment Variables</h3>
 
@@ -153,14 +151,14 @@ specific driver.  This variable is ignored for setuid/setgid binaries.</p>
 
 </li>
 
-<li><code>EGL_DISPLAY</code>
+<li><code>EGL_PLATFORM</code>
 
 <p>When <code>EGL_DRIVER</code> is not set, the main library loads <em>all</em>
-EGL drivers that support a certain window system.  <code>EGL_DISPLAY</code> can
-be used to specify the window system and the valid values are, for example,
+EGL drivers that support a certain window system.  <code>EGL_PLATFORM</code>
+can be used to specify the window system and the valid values are, for example,
 <code>x11</code> or <code>kms</code>.  When the variable is not set, the main
 library defaults the value to the first window system listed in
-<code>--with-egl-displays</code> at configuration time.
+<code>--with-egl-platforms</code> at configuration time.
 
 </li>
 
@@ -184,27 +182,27 @@ variable to true forces the use of software rendering.</p>
 
 <p>There are two categories of EGL drivers: Gallium and classic.</p>
 
-<p>Gallium EGL drivers supports all rendering APIs specified in EGL 1.4.  The
-support for optional EGL functions and EGL extensions is usually more complete
-than the classic ones.  These drivers depend on the <code>egl</code> state
-tracker to build.  The available drivers are</p>
+<p>Gallium EGL drivers supports all rendering APIs specified in EGL 1.4.  These
+drivers depend on the <code>egl</code> state tracker to build.  The available
+drivers are</p>
 
 <ul>
 <li><code>egl_&lt;dpy&gt;_i915</code></li>
 <li><code>egl_&lt;dpy&gt;_i965</code></li>
-<li><code>egl_&lt;dpy&gt;_radeon</code></li>
 <li><code>egl_&lt;dpy&gt;_nouveau</code></li>
+<li><code>egl_&lt;dpy&gt;_radeon</code></li>
 <li><code>egl_&lt;dpy&gt;_swrast</code></li>
 <li><code>egl_&lt;dpy&gt;_vmwgfx</code></li>
 </ul>
 
-<p><code>&lt;dpy&gt;</code> is given by <code>--with-egl-displays</code> at
-configuration time.  There will be one EGL driver for each combination of the
-displays listed and the hardware drivers enabled.</p>
+<p><code>&lt;dpy&gt;</code> is given by <code>--with-egl-platforms</code> at
+configuration time.  There is usually one EGL driver for each combination of
+the platforms listed and the pipe drivers enabled.  When the platform is pure
+software or pure hardware, non-working combinations will not be built.</p>
 
-<p>Classic EGL drivers, on the other hand, supports only OpenGL as its
-rendering API.  They can be found under <code>src/egl/drivers/</code>.  There
-are 3 of them</p>
+<p>Classic EGL drivers, on the other hand, support only a subset of the
+available rendering APIs.  They can be found under
+<code>src/egl/drivers/</code>.  There are 3 of them</p>
 
 <ul>
 <li><code>egl_glx</code>
@@ -324,7 +322,7 @@ should as well lock the display before using it.
 
 <ul>
 <li>Pass the conformance tests</li>
-<li>Better automatic driver selection: <code>EGL_DISPLAY</code> loads all
+<li>Better automatic driver selection: <code>EGL_PLATFORM</code> loads all
 drivers and might eat too much memory.</li>
 
 </ul>