Home | History | Annotate | Download | only in main
      1 /**************************************************************************
      2  *
      3  * Copyright 2008 VMware, Inc.
      4  * Copyright 2009-2010 Chia-I Wu <olvaffe (at) 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_swap_buffers_with_damage;
    106 
    107    EGLBoolean KHR_cl_event2;
    108    EGLBoolean KHR_config_attribs;
    109    EGLBoolean KHR_create_context;
    110    EGLBoolean KHR_fence_sync;
    111    EGLBoolean KHR_get_all_proc_addresses;
    112    EGLBoolean KHR_gl_colorspace;
    113    EGLBoolean KHR_gl_renderbuffer_image;
    114    EGLBoolean KHR_gl_texture_2D_image;
    115    EGLBoolean KHR_gl_texture_3D_image;
    116    EGLBoolean KHR_gl_texture_cubemap_image;
    117    EGLBoolean KHR_image_base;
    118    EGLBoolean KHR_image_pixmap;
    119    EGLBoolean KHR_no_config_context;
    120    EGLBoolean KHR_reusable_sync;
    121    EGLBoolean KHR_surfaceless_context;
    122    EGLBoolean KHR_wait_sync;
    123 
    124    EGLBoolean MESA_drm_image;
    125    EGLBoolean MESA_image_dma_buf_export;
    126 
    127    EGLBoolean NOK_swap_region;
    128    EGLBoolean NOK_texture_from_pixmap;
    129 
    130    EGLBoolean NV_post_sub_buffer;
    131 
    132    EGLBoolean WL_bind_wayland_display;
    133    EGLBoolean WL_create_wayland_buffer_from_image;
    134 };
    135 
    136 
    137 struct _egl_display
    138 {
    139    /* used to link displays */
    140    _EGLDisplay *Next;
    141 
    142    mtx_t Mutex;
    143 
    144    _EGLPlatformType Platform; /**< The type of the platform display */
    145    void *PlatformDisplay;     /**< A pointer to the platform display */
    146 
    147    _EGLDriver *Driver;        /**< Matched driver of the display */
    148    EGLBoolean Initialized;    /**< True if the display is initialized */
    149 
    150    /* options that affect how the driver initializes the display */
    151    struct {
    152       EGLBoolean TestOnly;    /**< Driver should not set fields when true */
    153       EGLBoolean UseFallback; /**< Use fallback driver (sw or less features) */
    154    } Options;
    155 
    156    /* these fields are set by the driver during init */
    157    void *DriverData;          /**< Driver private data */
    158    EGLint Version;            /**< EGL version major*10+minor */
    159    EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
    160    _EGLExtensions Extensions; /**< Extensions supported */
    161 
    162    /* these fields are derived from above */
    163    char VersionString[100];                        /**< EGL_VERSION */
    164    char ClientAPIsString[100];                     /**< EGL_CLIENT_APIS */
    165    char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
    166 
    167    _EGLArray *Screens;
    168    _EGLArray *Configs;
    169 
    170    /* lists of resources */
    171    _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
    172 
    173    EGLLabelKHR Label;
    174 };
    175 
    176 
    177 extern _EGLPlatformType
    178 _eglGetNativePlatform(void *nativeDisplay);
    179 
    180 
    181 extern void
    182 _eglFiniDisplay(void);
    183 
    184 
    185 extern _EGLDisplay *
    186 _eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
    187 
    188 
    189 extern void
    190 _eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
    191 
    192 
    193 extern void
    194 _eglCleanupDisplay(_EGLDisplay *disp);
    195 
    196 
    197 extern EGLBoolean
    198 _eglCheckDisplayHandle(EGLDisplay dpy);
    199 
    200 
    201 extern EGLBoolean
    202 _eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
    203 
    204 
    205 /**
    206  * Lookup a handle to find the linked display.
    207  * Return NULL if the handle has no corresponding linked display.
    208  */
    209 static inline _EGLDisplay *
    210 _eglLookupDisplay(EGLDisplay display)
    211 {
    212    _EGLDisplay *dpy = (_EGLDisplay *) display;
    213    if (!_eglCheckDisplayHandle(display))
    214       dpy = NULL;
    215    return dpy;
    216 }
    217 
    218 
    219 /**
    220  * Return the handle of a linked display, or EGL_NO_DISPLAY.
    221  */
    222 static inline EGLDisplay
    223 _eglGetDisplayHandle(_EGLDisplay *dpy)
    224 {
    225    return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
    226 }
    227 
    228 
    229 extern void
    230 _eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
    231 
    232 
    233 extern void
    234 _eglGetResource(_EGLResource *res);
    235 
    236 
    237 extern EGLBoolean
    238 _eglPutResource(_EGLResource *res);
    239 
    240 
    241 extern void
    242 _eglLinkResource(_EGLResource *res, _EGLResourceType type);
    243 
    244 
    245 extern void
    246 _eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
    247 
    248 
    249 /**
    250  * Return true if the resource is linked.
    251  */
    252 static inline EGLBoolean
    253 _eglIsResourceLinked(_EGLResource *res)
    254 {
    255    return res->IsLinked;
    256 }
    257 
    258 #ifdef HAVE_X11_PLATFORM
    259 _EGLDisplay*
    260 _eglGetX11Display(Display *native_display, const EGLint *attrib_list);
    261 #endif
    262 
    263 #ifdef HAVE_DRM_PLATFORM
    264 struct gbm_device;
    265 
    266 _EGLDisplay*
    267 _eglGetGbmDisplay(struct gbm_device *native_display,
    268                   const EGLint *attrib_list);
    269 #endif
    270 
    271 #ifdef HAVE_WAYLAND_PLATFORM
    272 struct wl_display;
    273 
    274 _EGLDisplay*
    275 _eglGetWaylandDisplay(struct wl_display *native_display,
    276                       const EGLint *attrib_list);
    277 #endif
    278 
    279 #ifdef HAVE_SURFACELESS_PLATFORM
    280 _EGLDisplay*
    281 _eglGetSurfacelessDisplay(void *native_display,
    282                           const EGLint *attrib_list);
    283 #endif
    284 
    285 #ifdef __cplusplus
    286 }
    287 #endif
    288 
    289 #endif /* EGLDISPLAY_INCLUDED */
    290