X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fegl.html;h=5b750070ca1ff4e9503240066546a177c1aabf8b;hb=509ddb0a0414cfc83102c463da542d95d83eabad;hp=d38f2dd7b7d018dc13ef757fef7ae272be916e3c;hpb=e7424d72405a1cb1fb5ac625b340043aaa9f88be;p=mesa.git diff --git a/docs/egl.html b/docs/egl.html index d38f2dd7b7d..5b750070ca1 100644 --- a/docs/egl.html +++ b/docs/egl.html @@ -19,35 +19,33 @@ API entry points and helper functions for use by the drivers. Drivers are dynamically loaded by the main library and most of the EGL API calls are directly dispatched to the drivers.
-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.
+The driver in use decides the window system to support.
Run configure
with the desired state trackers and enable
-the Gallium driver for your hardware. For example
Run configure
with the desired client APIs and enable
+the driver for your hardware. For example
- $ ./configure --enable-gles-overlay --with-state-trackers=egl,vega --enable-gallium-intel + $ ./configure --enable-gles1 --enable-gles2 \ + --with-dri-drivers=... \ + --with-gallium-drivers=...-
The main library and OpenGL is enabled by default. The first option enables
-OpenGL ES 1.x and 2.x. The egl
state
-tracker is needed by a number of EGL drivers. EGL drivers will be covered
-later. The vega state tracker provides OpenVG
-1.x.
The main library and OpenGL is enabled by default. The first two options +above enables OpenGL ES 1.x and 2.x. The last two +options enables the listed classic and and Gallium drivers respectively.
+In the given example, it will build and install libEGL
,
-libGL
, libGLESv1_CM
, libGLESv2
,
-libOpenVG
, and one or more EGL drivers.
libGL
, libGLESv1_CM
, libGLESv2
, and one
+or more EGL drivers.
${libdir}/egl
.
+--enable-gallium-egl
+
+Enable the optional egl_gallium
driver.
--with-egl-platforms
List the platforms (window systems) to support. Its argument is a comma
@@ -80,31 +84,29 @@ types such as EGLNativeDisplayType
or
The available platforms are x11
, drm
,
fbdev
, and gdi
. The gdi
platform can
-only be built with SCons.
--with-state-trackers
+--enable-gles1
and --enable-gles2
-The argument is a comma separated string. It is usually used to specify the
-rendering APIs, such as OpenVG, to build. But it is also used to specify
-egl
state tracker that egl_gallium
depends on.
These options enable OpenGL ES support in OpenGL. The result is one big +internal library that supports multiple APIs.
--enable-gles-overlay
+--enable-shared-glapi
-OpenGL and OpenGL ES are not controlled by
---with-state-trackers
. OpenGL is always built. To build OpenGL
-ES, this option must be explicitly given.
By default, libGL
has its own copy of libglapi
.
+This options makes libGL
use the shared libglapi
. This
+is required if applications mix OpenGL and OpenGL ES.
--enable-gles1
and --enable-gles2
+--enable-openvg
-Unlike --enable-gles-overlay
, which builds one library for each
-rendering API, these options enable OpenGL ES support in OpenGL. The result is
-one big library that supports multiple APIs.
OpenVG must be explicitly enabled by this option.
This variable is usually set to test an uninstalled build. For example, one +may set
+ ++ $ export LD_LIBRARY_PATH=$mesa/lib + $ export EGL_DRIVERS_PATH=$mesa/lib/egl ++ +
to test a build without installation
+EGL_DRIVER
-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.
- -egl_gallium
dynamically loads hardware drivers and client API
-modules found in EGL_DRIVERS_PATH
. Thus, specifying this variable
-alone is not sufficient for egl_gallium
for uninstalled build.
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.
egl_gallium
for uninstalled build.
This variable specifies the native platform. The valid values are the same
as those for --with-egl-platforms
. When the variable is not set,
the main library uses the first platform listed in
---with-egl-platforms
as the native platform
--with-egl-platforms
as the native platform.
+
+Extensions like EGL_MESA_drm_display
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.
egl_dri2
+
+This driver supports both x11
and drm
platforms.
+It functions as a DRI driver loader. For x11
support, it talks to
+the X server directly using (XCB-)DRI2 protocol.
This driver can share DRI drivers with libGL
.
egl_gallium
This driver is based on Gallium3D. It supports all rendering APIs and hardwares supported by Gallium3D. It is the only driver that supports OpenVG. -The supported platforms are X11, KMS, FBDEV, and GDI.
+The supported platforms are X11, DRM, FBDEV, and GDI. + +This driver comes with its own hardware drivers
+(pipe_<hw>
) and client API modules
+(st_<api>
).
egl_dri2
-
-This driver supports the X Window System as its window system. It functions
-as a DRI2 driver loader. Unlike egl_glx
, it has no dependency on
-libGL
. It talks to the X server directly using DRI2 protocol.
egl_dri
+The ABI between the main library and its drivers are not stable. Nor is
+there a plan to stabilize it at the moment. Of the EGL drivers,
+egl_gallium
has its own hardware drivers and client API modules.
+They are considered internal to egl_gallium
and there is also no
+stable ABI between them. These should be kept in mind when packaging for
+distribution.
This driver lacks maintenance and does not build. It is similiar
-to egl_dri2
in that it functions as a DRI(1) driver loader. But
-unlike egl_dri2
, 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 egl_dri2
.
Generally, egl_dri2
is preferred over egl_gallium
+when the system already has DRI drivers. As egl_gallium
is loaded
+before egl_dri2
when both are available, egl_gallium
+is disabled by default.
EGLDisplay
without going through the EGL APIs, the driver
should as well lock the display before using it.
-libGL.so
, libGLESv1_CM.so
, and
-libGLESv2.so
should an application link to? Bad things may happen
-when, say, an application is linked to libGLESv2.so
and
-libcairo
, which is linked to libGL.so
instead.