egl: remove final pieces of KHR_vg_parent_image
[mesa.git] / src / egl / main / egldisplay.h
index 70c59ef5e46807bfe762d0c01f8d013d85c8df37..bca9122ce6d21c4ee302ccc211a5082f7896140f 100644 (file)
+/**************************************************************************
+ *
+ * Copyright 2008 VMware, Inc.
+ * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
+ * Copyright 2010-2011 LunarG, Inc.
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ **************************************************************************/
+
+
 #ifndef EGLDISPLAY_INCLUDED
 #define EGLDISPLAY_INCLUDED
 
-#ifdef _EGL_PLATFORM_X
-#include <X11/Xlib.h>
-#endif
+#include "c99_compat.h"
+#include "c11/threads.h"
 
 #include "egltypedefs.h"
-#include "eglhash.h"
+#include "egldefines.h"
+#include "eglarray.h"
 
 
-struct _egl_display 
-{
-   EGLNativeDisplayType NativeDisplay;
-   EGLDisplay Handle;
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-   const char *DriverName;
-   const char *DriverArgs;
-   _EGLDriver *Driver;
+enum _egl_platform_type {
+   _EGL_PLATFORM_X11,
+   _EGL_PLATFORM_WAYLAND,
+   _EGL_PLATFORM_DRM,
+   _EGL_PLATFORM_ANDROID,
+   _EGL_PLATFORM_HAIKU,
+   _EGL_PLATFORM_SURFACELESS,
 
-   EGLint NumScreens;
-   _EGLScreen **Screens;  /* array [NumScreens] */
+   _EGL_NUM_PLATFORMS,
+   _EGL_INVALID_PLATFORM = -1
+};
+typedef enum _egl_platform_type _EGLPlatformType;
 
-   EGLint NumConfigs;
-   _EGLConfig **Configs;  /* array [NumConfigs] of ptr to _EGLConfig */
 
-   /* lists of linked contexts and surface */
-   _EGLContext *ContextList;
-   _EGLSurface *SurfaceList;
+enum _egl_resource_type {
+   _EGL_RESOURCE_CONTEXT,
+   _EGL_RESOURCE_SURFACE,
+   _EGL_RESOURCE_IMAGE,
+   _EGL_RESOURCE_SYNC,
 
-   /* hash table to map surfaces to handles */
-   _EGLHashtable *SurfaceHash;
+   _EGL_NUM_RESOURCES
+};
+/* this cannot and need not go into egltypedefs.h */
+typedef enum _egl_resource_type _EGLResourceType;
 
-#ifdef _EGL_PLATFORM_X
-   Display *Xdpy;
-#endif
+
+/**
+ * A resource of a display.
+ */
+struct _egl_resource
+{
+   /* which display the resource belongs to */
+   _EGLDisplay *Display;
+   EGLBoolean IsLinked;
+   EGLint RefCount;
+
+   /* used to link resources of the same type */
+   _EGLResource *Next;
 };
 
 
-extern _EGLDisplay *
-_eglNewDisplay(NativeDisplayType displayName);
+/**
+ * Optional EGL extensions info.
+ */
+struct _egl_extensions
+{
+   /* Please keep these sorted alphabetically. */
+   EGLBoolean ANDROID_image_native_buffer;
+
+   EGLBoolean CHROMIUM_sync_control;
+
+   EGLBoolean EXT_buffer_age;
+   EGLBoolean EXT_create_context_robustness;
+   EGLBoolean EXT_image_dma_buf_import;
+   EGLBoolean EXT_swap_buffers_with_damage;
+
+   EGLBoolean KHR_cl_event2;
+   EGLBoolean KHR_create_context;
+   EGLBoolean KHR_fence_sync;
+   EGLBoolean KHR_get_all_proc_addresses;
+   EGLBoolean KHR_gl_colorspace;
+   EGLBoolean KHR_gl_renderbuffer_image;
+   EGLBoolean KHR_gl_texture_2D_image;
+   EGLBoolean KHR_gl_texture_3D_image;
+   EGLBoolean KHR_gl_texture_cubemap_image;
+   EGLBoolean KHR_image_base;
+   EGLBoolean KHR_image_pixmap;
+   EGLBoolean KHR_reusable_sync;
+   EGLBoolean KHR_surfaceless_context;
+   EGLBoolean KHR_wait_sync;
+
+   EGLBoolean MESA_configless_context;
+   EGLBoolean MESA_drm_display;
+   EGLBoolean MESA_drm_image;
+   EGLBoolean MESA_image_dma_buf_export;
+
+   EGLBoolean NOK_swap_region;
+   EGLBoolean NOK_texture_from_pixmap;
+
+   EGLBoolean NV_post_sub_buffer;
+
+   EGLBoolean WL_bind_wayland_display;
+   EGLBoolean WL_create_wayland_buffer_from_image;
+};
 
 
-extern EGLDisplay
-_eglLinkDisplay(_EGLDisplay *dpy);
+struct _egl_display
+{
+   /* used to link displays */
+   _EGLDisplay *Next;
 
+   mtx_t Mutex;
 
-extern void
-_eglUnlinkDisplay(_EGLDisplay *dpy);
+   _EGLPlatformType Platform; /**< The type of the platform display */
+   void *PlatformDisplay;     /**< A pointer to the platform display */
 
+   _EGLDriver *Driver;        /**< Matched driver of the display */
+   EGLBoolean Initialized;    /**< True if the display is initialized */
 
-extern EGLDisplay
-_eglGetDisplayHandle(_EGLDisplay *display);
+   /* options that affect how the driver initializes the display */
+   struct {
+      EGLBoolean TestOnly;    /**< Driver should not set fields when true */
+      EGLBoolean UseFallback; /**< Use fallback driver (sw or less features) */
+   } Options;
 
+   /* these fields are set by the driver during init */
+   void *DriverData;          /**< Driver private data */
+   EGLint Version;            /**< EGL version major*10+minor */
+   EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
+   _EGLExtensions Extensions; /**< Extensions supported */
 
-extern _EGLDisplay *
-_eglLookupDisplay(EGLDisplay dpy);
+   /* these fields are derived from above */
+   char VersionString[100];                        /**< EGL_VERSION */
+   char ClientAPIsString[100];                     /**< EGL_CLIENT_APIS */
+   char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
 
+   _EGLArray *Screens;
+   _EGLArray *Configs;
 
-/**
- * Return true if the display is linked.
- */
-static INLINE EGLBoolean
-_eglIsDisplayLinked(_EGLDisplay *dpy)
-{
-   return (EGLBoolean) (_eglGetDisplayHandle(dpy) != EGL_NO_DISPLAY);
-}
+   /* lists of resources */
+   _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
+};
 
 
-extern _EGLDisplay *
-_eglFindDisplay(NativeDisplayType nativeDisplay);
+extern _EGLPlatformType
+_eglGetNativePlatform(void *nativeDisplay);
 
 
 extern void
-_eglReleaseDisplayResources(_EGLDriver *drv, EGLDisplay dpy);
+_eglFiniDisplay(void);
 
 
-extern void
-_eglCleanupDisplay(_EGLDisplay *disp);
+extern _EGLDisplay *
+_eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
 
 
-extern EGLContext
-_eglLinkContext(_EGLContext *ctx, _EGLDisplay *dpy);
+extern void
+_eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
 
 
 extern void
-_eglUnlinkContext(_EGLContext *ctx);
+_eglCleanupDisplay(_EGLDisplay *disp);
 
 
-extern EGLContext
-_eglGetContextHandle(_EGLContext *ctx);
+extern EGLBoolean
+_eglCheckDisplayHandle(EGLDisplay dpy);
 
 
-extern _EGLContext *
-_eglLookupContext(EGLContext ctx);
+extern EGLBoolean
+_eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
 
 
 /**
- * Return true if the context is linked to a display.
+ * Lookup a handle to find the linked display.
+ * Return NULL if the handle has no corresponding linked display.
  */
-static INLINE EGLBoolean
-_eglIsContextLinked(_EGLContext *ctx)
+static inline _EGLDisplay *
+_eglLookupDisplay(EGLDisplay display)
 {
-   return (EGLBoolean) (_eglGetContextHandle(ctx) != EGL_NO_CONTEXT);
+   _EGLDisplay *dpy = (_EGLDisplay *) display;
+   if (!_eglCheckDisplayHandle(display))
+      dpy = NULL;
+   return dpy;
 }
 
-extern EGLSurface
-_eglLinkSurface(_EGLSurface *surf, _EGLDisplay *dpy);
+
+/**
+ * Return the handle of a linked display, or EGL_NO_DISPLAY.
+ */
+static inline EGLDisplay
+_eglGetDisplayHandle(_EGLDisplay *dpy)
+{
+   return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
+}
 
 
 extern void
-_eglUnlinkSurface(_EGLSurface *surf);
+_eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
 
 
-extern EGLSurface
-_eglGetSurfaceHandle(_EGLSurface *);
+extern void
+_eglGetResource(_EGLResource *res);
 
 
-extern _EGLSurface *
-_eglLookupSurface(EGLSurface surf);
+extern EGLBoolean
+_eglPutResource(_EGLResource *res);
 
 
-/**
- * Return true if the surface is linked to a display.
- */
-static INLINE EGLBoolean
-_eglIsSurfaceLinked(_EGLSurface *surf)
-{
-   return (EGLBoolean) (_eglGetSurfaceHandle(surf) != EGL_NO_SURFACE);
-}
+extern void
+_eglLinkResource(_EGLResource *res, _EGLResourceType type);
 
 
-/**
- * Cast an unsigned int to a pointer.
- */
-static INLINE void *
-_eglUIntToPointer(unsigned int v)
-{
-   return (void *) ((uintptr_t) v);
-}
+extern void
+_eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
 
 
 /**
- * Cast a pointer to an unsigned int.  The pointer must be one that is
- * returned by _eglUIntToPointer.
+ * Return true if the resource is linked.
  */
-static INLINE unsigned int
-_eglPointerToUInt(const void *p)
+static inline EGLBoolean
+_eglIsResourceLinked(_EGLResource *res)
 {
-   return (unsigned int) ((uintptr_t) p);
+   return res->IsLinked;
 }
 
+#ifdef HAVE_X11_PLATFORM
+_EGLDisplay*
+_eglGetX11Display(Display *native_display, const EGLint *attrib_list);
+#endif
+
+#ifdef HAVE_DRM_PLATFORM
+struct gbm_device;
+
+_EGLDisplay*
+_eglGetGbmDisplay(struct gbm_device *native_display,
+                  const EGLint *attrib_list);
+#endif
+
+#ifdef HAVE_WAYLAND_PLATFORM
+struct wl_display;
+
+_EGLDisplay*
+_eglGetWaylandDisplay(struct wl_display *native_display,
+                      const EGLint *attrib_list);
+#endif
+
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* EGLDISPLAY_INCLUDED */