docs/egl: add haiku driver
[mesa.git] / src / egl / main / README.txt
1
2
3 Notes about the EGL library:
4
5
6 The EGL code here basically consists of two things:
7
8 1. An EGL API dispatcher. This directly routes all the eglFooBar() API
9 calls into driver-specific functions.
10
11 2. Fallbacks for EGL API functions. A driver _could_ implement all the
12 EGL API calls from scratch. But in many cases, the fallbacks provided
13 in libEGL (such as eglChooseConfig()) will do the job.
14
15
16
17 Bootstrapping:
18
19 When the apps calls eglInitialize() a device driver is selected and loaded
20 (look for _eglAddDrivers() and _eglLoadModule() in egldriver.c).
21
22 The built-in driver's entry point function is then called and given
23 a freshly allocated and initialised _EGLDriver, with default fallback
24 entrypoints set.
25
26 As part of initialization, the dispatch table in _EGLDriver->API must be
27 populated with all the EGL entrypoints. Some functions like
28 driver->Initialize and driver->Terminate _must_ be implemented
29 with driver-specific code (no default/fallback function is possible).
30
31
32 Shortly after, the driver->Initialize() function is executed. Any additional
33 driver initialization that wasn't done in the driver entry point should be
34 done at this point. Typically, this will involve setting up visual configs, etc.
35
36
37
38 Special Functions:
39
40 Certain EGL functions _must_ be implemented by the driver. This includes:
41
42 eglCreateContext
43 eglCreateWindowSurface
44 eglCreatePixmapSurface
45 eglCreatePBufferSurface
46 eglMakeCurrent
47 eglSwapBuffers
48
49 Most of the EGLConfig-related functions can be implemented with the
50 defaults/fallbacks. Same thing for the eglGet/Query functions.
51
52
53
54
55 Teardown:
56
57 When eglTerminate() is called, the driver->Terminate() function is
58 called. The driver should clean up after itself. eglTerminate() will
59 then close/unload the driver (shared library).
60
61
62
63
64 Subclassing:
65
66 The internal libEGL data structures such as _EGLDisplay, _EGLContext,
67 _EGLSurface, etc should be considered base classes from which drivers
68 will derive subclasses.
69