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 **************************************************************************/
34 #include "eglconfig.h"
35 #include "eglcontext.h"
36 #include "egldisplay.h"
37 #include "eglcurrent.h"
38 #include "eglsurface.h"
43 * Return the API bit (one of EGL_xxx_BIT) of the context.
46 _eglGetContextAPIBit(_EGLContext
*ctx
)
50 switch (ctx
->ClientAPI
) {
51 case EGL_OPENGL_ES_API
:
52 switch (ctx
->ClientMajorVersion
) {
54 bit
= EGL_OPENGL_ES_BIT
;
57 bit
= EGL_OPENGL_ES2_BIT
;
60 bit
= EGL_OPENGL_ES3_BIT_KHR
;
81 * Parse the list of context attributes and return the proper error code.
84 _eglParseContextAttribList(_EGLContext
*ctx
, _EGLDisplay
*dpy
,
85 const EGLint
*attrib_list
)
87 EGLenum api
= ctx
->ClientAPI
;
88 EGLint i
, err
= EGL_SUCCESS
;
93 if (api
== EGL_OPENVG_API
&& attrib_list
[0] != EGL_NONE
) {
94 _eglLog(_EGL_DEBUG
, "bad context attribute 0x%04x", attrib_list
[0]);
95 return EGL_BAD_ATTRIBUTE
;
98 for (i
= 0; attrib_list
[i
] != EGL_NONE
; i
++) {
99 EGLint attr
= attrib_list
[i
++];
100 EGLint val
= attrib_list
[i
];
103 case EGL_CONTEXT_CLIENT_VERSION
:
104 ctx
->ClientMajorVersion
= val
;
107 case EGL_CONTEXT_MINOR_VERSION_KHR
:
108 if (!dpy
->Extensions
.KHR_create_context
) {
109 err
= EGL_BAD_ATTRIBUTE
;
113 ctx
->ClientMinorVersion
= val
;
116 case EGL_CONTEXT_FLAGS_KHR
:
117 if (!dpy
->Extensions
.KHR_create_context
) {
118 err
= EGL_BAD_ATTRIBUTE
;
122 /* The EGL_KHR_create_context spec says:
124 * "Flags are only defined for OpenGL context creation, and
125 * specifying a flags value other than zero for other types of
126 * contexts, including OpenGL ES contexts, will generate an
129 if (api
!= EGL_OPENGL_API
&& val
!= 0) {
130 err
= EGL_BAD_ATTRIBUTE
;
137 case EGL_CONTEXT_OPENGL_PROFILE_MASK_KHR
:
138 if (!dpy
->Extensions
.KHR_create_context
) {
139 err
= EGL_BAD_ATTRIBUTE
;
143 /* The EGL_KHR_create_context spec says:
145 * "[EGL_CONTEXT_OPENGL_PROFILE_MASK_KHR] is only meaningful for
146 * OpenGL contexts, and specifying it for other types of
147 * contexts, including OpenGL ES contexts, will generate an
150 if (api
!= EGL_OPENGL_API
) {
151 err
= EGL_BAD_ATTRIBUTE
;
158 case EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY_KHR
:
159 /* The EGL_KHR_create_context spec says:
161 * "[EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY_KHR] is only
162 * meaningful for OpenGL contexts, and specifying it for other
163 * types of contexts, including OpenGL ES contexts, will generate
166 if (!dpy
->Extensions
.KHR_create_context
167 || api
!= EGL_OPENGL_API
) {
168 err
= EGL_BAD_ATTRIBUTE
;
172 ctx
->ResetNotificationStrategy
= val
;
175 case EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY_EXT
:
176 /* The EGL_EXT_create_context_robustness spec says:
178 * "[EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY_EXT] is only
179 * meaningful for OpenGL ES contexts, and specifying it for other
180 * types of contexts will generate an EGL_BAD_ATTRIBUTE error."
182 if (!dpy
->Extensions
.EXT_create_context_robustness
183 || api
!= EGL_OPENGL_ES_API
) {
184 err
= EGL_BAD_ATTRIBUTE
;
188 ctx
->ResetNotificationStrategy
= val
;
191 case EGL_CONTEXT_OPENGL_ROBUST_ACCESS_EXT
:
192 if (!dpy
->Extensions
.EXT_create_context_robustness
) {
193 err
= EGL_BAD_ATTRIBUTE
;
198 ctx
->Flags
|= EGL_CONTEXT_OPENGL_ROBUST_ACCESS_BIT_KHR
;
201 case EGL_CONTEXT_OPENGL_ROBUST_ACCESS
:
202 if (dpy
->Version
< 15) {
203 err
= EGL_BAD_ATTRIBUTE
;
208 ctx
->Flags
|= EGL_CONTEXT_OPENGL_ROBUST_ACCESS_BIT_KHR
;
211 case EGL_CONTEXT_OPENGL_DEBUG
:
212 if (dpy
->Version
< 15) {
213 err
= EGL_BAD_ATTRIBUTE
;
218 ctx
->Flags
|= EGL_CONTEXT_OPENGL_DEBUG_BIT_KHR
;
221 case EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE
:
222 if (dpy
->Version
< 15) {
223 err
= EGL_BAD_ATTRIBUTE
;
228 ctx
->Flags
|= EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR
;
232 err
= EGL_BAD_ATTRIBUTE
;
236 if (err
!= EGL_SUCCESS
) {
237 _eglLog(_EGL_DEBUG
, "bad context attribute 0x%04x", attr
);
242 if (api
== EGL_OPENGL_API
) {
243 /* The EGL_KHR_create_context spec says:
245 * "If the requested OpenGL version is less than 3.2,
246 * EGL_CONTEXT_OPENGL_PROFILE_MASK_KHR is ignored and the
247 * functionality of the context is determined solely by the
248 * requested version."
250 * Since the value is ignored, only validate the setting if the version
253 if (ctx
->ClientMajorVersion
>= 4
254 || (ctx
->ClientMajorVersion
== 3 && ctx
->ClientMinorVersion
>= 2)) {
255 switch (ctx
->Profile
) {
256 case EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT_KHR
:
257 case EGL_CONTEXT_OPENGL_COMPATIBILITY_PROFILE_BIT_KHR
:
261 /* The EGL_KHR_create_context spec says:
263 * "* If an OpenGL context is requested, the requested version
264 * is greater than 3.2, and the value for attribute
265 * EGL_CONTEXT_OPENGL_PROFILE_MASK_KHR has no bits set; has
266 * any bits set other than EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT_KHR
267 * and EGL_CONTEXT_OPENGL_COMPATIBILITY_PROFILE_BIT_KHR; has
268 * more than one of these bits set; or if the implementation does
269 * not support the requested profile, then an EGL_BAD_MATCH error
277 /* The EGL_KHR_create_context spec says:
279 * "* If an OpenGL context is requested and the values for
280 * attributes EGL_CONTEXT_MAJOR_VERSION_KHR and
281 * EGL_CONTEXT_MINOR_VERSION_KHR, when considered together with
282 * the value for attribute
283 * EGL_CONTEXT_FORWARD_COMPATIBLE_BIT_KHR, specify an OpenGL
284 * version and feature set that are not defined, than an
285 * EGL_BAD_MATCH error is generated.
287 * ... Thus, examples of invalid combinations of attributes
290 * - Major version < 1 or > 4
291 * - Major version == 1 and minor version < 0 or > 5
292 * - Major version == 2 and minor version < 0 or > 1
293 * - Major version == 3 and minor version < 0 or > 2
294 * - Major version == 4 and minor version < 0 or > 2
295 * - Forward-compatible flag set and major version < 3"
297 if (ctx
->ClientMajorVersion
< 1 || ctx
->ClientMinorVersion
< 0)
300 switch (ctx
->ClientMajorVersion
) {
302 if (ctx
->ClientMinorVersion
> 5
303 || (ctx
->Flags
& EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR
) != 0)
308 if (ctx
->ClientMinorVersion
> 1
309 || (ctx
->Flags
& EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR
) != 0)
314 /* Note: The text above is incorrect. There *is* an OpenGL 3.3!
316 if (ctx
->ClientMinorVersion
> 3)
322 /* Don't put additional version checks here. We don't know that
323 * there won't be versions > 4.2.
327 } else if (api
== EGL_OPENGL_ES_API
) {
328 /* The EGL_KHR_create_context spec says:
330 * "* If an OpenGL ES context is requested and the values for
331 * attributes EGL_CONTEXT_MAJOR_VERSION_KHR and
332 * EGL_CONTEXT_MINOR_VERSION_KHR specify an OpenGL ES version that
333 * is not defined, than an EGL_BAD_MATCH error is generated.
335 * ... Examples of invalid combinations of attributes include:
337 * - Major version < 1 or > 2
338 * - Major version == 1 and minor version < 0 or > 1
339 * - Major version == 2 and minor version != 0
341 if (ctx
->ClientMajorVersion
< 1 || ctx
->ClientMinorVersion
< 0)
344 switch (ctx
->ClientMajorVersion
) {
346 if (ctx
->ClientMinorVersion
> 1)
351 if (ctx
->ClientMinorVersion
> 0)
356 /* Don't put additional version checks here. We don't know that
357 * there won't be versions > 3.0.
367 switch (ctx
->ResetNotificationStrategy
) {
368 case EGL_NO_RESET_NOTIFICATION_KHR
:
369 case EGL_LOSE_CONTEXT_ON_RESET_KHR
:
373 err
= EGL_BAD_ATTRIBUTE
;
377 if ((ctx
->Flags
& ~(EGL_CONTEXT_OPENGL_DEBUG_BIT_KHR
378 | EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR
379 | EGL_CONTEXT_OPENGL_ROBUST_ACCESS_BIT_KHR
)) != 0) {
380 err
= EGL_BAD_ATTRIBUTE
;
388 * Initialize the given _EGLContext object to defaults and/or the values
389 * in the attrib_list.
392 _eglInitContext(_EGLContext
*ctx
, _EGLDisplay
*dpy
, _EGLConfig
*conf
,
393 const EGLint
*attrib_list
)
395 const EGLenum api
= eglQueryAPI();
398 if (api
== EGL_NONE
) {
399 _eglError(EGL_BAD_MATCH
, "eglCreateContext(no client API)");
403 _eglInitResource(&ctx
->Resource
, sizeof(*ctx
), dpy
);
404 ctx
->ClientAPI
= api
;
406 ctx
->WindowRenderBuffer
= EGL_NONE
;
407 ctx
->Profile
= EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT_KHR
;
409 ctx
->ClientMajorVersion
= 1; /* the default, per EGL spec */
410 ctx
->ClientMinorVersion
= 0;
412 ctx
->Profile
= EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT_KHR
;
413 ctx
->ResetNotificationStrategy
= EGL_NO_RESET_NOTIFICATION_KHR
;
415 err
= _eglParseContextAttribList(ctx
, dpy
, attrib_list
);
416 if (err
== EGL_SUCCESS
&& ctx
->Config
) {
419 api_bit
= _eglGetContextAPIBit(ctx
);
420 if (!(ctx
->Config
->RenderableType
& api_bit
)) {
421 _eglLog(_EGL_DEBUG
, "context api is 0x%x while config supports 0x%x",
422 api_bit
, ctx
->Config
->RenderableType
);
423 err
= EGL_BAD_CONFIG
;
426 if (err
!= EGL_SUCCESS
)
427 return _eglError(err
, "eglCreateContext");
434 _eglQueryContextRenderBuffer(_EGLContext
*ctx
)
436 _EGLSurface
*surf
= ctx
->DrawSurface
;
441 if (surf
->Type
== EGL_WINDOW_BIT
&& ctx
->WindowRenderBuffer
!= EGL_NONE
)
442 rb
= ctx
->WindowRenderBuffer
;
444 rb
= surf
->RenderBuffer
;
450 _eglQueryContext(_EGLDriver
*drv
, _EGLDisplay
*dpy
, _EGLContext
*c
,
451 EGLint attribute
, EGLint
*value
)
457 return _eglError(EGL_BAD_PARAMETER
, "eglQueryContext");
462 return _eglError(EGL_BAD_ATTRIBUTE
, "eglQueryContext");
463 *value
= c
->Config
->ConfigID
;
465 case EGL_CONTEXT_CLIENT_VERSION
:
466 *value
= c
->ClientMajorVersion
;
468 case EGL_CONTEXT_CLIENT_TYPE
:
469 *value
= c
->ClientAPI
;
471 case EGL_RENDER_BUFFER
:
472 *value
= _eglQueryContextRenderBuffer(c
);
475 return _eglError(EGL_BAD_ATTRIBUTE
, "eglQueryContext");
483 * Bind the context to the thread and return the previous context.
485 * Note that the context may be NULL.
488 _eglBindContextToThread(_EGLContext
*ctx
, _EGLThreadInfo
*t
)
494 _eglConvertApiToIndex(ctx
->ClientAPI
) : t
->CurrentAPIIndex
;
496 oldCtx
= t
->CurrentContexts
[apiIndex
];
499 oldCtx
->Binding
= NULL
;
503 t
->CurrentContexts
[apiIndex
] = ctx
;
511 * Return true if the given context and surfaces can be made current.
514 _eglCheckMakeCurrent(_EGLContext
*ctx
, _EGLSurface
*draw
, _EGLSurface
*read
)
516 _EGLThreadInfo
*t
= _eglGetCurrentThread();
520 if (_eglIsCurrentThreadDummy())
521 return _eglError(EGL_BAD_ALLOC
, "eglMakeCurrent");
526 return _eglError(EGL_BAD_MATCH
, "eglMakeCurrent");
530 dpy
= ctx
->Resource
.Display
;
531 if (!dpy
->Extensions
.KHR_surfaceless_context
532 && (draw
== NULL
|| read
== NULL
))
533 return _eglError(EGL_BAD_MATCH
, "eglMakeCurrent");
538 * "If ctx is current to some other thread, or if either draw or read are
539 * bound to contexts in another thread, an EGL_BAD_ACCESS error is
544 * "at most one context may be bound to a particular surface at a given
547 if (ctx
->Binding
&& ctx
->Binding
!= t
)
548 return _eglError(EGL_BAD_ACCESS
, "eglMakeCurrent");
549 if (draw
&& draw
->CurrentContext
&& draw
->CurrentContext
!= ctx
) {
550 if (draw
->CurrentContext
->Binding
!= t
||
551 draw
->CurrentContext
->ClientAPI
!= ctx
->ClientAPI
)
552 return _eglError(EGL_BAD_ACCESS
, "eglMakeCurrent");
554 if (read
&& read
->CurrentContext
&& read
->CurrentContext
!= ctx
) {
555 if (read
->CurrentContext
->Binding
!= t
||
556 read
->CurrentContext
->ClientAPI
!= ctx
->ClientAPI
)
557 return _eglError(EGL_BAD_ACCESS
, "eglMakeCurrent");
560 /* If the context has a config then it must match that of the two
563 if ((draw
&& draw
->Config
!= ctx
->Config
) ||
564 (read
&& read
->Config
!= ctx
->Config
))
565 return _eglError(EGL_BAD_MATCH
, "eglMakeCurrent");
567 /* Otherwise we must be using the EGL_MESA_configless_context
569 assert(dpy
->Extensions
.MESA_configless_context
);
571 /* The extension doesn't permit binding draw and read buffers with
572 * differing contexts */
573 if (draw
&& read
&& draw
->Config
!= read
->Config
)
574 return _eglError(EGL_BAD_MATCH
, "eglMakeCurrent");
577 switch (ctx
->ClientAPI
) {
578 /* OpenGL and OpenGL ES are conflicting */
579 case EGL_OPENGL_ES_API
:
580 conflict_api
= EGL_OPENGL_API
;
583 conflict_api
= EGL_OPENGL_ES_API
;
590 if (conflict_api
>= 0 && _eglGetAPIContext(conflict_api
))
591 return _eglError(EGL_BAD_ACCESS
, "eglMakeCurrent");
598 * Bind the context to the current thread and given surfaces. Return the
599 * previous bound context and surfaces. The caller should unreference the
600 * returned context and surfaces.
602 * Making a second call with the resources returned by the first call
603 * unsurprisingly undoes the first call, except for the resouce reference
607 _eglBindContext(_EGLContext
*ctx
, _EGLSurface
*draw
, _EGLSurface
*read
,
608 _EGLContext
**old_ctx
,
609 _EGLSurface
**old_draw
, _EGLSurface
**old_read
)
611 _EGLThreadInfo
*t
= _eglGetCurrentThread();
612 _EGLContext
*prev_ctx
;
613 _EGLSurface
*prev_draw
, *prev_read
;
615 if (!_eglCheckMakeCurrent(ctx
, draw
, read
))
618 /* increment refcounts before binding */
620 _eglGetSurface(draw
);
621 _eglGetSurface(read
);
623 /* bind the new context */
624 prev_ctx
= _eglBindContextToThread(ctx
, t
);
626 /* break previous bindings */
628 prev_draw
= prev_ctx
->DrawSurface
;
629 prev_read
= prev_ctx
->ReadSurface
;
632 prev_draw
->CurrentContext
= NULL
;
634 prev_read
->CurrentContext
= NULL
;
636 prev_ctx
->DrawSurface
= NULL
;
637 prev_ctx
->ReadSurface
= NULL
;
640 prev_draw
= prev_read
= NULL
;
643 /* establish new bindings */
646 draw
->CurrentContext
= ctx
;
648 read
->CurrentContext
= ctx
;
650 ctx
->DrawSurface
= draw
;
651 ctx
->ReadSurface
= read
;
654 assert(old_ctx
&& old_draw
&& old_read
);
656 *old_draw
= prev_draw
;
657 *old_read
= prev_read
;