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