X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=docs%2Fegl.html;h=fb15086679f5ba6310d063caa32fbe45e9060a68;hb=8d62b2aca99ba67f794dd682ed1ec49dc8826390;hp=47582672944f8ba1ed7a178582afcb177f75d532;hpb=26fe16a99b762d27e8f499c2e02116e9c4b7a6bb;p=mesa.git diff --git a/docs/egl.html b/docs/egl.html index 47582672944..fb15086679f 100644 --- a/docs/egl.html +++ b/docs/egl.html @@ -19,27 +19,23 @@ 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 --with-state-trackers=egl,vega --enable-gallium-intel
+  $ ./configure --enable-gles2 --enable-openvg --enable-gallium-nouveau
    -

    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 option above +enables OpenGL ES 2.x. The second option enables +OpenVG.

    +
  2. Build and install Mesa as usual.
    3. @@ -72,39 +68,35 @@ drivers will be installed to ${libdir}/egl.

  3. --with-egl-platforms

    List the platforms (window systems) to support. Its argument is a comma -seprated string such as --with-egl-platforms=x11,kms. It decides +seprated string such as --with-egl-platforms=x11,drm. 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 EGLNativeDisplayType or EGLNativeWindowType defined for.

    -

    The available platforms are x11, kms, +

    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.

    4. -
  4. --with-state-trackers +
  5. --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.

    6. -
  6. --enable-gles-overlay +
  7. --enable-openvg -

    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.

    +

    OpenVG must be explicitly enabled by this option.

    8. -
  8. --enable-gles1 and --enable-gles2 +
  9. --enable-gallium-egl -

    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.

    +

    Explicitly enable or disable egl_gallium.

    10. @@ -131,17 +123,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

    +
  10. 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.

    11. @@ -150,7 +149,12 @@ alone is not sufficient for 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.

    @@ -173,11 +177,25 @@ variable to true forces the use of software rendering.

    EGL Drivers

    -
  11. 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.

    - -
    12. -
  12. egl_dri +

    Packaging

    -

    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.

    +

    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.

    -
    13. - +

    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 +may either be disabled with --disable-gallium-egl or packaged +separately.

    Developers

    @@ -295,7 +311,6 @@ should as well lock the display before using it.