xref: /third_party/mesa3d/src/egl/main/egldisplay.h (revision bf215546) 
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 "c11/threads.h"
35
36#include "egltypedefs.h"
37#include "egldefines.h"
38#include "eglarray.h"
39
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45enum _egl_platform_type {
46   _EGL_PLATFORM_X11,
47   _EGL_PLATFORM_XCB,
48   _EGL_PLATFORM_WAYLAND,
49   _EGL_PLATFORM_DRM,
50   _EGL_PLATFORM_ANDROID,
51   _EGL_PLATFORM_HAIKU,
52   _EGL_PLATFORM_SURFACELESS,
53   _EGL_PLATFORM_DEVICE,
54   _EGL_PLATFORM_WINDOWS,
55   _EGL_PLATFORM_OHOS,
56
57   _EGL_NUM_PLATFORMS,
58   _EGL_INVALID_PLATFORM = -1
59};
60typedef enum _egl_platform_type _EGLPlatformType;
61
62
63enum _egl_resource_type {
64   _EGL_RESOURCE_CONTEXT,
65   _EGL_RESOURCE_SURFACE,
66   _EGL_RESOURCE_IMAGE,
67   _EGL_RESOURCE_SYNC,
68
69   _EGL_NUM_RESOURCES
70};
71/* this cannot and need not go into egltypedefs.h */
72typedef enum _egl_resource_type _EGLResourceType;
73
74
75/**
76 * A resource of a display.
77 */
78struct _egl_resource
79{
80   /* which display the resource belongs to */
81   _EGLDisplay *Display;
82   EGLBoolean IsLinked;
83   EGLint RefCount;
84
85   EGLLabelKHR Label;
86
87   /* used to link resources of the same type */
88   _EGLResource *Next;
89};
90
91
92/**
93 * Optional EGL extensions info.
94 */
95struct _egl_extensions
96{
97   /* Please keep these sorted alphabetically. */
98   EGLBoolean ANDROID_blob_cache;
99   EGLBoolean ANDROID_framebuffer_target;
100   EGLBoolean ANDROID_image_native_buffer;
101   EGLBoolean ANDROID_native_fence_sync;
102   EGLBoolean ANDROID_recordable;
103
104   EGLBoolean CHROMIUM_sync_control;
105
106   EGLBoolean EXT_buffer_age;
107   EGLBoolean EXT_create_context_robustness;
108   EGLBoolean EXT_image_dma_buf_import;
109   EGLBoolean EXT_image_dma_buf_import_modifiers;
110   EGLBoolean EXT_pixel_format_float;
111   EGLBoolean EXT_protected_surface;
112   EGLBoolean EXT_present_opaque;
113   EGLBoolean EXT_surface_CTA861_3_metadata;
114   EGLBoolean EXT_surface_SMPTE2086_metadata;
115   EGLBoolean EXT_swap_buffers_with_damage;
116
117   unsigned int IMG_context_priority;
118#define  __EGL_CONTEXT_PRIORITY_LOW_BIT    0
119#define  __EGL_CONTEXT_PRIORITY_MEDIUM_BIT 1
120#define  __EGL_CONTEXT_PRIORITY_HIGH_BIT   2
121
122   EGLBoolean KHR_cl_event2;
123   EGLBoolean KHR_config_attribs;
124   EGLBoolean KHR_context_flush_control;
125   EGLBoolean KHR_create_context;
126   EGLBoolean KHR_create_context_no_error;
127   EGLBoolean KHR_fence_sync;
128   EGLBoolean KHR_get_all_proc_addresses;
129   EGLBoolean KHR_gl_colorspace;
130   EGLBoolean KHR_gl_renderbuffer_image;
131   EGLBoolean KHR_gl_texture_2D_image;
132   EGLBoolean KHR_gl_texture_3D_image;
133   EGLBoolean KHR_gl_texture_cubemap_image;
134   EGLBoolean KHR_image;
135   EGLBoolean KHR_image_base;
136   EGLBoolean KHR_image_pixmap;
137   EGLBoolean KHR_mutable_render_buffer;
138   EGLBoolean KHR_no_config_context;
139   EGLBoolean KHR_partial_update;
140   EGLBoolean KHR_reusable_sync;
141   EGLBoolean KHR_surfaceless_context;
142   EGLBoolean KHR_wait_sync;
143
144   EGLBoolean MESA_drm_image;
145   EGLBoolean MESA_image_dma_buf_export;
146   EGLBoolean MESA_query_driver;
147
148   EGLBoolean NOK_swap_region;
149   EGLBoolean NOK_texture_from_pixmap;
150
151   EGLBoolean NV_post_sub_buffer;
152
153   EGLBoolean WL_bind_wayland_display;
154   EGLBoolean WL_create_wayland_buffer_from_image;
155};
156
157struct _egl_display
158{
159   /* used to link displays */
160   _EGLDisplay *Next;
161
162   mtx_t Mutex;
163
164   _EGLPlatformType Platform; /**< The type of the platform display */
165   void *PlatformDisplay;     /**< A pointer to the platform display */
166
167   _EGLDevice *Device;        /**< Device backing the display */
168   const _EGLDriver *Driver;  /**< Matched driver of the display */
169   EGLBoolean Initialized;    /**< True if the display is initialized */
170
171   /* options that affect how the driver initializes the display */
172   struct {
173      EGLBoolean Zink; /**< Use kopper only */
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
202extern _EGLPlatformType
203_eglGetNativePlatform(void *nativeDisplay);
204
205
206extern void
207_eglFiniDisplay(void);
208
209
210extern _EGLDisplay *
211_eglFindDisplay(_EGLPlatformType plat, void *plat_dpy, const EGLAttrib *attr);
212
213
214extern void
215_eglReleaseDisplayResources(_EGLDisplay *disp);
216
217
218extern void
219_eglCleanupDisplay(_EGLDisplay *disp);
220
221
222extern EGLBoolean
223_eglCheckDisplayHandle(EGLDisplay dpy);
224
225
226extern 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 */
234static inline _EGLDisplay *
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 */
247static inline EGLDisplay
248_eglGetDisplayHandle(_EGLDisplay *disp)
249{
250   return (EGLDisplay) ((disp) ? disp : EGL_NO_DISPLAY);
251}
252
253
254extern void
255_eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *disp);
256
257
258extern void
259_eglGetResource(_EGLResource *res);
260
261
262extern EGLBoolean
263_eglPutResource(_EGLResource *res);
264
265
266extern void
267_eglLinkResource(_EGLResource *res, _EGLResourceType type);
268
269
270extern void
271_eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
272
273
274/**
275 * Return true if the resource is linked.
276 */
277static inline EGLBoolean
278_eglIsResourceLinked(_EGLResource *res)
279{
280   return res->IsLinked;
281}
282
283static inline size_t
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
302typedef 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
308struct 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
316struct 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