egldisplay.h revision 01e04c3f 
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
142   EGLBoolean NOK_swap_region;
143   EGLBoolean NOK_texture_from_pixmap;
144
145   EGLBoolean NV_post_sub_buffer;
146
147   EGLBoolean WL_bind_wayland_display;
148   EGLBoolean WL_create_wayland_buffer_from_image;
149};
150
151
152struct _egl_display
153{
154   /* used to link displays */
155   _EGLDisplay *Next;
156
157   mtx_t Mutex;
158
159   _EGLPlatformType Platform; /**< The type of the platform display */
160   void *PlatformDisplay;     /**< A pointer to the platform display */
161
162   _EGLDevice *Device;        /**< Device backing the display */
163   _EGLDriver *Driver;        /**< Matched driver of the display */
164   EGLBoolean Initialized;    /**< True if the display is initialized */
165
166   /* options that affect how the driver initializes the display */
167   struct {
168      EGLBoolean ForceSoftware; /**< Use software path only */
169      void *Platform;         /**< Platform-specific options */
170   } Options;
171
172   /* these fields are set by the driver during init */
173   void *DriverData;          /**< Driver private data */
174   EGLint Version;            /**< EGL version major*10+minor */
175   EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
176   _EGLExtensions Extensions; /**< Extensions supported */
177
178   /* these fields are derived from above */
179   char VersionString[100];                        /**< EGL_VERSION */
180   char ClientAPIsString[100];                     /**< EGL_CLIENT_APIS */
181   char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
182
183   _EGLArray *Configs;
184
185   /* lists of resources */
186   _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
187
188   EGLLabelKHR Label;
189
190   EGLSetBlobFuncANDROID BlobCacheSet;
191   EGLGetBlobFuncANDROID BlobCacheGet;
192};
193
194
195extern _EGLPlatformType
196_eglGetNativePlatform(void *nativeDisplay);
197
198
199extern void
200_eglFiniDisplay(void);
201
202
203extern _EGLDisplay *
204_eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
205
206
207extern void
208_eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
209
210
211extern void
212_eglCleanupDisplay(_EGLDisplay *disp);
213
214
215extern EGLBoolean
216_eglCheckDisplayHandle(EGLDisplay dpy);
217
218
219extern EGLBoolean
220_eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
221
222
223/**
224 * Lookup a handle to find the linked display.
225 * Return NULL if the handle has no corresponding linked display.
226 */
227static inline _EGLDisplay *
228_eglLookupDisplay(EGLDisplay display)
229{
230   _EGLDisplay *dpy = (_EGLDisplay *) display;
231   if (!_eglCheckDisplayHandle(display))
232      dpy = NULL;
233   return dpy;
234}
235
236
237/**
238 * Return the handle of a linked display, or EGL_NO_DISPLAY.
239 */
240static inline EGLDisplay
241_eglGetDisplayHandle(_EGLDisplay *dpy)
242{
243   return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
244}
245
246
247extern void
248_eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
249
250
251extern void
252_eglGetResource(_EGLResource *res);
253
254
255extern EGLBoolean
256_eglPutResource(_EGLResource *res);
257
258
259extern void
260_eglLinkResource(_EGLResource *res, _EGLResourceType type);
261
262
263extern void
264_eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
265
266
267/**
268 * Return true if the resource is linked.
269 */
270static inline EGLBoolean
271_eglIsResourceLinked(_EGLResource *res)
272{
273   return res->IsLinked;
274}
275
276#ifdef HAVE_X11_PLATFORM
277_EGLDisplay*
278_eglGetX11Display(Display *native_display, const EGLAttrib *attrib_list);
279#endif
280
281#ifdef HAVE_DRM_PLATFORM
282struct gbm_device;
283
284_EGLDisplay*
285_eglGetGbmDisplay(struct gbm_device *native_display,
286                  const EGLAttrib *attrib_list);
287#endif
288
289#ifdef HAVE_WAYLAND_PLATFORM
290struct wl_display;
291
292_EGLDisplay*
293_eglGetWaylandDisplay(struct wl_display *native_display,
294                      const EGLAttrib *attrib_list);
295#endif
296
297#ifdef HAVE_SURFACELESS_PLATFORM
298_EGLDisplay*
299_eglGetSurfacelessDisplay(void *native_display,
300                          const EGLAttrib *attrib_list);
301#endif
302
303#ifdef __cplusplus
304}
305#endif
306
307#endif /* EGLDISPLAY_INCLUDED */
308