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