src/egl/main/egldisplay.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   5  * Copyright 2010-2011 LunarG, Inc.
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26  * DEALINGS IN THE SOFTWARE.
  27  *
  28  **************************************************************************/
  29
  30
  31 #ifndef EGLDISPLAY_INCLUDED
  32 #define EGLDISPLAY_INCLUDED
  33
  34 #include "c99_compat.h"
  35 #include "c11/threads.h"
  36
  37 #include "egltypedefs.h"
  38 #include "egldefines.h"
  39 #include "eglarray.h"
  40
  41
  42 enum _egl_platform_type {
  43    _EGL_PLATFORM_WINDOWS,
  44    _EGL_PLATFORM_X11,
  45    _EGL_PLATFORM_WAYLAND,
  46    _EGL_PLATFORM_DRM,
  47    _EGL_PLATFORM_NULL,
  48    _EGL_PLATFORM_ANDROID,
  49    _EGL_PLATFORM_HAIKU,
  50
  51    _EGL_NUM_PLATFORMS,
  52    _EGL_INVALID_PLATFORM = -1
  53 };
  54 typedef enum _egl_platform_type _EGLPlatformType;
  55
  56
  57 enum _egl_resource_type {
  58    _EGL_RESOURCE_CONTEXT,
  59    _EGL_RESOURCE_SURFACE,
  60    _EGL_RESOURCE_IMAGE,
  61    _EGL_RESOURCE_SYNC,
  62
  63    _EGL_NUM_RESOURCES
  64 };
  65 /* this cannot and need not go into egltypedefs.h */
  66 typedef enum _egl_resource_type _EGLResourceType;
  67
  68
  69 /**
  70  * A resource of a display.
  71  */
  72 struct _egl_resource
  73 {
  74    /* which display the resource belongs to */
  75    _EGLDisplay *Display;
  76    EGLBoolean IsLinked;
  77    EGLint RefCount;
  78
  79    /* used to link resources of the same type */
  80    _EGLResource *Next;
  81 };
  82
  83
  84 /**
  85  * Optional EGL extensions info.
  86  */
  87 struct _egl_extensions
  88 {
  89    EGLBoolean MESA_screen_surface;
  90    EGLBoolean MESA_copy_context;
  91    EGLBoolean MESA_drm_display;
  92    EGLBoolean MESA_drm_image;
  93    EGLBoolean MESA_configless_context;
  94
  95    EGLBoolean WL_bind_wayland_display;
  96    EGLBoolean WL_create_wayland_buffer_from_image;
  97
  98    EGLBoolean KHR_image_base;
  99    EGLBoolean KHR_image_pixmap;
 100    EGLBoolean KHR_vg_parent_image;
 101    EGLBoolean KHR_get_all_proc_addresses;
 102    EGLBoolean KHR_gl_texture_2D_image;
 103    EGLBoolean KHR_gl_texture_cubemap_image;
 104    EGLBoolean KHR_gl_texture_3D_image;
 105    EGLBoolean KHR_gl_renderbuffer_image;
 106
 107    EGLBoolean KHR_reusable_sync;
 108    EGLBoolean KHR_fence_sync;
 109
 110    EGLBoolean KHR_surfaceless_context;
 111    EGLBoolean KHR_create_context;
 112
 113    EGLBoolean NOK_swap_region;
 114    EGLBoolean NOK_texture_from_pixmap;
 115
 116    EGLBoolean ANDROID_image_native_buffer;
 117
 118    EGLBoolean CHROMIUM_sync_control;
 119
 120    EGLBoolean NV_post_sub_buffer;
 121
 122    EGLBoolean EXT_create_context_robustness;
 123    EGLBoolean EXT_buffer_age;
 124    EGLBoolean EXT_swap_buffers_with_damage;
 125    EGLBoolean EXT_image_dma_buf_import;
 126 };
 127
 128
 129 struct _egl_display
 130 {
 131    /* used to link displays */
 132    _EGLDisplay *Next;
 133
 134    mtx_t Mutex;
 135
 136    _EGLPlatformType Platform; /**< The type of the platform display */
 137    void *PlatformDisplay;     /**< A pointer to the platform display */
 138
 139    _EGLDriver *Driver;        /**< Matched driver of the display */
 140    EGLBoolean Initialized;    /**< True if the display is initialized */
 141
 142    /* options that affect how the driver initializes the display */
 143    struct {
 144       EGLBoolean TestOnly;    /**< Driver should not set fields when true */
 145       EGLBoolean UseFallback; /**< Use fallback driver (sw or less features) */
 146    } Options;
 147
 148    /* these fields are set by the driver during init */
 149    void *DriverData;          /**< Driver private data */
 150    EGLint VersionMajor;       /**< EGL major version */
 151    EGLint VersionMinor;       /**< EGL minor version */
 152    EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
 153    _EGLExtensions Extensions; /**< Extensions supported */
 154
 155    /* these fields are derived from above */
 156    char VersionString[100];                        /**< EGL_VERSION */
 157    char ClientAPIsString[100];                     /**< EGL_CLIENT_APIS */
 158    char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
 159
 160    _EGLArray *Screens;
 161    _EGLArray *Configs;
 162
 163    /* lists of resources */
 164    _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
 165 };
 166
 167
 168 extern _EGLPlatformType
 169 _eglGetNativePlatform(void *nativeDisplay);
 170
 171
 172 extern void
 173 _eglFiniDisplay(void);
 174
 175
 176 extern _EGLDisplay *
 177 _eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
 178
 179
 180 extern void
 181 _eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
 182
 183
 184 extern void
 185 _eglCleanupDisplay(_EGLDisplay *disp);
 186
 187
 188 extern EGLBoolean
 189 _eglCheckDisplayHandle(EGLDisplay dpy);
 190
 191
 192 extern EGLBoolean
 193 _eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
 194
 195
 196 /**
 197  * Lookup a handle to find the linked display.
 198  * Return NULL if the handle has no corresponding linked display.
 199  */
 200 static inline _EGLDisplay *
 201 _eglLookupDisplay(EGLDisplay display)
 202 {
 203    _EGLDisplay *dpy = (_EGLDisplay *) display;
 204    if (!_eglCheckDisplayHandle(display))
 205       dpy = NULL;
 206    return dpy;
 207 }
 208
 209
 210 /**
 211  * Return the handle of a linked display, or EGL_NO_DISPLAY.
 212  */
 213 static inline EGLDisplay
 214 _eglGetDisplayHandle(_EGLDisplay *dpy)
 215 {
 216    return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
 217 }
 218
 219
 220 extern void
 221 _eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
 222
 223
 224 extern void
 225 _eglGetResource(_EGLResource *res);
 226
 227
 228 extern EGLBoolean
 229 _eglPutResource(_EGLResource *res);
 230
 231
 232 extern void
 233 _eglLinkResource(_EGLResource *res, _EGLResourceType type);
 234
 235
 236 extern void
 237 _eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
 238
 239
 240 /**
 241  * Return true if the resource is linked.
 242  */
 243 static inline EGLBoolean
 244 _eglIsResourceLinked(_EGLResource *res)
 245 {
 246    return res->IsLinked;
 247 }
 248
 249 #ifdef HAVE_X11_PLATFORM
 250 _EGLDisplay*
 251 _eglGetX11Display(Display *native_display, const EGLint *attrib_list);
 252 #endif
 253
 254 #ifdef HAVE_DRM_PLATFORM
 255 struct gbm_device;
 256
 257 _EGLDisplay*
 258 _eglGetGbmDisplay(struct gbm_device *native_display,
 259                   const EGLint *attrib_list);
 260 #endif
 261
 262 #ifdef HAVE_WAYLAND_PLATFORM
 263 struct wl_display;
 264
 265 _EGLDisplay*
 266 _eglGetWaylandDisplay(struct wl_display *native_display,
 267                       const EGLint *attrib_list);
 268 #endif
 269
 270 #endif /* EGLDISPLAY_INCLUDED */