util/hash_table: replace fnv1a hash function with xxhash
[mesa.git] / docs / egl.html
index d946bb0ae38d87b0e78b9e141a0446d0f7f8c0d4..6f4028f756acfdef34ed4bcfb45b5a067a034445 100644 (file)
@@ -2,24 +2,24 @@
 <html lang="en">
 <head>
   <meta http-equiv="content-type" content="text/html; charset=utf-8">
-  <title>Mesa EGL</title>
+  <title>EGL</title>
   <link rel="stylesheet" type="text/css" href="mesa.css">
 </head>
 <body>
 
 <div class="header">
-  <h1>The Mesa 3D Graphics Library</h1>
+  The Mesa 3D Graphics Library
 </div>
 
 <iframe src="contents.html"></iframe>
 <div class="content">
 
-<h1>Mesa EGL</h1>
+<h1>EGL</h1>
 
 <p>The current version of EGL in Mesa implements EGL 1.4.  More information
 about EGL can be found at
-<a href="http://www.khronos.org/egl/">
-http://www.khronos.org/egl/</a>.</p>
+<a href="https://www.khronos.org/egl/">
+https://www.khronos.org/egl/</a>.</p>
 
 <p>The Mesa's implementation of EGL uses a driver architecture.  The main
 library (<code>libEGL</code>) is window system neutral.  It provides the EGL
@@ -33,18 +33,21 @@ directly dispatched to the drivers.</p>
 
 <ol>
 <li>
-<p>Run <code>configure</code> with the desired client APIs and enable
-the driver for your hardware.  For example</p>
+<p>Configure your build with the desired client APIs and enable
+the driver for your hardware.  For example:</p>
 
 <pre>
-  $ ./configure --enable-gles1 --enable-gles2 \
-                --with-dri-drivers=... \
-                --with-gallium-drivers=...
+$ meson configure \
+        -D egl=true \
+        -D gles1=true \
+        -D gles2=true \
+        -D dri-drivers=... \
+        -D gallium-drivers=...
 </pre>
 
 <p>The main library and OpenGL is enabled by default.  The first two options
 above enables <a href="opengles.html">OpenGL ES 1.x and 2.x</a>.  The last two
-options enables the listed classic and and Gallium drivers respectively.</p>
+options enables the listed classic and Gallium drivers respectively.</p>
 
 </li>
 
@@ -61,7 +64,7 @@ or more EGL drivers.</p>
 time</p>
 
 <dl>
-<dt><code>--enable-egl</code></dt>
+<dt><code>-D egl=true</code></dt>
 <dd>
 
 <p>By default, EGL is enabled.  When disabled, the main library and the drivers
@@ -69,36 +72,26 @@ will not be built.</p>
 
 </dd>
 
-<dt><code>--with-egl-driver-dir</code></dt>
-<dd>
-
-<p>The directory EGL drivers should be installed to.  If not specified, EGL
-drivers will be installed to <code>${libdir}/egl</code>.</p>
-
-</dd>
-
-<dt><code>--with-egl-platforms</code></dt>
+<dt><code>-D platforms=...</code></dt>
 <dd>
 
 <p>List the platforms (window systems) to support.  Its argument is a comma
-separated string such as <code>--with-egl-platforms=x11,drm</code>.  It decides
+separated string such as <code>-platforms=x11,drm</code>.  It decides
 the platforms a driver may support.  The first listed platform is also used by
-the main library to decide the native platform: the platform the EGL native
-types such as <code>EGLNativeDisplayType</code> or
-<code>EGLNativeWindowType</code> defined for.</p>
+the main library to decide the native platform.</p>
 
 <p>The available platforms are <code>x11</code>, <code>drm</code>,
-<code>wayland</code>, <code>null</code>, <code>android</code>,
-<code>haiku</code>, and <code>gdi</code>.  The <code>android</code> platform
-can only be built as a system component, part of AOSP, while the
-<code>haiku</code> and <code>gdi</code> platforms can only be built with SCons.
+<code>wayland</code>, <code>surfaceless</code>, <code>android</code>,
+and <code>haiku</code>.
+The <code>android</code> platform can either be built as a system
+component, part of AOSP, using <code>Android.mk</code> files, or
+cross-compiled using appropriate options.
 Unless for special needs, the build system should
 select the right platforms automatically.</p>
 
 </dd>
 
-<dt><code>--enable-gles1</code></dt>
-<dt><code>--enable-gles2</code></dt>
+<dt><code>-D gles1=true</code> and <code>-D gles2=true</code></dt>
 <dd>
 
 <p>These options enable OpenGL ES support in OpenGL.  The result is one big
@@ -106,7 +99,7 @@ internal library that supports multiple APIs.</p>
 
 </dd>
 
-<dt><code>--enable-shared-glapi</code></dt>
+<dt><code>-D shared-glapi=true</code></dt>
 <dd>
 
 <p>By default, <code>libGL</code> has its own copy of <code>libglapi</code>.
@@ -130,44 +123,13 @@ mesa/demos repository.</p>
 runtime</p>
 
 <dl>
-<dt><code>EGL_DRIVERS_PATH</code></dt>
-<dd>
-
-<p>By default, the main library will look for drivers in the directory where
-the drivers are installed to.  This variable specifies a list of
-colon-separated directories where the main library will look for drivers, in
-addition to the default directory.  This variable is ignored for setuid/setgid
-binaries.</p>
-
-<p>This variable is usually set to test an uninstalled build.  For example, one
-may set</p>
-
-<pre>
-  $ export LD_LIBRARY_PATH=$mesa/lib
-  $ export EGL_DRIVERS_PATH=$mesa/lib/egl
-</pre>
-
-<p>to test a build without installation</p>
-
-</dd>
-
-<dt><code>EGL_DRIVER</code></dt>
-<dd>
-
-<p>This variable specifies a full path to or the name of an EGL driver.  It
-forces the specified EGL driver to be loaded.  It comes in handy when one wants
-to test a specific driver.  This variable is ignored for setuid/setgid
-binaries.</p>
-
-</dd>
-
 <dt><code>EGL_PLATFORM</code></dt>
 <dd>
 
 <p>This variable specifies the native platform.  The valid values are the same
-as those for <code>--with-egl-platforms</code>.  When the variable is not set,
+as those for <code>-D platforms=...</code>.  When the variable is not set,
 the main library uses the first platform listed in
-<code>--with-egl-platforms</code> as the native platform.</p>
+<code>-D platforms=...</code> as the native platform.</p>
 
 <p>Extensions like <code>EGL_MESA_drm_display</code> define new functions to
 create displays for non-native platforms.  These extensions are usually used by
@@ -183,14 +145,6 @@ probably required only for some of the demos found in mesa/demo repository.</p>
 values are: <code>debug</code>, <code>info</code>, <code>warning</code>, and
 <code>fatal</code>.</p>
 
-</dd>
-
-<dt><code>EGL_SOFTWARE</code></dt>
-<dd>
-
-<p>For drivers that support both hardware and software rendering, setting this
-variable to true forces the use of software rendering.</p>
-
 </dd>
 </dl>
 
@@ -207,6 +161,7 @@ the X server directly using (XCB-)DRI2 protocol.</p>
 <p>This driver can share DRI drivers with <code>libGL</code>.</p>
 
 </dd>
+</dl>
 
 <h2>Packaging</h2>