egldisplay.h revision af69d88d 
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
35#include "egltypedefs.h"
36#include "egldefines.h"
37#include "eglmutex.h"
38#include "eglarray.h"
39
40
41enum _egl_platform_type {
42   _EGL_PLATFORM_WINDOWS,
43   _EGL_PLATFORM_X11,
44   _EGL_PLATFORM_WAYLAND,
45   _EGL_PLATFORM_DRM,
46   _EGL_PLATFORM_FBDEV,
47   _EGL_PLATFORM_NULL,
48   _EGL_PLATFORM_ANDROID,
49
50   _EGL_NUM_PLATFORMS,
51   _EGL_INVALID_PLATFORM = -1
52};
53typedef enum _egl_platform_type _EGLPlatformType;
54
55
56enum _egl_resource_type {
57   _EGL_RESOURCE_CONTEXT,
58   _EGL_RESOURCE_SURFACE,
59   _EGL_RESOURCE_IMAGE,
60   _EGL_RESOURCE_SYNC,
61
62   _EGL_NUM_RESOURCES
63};
64/* this cannot and need not go into egltypedefs.h */
65typedef enum _egl_resource_type _EGLResourceType;
66
67
68/**
69 * A resource of a display.
70 */
71struct _egl_resource
72{
73   /* which display the resource belongs to */
74   _EGLDisplay *Display;
75   EGLBoolean IsLinked;
76   EGLint RefCount;
77
78   /* used to link resources of the same type */
79   _EGLResource *Next;
80};
81
82
83/**
84 * Optional EGL extensions info.
85 */
86struct _egl_extensions
87{
88   EGLBoolean MESA_screen_surface;
89   EGLBoolean MESA_copy_context;
90   EGLBoolean MESA_drm_display;
91   EGLBoolean MESA_drm_image;
92   EGLBoolean MESA_configless_context;
93
94   EGLBoolean WL_bind_wayland_display;
95   EGLBoolean WL_create_wayland_buffer_from_image;
96
97   EGLBoolean KHR_image_base;
98   EGLBoolean KHR_image_pixmap;
99   EGLBoolean KHR_vg_parent_image;
100   EGLBoolean KHR_gl_texture_2D_image;
101   EGLBoolean KHR_gl_texture_cubemap_image;
102   EGLBoolean KHR_gl_texture_3D_image;
103   EGLBoolean KHR_gl_renderbuffer_image;
104
105   EGLBoolean KHR_reusable_sync;
106   EGLBoolean KHR_fence_sync;
107
108   EGLBoolean KHR_surfaceless_context;
109   EGLBoolean KHR_create_context;
110
111   EGLBoolean NOK_swap_region;
112   EGLBoolean NOK_texture_from_pixmap;
113
114   EGLBoolean ANDROID_image_native_buffer;
115
116   EGLBoolean CHROMIUM_sync_control;
117
118   EGLBoolean NV_post_sub_buffer;
119
120   EGLBoolean EXT_create_context_robustness;
121   EGLBoolean EXT_buffer_age;
122   EGLBoolean EXT_swap_buffers_with_damage;
123   EGLBoolean EXT_image_dma_buf_import;
124};
125
126
127struct _egl_display
128{
129   /* used to link displays */
130   _EGLDisplay *Next;
131
132   _EGLMutex Mutex;
133
134   _EGLPlatformType Platform; /**< The type of the platform display */
135   void *PlatformDisplay;     /**< A pointer to the platform display */
136
137   _EGLDriver *Driver;        /**< Matched driver of the display */
138   EGLBoolean Initialized;    /**< True if the display is initialized */
139
140   /* options that affect how the driver initializes the display */
141   struct {
142      EGLBoolean TestOnly;    /**< Driver should not set fields when true */
143      EGLBoolean UseFallback; /**< Use fallback driver (sw or less features) */
144   } Options;
145
146   /* these fields are set by the driver during init */
147   void *DriverData;          /**< Driver private data */
148   EGLint VersionMajor;       /**< EGL major version */
149   EGLint VersionMinor;       /**< EGL minor version */
150   EGLint ClientAPIs;         /**< Bitmask of APIs supported (EGL_xxx_BIT) */
151   _EGLExtensions Extensions; /**< Extensions supported */
152
153   /* these fields are derived from above */
154   char VersionString[1000];                       /**< EGL_VERSION */
155   char ClientAPIsString[1000];                    /**< EGL_CLIENT_APIS */
156   char ExtensionsString[_EGL_MAX_EXTENSIONS_LEN]; /**< EGL_EXTENSIONS */
157
158   _EGLArray *Screens;
159   _EGLArray *Configs;
160
161   /* lists of resources */
162   _EGLResource *ResourceLists[_EGL_NUM_RESOURCES];
163};
164
165
166extern _EGLPlatformType
167_eglGetNativePlatform(void *nativeDisplay);
168
169
170extern void
171_eglFiniDisplay(void);
172
173
174extern _EGLDisplay *
175_eglFindDisplay(_EGLPlatformType plat, void *plat_dpy);
176
177
178PUBLIC void
179_eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *dpy);
180
181
182PUBLIC void
183_eglCleanupDisplay(_EGLDisplay *disp);
184
185
186extern EGLBoolean
187_eglCheckDisplayHandle(EGLDisplay dpy);
188
189
190PUBLIC EGLBoolean
191_eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy);
192
193
194/**
195 * Lookup a handle to find the linked display.
196 * Return NULL if the handle has no corresponding linked display.
197 */
198static INLINE _EGLDisplay *
199_eglLookupDisplay(EGLDisplay display)
200{
201   _EGLDisplay *dpy = (_EGLDisplay *) display;
202   if (!_eglCheckDisplayHandle(display))
203      dpy = NULL;
204   return dpy;
205}
206
207
208/**
209 * Return the handle of a linked display, or EGL_NO_DISPLAY.
210 */
211static INLINE EGLDisplay
212_eglGetDisplayHandle(_EGLDisplay *dpy)
213{
214   return (EGLDisplay) ((dpy) ? dpy : EGL_NO_DISPLAY);
215}
216
217
218extern void
219_eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy);
220
221
222PUBLIC void
223_eglGetResource(_EGLResource *res);
224
225
226PUBLIC EGLBoolean
227_eglPutResource(_EGLResource *res);
228
229
230extern void
231_eglLinkResource(_EGLResource *res, _EGLResourceType type);
232
233
234extern void
235_eglUnlinkResource(_EGLResource *res, _EGLResourceType type);
236
237
238/**
239 * Return true if the resource is linked.
240 */
241static INLINE EGLBoolean
242_eglIsResourceLinked(_EGLResource *res)
243{
244   return res->IsLinked;
245}
246
247#ifdef HAVE_X11_PLATFORM
248_EGLDisplay*
249_eglGetX11Display(Display *native_display, const EGLint *attrib_list);
250#endif
251
252#ifdef HAVE_DRM_PLATFORM
253struct gbm_device;
254
255_EGLDisplay*
256_eglGetGbmDisplay(struct gbm_device *native_display,
257                  const EGLint *attrib_list);
258#endif
259
260#ifdef HAVE_WAYLAND_PLATFORM
261struct wl_display;
262
263_EGLDisplay*
264_eglGetWaylandDisplay(struct wl_display *native_display,
265                      const EGLint *attrib_list);
266#endif
267
268#endif /* EGLDISPLAY_INCLUDED */
269