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