From: Chia-I Wu <olvaffe@gmail.com>
Date: Wed, 30 Sep 2009 07:08:34 +0000 (+0800)
Subject: egl: Update comments about eglapi.c.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=aaa1253b09a6a38e7fcd695aa36e89b9d4bd8dfe;p=mesa.git

egl: Update comments about eglapi.c.

Mention that opaque handles are looked up and checked.

Signed-off-by: Chia-I Wu <olvaffe@gmail.com>
---

diff --git a/src/egl/main/eglapi.c b/src/egl/main/eglapi.c
index 1512c0a14ea..1d370db4718 100644
--- a/src/egl/main/eglapi.c
+++ b/src/egl/main/eglapi.c
@@ -9,12 +9,27 @@
  * heterogeneous hardware devices in the future.
  *
  * The EGLDisplay, EGLConfig, EGLContext and EGLSurface types are
- * opaque handles implemented with 32-bit unsigned integers.
- * It's up to the driver function or fallback function to look up the
- * handle and get an object.
- * By using opaque handles, we leave open the possibility of having
- * indirect rendering in the future, like GLX.
+ * opaque handles. Internal objects are linked to a display to
+ * create the handles.
  *
+ * For each public API entry point, the opaque handles are looked up
+ * before being dispatched to the drivers.  When it fails to look up
+ * a handle, one of
+ *
+ * EGL_BAD_DISPLAY
+ * EGL_BAD_CONFIG
+ * EGL_BAD_CONTEXT
+ * EGL_BAD_SURFACE
+ * EGL_BAD_SCREEN_MESA
+ * EGL_BAD_MODE_MESA
+ *
+ * is generated and the driver function is not called. An
+ * uninitialized EGLDisplay has no driver associated with it. When
+ * such display is detected,
+ *
+ * EGL_NOT_INITIALIZED
+ *
+ * is generated.
  *
  * Notes on naming conventions:
  *