X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fegl.html;h=5b750070ca1ff4e9503240066546a177c1aabf8b;hb=dd898c3e89597f841a55272be1ccc07345500f60;hp=c86e543859267ca0687ab528d321415f2195076f;hpb=ad00a92ee720c275d3852faea4e442a8da876ca2;p=mesa.git diff --git a/docs/egl.html b/docs/egl.html index c86e5438592..5b750070ca1 100644 --- a/docs/egl.html +++ b/docs/egl.html @@ -19,26 +19,24 @@ 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.

Build EGL

  1. -

    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 --enable-openvg --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 second option enables -OpenVG. -

    +

    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.

    2. @@ -46,8 +44,8 @@ the Gallium driver for your hardware. For example

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.

Configure Options

@@ -69,6 +67,12 @@ drivers will be installed to ${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,22 +84,23 @@ types such as EGLNativeDisplayType or

    The available platforms are x11, drm, fbdev, and gdi. The gdi platform can -only be built with SCons.

    +only be built with SCons. Unless for special needs, the build system should +select the right platforms automatically.

    • -
  • --enable-gles-overlay +
  • --enable-gles1 and --enable-gles2 -

    OpenGL is built by default. To build OpenGL ES, this option must be -explicitly given.

    +

    These options enable OpenGL ES support in OpenGL. The result is one big +internal library that supports multiple APIs.

    • -
  • --enable-gles1 and --enable-gles2 +
  • --enable-shared-glapi -

    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.

    +

    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.

    • @@ -128,13 +133,24 @@ 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.

    +

    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.

    +

    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.

    • @@ -143,7 +159,12 @@ specific driver. This variable is ignored for setuid/setgid binaries.

    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.

    @@ -166,12 +187,26 @@ variable to true forces the use of software rendering.

    EGL Drivers

    -
  • egl_dri2 +

    Packaging

    -

    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 (XCB-)DRI2 -protocol.

    +

    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.

    -
    • - +

    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.

    Developers

    @@ -276,17 +316,5 @@ not be called with the sample display at the same time. If a driver has access to an EGLDisplay without going through the EGL APIs, the driver should as well lock the display before using it. -

    TODOs

    - - -