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