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

@@ -32,12 +29,14 @@ cards.

the driver for your hardware. For example

-  $ ./configure --enable-gles2 --enable-openvg --enable-gallium-nouveau
+  $ ./configure --enable-gles1 --enable-gles2 \
+                --with-dri-drivers=... \
+                --with-gallium-drivers=...
-

The main library and OpenGL is enabled by default. The first option above -enables OpenGL ES 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.

@@ -45,8 +44,8 @@ enables OpenGL ES 2.x. The second option enables

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

@@ -68,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 @@ -86,16 +91,16 @@ select the right platforms automatically.

  • --enable-gles1 and --enable-gles2 -

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

    +

    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 -

    This option enables OpenGL ES as separate libraries. This is an alternative -approach to enable OpenGL ES. It is only supported by -egl_gallium.

    +

    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.

    • @@ -105,12 +110,6 @@ approach to enable OpenGL ES. It is only supported by -
  • --enable-gallium-egl - -

    Explicitly enable or disable egl_gallium.

    - -
    • -

    Use EGL

    @@ -134,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.

    • @@ -180,8 +190,10 @@ variable to true forces the use of software rendering.

  • egl_dri2

    This driver supports both x11 and drm platforms. -It functions as a DRI2 driver loader. For x11 support, it talks -to the X server directly using (XCB-)DRI2 protocol.

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

    • @@ -191,6 +203,10 @@ to the X server directly using (XCB-)DRI2 protocol.

    hardwares supported by Gallium3D. It is the only driver that supports OpenVG. 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_glx @@ -202,6 +218,20 @@ is not available in GLX or GLX extensions.

    • +

    Packaging

    + +

    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

    The sources of the main library and the classic drivers can be found at @@ -286,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

    - - -