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