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_FBDEV,
  48    _EGL_PLATFORM_NULL,
  49    _EGL_PLATFORM_ANDROID,
  50    _EGL_PLATFORM_HAIKU,
  51
  52    _EGL_NUM_PLATFORMS,
  53    _EGL_INVALID_PLATFORM = -1
  54 };
  55 typedef enum _egl_platform_type _EGLPlatformType;
  56
  57
  58 enum _egl_resource_type {
  59    _EGL_RESOURCE_CONTEXT,
  60    _EGL_RESOURCE_SURFACE,
  61    _EGL_RESOURCE_IMAGE,
  62    _EGL_RESOURCE_SYNC,
  63
  64    _EGL_NUM_RESOURCES
  65 };
  66 /* this cannot and need not go into egltypedefs.h */
  67 typedef enum _egl_resource_type _EGLResourceType;
  68
  69
  70 /**
  71  * A resource of a display.
  72  */
  73 struct _egl_resource
  74 {
  75    /* which display the resource belongs to */
  76    _EGLDisplay *Display;
  77    EGLBoolean IsLinked;
  78    EGLint RefCount;
  79
  80    /* used to link resources of the same type */
  81    _EGLResource *Next;
  82 };
  83
  84
  85 /**
  86  * Optional EGL extensions info.
  87  */
  88 struct _egl_extensions
  89 {
  90    EGLBoolean MESA_screen_surface;
  91    EGLBoolean MESA_copy_context;
  92    EGLBoolean MESA_drm_display;
  93    EGLBoolean MESA_drm_image;
  94    EGLBoolean MESA_configless_context;
  95
  96    EGLBoolean WL_bind_wayland_display;
  97    EGLBoolean WL_create_wayland_buffer_from_image;
  98
  99    EGLBoolean KHR_image_base;
 100    EGLBoolean KHR_image_pixmap;
 101    EGLBoolean KHR_vg_parent_image;
 102    EGLBoolean KHR_get_all_proc_addresses;
 103    EGLBoolean KHR_gl_texture_2D_image;
 104    EGLBoolean KHR_gl_texture_cubemap_image;
 105    EGLBoolean KHR_gl_texture_3D_image;
 106    EGLBoolean KHR_gl_renderbuffer_image;
 107
 108    EGLBoolean KHR_reusable_sync;
 109    EGLBoolean KHR_fence_sync;
 110
 111    EGLBoolean KHR_surfaceless_context;
 112    EGLBoolean KHR_create_context;
 113
 114    EGLBoolean NOK_swap_region;
 115    EGLBoolean NOK_texture_from_pixmap;
 116
 117    EGLBoolean ANDROID_image_native_buffer;
 118
 119    EGLBoolean CHROMIUM_sync_control;
 120
 121    EGLBoolean NV_post_sub_buffer;
 122
 123    EGLBoolean EXT_create_context_robustness;
 124    EGLBoolean EXT_buffer_age;
 125    EGLBoolean EXT_swap_buffers_with_damage;
 126    EGLBoolean EXT_image_dma_buf_import;
 127 };
 128
 129
 130 struct _egl_display
 131 {
 132    /* used to link displays */
 133    _EGLDisplay *Next;
 134
 135    mtx_t Mutex;
 136
 137    _EGLPlatformType Platform; /**< The type of the platform display */
 138    void *PlatformDisplay;     /**< A pointer to the platform display */
 139
 140    _EGLDriver *Driver;        /**< Matched driver of the display */
 141    EGLBoolean Initialized;    /**< True if the display is initialized */
 142
 143    /* options that affect how the driver initializes the display */
 144    struct {
 145       EGLBoolean TestOnly;    /**< Driver should not set fields when true */
 146       EGLBoolean UseFallback; /**< Use fallback driver (sw or less features) */
 147    } Options;
 148
 149    /* these fields are set by the driver during init */
 150    void *DriverData;          /**< Driver private data */
 151    EGLint VersionMajor;       /**< EGL major version */
 152    EGLint VersionMinor;       /**< EGL minor version */
 153    EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
 154    _EGLExtensions Extensions; /**< Extensions supported */
 155
 156    /* these fields are derived from above */
 157    char VersionString[1000];                       /**< EGL_VERSION */
 158    char ClientAPIsString[1000];                    /**< EGL_CLIENT_APIS */
 159    char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
 160
 161    _EGLArray *Screens;
 162    _EGLArray *Configs;
 163
 164    /* lists of resources */
 165    _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
 166 };
 167
 168
 169 extern _EGLPlatformType
 170 _eglGetNativePlatform(void *nativeDisplay);
 171
 172
 173 extern void
 174 _eglFiniDisplay(void);
 175
 176
 177 extern _EGLDisplay *
 178 _eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
 179
 180
 181 extern void
 182 _eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
 183
 184
 185 extern void
 186 _eglCleanupDisplay(_EGLDisplay *disp);
 187
 188
 189 extern EGLBoolean
 190 _eglCheckDisplayHandle(EGLDisplay dpy);
 191
 192
 193 extern EGLBoolean
 194 _eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
 195
 196
 197 /**
 198  * Lookup a handle to find the linked display.
 199  * Return NULL if the handle has no corresponding linked display.
 200  */
 201 static inline _EGLDisplay *
 202 _eglLookupDisplay(EGLDisplay display)
 203 {
 204    _EGLDisplay *dpy = (_EGLDisplay *) display;
 205    if (!_eglCheckDisplayHandle(display))
 206       dpy = NULL;
 207    return dpy;
 208 }
 209
 210
 211 /**
 212  * Return the handle of a linked display, or EGL_NO_DISPLAY.
 213  */
 214 static inline EGLDisplay
 215 _eglGetDisplayHandle(_EGLDisplay *dpy)
 216 {
 217    return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
 218 }
 219
 220
 221 extern void
 222 _eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
 223
 224
 225 extern void
 226 _eglGetResource(_EGLResource *res);
 227
 228
 229 extern EGLBoolean
 230 _eglPutResource(_EGLResource *res);
 231
 232
 233 extern void
 234 _eglLinkResource(_EGLResource *res, _EGLResourceType type);
 235
 236
 237 extern void
 238 _eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
 239
 240
 241 /**
 242  * Return true if the resource is linked.
 243  */
 244 static inline EGLBoolean
 245 _eglIsResourceLinked(_EGLResource *res)
 246 {
 247    return res->IsLinked;
 248 }
 249
 250 #ifdef HAVE_X11_PLATFORM
 251 _EGLDisplay*
 252 _eglGetX11Display(Display *native_display, const EGLint *attrib_list);
 253 #endif
 254
 255 #ifdef HAVE_DRM_PLATFORM
 256 struct gbm_device;
 257
 258 _EGLDisplay*
 259 _eglGetGbmDisplay(struct gbm_device *native_display,
 260                   const EGLint *attrib_list);
 261 #endif
 262
 263 #ifdef HAVE_WAYLAND_PLATFORM
 264 struct wl_display;
 265
 266 _EGLDisplay*
 267 _eglGetWaylandDisplay(struct wl_display *native_display,
 268                       const EGLint *attrib_list);
 269 #endif
 270
 271 #endif /* EGLDISPLAY_INCLUDED */