-<html>
-
-<title>Mesa EGL</title>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8">
+ <title>EGL</title>
+ <link rel="stylesheet" type="text/css" href="mesa.css">
+</head>
+<body>
-<head><link rel="stylesheet" type="text/css" href="mesa.css"></head>
+<div class="header">
+ The Mesa 3D Graphics Library
+</div>
-<body>
+<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/" target="_parent">
-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
dynamically loaded by the main library and most of the EGL API calls are
directly dispatched to the drivers.</p>
-<p>The driver in use decides the window system to support. For drivers that
-support hardware rendering, there are usually multiple drivers supporting the
-same window system. Each one of of them supports a certain range of graphics
-cards.</p>
+<p>The driver in use decides the window system to support.</p>
<h2>Build EGL</h2>
<ol>
<li>
-<p>Run <code>configure</code> with the desired state trackers and enable
-the Gallium 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 --with-state-trackers=egl,es,vega --enable-gallium-{swrast,intel}
+$ meson configure \
+ -D egl=true \
+ -D gles1=true \
+ -D gles2=true \
+ -D dri-drivers=... \
+ -D gallium-drivers=...
</pre>
-<p>The main library will be enabled by default. The <code>egl</code> state
-tracker is needed by a number of EGL drivers. EGL drivers will be covered
-later. The <a href="opengles.html">es state tracker</a> provides OpenGL ES 1.x
-and 2.x and the <a href="openvg.html">vega state tracker</a> provides OpenVG
-1.x.</p>
+<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 Gallium drivers respectively.</p>
+
</li>
<li>Build and install Mesa as usual.</li>
</ol>
<p>In the given example, it will build and install <code>libEGL</code>,
-<code>libGLESv1_CM</code>, <code>libGLESv2</code>, <code>libOpenVG</code>, and
-one or more EGL drivers.</p>
+<code>libGL</code>, <code>libGLESv1_CM</code>, <code>libGLESv2</code>, and one
+or more EGL drivers.</p>
<h3>Configure Options</h3>
<p>There are several options that control the build of EGL at configuration
time</p>
-<ul>
-<li><code>--enable-egl</code>
+<dl>
+<dt><code>-D egl=true</code></dt>
+<dd>
<p>By default, EGL is enabled. When disabled, the main library and the drivers
will not be built.</p>
-</li>
-
-<li><code>--with-egl-driver-dir</code>
-
-<p>The directory EGL drivers should be installed to. If not specified, EGL
-drivers will be installed to <code>${libdir}/egl</code>.</p>
-
-</li>
+</dd>
-<li><code>--with-egl-displays</code>
+<dt><code>-D platforms=...</code></dt>
+<dd>
-<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 platforms (window systems) to support. Its argument is a comma
+separated string such as <code>-D 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.</p>
-</li>
+<p>The available platforms are <code>x11</code>, <code>drm</code>,
+<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>
-<li><code>--with-state-trackers</code>
+</dd>
-<p>The argument is a comma separated string. It is usually used to specify the
-rendering APIs, like OpenGL ES or OpenVG, to build. But it should be noted
-that a number of EGL drivers depend on the <code>egl</code> state tracker.
-They will <em>not</em> be built without the <code>egl</code> state tracker.</p>
+<dt><code>-D gles1=true</code> and <code>-D gles2=true</code></dt>
+<dd>
-</li>
+<p>These options enable OpenGL ES support in OpenGL. The result is one big
+internal library that supports multiple APIs.</p>
-<li><code>--enable-gallium-swrast</code>
+</dd>
-<p>This option is not specific to EGL. But if there is no driver for your
-hardware, or you are experiencing problems with the hardware driver, you can
-enable the swrast DRM driver. It is a dummy driver and EGL will fallback to
-software rendering automatically.</p>
+<dt><code>-D shared-glapi=true</code></dt>
+<dd>
-</li>
-</ul>
+<p>By default, <code>libGL</code> has its own copy of <code>libglapi</code>.
+This options makes <code>libGL</code> use the shared <code>libglapi</code>. This
+is required if applications mix OpenGL and OpenGL ES.</p>
-<h3>OpenGL</h3>
+</dd>
-<p>The OpenGL state tracker is not built in the above example. It should be
-noted that the classic <code>libGL</code> is not a state tracker and cannot be
-used with EGL (unless the EGL driver in use is <code>egl_glx</code>). To build
-the OpenGL state tracker, one may append <code>glx</code> to
-<code>--with-state-trackers</code> and manually build
-<code>src/gallium/targets/libgl-xlib/</code>.</p>
+</dl>
<h2>Use EGL</h2>
-<p>The demos for OpenGL ES and OpenVG can be found in <code>progs/es1/</code>,
-<code>progs/es2/</code> and <code>progs/openvg/</code>. You can use them to
-test your build. For example,</p>
+<h3>Demos</h3>
-<pre>
- $ cd progs/es1/xegl
- $ make
- $ ./torus
-</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>
<p>There are several environment variables that control the behavior of EGL at
runtime</p>
-<ul>
-<li><code>EGL_DRIVERS_PATH</code>
+<dl>
+<dt><code>EGL_PLATFORM</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 specifies the native platform. The valid values are the same
+as those for <code>-D platforms=...</code>. When the variable is not set,
+the main library uses the first platform listed in
+<code>-D platforms=...</code> as the native platform.</p>
-</li>
-
-<li><code>EGL_DRIVER</code>
+<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
+applications that support non-native platforms. Setting this variable is
+probably required only for some of the demos found in mesa/demo repository.</p>
-<p>This variable specifies a full path to an EGL driver and 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>
-
-</li>
+</dd>
-<li><code>EGL_DISPLAY</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,
-<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.
-
-</li>
-
-<li><code>EGL_LOG_LEVEL</code>
+<dt><code>EGL_LOG_LEVEL</code></dt>
+<dd>
<p>This changes the log level of the main library and the drivers. The valid
values are: <code>debug</code>, <code>info</code>, <code>warning</code>, and
<code>fatal</code>.</p>
-</li>
-
-<li><code>EGL_SOFTWARE</code>
-
-<p>For drivers that support both hardware and software rendering, setting this
-variable to true forces the use of software rendering.</p>
-
-</li>
-</ul>
+</dd>
+</dl>
<h2>EGL Drivers</h2>
-<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>
-
-<ul>
-<li><code>egl_<dpy>_i915</code></li>
-<li><code>egl_<dpy>_i965</code></li>
-<li><code>egl_<dpy>_radeon</code></li>
-<li><code>egl_<dpy>_nouveau</code></li>
-<li><code>egl_<dpy>_swrast</code></li>
-<li><code>egl_<dpy>_vmwgfx</code></li>
-</ul>
-
-<p><code><dpy></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>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>
-
-<ul>
-<li><code>egl_glx</code>
-
-<p>This driver provides a wrapper to GLX. It uses exclusively GLX to implement
-the EGL API. It supports both direct and indirect rendering when the GLX does.
-It is accelerated when the GLX is. As such, it cannot provide functions that
-is not available in GLX or GLX extensions.</p>
-</li>
-
-<li><code>egl_dri2</code>
+<dl>
+<dt><code>egl_dri2</code></dt>
+<dd>
-<p>This driver supports the X Window System as its window system. It functions
-as a DRI2 driver loader. Unlike <code>egl_glx</code>, it has no dependency on
-<code>libGL</code>. It talks to the X server directly using DRI2 protocol.</p>
+<p>This driver supports both <code>x11</code> and <code>drm</code> platforms.
+It functions as a DRI driver loader. For <code>x11</code> support, it talks to
+the X server directly using (XCB-)DRI2 protocol.</p>
-</li>
-<li><code>egl_dri</code>
+<p>This driver can share DRI drivers with <code>libGL</code>.</p>
-<p>This driver lacks maintenance and does <em>not</em> build. It is similiar
-to <code>egl_dri2</code> in that it functions as a DRI(1) driver loader. But
-unlike <code>egl_dri2</code>, it supports Linux framebuffer devices as its
-window system and supports EGL_MESA_screen_surface extension. As DRI1 drivers
-are phasing out, it might eventually be replaced by <code>egl_dri2</code>.</p>
+</dd>
+</dl>
-</li>
-</ul>
+<h2>Packaging</h2>
-<p>To use the classic drivers, one must manually set <code>EGL_DRIVER</code> at
-runtime.</p>
+<p>The ABI between the main library and its drivers are not stable. Nor is
+there a plan to stabilize it at the moment.</p>
<h2>Developers</h2>
-<p>The sources of the main library and the classic drivers can be found at
-<code>src/egl/</code>. The sources of the <code>egl</code> state tracker can
-be found at <code>src/gallium/state_trackers/egl/</code>.</p>
-
-<p>The suggested way to learn to write a EGL driver is to see how other drivers
-are written. <code>egl_glx</code> should be a good reference. It works in any
-environment that has GLX support, and it is simpler than most drivers.</p>
+<p>The sources of the main library and drivers can be found at
+<code>src/egl/</code>.</p>
<h3>Lifetime of Display Resources</h3>
<p>In EGL, when a display is terminated through <code>eglTerminate</code>, all
display resources should be destroyed. Similarly, when a thread is released
-throught <code>eglReleaseThread</code>, all current display resources should be
-released. Another way to destory or release resources is through functions
+through <code>eglReleaseThread</code>, all current display resources should be
+released. Another way to destroy or release resources is through functions
such as <code>eglDestroySurface</code> or <code>eglMakeCurrent</code>.</p>
<p>When a resource that is current to some thread is destroyed, the resource
to an <code>EGLDisplay</code> without going through the EGL APIs, the driver
should as well lock the display before using it.
-<h3>TODOs</h3>
-
-<ul>
-<li>Pass the conformance tests</li>
-<li>Better automatic driver selection: <code>EGL_DISPLAY</code> loads all
-drivers and might eat too much memory.</li>
-
-</ul>
-
+</div>
</body>
</html>