1<?xml version="1.0" encoding="UTF-8"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> 3<!-- saved from url=(0013)about:internet --> 4<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> 5 <head> 6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 7 <style xmlns="" type="text/css"> 8 /* This style sets a margin around the entire page */ 9 html, body { 10 margin: 10px; 11 } 12 13 p { 14 font: normal 16px verdana, sans-serif; 15 margin: 0; 16 padding-bottom:12px; 17 } 18 19 h1 { 20 font: bold 25px verdana, sans-serif; 21 margin-top: 0; 22 margin-bottom: 3px; 23 padding-top: 0; 24 padding-bottom: 0; 25 } 26 27 h2 { 28 font: bold 19px verdana, sans-serif; 29 margin-top: 28px; 30 margin-bottom: 3px; 31 padding-top: 0; 32 padding-bottom: 0; 33 } 34 35 h3 { 36 font: bold 19px verdana, sans-serif !important; 37 margin-top: 28px; 38 margin-bottom: 3px; 39 padding-top: 0; 40 padding-bottom: 0; 41 } 42 43 li { 44 font: normal 16px verdana, sans-serif; 45 margin-top: 0; 46 margin-bottom: 18px; 47 padding-top: 0; 48 padding-bottom: 0; 49 } 50 51 .pdparam { 52 font: italic 16px verdana, sans-serif; 53 } 54 55 .term { 56 font: italic 16px verdana, sans-serif; 57 font-weight: normal; 58 } 59 60 .type { 61 font: normal 16px verdana, sans-serif !important; 62 } 63 64 .parameter { 65 font-style: italic; 66 } 67 68 a:link, a:visited { 69 color: blue; 70 text-decoration: none; 71 font: normal 16px; 72 } 73 74 a:hover { 75 background-color: #FFFF99; 76 font: normal 16px; 77 } 78 79 div.funcsynopsis { 80 text-align: left; 81 background-color: #e6e6e6; 82 font: normal 16px verdana, sans-serif; 83 padding-top: 10px; 84 padding-bottom: 10px; 85 } 86 87 div.funcsynopsis table { 88 border-collapse: separate; 89 font: normal 16px verdana, sans-serif; 90 } 91 92 div.funcsynopsis td { 93 background-color: #e6e6e6; 94 border: 0 solid #000; 95 padding: 1px; 96 font: normal 16px verdana, sans-serif; 97 } 98 99 div.refsect1 { 100 font-family: verdana, sans-serif; 101 font-size: 16px; 102 } 103 104 code.constant { 105 font: normal 16px courier new, monospace !important; 106 } 107 108 span.errorname { 109 font: normal 16px verdana, sans-serif !important; 110 } 111 112 code.function { 113 font: bold 16px verdana, sans-serif !important; 114 } 115 116 b.fsfunc { 117 font: bold 16px verdana, sans-serif !important; 118 } 119 120 code.varname { 121 font: italic 16px verdana, sans-serif; 122 } 123 124 code.replaceable { 125 font: italic 16px courier new, monospace; 126 } 127 128 code.funcdef { 129 font: normal 16px verdana, sans-serif !important; 130 } 131 132 .citerefentry { 133 font: normal 16px verdana, sans-serif !important; 134 } 135 136 .parameter { 137 font-style: italic; 138 } 139 140 code.fsfunc { 141 font: normal 16px verdana, sans-serif !important; 142 } 143 144 /* PARAMETER: This style controls spacing between the terms in Parameter section */ 145 dt { 146 margin-top: 15px; 147 } 148 149 /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ 150 div.refsect1 table { 151 width: 100%; 152 margin-top: 10px; 153 background-color: #FFF; 154 border-collapse: collapse; 155 border-color: #000; 156 border-width: 1px; 157 font: normal 16px verdana, sans-serif; 158 } 159 160 div.refsect1 th { 161 border-collapse: collapse; 162 border-color: #000; 163 border-width: 1px; 164 font: bold 16px verdana, sans-serif; 165 } 166 167 div.refsect1 td { 168 background-color: #FFF; 169 padding: 5px; 170 vertical-align: text-top; 171 border-collapse: collapse; 172 border-color: #000; 173 border-width: 1px; 174 font: normal 16px verdana, sans-serif; 175 } 176 177 div.refsect1 p{ 178 font: normal 16px verdana, sans-serif; 179 margin-top: 8px; 180 margin-bottom: 8px; 181 padding-top: 0; 182 padding-bottom: 0; 183 } 184 185 186 /* EXAMPLE: These styles apply only to the Example section */ 187 div.refsect2 { 188 font: normal 16px courier new, monospace !important; 189 } 190 191 div.refsect2 table { 192 margin-top: 0; 193 background-color: #e6e6e6; 194 width: 100%; 195 border: 0 solid #000; 196 padding: 2px; 197 font: normal 16px courier new, monospace !important; 198 } 199 200 div.refsect2 td { 201 background-color: #e6e6e6; 202 font: normal 16px courier new, monospace !important; 203 white-space:pre; 204 } 205 206 /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ 207 div.refsect3 { 208 font: normal 11px verdana, sans-serif; 209 margin-top: 50px; 210 margin-bottom: 20px; 211 padding-top: 0; 212 padding-bottom: 0; 213 } 214 215</style> 216 <title>eglGetConfigAttrib</title> 217 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> 218 </head> 219 <body> 220 <div class="refentry"> 221 <a id="eglGetConfigAttrib"></a> 222 <div class="titlepage"></div> 223 <div xmlns="" class="refnamediv"> 224 <h1>eglGetConfigAttrib</h1> 225 <p> 226 return information about an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> frame buffer 227 configuration 228 </p> 229 </div> 230 <div class="refsynopsisdiv"> 231 <h2>C Specification</h2> 232 <div class="funcsynopsis"> 233 <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> 234 <tr valign="bottom"> 235 <td> 236 <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigAttrib</strong>(</code> 237 <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> 238 </td> 239 </tr> 240 <tr valign="top"> 241 <td> </td> 242 <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> 243 </tr> 244 <tr valign="top"> 245 <td> </td> 246 <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td> 247 </tr> 248 <tr valign="top"> 249 <td> </td> 250 <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td> 251 </tr> 252 </table> 253 </div> 254 </div> 255 <div class="refsect1"> 256 <a id="parameters"></a> 257 <h2>Parameters</h2> 258 <div class="variablelist"> 259 <dl class="variablelist"> 260 <dt> 261 <span class="term"> 262 <em class="parameter"> 263 <code>display</code> 264 </em> 265 </span> 266 </dt> 267 <dd> 268 <p>Specifies the EGL display connection.</p> 269 </dd> 270 <dt> 271 <span class="term"> 272 <em class="parameter"> 273 <code>config</code> 274 </em> 275 </span> 276 </dt> 277 <dd> 278 <p>Specifies the EGL frame buffer configuration to be 279 queried. 280 </p> 281 </dd> 282 <dt> 283 <span class="term"> 284 <em class="parameter"> 285 <code>attribute</code> 286 </em> 287 </span> 288 </dt> 289 <dd> 290 <p>Specifies the EGL rendering context attribute to be 291 returned.</p> 292 </dd> 293 <dt> 294 <span class="term"> 295 <em class="parameter"> 296 <code>value</code> 297 </em> 298 </span> 299 </dt> 300 <dd> 301 <p>Returns the requested value.</p> 302 </dd> 303 </dl> 304 </div> 305 </div> 306 <div class="refsect1"> 307 <a id="description"></a> 308 <h2>Description</h2> 309 <p> 310 <code class="function">eglGetConfigAttrib</code> returns in 311 <em class="parameter"><code>value</code></em> the value of 312 <em class="parameter"><code>attribute</code></em> for 313 <em class="parameter"><code>config</code></em> 314 (config attributes are described in more detail in the 315 <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> 316 reference page). 317 <em class="parameter"><code>attribute</code></em> can be one of the following: 318 </p> 319 <div class="variablelist"> 320 <dl class="variablelist"> 321 <dt> 322 <span class="term"> 323 <code class="constant">EGL_ALPHA_SIZE</code> 324 </span> 325 </dt> 326 <dd> 327 <p>Returns the number of bits of alpha stored in the 328 color buffer. 329 </p> 330 </dd> 331 <dt> 332 <span class="term"> 333 <code class="constant">EGL_ALPHA_MASK_SIZE</code> 334 </span> 335 </dt> 336 <dd> 337 <p> 338 Returns the number of bits in the alpha mask buffer. 339 </p> 340 </dd> 341 <dt> 342 <span class="term"> 343 <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> 344 </span> 345 </dt> 346 <dd> 347 <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be 348 bound to an RGB texture, 349 <code class="constant">EGL_FALSE</code> otherwise. 350 </p> 351 </dd> 352 <dt> 353 <span class="term"> 354 <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> 355 </span> 356 </dt> 357 <dd> 358 <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be 359 bound to an RGBA texture, 360 <code class="constant">EGL_FALSE</code> otherwise. 361 </p> 362 </dd> 363 <dt> 364 <span class="term"> 365 <code class="constant">EGL_BLUE_SIZE</code> 366 </span> 367 </dt> 368 <dd> 369 <p>Returns the number of bits of blue stored in the 370 color buffer. 371 </p> 372 </dd> 373 <dt> 374 <span class="term"> 375 <code class="constant">EGL_BUFFER_SIZE</code> 376 </span> 377 </dt> 378 <dd> 379 <p>Returns the depth of the color buffer. 380 It is the sum of 381 <code class="constant">EGL_RED_SIZE</code>, 382 <code class="constant">EGL_GREEN_SIZE</code>, 383 <code class="constant">EGL_BLUE_SIZE</code>, and 384 <code class="constant">EGL_ALPHA_SIZE</code>. 385 </p> 386 </dd> 387 <dt> 388 <span class="term"> 389 <code class="constant">EGL_COLOR_BUFFER_TYPE</code> 390 </span> 391 </dt> 392 <dd> 393 <p> 394 Returns the color buffer type. Possible types are 395 <code class="constant">EGL_RGB_BUFFER</code> and 396 <code class="constant">EGL_LUMINANCE_BUFFER</code>. 397 </p> 398 </dd> 399 <dt> 400 <span class="term"> 401 <code class="constant">EGL_CONFIG_CAVEAT</code> 402 </span> 403 </dt> 404 <dd> 405 <p>Returns the caveats for the frame buffer configuration. 406 Possible caveat values are 407 <code class="constant">EGL_NONE</code>, 408 <code class="constant">EGL_SLOW_CONFIG</code>, and 409 <code class="constant">EGL_NON_CONFORMANT</code>. 410 </p> 411 </dd> 412 <dt> 413 <span class="term"> 414 <code class="constant">EGL_CONFIG_ID</code> 415 </span> 416 </dt> 417 <dd> 418 <p>Returns the ID of the frame buffer configuration. 419 </p> 420 </dd> 421 <dt> 422 <span class="term"> 423 <code class="constant">EGL_CONFORMANT</code> 424 </span> 425 </dt> 426 <dd> 427 <p> 428 Returns a bitmask indicating which client API contexts 429 created with respect to this config are conformant. 430 </p> 431 </dd> 432 <dt> 433 <span class="term"> 434 <code class="constant">EGL_DEPTH_SIZE</code> 435 </span> 436 </dt> 437 <dd> 438 <p>Returns the number of bits in the depth buffer. 439 </p> 440 </dd> 441 <dt> 442 <span class="term"> 443 <code class="constant">EGL_GREEN_SIZE</code> 444 </span> 445 </dt> 446 <dd> 447 <p>Returns the number of bits of green stored in the 448 color buffer. 449 </p> 450 </dd> 451 <dt> 452 <span class="term"> 453 <code class="constant">EGL_LEVEL</code> 454 </span> 455 </dt> 456 <dd> 457 <p>Returns the frame buffer level. 458 Level zero is the default frame buffer. 459 Positive levels correspond to frame buffers that overlay the default 460 buffer and negative levels correspond to frame buffers that underlay 461 the default buffer. 462 </p> 463 </dd> 464 <dt> 465 <span class="term"> 466 <code class="constant">EGL_LUMINANCE_SIZE</code> 467 </span> 468 </dt> 469 <dd> 470 <p> 471 Returns the number of bits of luminance stored in the luminance buffer. 472 </p> 473 </dd> 474 <dt> 475 <span class="term"> 476 <code class="constant">EGL_MAX_PBUFFER_WIDTH</code> 477 </span> 478 </dt> 479 <dd> 480 <p>Returns the maximum width of a pixel buffer surface in pixels. 481 </p> 482 </dd> 483 <dt> 484 <span class="term"> 485 <code class="constant">EGL_MAX_PBUFFER_HEIGHT</code> 486 </span> 487 </dt> 488 <dd> 489 <p>Returns the maximum height of a pixel buffer surface in pixels. 490 </p> 491 </dd> 492 <dt> 493 <span class="term"> 494 <code class="constant">EGL_MAX_PBUFFER_PIXELS</code> 495 </span> 496 </dt> 497 <dd> 498 <p>Returns the maximum size of a pixel buffer surface in pixels. 499 </p> 500 </dd> 501 <dt> 502 <span class="term"> 503 <code class="constant">EGL_MAX_SWAP_INTERVAL</code> 504 </span> 505 </dt> 506 <dd> 507 <p>Returns the maximum value that can be passed to eglSwapInterval. 508 </p> 509 </dd> 510 <dt> 511 <span class="term"> 512 <code class="constant">EGL_MIN_SWAP_INTERVAL</code> 513 </span> 514 </dt> 515 <dd> 516 <p>Returns the minimum value that can be passed to eglSwapInterval. 517 </p> 518 </dd> 519 <dt> 520 <span class="term"> 521 <code class="constant">EGL_NATIVE_RENDERABLE</code> 522 </span> 523 </dt> 524 <dd> 525 <p>Returns <code class="constant">EGL_TRUE</code> if native rendering 526 APIs can render into the surface, 527 <code class="constant">EGL_FALSE</code> otherwise. 528 </p> 529 </dd> 530 <dt> 531 <span class="term"> 532 <code class="constant">EGL_NATIVE_VISUAL_ID</code> 533 </span> 534 </dt> 535 <dd> 536 <p>Returns the ID of the associated native visual. 537 </p> 538 </dd> 539 <dt> 540 <span class="term"> 541 <code class="constant">EGL_NATIVE_VISUAL_TYPE</code> 542 </span> 543 </dt> 544 <dd> 545 <p>Returns the type of the associated native visual. 546 </p> 547 </dd> 548 <dt> 549 <span class="term"> 550 <code class="constant">EGL_RED_SIZE</code> 551 </span> 552 </dt> 553 <dd> 554 <p>Returns the number of bits of red stored in the 555 color buffer. 556 </p> 557 </dd> 558 <dt> 559 <span class="term"> 560 <code class="constant">EGL_RENDERABLE_TYPE</code> 561 </span> 562 </dt> 563 <dd> 564 <p> 565 Returns a bitmask indicating the types of supported 566 client API contexts. 567 </p> 568 </dd> 569 <dt> 570 <span class="term"> 571 <code class="constant">EGL_SAMPLE_BUFFERS</code> 572 </span> 573 </dt> 574 <dd> 575 <p>Returns the number of multisample buffers. 576 </p> 577 </dd> 578 <dt> 579 <span class="term"> 580 <code class="constant">EGL_SAMPLES</code> 581 </span> 582 </dt> 583 <dd> 584 <p>Returns the number of samples per pixel.</p> 585 </dd> 586 <dt> 587 <span class="term"> 588 <code class="constant">EGL_STENCIL_SIZE</code> 589 </span> 590 </dt> 591 <dd> 592 <p>Returns the number of bits in the stencil buffer. 593 </p> 594 </dd> 595 <dt> 596 <span class="term"> 597 <code class="constant">EGL_SURFACE_TYPE</code> 598 </span> 599 </dt> 600 <dd> 601 <p> 602 Returns a bitmask indicating the types of supported EGL 603 surfaces. 604 </p> 605 </dd> 606 <dt> 607 <span class="term"> 608 <code class="constant">EGL_TRANSPARENT_TYPE</code> 609 </span> 610 </dt> 611 <dd> 612 <p>Returns the type of supported transparency. 613 Possible transparency values are: 614 <code class="constant">EGL_NONE</code>, and 615 <code class="constant">EGL_TRANSPARENT_RGB</code>. 616 </p> 617 </dd> 618 <dt> 619 <span class="term"> 620 <code class="constant">EGL_TRANSPARENT_RED_VALUE</code> 621 </span> 622 </dt> 623 <dd> 624 <p>Returns the transparent red value.</p> 625 </dd> 626 <dt> 627 <span class="term"> 628 <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code> 629 </span> 630 </dt> 631 <dd> 632 <p>Returns the transparent green value.</p> 633 </dd> 634 <dt> 635 <span class="term"> 636 <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code> 637 </span> 638 </dt> 639 <dd> 640 <p>Returns the transparent blue value.</p> 641 </dd> 642 </dl> 643 </div> 644 </div> 645 <div class="refsect1"> 646 <a id="notes"></a> 647 <h2>Notes</h2> 648 <p> 649 <code class="constant">EGL_CONFORMANT</code> is supported only if the 650 EGL version is 1.3 or greater. 651 </p> 652 <p> 653 <code class="constant">EGL_ALPHA_MASK_SIZE</code>, 654 <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, 655 <code class="constant">EGL_LUMINANCE_SIZE</code>, and 656 <code class="constant">EGL_RENDERABLE_TYPE</code> are supported only 657 if the EGL version is 1.2 or greater. 658 </p> 659 <p> 660 While <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> can be 661 specified in the attribute list passed to 662 <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, 663 it is not an attribute of the resulting config and cannot be 664 queried using <code class="function">eglGetConfigAttrib</code>. 665 </p> 666 </div> 667 <div class="refsect1"> 668 <a id="errors"></a> 669 <h2>Errors</h2> 670 <p> 671 <code class="constant">EGL_FALSE</code> is returned on failure, 672 <code class="constant">EGL_TRUE</code> otherwise. 673 <em class="parameter"><code>value</code></em> is not modified when 674 <code class="constant">EGL_FALSE</code> is returned. 675 </p> 676 <p> 677 <code class="constant">EGL_BAD_DISPLAY</code> is generated if 678 <em class="parameter"><code>display</code></em> is not an EGL display connection. 679 </p> 680 <p> 681 <code class="constant">EGL_NOT_INITIALIZED</code> is generated if 682 <em class="parameter"><code>display</code></em> has not been initialized. 683 </p> 684 <p> 685 <code class="constant">EGL_BAD_CONFIG</code> is generated if 686 <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. 687 </p> 688 <p> 689 <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if 690 <em class="parameter"><code>attribute</code></em> is not a valid frame buffer 691 configuration attribute. 692 </p> 693 </div> 694 <div class="refsect1"> 695 <a id="seealso"></a> 696 <h2>See Also</h2> 697 <p> 698 <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, 699 <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> 700 </p> 701 </div> 702 <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> 703Copyright © 2003-2014 The Khronos Group Inc. 704Permission is hereby granted, free of charge, to any person obtaining a 705copy of this software and/or associated documentation files (the 706"Materials"), to deal in the Materials without restriction, including 707without limitation the rights to use, copy, modify, merge, publish, 708distribute, sublicense, and/or sell copies of the Materials, and to 709permit persons to whom the Materials are furnished to do so, subject to 710the condition that this copyright notice and permission notice shall be included 711in all copies or substantial portions of the Materials. 712</div> 713 </div> 714 </body> 715</html> 716
