1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetConfigAttrib - EGL Reference Pages</title> 5 <link rel="stylesheet" type="text/css" href="khronos-man.css"/> 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> 7 </head> 8 <body> 9 <header/> 10 <div class="refentry" id="eglGetConfigAttrib"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglGetConfigAttrib — 15 return information about an <abbr class="acronym">EGL</abbr> frame buffer 16 configuration 17 </p> 18 </div> 19 <div class="refsynopsisdiv"> 20 <h2>C Specification</h2> 21 <div class="funcsynopsis"> 22 <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> 23 <tr> 24 <td> 25 <code class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigAttrib</strong>(</code> 26 </td> 27 <td>EGLDisplay <var class="pdparam">display</var>, </td> 28 </tr> 29 <tr> 30 <td> </td> 31 <td>EGLConfig <var class="pdparam">config</var>, </td> 32 </tr> 33 <tr> 34 <td> </td> 35 <td>EGLint <var class="pdparam">attribute</var>, </td> 36 </tr> 37 <tr> 38 <td> </td> 39 <td>EGLint * <var class="pdparam">value</var><code>)</code>;</td> 40 </tr> 41 </table> 42 <div class="funcprototype-spacer"> </div> 43 </div> 44 </div> 45 <div class="refsect1" id="parameters"> 46 <h2>Parameters</h2> 47 <div class="variablelist"> 48 <dl class="variablelist"> 49 <dt> 50 <span class="term"> 51 <em class="parameter"> 52 <code>display</code> 53 </em> 54 </span> 55 </dt> 56 <dd> 57 <p>Specifies the EGL display connection.</p> 58 </dd> 59 <dt> 60 <span class="term"> 61 <em class="parameter"> 62 <code>config</code> 63 </em> 64 </span> 65 </dt> 66 <dd> 67 <p>Specifies the EGL frame buffer configuration to be 68 queried. 69 </p> 70 </dd> 71 <dt> 72 <span class="term"> 73 <em class="parameter"> 74 <code>attribute</code> 75 </em> 76 </span> 77 </dt> 78 <dd> 79 <p>Specifies the EGL rendering context attribute to be 80 returned.</p> 81 </dd> 82 <dt> 83 <span class="term"> 84 <em class="parameter"> 85 <code>value</code> 86 </em> 87 </span> 88 </dt> 89 <dd> 90 <p>Returns the requested value.</p> 91 </dd> 92 </dl> 93 </div> 94 </div> 95 <div class="refsect1" id="description"> 96 <h2>Description</h2> 97 <p> 98 <code class="function">eglGetConfigAttrib</code> returns in 99 <em class="parameter"><code>value</code></em> the value of 100 <em class="parameter"><code>attribute</code></em> for 101 <em class="parameter"><code>config</code></em> 102 (config attributes are described in more detail in the 103 <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> 104 reference page). 105 <em class="parameter"><code>attribute</code></em> can be one of the following: 106 </p> 107 <div class="variablelist"> 108 <dl class="variablelist"> 109 <dt> 110 <span class="term"> 111 <code class="constant">EGL_ALPHA_SIZE</code> 112 </span> 113 </dt> 114 <dd> 115 <p>Returns the number of bits of alpha stored in the 116 color buffer. 117 </p> 118 </dd> 119 <dt> 120 <span class="term"> 121 <code class="constant">EGL_ALPHA_MASK_SIZE</code> 122 </span> 123 </dt> 124 <dd> 125 <p> 126 Returns the number of bits in the alpha mask buffer. 127 </p> 128 </dd> 129 <dt> 130 <span class="term"> 131 <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> 132 </span> 133 </dt> 134 <dd> 135 <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be 136 bound to an RGB texture, 137 <code class="constant">EGL_FALSE</code> otherwise. 138 </p> 139 </dd> 140 <dt> 141 <span class="term"> 142 <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> 143 </span> 144 </dt> 145 <dd> 146 <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be 147 bound to an RGBA texture, 148 <code class="constant">EGL_FALSE</code> otherwise. 149 </p> 150 </dd> 151 <dt> 152 <span class="term"> 153 <code class="constant">EGL_BLUE_SIZE</code> 154 </span> 155 </dt> 156 <dd> 157 <p>Returns the number of bits of blue stored in the 158 color buffer. 159 </p> 160 </dd> 161 <dt> 162 <span class="term"> 163 <code class="constant">EGL_BUFFER_SIZE</code> 164 </span> 165 </dt> 166 <dd> 167 <p>Returns the depth of the color buffer. 168 It is the sum of 169 <code class="constant">EGL_RED_SIZE</code>, 170 <code class="constant">EGL_GREEN_SIZE</code>, 171 <code class="constant">EGL_BLUE_SIZE</code>, and 172 <code class="constant">EGL_ALPHA_SIZE</code>. 173 </p> 174 </dd> 175 <dt> 176 <span class="term"> 177 <code class="constant">EGL_COLOR_BUFFER_TYPE</code> 178 </span> 179 </dt> 180 <dd> 181 <p> 182 Returns the color buffer type. Possible types are 183 <code class="constant">EGL_RGB_BUFFER</code> and 184 <code class="constant">EGL_LUMINANCE_BUFFER</code>. 185 </p> 186 </dd> 187 <dt> 188 <span class="term"> 189 <code class="constant">EGL_CONFIG_CAVEAT</code> 190 </span> 191 </dt> 192 <dd> 193 <p>Returns the caveats for the frame buffer configuration. 194 Possible caveat values are 195 <code class="constant">EGL_NONE</code>, 196 <code class="constant">EGL_SLOW_CONFIG</code>, and 197 <code class="constant">EGL_NON_CONFORMANT</code>. 198 </p> 199 </dd> 200 <dt> 201 <span class="term"> 202 <code class="constant">EGL_CONFIG_ID</code> 203 </span> 204 </dt> 205 <dd> 206 <p>Returns the ID of the frame buffer configuration. 207 </p> 208 </dd> 209 <dt> 210 <span class="term"> 211 <code class="constant">EGL_CONFORMANT</code> 212 </span> 213 </dt> 214 <dd> 215 <p> 216 Returns a bitmask indicating which client API contexts 217 created with respect to this config are conformant. 218 </p> 219 </dd> 220 <dt> 221 <span class="term"> 222 <code class="constant">EGL_DEPTH_SIZE</code> 223 </span> 224 </dt> 225 <dd> 226 <p>Returns the number of bits in the depth buffer. 227 </p> 228 </dd> 229 <dt> 230 <span class="term"> 231 <code class="constant">EGL_GREEN_SIZE</code> 232 </span> 233 </dt> 234 <dd> 235 <p>Returns the number of bits of green stored in the 236 color buffer. 237 </p> 238 </dd> 239 <dt> 240 <span class="term"> 241 <code class="constant">EGL_LEVEL</code> 242 </span> 243 </dt> 244 <dd> 245 <p>Returns the frame buffer level. 246 Level zero is the default frame buffer. 247 Positive levels correspond to frame buffers that overlay the default 248 buffer and negative levels correspond to frame buffers that underlay 249 the default buffer. 250 </p> 251 </dd> 252 <dt> 253 <span class="term"> 254 <code class="constant">EGL_LUMINANCE_SIZE</code> 255 </span> 256 </dt> 257 <dd> 258 <p> 259 Returns the number of bits of luminance stored in the luminance buffer. 260 </p> 261 </dd> 262 <dt> 263 <span class="term"> 264 <code class="constant">EGL_MAX_PBUFFER_WIDTH</code> 265 </span> 266 </dt> 267 <dd> 268 <p>Returns the maximum width of a pixel buffer surface in pixels. 269 </p> 270 </dd> 271 <dt> 272 <span class="term"> 273 <code class="constant">EGL_MAX_PBUFFER_HEIGHT</code> 274 </span> 275 </dt> 276 <dd> 277 <p>Returns the maximum height of a pixel buffer surface in pixels. 278 </p> 279 </dd> 280 <dt> 281 <span class="term"> 282 <code class="constant">EGL_MAX_PBUFFER_PIXELS</code> 283 </span> 284 </dt> 285 <dd> 286 <p>Returns the maximum size of a pixel buffer surface in pixels. 287 </p> 288 </dd> 289 <dt> 290 <span class="term"> 291 <code class="constant">EGL_MAX_SWAP_INTERVAL</code> 292 </span> 293 </dt> 294 <dd> 295 <p>Returns the maximum value that can be passed to eglSwapInterval. 296 </p> 297 </dd> 298 <dt> 299 <span class="term"> 300 <code class="constant">EGL_MIN_SWAP_INTERVAL</code> 301 </span> 302 </dt> 303 <dd> 304 <p>Returns the minimum value that can be passed to eglSwapInterval. 305 </p> 306 </dd> 307 <dt> 308 <span class="term"> 309 <code class="constant">EGL_NATIVE_RENDERABLE</code> 310 </span> 311 </dt> 312 <dd> 313 <p>Returns <code class="constant">EGL_TRUE</code> if native rendering 314 APIs can render into the surface, 315 <code class="constant">EGL_FALSE</code> otherwise. 316 </p> 317 </dd> 318 <dt> 319 <span class="term"> 320 <code class="constant">EGL_NATIVE_VISUAL_ID</code> 321 </span> 322 </dt> 323 <dd> 324 <p>Returns the ID of the associated native visual. 325 </p> 326 </dd> 327 <dt> 328 <span class="term"> 329 <code class="constant">EGL_NATIVE_VISUAL_TYPE</code> 330 </span> 331 </dt> 332 <dd> 333 <p>Returns the type of the associated native visual. 334 </p> 335 </dd> 336 <dt> 337 <span class="term"> 338 <code class="constant">EGL_RED_SIZE</code> 339 </span> 340 </dt> 341 <dd> 342 <p>Returns the number of bits of red stored in the 343 color buffer. 344 </p> 345 </dd> 346 <dt> 347 <span class="term"> 348 <code class="constant">EGL_RENDERABLE_TYPE</code> 349 </span> 350 </dt> 351 <dd> 352 <p> 353 Returns a bitmask indicating the types of supported 354 client API contexts. 355 </p> 356 </dd> 357 <dt> 358 <span class="term"> 359 <code class="constant">EGL_SAMPLE_BUFFERS</code> 360 </span> 361 </dt> 362 <dd> 363 <p>Returns the number of multisample buffers. 364 </p> 365 </dd> 366 <dt> 367 <span class="term"> 368 <code class="constant">EGL_SAMPLES</code> 369 </span> 370 </dt> 371 <dd> 372 <p>Returns the number of samples per pixel.</p> 373 </dd> 374 <dt> 375 <span class="term"> 376 <code class="constant">EGL_STENCIL_SIZE</code> 377 </span> 378 </dt> 379 <dd> 380 <p>Returns the number of bits in the stencil buffer. 381 </p> 382 </dd> 383 <dt> 384 <span class="term"> 385 <code class="constant">EGL_SURFACE_TYPE</code> 386 </span> 387 </dt> 388 <dd> 389 <p> 390 Returns a bitmask indicating the types of supported EGL 391 surfaces. 392 </p> 393 </dd> 394 <dt> 395 <span class="term"> 396 <code class="constant">EGL_TRANSPARENT_TYPE</code> 397 </span> 398 </dt> 399 <dd> 400 <p>Returns the type of supported transparency. 401 Possible transparency values are: 402 <code class="constant">EGL_NONE</code>, and 403 <code class="constant">EGL_TRANSPARENT_RGB</code>. 404 </p> 405 </dd> 406 <dt> 407 <span class="term"> 408 <code class="constant">EGL_TRANSPARENT_RED_VALUE</code> 409 </span> 410 </dt> 411 <dd> 412 <p>Returns the transparent red value.</p> 413 </dd> 414 <dt> 415 <span class="term"> 416 <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code> 417 </span> 418 </dt> 419 <dd> 420 <p>Returns the transparent green value.</p> 421 </dd> 422 <dt> 423 <span class="term"> 424 <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code> 425 </span> 426 </dt> 427 <dd> 428 <p>Returns the transparent blue value.</p> 429 </dd> 430 </dl> 431 </div> 432 </div> 433 <div class="refsect1" id="notes"> 434 <h2>Notes</h2> 435 <p> 436 <code class="constant">EGL_CONFORMANT</code> is supported only if the 437 EGL version is 1.3 or greater. 438 </p> 439 <p> 440 <code class="constant">EGL_ALPHA_MASK_SIZE</code>, 441 <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, 442 <code class="constant">EGL_LUMINANCE_SIZE</code>, and 443 <code class="constant">EGL_RENDERABLE_TYPE</code> are supported only 444 if the EGL version is 1.2 or greater. 445 </p> 446 <p> 447 While <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> can be 448 specified in the attribute list passed to 449 <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, 450 it is not an attribute of the resulting config and cannot be 451 queried using <code class="function">eglGetConfigAttrib</code>. 452 </p> 453 </div> 454 <div class="refsect1" id="errors"> 455 <h2>Errors</h2> 456 <p> 457 <code class="constant">EGL_FALSE</code> is returned on failure, 458 <code class="constant">EGL_TRUE</code> otherwise. 459 <em class="parameter"><code>value</code></em> is not modified when 460 <code class="constant">EGL_FALSE</code> is returned. 461 </p> 462 <p> 463 <code class="constant">EGL_BAD_DISPLAY</code> is generated if 464 <em class="parameter"><code>display</code></em> is not an EGL display connection. 465 </p> 466 <p> 467 <code class="constant">EGL_NOT_INITIALIZED</code> is generated if 468 <em class="parameter"><code>display</code></em> has not been initialized. 469 </p> 470 <p> 471 <code class="constant">EGL_BAD_CONFIG</code> is generated if 472 <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. 473 </p> 474 <p> 475 <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if 476 <em class="parameter"><code>attribute</code></em> is not a valid frame buffer 477 configuration attribute. 478 </p> 479 </div> 480 <div class="refsect1" id="seealso"> 481 <h2>See Also</h2> 482 <p> 483 <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, 484 <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> 485 </p> 486 </div> 487 <p> 488 </p> 489 <div class="refsect3" id="copyright"> 490 <img src="KhronosLogo.jpg"/> 491 <p> 492 Copyright © 2003-2014 The Khronos Group Inc. 493 Permission is hereby granted, free of charge, to any person obtaining a 494 copy of this software and/or associated documentation files (the 495 "Materials"), to deal in the Materials without restriction, including 496 without limitation the rights to use, copy, modify, merge, publish, 497 distribute, sublicense, and/or sell copies of the Materials, and to 498 permit persons to whom the Materials are furnished to do so, subject to 499 the condition that this copyright notice and permission notice shall be included 500 in all copies or substantial portions of the Materials. 501 </p> 502 </div> 503 <p> 504</p> 505 </div> 506 <footer/> 507 </body> 508</html> 509
