1 /**************************************************************************
3 * Copyright 2008 VMware, Inc.
4 * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
5 * Copyright 2010-2011 LunarG, Inc.
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:
16 * The above copyright notice and this permission notice (including the
17 * next paragraph) shall be included in all copies or substantial portions
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.
28 **************************************************************************/
31 #ifndef EGLDISPLAY_INCLUDED
32 #define EGLDISPLAY_INCLUDED
34 #include "c99_compat.h"
35 #include "c11/threads.h"
37 #include "egltypedefs.h"
38 #include "egldefines.h"
46 enum _egl_platform_type
{
48 _EGL_PLATFORM_WAYLAND
,
50 _EGL_PLATFORM_ANDROID
,
52 _EGL_PLATFORM_SURFACELESS
,
55 _EGL_INVALID_PLATFORM
= -1
57 typedef enum _egl_platform_type _EGLPlatformType
;
60 enum _egl_resource_type
{
61 _EGL_RESOURCE_CONTEXT
,
62 _EGL_RESOURCE_SURFACE
,
68 /* this cannot and need not go into egltypedefs.h */
69 typedef enum _egl_resource_type _EGLResourceType
;
73 * A resource of a display.
77 /* which display the resource belongs to */
82 /* used to link resources of the same type */
88 * Optional EGL extensions info.
90 struct _egl_extensions
92 /* Please keep these sorted alphabetically. */
93 EGLBoolean ANDROID_framebuffer_target
;
94 EGLBoolean ANDROID_image_native_buffer
;
95 EGLBoolean ANDROID_recordable
;
97 EGLBoolean CHROMIUM_sync_control
;
99 EGLBoolean EXT_buffer_age
;
100 EGLBoolean EXT_create_context_robustness
;
101 EGLBoolean EXT_image_dma_buf_import
;
102 EGLBoolean EXT_swap_buffers_with_damage
;
104 EGLBoolean KHR_cl_event2
;
105 EGLBoolean KHR_create_context
;
106 EGLBoolean KHR_fence_sync
;
107 EGLBoolean KHR_get_all_proc_addresses
;
108 EGLBoolean KHR_gl_colorspace
;
109 EGLBoolean KHR_gl_renderbuffer_image
;
110 EGLBoolean KHR_gl_texture_2D_image
;
111 EGLBoolean KHR_gl_texture_3D_image
;
112 EGLBoolean KHR_gl_texture_cubemap_image
;
113 EGLBoolean KHR_image_base
;
114 EGLBoolean KHR_image_pixmap
;
115 EGLBoolean KHR_reusable_sync
;
116 EGLBoolean KHR_surfaceless_context
;
117 EGLBoolean KHR_wait_sync
;
119 EGLBoolean MESA_configless_context
;
120 EGLBoolean MESA_drm_image
;
121 EGLBoolean MESA_image_dma_buf_export
;
123 EGLBoolean NOK_swap_region
;
124 EGLBoolean NOK_texture_from_pixmap
;
126 EGLBoolean NV_post_sub_buffer
;
128 EGLBoolean WL_bind_wayland_display
;
129 EGLBoolean WL_create_wayland_buffer_from_image
;
135 /* used to link displays */
140 _EGLPlatformType Platform
; /**< The type of the platform display */
141 void *PlatformDisplay
; /**< A pointer to the platform display */
143 _EGLDriver
*Driver
; /**< Matched driver of the display */
144 EGLBoolean Initialized
; /**< True if the display is initialized */
146 /* options that affect how the driver initializes the display */
148 EGLBoolean TestOnly
; /**< Driver should not set fields when true */
149 EGLBoolean UseFallback
; /**< Use fallback driver (sw or less features) */
152 /* these fields are set by the driver during init */
153 void *DriverData
; /**< Driver private data */
154 EGLint Version
; /**< EGL version major*10+minor */
155 EGLint ClientAPIs
; /**< Bitmask of APIs supported (EGL_xxx_BIT) */
156 _EGLExtensions Extensions
; /**< Extensions supported */
158 /* these fields are derived from above */
159 char VersionString
[100]; /**< EGL_VERSION */
160 char ClientAPIsString
[100]; /**< EGL_CLIENT_APIS */
161 char ExtensionsString
[_EGL_MAX_EXTENSIONS_LEN
]; /**< EGL_EXTENSIONS */
166 /* lists of resources */
167 _EGLResource
*ResourceLists
[_EGL_NUM_RESOURCES
];
171 extern _EGLPlatformType
172 _eglGetNativePlatform(void *nativeDisplay
);
176 _eglFiniDisplay(void);
180 _eglFindDisplay(_EGLPlatformType plat
, void *plat_dpy
);
184 _eglReleaseDisplayResources(_EGLDriver
*drv
, _EGLDisplay
*dpy
);
188 _eglCleanupDisplay(_EGLDisplay
*disp
);
192 _eglCheckDisplayHandle(EGLDisplay dpy
);
196 _eglCheckResource(void *res
, _EGLResourceType type
, _EGLDisplay
*dpy
);
200 * Lookup a handle to find the linked display.
201 * Return NULL if the handle has no corresponding linked display.
203 static inline _EGLDisplay
*
204 _eglLookupDisplay(EGLDisplay display
)
206 _EGLDisplay
*dpy
= (_EGLDisplay
*) display
;
207 if (!_eglCheckDisplayHandle(display
))
214 * Return the handle of a linked display, or EGL_NO_DISPLAY.
216 static inline EGLDisplay
217 _eglGetDisplayHandle(_EGLDisplay
*dpy
)
219 return (EGLDisplay
) ((dpy
) ? dpy
: EGL_NO_DISPLAY
);
224 _eglInitResource(_EGLResource
*res
, EGLint size
, _EGLDisplay
*dpy
);
228 _eglGetResource(_EGLResource
*res
);
232 _eglPutResource(_EGLResource
*res
);
236 _eglLinkResource(_EGLResource
*res
, _EGLResourceType type
);
240 _eglUnlinkResource(_EGLResource
*res
, _EGLResourceType type
);
244 * Return true if the resource is linked.
246 static inline EGLBoolean
247 _eglIsResourceLinked(_EGLResource
*res
)
249 return res
->IsLinked
;
252 #ifdef HAVE_X11_PLATFORM
254 _eglGetX11Display(Display
*native_display
, const EGLint
*attrib_list
);
257 #ifdef HAVE_DRM_PLATFORM
261 _eglGetGbmDisplay(struct gbm_device
*native_display
,
262 const EGLint
*attrib_list
);
265 #ifdef HAVE_WAYLAND_PLATFORM
269 _eglGetWaylandDisplay(struct wl_display
*native_display
,
270 const EGLint
*attrib_list
);
278 #endif /* EGLDISPLAY_INCLUDED */