egl: Clean up eglconfig.h.
authorChia-I Wu <olvaffe@gmail.com>
Fri, 5 Feb 2010 05:33:55 +0000 (13:33 +0800)
committerChia-I Wu <olvaffe@gmail.com>
Fri, 5 Feb 2010 05:42:02 +0000 (13:42 +0800)
Update the comments to macros/functions.  Remove unused
_eglSetConfigAttrib.

src/egl/main/eglconfig.h

index 09dc61f547361980c6e32a6c00ecf406d9459155..56ec95fe9adb83eafe937996834f012ea96cdb58 100644 (file)
@@ -21,6 +21,9 @@ struct _egl_config
 };
 
 
+/**
+ * Macros for source level compatibility.
+ */
 #define SET_CONFIG_ATTRIB(CONF, ATTR, VAL) _eglSetConfigKey(CONF, ATTR, VAL)
 #define GET_CONFIG_ATTRIB(CONF, ATTR) _eglGetConfigKey(CONF, ATTR)
 
@@ -55,6 +58,10 @@ _eglResetConfigKeys(_EGLConfig *conf, EGLint val)
 
 /**
  * Update a config for a given key.
+ *
+ * Note that a valid key is not necessarily a valid attribute.  There are gaps
+ * in the attribute enums.  The separation is to catch application errors.
+ * Drivers should never set a key that is an invalid attribute.
  */
 static INLINE void
 _eglSetConfigKey(_EGLConfig *conf, EGLint key, EGLint val)
@@ -77,20 +84,6 @@ _eglGetConfigKey(const _EGLConfig *conf, EGLint key)
 }
 
 
-/**
- * Set a given attribute.
- *
- * Because _eglGetConfigAttrib is already used as a fallback driver
- * function, this function is not considered to have a good name.
- * SET_CONFIG_ATTRIB is preferred over this function.
- */
-static INLINE void
-_eglSetConfigAttrib(_EGLConfig *conf, EGLint attr, EGLint val)
-{
-   SET_CONFIG_ATTRIB(conf, attr, val);
-}
-
-
 PUBLIC void
 _eglInitConfig(_EGLConfig *config, _EGLDisplay *dpy, EGLint id);