src/egl/main/egldisplay.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   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
  35 #include "egltypedefs.h"
  36 #include "egldefines.h"
  37 #include "eglmutex.h"
  38 #include "eglarray.h"
  39
  40
  41 enum _egl_platform_type {
  42    _EGL_PLATFORM_WINDOWS,
  43    _EGL_PLATFORM_X11,
  44    _EGL_PLATFORM_WAYLAND,
  45    _EGL_PLATFORM_DRM,
  46    _EGL_PLATFORM_FBDEV,
  47
  48    _EGL_NUM_PLATFORMS,
  49    _EGL_INVALID_PLATFORM = -1
  50 };
  51 typedef enum _egl_platform_type _EGLPlatformType;
  52
  53
  54 enum _egl_resource_type {
  55    _EGL_RESOURCE_CONTEXT,
  56    _EGL_RESOURCE_SURFACE,
  57    _EGL_RESOURCE_IMAGE,
  58    _EGL_RESOURCE_SYNC,
  59
  60    _EGL_NUM_RESOURCES
  61 };
  62 /* this cannot and need not go into egltypedefs.h */
  63 typedef enum _egl_resource_type _EGLResourceType;
  64
  65
  66 /**
  67  * A resource of a display.
  68  */
  69 struct _egl_resource
  70 {
  71    /* which display the resource belongs to */
  72    _EGLDisplay *Display;
  73    EGLBoolean IsLinked;
  74    EGLint RefCount;
  75
  76    /* used to link resources of the same type */
  77    _EGLResource *Next;
  78 };
  79
  80
  81 /**
  82  * Optional EGL extensions info.
  83  */
  84 struct _egl_extensions
  85 {
  86    EGLBoolean MESA_screen_surface;
  87    EGLBoolean MESA_copy_context;
  88    EGLBoolean MESA_drm_display;
  89    EGLBoolean MESA_drm_image;
  90
  91    EGLBoolean WL_bind_wayland_display;
  92
  93    EGLBoolean KHR_image_base;
  94    EGLBoolean KHR_image_pixmap;
  95    EGLBoolean KHR_vg_parent_image;
  96    EGLBoolean KHR_gl_texture_2D_image;
  97    EGLBoolean KHR_gl_texture_cubemap_image;
  98    EGLBoolean KHR_gl_texture_3D_image;
  99    EGLBoolean KHR_gl_renderbuffer_image;
 100
 101    EGLBoolean KHR_reusable_sync;
 102    EGLBoolean KHR_fence_sync;
 103
 104    EGLBoolean KHR_surfaceless_gles1;
 105    EGLBoolean KHR_surfaceless_gles2;
 106    EGLBoolean KHR_surfaceless_opengl;
 107
 108    EGLBoolean NOK_swap_region;
 109    EGLBoolean NOK_texture_from_pixmap;
 110 };
 111
 112
 113 struct _egl_display
 114 {
 115    /* used to link displays */
 116    _EGLDisplay *Next;
 117
 118    _EGLMutex Mutex;
 119
 120    _EGLPlatformType Platform; /**< The type of the platform display */
 121    void *PlatformDisplay;     /**< A pointer to the platform display */
 122
 123    _EGLDriver *Driver;        /**< Matched driver of the display */
 124    EGLBoolean Initialized;    /**< True if the display is initialized */
 125
 126    /* options that affect how the driver initializes the display */
 127    struct {
 128       EGLBoolean TestOnly;    /**< Driver should not set fields when true */
 129       EGLBoolean UseFallback; /**< Use fallback driver (sw or less features) */
 130    } Options;
 131
 132    /* these fields are set by the driver during init */
 133    void *DriverData;          /**< Driver private data */
 134    EGLint VersionMajor;       /**< EGL major version */
 135    EGLint VersionMinor;       /**< EGL minor version */
 136    EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
 137    _EGLExtensions Extensions; /**< Extensions supported */
 138
 139    /* these fields are derived from above */
 140    char VersionString[1000];                       /**< EGL_VERSION */
 141    char ClientAPIsString[1000];                    /**< EGL_CLIENT_APIS */
 142    char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
 143
 144    _EGLArray *Screens;
 145    _EGLArray *Configs;
 146
 147    /* lists of resources */
 148    _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
 149 };
 150
 151
 152 extern _EGLPlatformType
 153 _eglGetNativePlatform(void);
 154
 155
 156 extern void
 157 _eglFiniDisplay(void);
 158
 159
 160 extern _EGLDisplay *
 161 _eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
 162
 163
 164 PUBLIC void
 165 _eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
 166
 167
 168 PUBLIC void
 169 _eglCleanupDisplay(_EGLDisplay *disp);
 170
 171
 172 extern EGLBoolean
 173 _eglCheckDisplayHandle(EGLDisplay dpy);
 174
 175
 176 PUBLIC EGLBoolean
 177 _eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
 178
 179
 180 /**
 181  * Lookup a handle to find the linked display.
 182  * Return NULL if the handle has no corresponding linked display.
 183  */
 184 static INLINE _EGLDisplay *
 185 _eglLookupDisplay(EGLDisplay display)
 186 {
 187    _EGLDisplay *dpy = (_EGLDisplay *) display;
 188    if (!_eglCheckDisplayHandle(display))
 189       dpy = NULL;
 190    return dpy;
 191 }
 192
 193
 194 /**
 195  * Return the handle of a linked display, or EGL_NO_DISPLAY.
 196  */
 197 static INLINE EGLDisplay
 198 _eglGetDisplayHandle(_EGLDisplay *dpy)
 199 {
 200    return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
 201 }
 202
 203
 204 extern void
 205 _eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
 206
 207
 208 PUBLIC void
 209 _eglGetResource(_EGLResource *res);
 210
 211
 212 PUBLIC EGLBoolean
 213 _eglPutResource(_EGLResource *res);
 214
 215
 216 extern void
 217 _eglLinkResource(_EGLResource *res, _EGLResourceType type);
 218
 219
 220 extern void
 221 _eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
 222
 223
 224 /**
 225  * Return true if the resource is linked.
 226  */
 227 static INLINE EGLBoolean
 228 _eglIsResourceLinked(_EGLResource *res)
 229 {
 230    return res->IsLinked;
 231 }
 232
 233
 234 #endif /* EGLDISPLAY_INCLUDED */