2 * EGL Configuration (pixel format) functions.
10 #include "egldisplay.h"
11 #include "eglcurrent.h"
15 #define MIN2(A, B) (((A) < (B)) ? (A) : (B))
19 * Init the given _EGLconfig to default values.
20 * \param id the configuration's ID.
22 * Note that id must be positive for the config to be valid.
23 * It is also recommended that when there are N configs, their
24 * IDs are from 1 to N respectively.
27 _eglInitConfig(_EGLConfig
*conf
, _EGLDisplay
*dpy
, EGLint id
)
29 memset(conf
, 0, sizeof(*conf
));
33 /* some attributes take non-zero default values */
35 conf
->ConfigCaveat
= EGL_NONE
;
36 conf
->TransparentType
= EGL_NONE
;
37 conf
->NativeVisualType
= EGL_NONE
;
38 conf
->ColorBufferType
= EGL_RGB_BUFFER
;
43 * Link a config to its display and return the handle of the link.
44 * The handle can be passed to client directly.
46 * Note that we just save the ptr to the config (we don't copy the config).
49 _eglLinkConfig(_EGLConfig
*conf
)
51 _EGLDisplay
*dpy
= conf
->Display
;
54 assert(dpy
&& conf
->ConfigID
> 0);
57 dpy
->Configs
= _eglCreateArray("Config", 16);
59 return (EGLConfig
) NULL
;
62 _eglAppendArray(dpy
->Configs
, (void *) conf
);
64 return (EGLConfig
) conf
;
69 * Lookup a handle to find the linked config.
70 * Return NULL if the handle has no corresponding linked config.
73 _eglLookupConfig(EGLConfig config
, _EGLDisplay
*dpy
)
80 conf
= (_EGLConfig
*) _eglFindArray(dpy
->Configs
, (void *) config
);
82 assert(conf
->Display
== dpy
);
94 ATTRIB_TYPE_PSEUDO
, /* non-queryable */
95 ATTRIB_TYPE_PLATFORM
, /* platform-dependent */
97 ATTRIB_CRITERION_EXACT
,
98 ATTRIB_CRITERION_ATLEAST
,
99 ATTRIB_CRITERION_MASK
,
100 ATTRIB_CRITERION_SPECIAL
,
101 ATTRIB_CRITERION_IGNORE
105 /* EGL spec Table 3.1 and 3.4 */
106 static const struct {
110 EGLint default_value
;
111 } _eglValidationTable
[] =
114 { EGL_BUFFER_SIZE
, ATTRIB_TYPE_INTEGER
,
115 ATTRIB_CRITERION_ATLEAST
,
117 { EGL_RED_SIZE
, ATTRIB_TYPE_INTEGER
,
118 ATTRIB_CRITERION_ATLEAST
,
120 { EGL_GREEN_SIZE
, ATTRIB_TYPE_INTEGER
,
121 ATTRIB_CRITERION_ATLEAST
,
123 { EGL_BLUE_SIZE
, ATTRIB_TYPE_INTEGER
,
124 ATTRIB_CRITERION_ATLEAST
,
126 { EGL_LUMINANCE_SIZE
, ATTRIB_TYPE_INTEGER
,
127 ATTRIB_CRITERION_ATLEAST
,
129 { EGL_ALPHA_SIZE
, ATTRIB_TYPE_INTEGER
,
130 ATTRIB_CRITERION_ATLEAST
,
132 { EGL_ALPHA_MASK_SIZE
, ATTRIB_TYPE_INTEGER
,
133 ATTRIB_CRITERION_ATLEAST
,
135 { EGL_BIND_TO_TEXTURE_RGB
, ATTRIB_TYPE_BOOLEAN
,
136 ATTRIB_CRITERION_EXACT
,
138 { EGL_BIND_TO_TEXTURE_RGBA
, ATTRIB_TYPE_BOOLEAN
,
139 ATTRIB_CRITERION_EXACT
,
141 { EGL_COLOR_BUFFER_TYPE
, ATTRIB_TYPE_ENUM
,
142 ATTRIB_CRITERION_EXACT
,
144 { EGL_CONFIG_CAVEAT
, ATTRIB_TYPE_ENUM
,
145 ATTRIB_CRITERION_EXACT
,
147 { EGL_CONFIG_ID
, ATTRIB_TYPE_INTEGER
,
148 ATTRIB_CRITERION_EXACT
,
150 { EGL_CONFORMANT
, ATTRIB_TYPE_BITMASK
,
151 ATTRIB_CRITERION_MASK
,
153 { EGL_DEPTH_SIZE
, ATTRIB_TYPE_INTEGER
,
154 ATTRIB_CRITERION_ATLEAST
,
156 { EGL_LEVEL
, ATTRIB_TYPE_PLATFORM
,
157 ATTRIB_CRITERION_EXACT
,
159 { EGL_MAX_PBUFFER_WIDTH
, ATTRIB_TYPE_INTEGER
,
160 ATTRIB_CRITERION_IGNORE
,
162 { EGL_MAX_PBUFFER_HEIGHT
, ATTRIB_TYPE_INTEGER
,
163 ATTRIB_CRITERION_IGNORE
,
165 { EGL_MAX_PBUFFER_PIXELS
, ATTRIB_TYPE_INTEGER
,
166 ATTRIB_CRITERION_IGNORE
,
168 { EGL_MAX_SWAP_INTERVAL
, ATTRIB_TYPE_INTEGER
,
169 ATTRIB_CRITERION_EXACT
,
171 { EGL_MIN_SWAP_INTERVAL
, ATTRIB_TYPE_INTEGER
,
172 ATTRIB_CRITERION_EXACT
,
174 { EGL_NATIVE_RENDERABLE
, ATTRIB_TYPE_BOOLEAN
,
175 ATTRIB_CRITERION_EXACT
,
177 { EGL_NATIVE_VISUAL_ID
, ATTRIB_TYPE_PLATFORM
,
178 ATTRIB_CRITERION_IGNORE
,
180 { EGL_NATIVE_VISUAL_TYPE
, ATTRIB_TYPE_PLATFORM
,
181 ATTRIB_CRITERION_EXACT
,
183 { EGL_RENDERABLE_TYPE
, ATTRIB_TYPE_BITMASK
,
184 ATTRIB_CRITERION_MASK
,
186 { EGL_SAMPLE_BUFFERS
, ATTRIB_TYPE_INTEGER
,
187 ATTRIB_CRITERION_ATLEAST
,
189 { EGL_SAMPLES
, ATTRIB_TYPE_INTEGER
,
190 ATTRIB_CRITERION_ATLEAST
,
192 { EGL_STENCIL_SIZE
, ATTRIB_TYPE_INTEGER
,
193 ATTRIB_CRITERION_ATLEAST
,
195 { EGL_SURFACE_TYPE
, ATTRIB_TYPE_BITMASK
,
196 ATTRIB_CRITERION_MASK
,
198 { EGL_TRANSPARENT_TYPE
, ATTRIB_TYPE_ENUM
,
199 ATTRIB_CRITERION_EXACT
,
201 { EGL_TRANSPARENT_RED_VALUE
, ATTRIB_TYPE_INTEGER
,
202 ATTRIB_CRITERION_EXACT
,
204 { EGL_TRANSPARENT_GREEN_VALUE
, ATTRIB_TYPE_INTEGER
,
205 ATTRIB_CRITERION_EXACT
,
207 { EGL_TRANSPARENT_BLUE_VALUE
, ATTRIB_TYPE_INTEGER
,
208 ATTRIB_CRITERION_EXACT
,
210 { EGL_MATCH_NATIVE_PIXMAP
, ATTRIB_TYPE_PSEUDO
,
211 ATTRIB_CRITERION_SPECIAL
,
214 { EGL_Y_INVERTED_NOK
, ATTRIB_TYPE_BOOLEAN
,
215 ATTRIB_CRITERION_EXACT
,
221 * Return true if a config is valid. When for_matching is true,
222 * EGL_DONT_CARE is accepted as a valid attribute value, and checks
223 * for conflicting attribute values are skipped.
225 * Note that some attributes are platform-dependent and are not
229 _eglValidateConfig(const _EGLConfig
*conf
, EGLBoolean for_matching
)
232 EGLBoolean valid
= EGL_TRUE
;
234 /* check attributes by their types */
235 for (i
= 0; i
< ARRAY_SIZE(_eglValidationTable
); i
++) {
238 attr
= _eglValidationTable
[i
].attr
;
239 val
= _eglGetConfigKey(conf
, attr
);
241 switch (_eglValidationTable
[i
].type
) {
242 case ATTRIB_TYPE_INTEGER
:
245 /* config id must be positive */
249 case EGL_SAMPLE_BUFFERS
:
250 /* there can be at most 1 sample buffer */
251 if (val
> 1 || val
< 0)
260 case ATTRIB_TYPE_BOOLEAN
:
261 if (val
!= EGL_TRUE
&& val
!= EGL_FALSE
)
264 case ATTRIB_TYPE_ENUM
:
266 case EGL_CONFIG_CAVEAT
:
267 if (val
!= EGL_NONE
&& val
!= EGL_SLOW_CONFIG
&&
268 val
!= EGL_NON_CONFORMANT_CONFIG
)
271 case EGL_TRANSPARENT_TYPE
:
272 if (val
!= EGL_NONE
&& val
!= EGL_TRANSPARENT_RGB
)
275 case EGL_COLOR_BUFFER_TYPE
:
276 if (val
!= EGL_RGB_BUFFER
&& val
!= EGL_LUMINANCE_BUFFER
)
284 case ATTRIB_TYPE_BITMASK
:
286 case EGL_SURFACE_TYPE
:
287 mask
= EGL_PBUFFER_BIT
|
290 EGL_VG_COLORSPACE_LINEAR_BIT
|
291 EGL_VG_ALPHA_FORMAT_PRE_BIT
|
292 EGL_MULTISAMPLE_RESOLVE_BOX_BIT
|
293 EGL_SWAP_BEHAVIOR_PRESERVED_BIT
;
294 #ifdef EGL_MESA_screen_surface
295 if (conf
->Display
->Extensions
.MESA_screen_surface
)
296 mask
|= EGL_SCREEN_BIT_MESA
;
299 case EGL_RENDERABLE_TYPE
:
301 mask
= EGL_OPENGL_ES_BIT
|
313 case ATTRIB_TYPE_PLATFORM
:
314 /* unable to check platform-dependent attributes here */
316 case ATTRIB_TYPE_PSEUDO
:
317 /* pseudo attributes should not be set */
326 if (!valid
&& for_matching
) {
327 /* accept EGL_DONT_CARE as a valid value */
328 if (val
== EGL_DONT_CARE
)
330 if (_eglValidationTable
[i
].criterion
== ATTRIB_CRITERION_SPECIAL
)
335 "attribute 0x%04x has an invalid value 0x%x", attr
, val
);
340 /* any invalid attribute value should have been catched */
341 if (!valid
|| for_matching
)
344 /* now check for conflicting attribute values */
346 switch (conf
->ColorBufferType
) {
348 if (conf
->LuminanceSize
)
350 if (conf
->RedSize
+ conf
->GreenSize
+
351 conf
->BlueSize
+ conf
->AlphaSize
!= conf
->BufferSize
)
354 case EGL_LUMINANCE_BUFFER
:
355 if (conf
->RedSize
|| conf
->GreenSize
|| conf
->BlueSize
)
357 if (conf
->LuminanceSize
+ conf
->AlphaSize
!= conf
->BufferSize
)
362 _eglLog(_EGL_DEBUG
, "conflicting color buffer type and channel sizes");
366 if (!conf
->SampleBuffers
&& conf
->Samples
)
369 _eglLog(_EGL_DEBUG
, "conflicting samples and sample buffers");
373 if (!(conf
->SurfaceType
& EGL_WINDOW_BIT
)) {
374 if (conf
->NativeVisualID
!= 0 || conf
->NativeVisualType
!= EGL_NONE
)
377 if (!(conf
->SurfaceType
& EGL_PBUFFER_BIT
)) {
378 if (conf
->BindToTextureRGB
|| conf
->BindToTextureRGBA
)
382 _eglLog(_EGL_DEBUG
, "conflicting surface type and native visual/texture binding");
391 * Return true if a config matches the criteria. This and
392 * _eglParseConfigAttribList together implement the algorithm
393 * described in "Selection of EGLConfigs".
395 * Note that attributes that are special (currently, only
396 * EGL_MATCH_NATIVE_PIXMAP) are ignored.
399 _eglMatchConfig(const _EGLConfig
*conf
, const _EGLConfig
*criteria
)
402 EGLBoolean matched
= EGL_TRUE
;
404 for (i
= 0; i
< ARRAY_SIZE(_eglValidationTable
); i
++) {
406 if (_eglValidationTable
[i
].criterion
== ATTRIB_CRITERION_IGNORE
)
409 attr
= _eglValidationTable
[i
].attr
;
410 cmp
= _eglGetConfigKey(criteria
, attr
);
411 if (cmp
== EGL_DONT_CARE
)
414 val
= _eglGetConfigKey(conf
, attr
);
415 switch (_eglValidationTable
[i
].criterion
) {
416 case ATTRIB_CRITERION_EXACT
:
420 case ATTRIB_CRITERION_ATLEAST
:
424 case ATTRIB_CRITERION_MASK
:
425 if ((val
& cmp
) != cmp
)
428 case ATTRIB_CRITERION_SPECIAL
:
438 /* only print the common errors when DEBUG is not defined */
439 if (attr
!= EGL_RENDERABLE_TYPE
)
443 "the value (0x%x) of attribute 0x%04x did not meet the criteria (0x%x)",
452 static INLINE EGLBoolean
453 _eglIsConfigAttribValid(_EGLConfig
*conf
, EGLint attr
)
455 if (_eglOffsetOfConfig(attr
) < 0)
459 case EGL_MATCH_NATIVE_PIXMAP
:
461 case EGL_Y_INVERTED_NOK
:
462 return conf
->Display
->Extensions
.NOK_texture_from_pixmap
;
471 * Initialize a criteria config from the given attribute list.
472 * Return EGL_FALSE if any of the attribute is invalid.
475 _eglParseConfigAttribList(_EGLConfig
*conf
, _EGLDisplay
*dpy
,
476 const EGLint
*attrib_list
)
480 _eglInitConfig(conf
, dpy
, EGL_DONT_CARE
);
482 /* reset to default values */
483 for (i
= 0; i
< ARRAY_SIZE(_eglValidationTable
); i
++) {
484 attr
= _eglValidationTable
[i
].attr
;
485 val
= _eglValidationTable
[i
].default_value
;
486 _eglSetConfigKey(conf
, attr
, val
);
490 for (i
= 0; attrib_list
&& attrib_list
[i
] != EGL_NONE
; i
+= 2) {
491 attr
= attrib_list
[i
];
492 val
= attrib_list
[i
+ 1];
494 if (!_eglIsConfigAttribValid(conf
, attr
))
497 _eglSetConfigKey(conf
, attr
, val
);
500 if (!_eglValidateConfig(conf
, EGL_TRUE
))
503 /* the spec says that EGL_LEVEL cannot be EGL_DONT_CARE */
504 if (conf
->Level
== EGL_DONT_CARE
)
507 /* ignore other attributes when EGL_CONFIG_ID is given */
508 if (conf
->ConfigID
!= EGL_DONT_CARE
) {
509 for (i
= 0; i
< ARRAY_SIZE(_eglValidationTable
); i
++) {
510 attr
= _eglValidationTable
[i
].attr
;
511 if (attr
!= EGL_CONFIG_ID
)
512 _eglSetConfigKey(conf
, attr
, EGL_DONT_CARE
);
516 if (!(conf
->SurfaceType
& EGL_WINDOW_BIT
))
517 conf
->NativeVisualType
= EGL_DONT_CARE
;
519 if (conf
->TransparentType
== EGL_NONE
) {
520 conf
->TransparentRedValue
= EGL_DONT_CARE
;
521 conf
->TransparentGreenValue
= EGL_DONT_CARE
;
522 conf
->TransparentBlueValue
= EGL_DONT_CARE
;
531 * Decide the ordering of conf1 and conf2, under the given criteria.
532 * When compare_id is true, this implements the algorithm described
533 * in "Sorting of EGLConfigs". When compare_id is false,
534 * EGL_CONFIG_ID is not compared.
536 * It returns a negative integer if conf1 is considered to come
537 * before conf2; a positive integer if conf2 is considered to come
538 * before conf1; zero if the ordering cannot be decided.
540 * Note that EGL_NATIVE_VISUAL_TYPE is platform-dependent and is
544 _eglCompareConfigs(const _EGLConfig
*conf1
, const _EGLConfig
*conf2
,
545 const _EGLConfig
*criteria
, EGLBoolean compare_id
)
547 const EGLint compare_attribs
[] = {
561 /* the enum values have the desired ordering */
562 assert(EGL_NONE
< EGL_SLOW_CONFIG
);
563 assert(EGL_SLOW_CONFIG
< EGL_NON_CONFORMANT_CONFIG
);
564 val1
= conf1
->ConfigCaveat
- conf2
->ConfigCaveat
;
568 /* the enum values have the desired ordering */
569 assert(EGL_RGB_BUFFER
< EGL_LUMINANCE_BUFFER
);
570 val1
= conf1
->ColorBufferType
- conf2
->ColorBufferType
;
576 if (conf1
->ColorBufferType
== EGL_RGB_BUFFER
) {
577 if (criteria
->RedSize
> 0) {
578 val1
+= conf1
->RedSize
;
579 val2
+= conf2
->RedSize
;
581 if (criteria
->GreenSize
> 0) {
582 val1
+= conf1
->GreenSize
;
583 val2
+= conf2
->GreenSize
;
585 if (criteria
->BlueSize
> 0) {
586 val1
+= conf1
->BlueSize
;
587 val2
+= conf2
->BlueSize
;
591 if (criteria
->LuminanceSize
> 0) {
592 val1
+= conf1
->LuminanceSize
;
593 val2
+= conf2
->LuminanceSize
;
596 if (criteria
->AlphaSize
> 0) {
597 val1
+= conf1
->AlphaSize
;
598 val2
+= conf2
->AlphaSize
;
602 /* assume the default criteria, which gives no specific ordering */
606 /* for color bits, larger one is preferred */
608 return (val2
- val1
);
610 for (i
= 0; i
< ARRAY_SIZE(compare_attribs
); i
++) {
611 val1
= _eglGetConfigKey(conf1
, compare_attribs
[i
]);
612 val2
= _eglGetConfigKey(conf2
, compare_attribs
[i
]);
614 return (val1
- val2
);
617 /* EGL_NATIVE_VISUAL_TYPE cannot be compared here */
619 return (compare_id
) ? (conf1
->ConfigID
- conf2
->ConfigID
) : 0;
624 void _eglSwapConfigs(const _EGLConfig
**conf1
, const _EGLConfig
**conf2
)
626 const _EGLConfig
*tmp
= *conf1
;
633 * Quick sort an array of configs. This differs from the standard
634 * qsort() in that the compare function accepts an additional
638 _eglSortConfigs(const _EGLConfig
**configs
, EGLint count
,
639 EGLint (*compare
)(const _EGLConfig
*, const _EGLConfig
*,
643 const EGLint pivot
= 0;
649 _eglSwapConfigs(&configs
[pivot
], &configs
[count
/ 2]);
653 while (i
< count
&& compare(configs
[i
], configs
[pivot
], priv_data
) < 0)
655 while (compare(configs
[j
], configs
[pivot
], priv_data
) > 0)
658 _eglSwapConfigs(&configs
[i
], &configs
[j
]);
668 _eglSwapConfigs(&configs
[pivot
], &configs
[j
]);
670 _eglSortConfigs(configs
, j
, compare
, priv_data
);
671 _eglSortConfigs(configs
+ i
, count
- i
, compare
, priv_data
);
676 _eglFallbackCompare(const _EGLConfig
*conf1
, const _EGLConfig
*conf2
,
679 const _EGLConfig
*criteria
= (const _EGLConfig
*) priv_data
;
680 return _eglCompareConfigs(conf1
, conf2
, criteria
, EGL_TRUE
);
685 * Typical fallback routine for eglChooseConfig
688 _eglChooseConfig(_EGLDriver
*drv
, _EGLDisplay
*disp
, const EGLint
*attrib_list
,
689 EGLConfig
*configs
, EGLint config_size
, EGLint
*num_configs
)
691 _EGLConfig
**configList
, criteria
;
695 return _eglError(EGL_BAD_PARAMETER
, "eglChooseConfigs");
697 if (!_eglParseConfigAttribList(&criteria
, disp
, attrib_list
))
698 return _eglError(EGL_BAD_ATTRIBUTE
, "eglChooseConfig");
700 configList
= (_EGLConfig
**) _eglFilterArray(disp
->Configs
, &count
,
701 (_EGLArrayForEach
) _eglMatchConfig
, (void *) &criteria
);
703 return _eglError(EGL_BAD_ALLOC
, "eglChooseConfig(out of memory)");
705 /* perform sorting of configs */
706 if (configs
&& count
) {
707 _eglSortConfigs((const _EGLConfig
**) configList
, count
,
708 _eglFallbackCompare
, (void *) &criteria
);
709 count
= MIN2(count
, config_size
);
710 for (i
= 0; i
< count
; i
++)
711 configs
[i
] = _eglGetConfigHandle(configList
[i
]);
716 *num_configs
= count
;
723 * Fallback for eglGetConfigAttrib.
726 _eglGetConfigAttrib(_EGLDriver
*drv
, _EGLDisplay
*dpy
, _EGLConfig
*conf
,
727 EGLint attribute
, EGLint
*value
)
729 if (!_eglIsConfigAttribValid(conf
, attribute
))
730 return _eglError(EGL_BAD_ATTRIBUTE
, "eglGetConfigAttrib");
732 return _eglError(EGL_BAD_PARAMETER
, "eglGetConfigAttrib");
734 *value
= _eglGetConfigKey(conf
, attribute
);
740 _eglFlattenConfig(void *elem
, void *buffer
)
742 _EGLConfig
*conf
= (_EGLConfig
*) elem
;
743 EGLConfig
*handle
= (EGLConfig
*) buffer
;
744 *handle
= _eglGetConfigHandle(conf
);
749 * Fallback for eglGetConfigs.
752 _eglGetConfigs(_EGLDriver
*drv
, _EGLDisplay
*disp
, EGLConfig
*configs
,
753 EGLint config_size
, EGLint
*num_config
)
756 return _eglError(EGL_BAD_PARAMETER
, "eglGetConfigs");
758 *num_config
= _eglFlattenArray(disp
->Configs
, (void *) configs
,
759 sizeof(configs
[0]), config_size
, _eglFlattenConfig
);