1 /**************************************************************************
3 * Copyright 2008 VMware, Inc.
4 * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
5 * Copyright 2010-2011 LunarG, Inc.
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:
16 * The above copyright notice and this permission notice (including the
17 * next paragraph) shall be included in all copies or substantial portions
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.
28 **************************************************************************/
31 #ifndef EGLDISPLAY_INCLUDED
32 #define EGLDISPLAY_INCLUDED
34 #include "c99_compat.h"
35 #include "c11/threads.h"
37 #include "egltypedefs.h"
38 #include "egldefines.h"
46 enum _egl_platform_type
{
48 _EGL_PLATFORM_WAYLAND
,
50 _EGL_PLATFORM_ANDROID
,
52 _EGL_PLATFORM_SURFACELESS
,
56 _EGL_INVALID_PLATFORM
= -1
58 typedef enum _egl_platform_type _EGLPlatformType
;
61 enum _egl_resource_type
{
62 _EGL_RESOURCE_CONTEXT
,
63 _EGL_RESOURCE_SURFACE
,
69 /* this cannot and need not go into egltypedefs.h */
70 typedef enum _egl_resource_type _EGLResourceType
;
74 * A resource of a display.
78 /* which display the resource belongs to */
85 /* used to link resources of the same type */
91 * Optional EGL extensions info.
93 struct _egl_extensions
95 /* Please keep these sorted alphabetically. */
96 EGLBoolean ANDROID_blob_cache
;
97 EGLBoolean ANDROID_framebuffer_target
;
98 EGLBoolean ANDROID_image_native_buffer
;
99 EGLBoolean ANDROID_native_fence_sync
;
100 EGLBoolean ANDROID_recordable
;
102 EGLBoolean CHROMIUM_sync_control
;
104 EGLBoolean EXT_buffer_age
;
105 EGLBoolean EXT_create_context_robustness
;
106 EGLBoolean EXT_image_dma_buf_import
;
107 EGLBoolean EXT_image_dma_buf_import_modifiers
;
108 EGLBoolean EXT_pixel_format_float
;
109 EGLBoolean EXT_surface_CTA861_3_metadata
;
110 EGLBoolean EXT_surface_SMPTE2086_metadata
;
111 EGLBoolean EXT_swap_buffers_with_damage
;
113 unsigned int IMG_context_priority
;
114 #define __EGL_CONTEXT_PRIORITY_LOW_BIT 0
115 #define __EGL_CONTEXT_PRIORITY_MEDIUM_BIT 1
116 #define __EGL_CONTEXT_PRIORITY_HIGH_BIT 2
118 EGLBoolean KHR_cl_event2
;
119 EGLBoolean KHR_config_attribs
;
120 EGLBoolean KHR_context_flush_control
;
121 EGLBoolean KHR_create_context
;
122 EGLBoolean KHR_create_context_no_error
;
123 EGLBoolean KHR_fence_sync
;
124 EGLBoolean KHR_get_all_proc_addresses
;
125 EGLBoolean KHR_gl_colorspace
;
126 EGLBoolean KHR_gl_renderbuffer_image
;
127 EGLBoolean KHR_gl_texture_2D_image
;
128 EGLBoolean KHR_gl_texture_3D_image
;
129 EGLBoolean KHR_gl_texture_cubemap_image
;
130 EGLBoolean KHR_image
;
131 EGLBoolean KHR_image_base
;
132 EGLBoolean KHR_image_pixmap
;
133 EGLBoolean KHR_mutable_render_buffer
;
134 EGLBoolean KHR_no_config_context
;
135 EGLBoolean KHR_partial_update
;
136 EGLBoolean KHR_reusable_sync
;
137 EGLBoolean KHR_surfaceless_context
;
138 EGLBoolean KHR_wait_sync
;
140 EGLBoolean MESA_drm_image
;
141 EGLBoolean MESA_image_dma_buf_export
;
142 EGLBoolean MESA_query_driver
;
144 EGLBoolean NOK_swap_region
;
145 EGLBoolean NOK_texture_from_pixmap
;
147 EGLBoolean NV_post_sub_buffer
;
149 EGLBoolean WL_bind_wayland_display
;
150 EGLBoolean WL_create_wayland_buffer_from_image
;
155 /* used to link displays */
160 _EGLPlatformType Platform
; /**< The type of the platform display */
161 void *PlatformDisplay
; /**< A pointer to the platform display */
163 _EGLDevice
*Device
; /**< Device backing the display */
164 _EGLDriver
*Driver
; /**< Matched driver of the display */
165 EGLBoolean Initialized
; /**< True if the display is initialized */
167 /* options that affect how the driver initializes the display */
169 EGLBoolean ForceSoftware
; /**< Use software path only */
170 EGLAttrib
*Attribs
; /**< Platform-specific options */
171 int fd
; /**< plaform device specific, local fd */
174 /* these fields are set by the driver during init */
175 void *DriverData
; /**< Driver private data */
176 EGLint Version
; /**< EGL version major*10+minor */
177 EGLint ClientAPIs
; /**< Bitmask of APIs supported (EGL_xxx_BIT) */
178 _EGLExtensions Extensions
; /**< Extensions supported */
180 /* these fields are derived from above */
181 char VersionString
[100]; /**< EGL_VERSION */
182 char ClientAPIsString
[100]; /**< EGL_CLIENT_APIS */
183 char ExtensionsString
[_EGL_MAX_EXTENSIONS_LEN
]; /**< EGL_EXTENSIONS */
187 /* lists of resources */
188 _EGLResource
*ResourceLists
[_EGL_NUM_RESOURCES
];
192 EGLSetBlobFuncANDROID BlobCacheSet
;
193 EGLGetBlobFuncANDROID BlobCacheGet
;
197 extern _EGLPlatformType
198 _eglGetNativePlatform(void *nativeDisplay
);
202 _eglFiniDisplay(void);
206 _eglFindDisplay(_EGLPlatformType plat
, void *plat_dpy
, const EGLAttrib
*attr
);
210 _eglReleaseDisplayResources(_EGLDriver
*drv
, _EGLDisplay
*disp
);
214 _eglCleanupDisplay(_EGLDisplay
*disp
);
218 _eglCheckDisplayHandle(EGLDisplay dpy
);
222 _eglCheckResource(void *res
, _EGLResourceType type
, _EGLDisplay
*disp
);
226 * Lookup a handle to find the linked display.
227 * Return NULL if the handle has no corresponding linked display.
229 static inline _EGLDisplay
*
230 _eglLookupDisplay(EGLDisplay dpy
)
232 _EGLDisplay
*disp
= (_EGLDisplay
*) dpy
;
233 if (!_eglCheckDisplayHandle(dpy
))
240 * Return the handle of a linked display, or EGL_NO_DISPLAY.
242 static inline EGLDisplay
243 _eglGetDisplayHandle(_EGLDisplay
*disp
)
245 return (EGLDisplay
) ((disp
) ? disp
: EGL_NO_DISPLAY
);
250 _eglInitResource(_EGLResource
*res
, EGLint size
, _EGLDisplay
*disp
);
254 _eglGetResource(_EGLResource
*res
);
258 _eglPutResource(_EGLResource
*res
);
262 _eglLinkResource(_EGLResource
*res
, _EGLResourceType type
);
266 _eglUnlinkResource(_EGLResource
*res
, _EGLResourceType type
);
270 * Return true if the resource is linked.
272 static inline EGLBoolean
273 _eglIsResourceLinked(_EGLResource
*res
)
275 return res
->IsLinked
;
279 _eglNumAttribs(const EGLAttrib
*attribs
)
284 while (attribs
[len
] != EGL_NONE
)
291 #ifdef HAVE_X11_PLATFORM
293 _eglGetX11Display(Display
*native_display
, const EGLAttrib
*attrib_list
);
296 #ifdef HAVE_DRM_PLATFORM
300 _eglGetGbmDisplay(struct gbm_device
*native_display
,
301 const EGLAttrib
*attrib_list
);
304 #ifdef HAVE_WAYLAND_PLATFORM
308 _eglGetWaylandDisplay(struct wl_display
*native_display
,
309 const EGLAttrib
*attrib_list
);
312 #ifdef HAVE_SURFACELESS_PLATFORM
314 _eglGetSurfacelessDisplay(void *native_display
,
315 const EGLAttrib
*attrib_list
);
318 #ifdef HAVE_ANDROID_PLATFORM
320 _eglGetAndroidDisplay(void *native_display
,
321 const EGLAttrib
*attrib_list
);
325 _eglGetDeviceDisplay(void *native_display
,
326 const EGLAttrib
*attrib_list
);
332 #endif /* EGLDISPLAY_INCLUDED */