/usr/share/gtk-doc/html/cogl-2.0-experimental/cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html is in libcogl-doc 1.22.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CoglRenderer: Connect to a backend renderer: Cogl 2.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Cogl 2.0 Reference Manual">
<link rel="up" href="cogl-context-apis.html" title="Setting Up A Drawing Context">
<link rel="prev" href="cogl-context-apis.html" title="Setting Up A Drawing Context">
<link rel="next" href="cogl-2.0-experimental-CoglOnscreenTemplate---Describe-a-template-for-onscreen-framebuffers.html" title="CoglOnscreenTemplate: Describe a template for onscreen framebuffers">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="cogl-context-apis.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-context-apis.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="cogl-2.0-experimental-CoglOnscreenTemplate---Describe-a-template-for-onscreen-framebuffers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.top_of_page"></a>CoglRenderer: Connect to a backend renderer</span></h2>
<p>CoglRenderer: Connect to a backend renderer — Choosing a means to render</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-is-renderer" title="cogl_is_renderer ()">cogl_is_renderer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="returnvalue">CoglRenderer</span></a> *
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-new" title="cogl_renderer_new ()">cogl_renderer_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-get-n-fragment-texture-units" title="cogl_renderer_get_n_fragment_texture_units ()">cogl_renderer_get_n_fragment_texture_units</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect" title="cogl_renderer_connect ()">cogl_renderer_connect</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-set-winsys-id" title="cogl_renderer_set_winsys_id ()">cogl_renderer_set_winsys_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWinsysID" title="enum CoglWinsysID"><span class="returnvalue">CoglWinsysID</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-get-winsys-id" title="cogl_renderer_get_winsys_id ()">cogl_renderer_get_winsys_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-add-constraint" title="cogl_renderer_add_constraint ()">cogl_renderer_add_constraint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-remove-constraint" title="cogl_renderer_remove_constraint ()">cogl_renderer_remove_constraint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-xlib-renderer-set-foreign-display" title="cogl_xlib_renderer_set_foreign_display ()">cogl_xlib_renderer_set_foreign_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Display</span> *
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-xlib-renderer-get-foreign-display" title="cogl_xlib_renderer_get_foreign_display ()">cogl_xlib_renderer_get_foreign_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglXlibFilterFunc" title="CoglXlibFilterFunc ()">*CoglXlibFilterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-xlib-renderer-add-filter" title="cogl_xlib_renderer_add_filter ()">cogl_xlib_renderer_add_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-xlib-renderer-remove-filter" title="cogl_xlib_renderer_remove_filter ()">cogl_xlib_renderer_remove_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-xlib-renderer-handle-event" title="cogl_xlib_renderer_handle_event ()">cogl_xlib_renderer_handle_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWin32FilterFunc" title="CoglWin32FilterFunc ()">*CoglWin32FilterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-add-filter" title="cogl_win32_renderer_add_filter ()">cogl_win32_renderer_add_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-remove-filter" title="cogl_win32_renderer_remove_filter ()">cogl_win32_renderer_remove_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-handle-event" title="cogl_win32_renderer_handle_event ()">cogl_win32_renderer_handle_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-set-event-retrieval-enabled" title="cogl_win32_renderer_set_event_retrieval_enabled ()">cogl_win32_renderer_set_event_retrieval_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-wayland-renderer-set-foreign-display" title="cogl_wayland_renderer_set_foreign_display ()">cogl_wayland_renderer_set_foreign_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-wayland-renderer-set-event-dispatch-enabled" title="cogl_wayland_renderer_set_event_dispatch_enabled ()">cogl_wayland_renderer_set_event_dispatch_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <span class="returnvalue">wl_display</span> *
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-wayland-renderer-get-display" title="cogl_wayland_renderer_get_display ()">cogl_wayland_renderer_get_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer">CoglRenderer</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWinsysID" title="enum CoglWinsysID">CoglWinsysID</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRendererConstraint" title="enum CoglRendererConstraint">CoglRendererConstraint</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn">CoglFilterReturn</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.description"></a><h2>Description</h2>
<p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> represents a means to render. It encapsulates the
selection of an underlying driver, such as OpenGL or OpenGL-ES and
a selection of a window system binding API such as GLX, or EGL or
WGL.</p>
<p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> has two states, "unconnected" and "connected". When
a renderer is first instantiated using <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-new" title="cogl_renderer_new ()"><code class="function">cogl_renderer_new()</code></a> it is
unconnected so that it can be configured and constraints can be
specified for how the backend driver and window system should be
chosen.</p>
<p>After configuration a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> can (optionally) be explicitly
connected using <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect" title="cogl_renderer_connect ()"><code class="function">cogl_renderer_connect()</code></a> which allows for the
handling of connection errors so that fallback configurations can
be tried if necessary. Applications that don't support any
fallbacks though can skip using <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect" title="cogl_renderer_connect ()"><code class="function">cogl_renderer_connect()</code></a> and leave
Cogl to automatically connect the renderer.</p>
<p>Once you have a configured <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> it can be used to create a
<a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#CoglDisplay" title="CoglDisplay"><span class="type">CoglDisplay</span></a> object using <a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-new" title="cogl_display_new ()"><code class="function">cogl_display_new()</code></a>.</p>
<div class="note">Many applications don't need to explicitly use
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-new" title="cogl_renderer_new ()"><code class="function">cogl_renderer_new()</code></a> or <a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-new" title="cogl_display_new ()"><code class="function">cogl_display_new()</code></a> and can just jump
straight to <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#cogl-context-new" title="cogl_context_new ()"><code class="function">cogl_context_new()</code></a> and pass a <code class="literal">NULL</code> display argument so
Cogl will automatically connect and setup a renderer and
display.</div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cogl-is-renderer"></a><h3>cogl_is_renderer ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
cogl_is_renderer (<em class="parameter"><code><span class="type">void</span> *object</code></em>);</pre>
<p>Determines if the given <em class="parameter"><code>object</code></em>
is a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p>
<div class="refsect3">
<a name="cogl-is-renderer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a> pointer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-is-renderer.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>object</code></em>
is a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a>, else <code class="literal">FALSE</code>.</p>
</div>
<p class="since">Since: 1.10</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-new"></a><h3>cogl_renderer_new ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="returnvalue">CoglRenderer</span></a> *
cogl_renderer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Instantiates a new (unconnected) <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> object. A
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> represents a means to render. It encapsulates the
selection of an underlying driver, such as OpenGL or OpenGL-ES and
a selection of a window system binding API such as GLX, or EGL or
WGL.</p>
<p>While the renderer is unconnected it can be configured so that
applications may specify backend constraints, such as "must use
x11" for example via <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-add-constraint" title="cogl_renderer_add_constraint ()"><code class="function">cogl_renderer_add_constraint()</code></a>.</p>
<p>There are also some platform specific configuration apis such
as <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-xlib-renderer-set-foreign-display" title="cogl_xlib_renderer_set_foreign_display ()"><code class="function">cogl_xlib_renderer_set_foreign_display()</code></a> that may also be
used while the renderer is unconnected.</p>
<p>Once the renderer has been configured, then it may (optionally) be
explicitly connected using <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect" title="cogl_renderer_connect ()"><code class="function">cogl_renderer_connect()</code></a> which allows
errors to be handled gracefully and potentially fallback
configurations can be tried out if there are initial failures.</p>
<p>If a renderer is not explicitly connected then <a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-new" title="cogl_display_new ()"><code class="function">cogl_display_new()</code></a>
will automatically connect the renderer for you. If you don't
have any code to deal with error/fallback situations then its fine
to just let Cogl do the connection for you.</p>
<p>Once you have setup your renderer then the next step is to create a
<a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#CoglDisplay" title="CoglDisplay"><span class="type">CoglDisplay</span></a> using <a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-new" title="cogl_display_new ()"><code class="function">cogl_display_new()</code></a>.</p>
<div class="note">Many applications don't need to explicitly use
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-new" title="cogl_renderer_new ()"><code class="function">cogl_renderer_new()</code></a> or <a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-new" title="cogl_display_new ()"><code class="function">cogl_display_new()</code></a> and can just jump
straight to <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#cogl-context-new" title="cogl_context_new ()"><code class="function">cogl_context_new()</code></a> and pass a <code class="literal">NULL</code> display argument
so Cogl will automatically connect and setup a renderer and
display.</div>
<div class="refsect3">
<a name="cogl-renderer-new.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 1.10</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-get-n-fragment-texture-units"></a><h3>cogl_renderer_get_n_fragment_texture_units ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
cogl_renderer_get_n_fragment_texture_units
(<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>);</pre>
<p>Queries how many texture units can be used from fragment programs</p>
<div class="refsect3">
<a name="cogl-renderer-get-n-fragment-texture-units.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-renderer-get-n-fragment-texture-units.returns"></a><h4>Returns</h4>
<p> the number of texture image units.</p>
</div>
<p class="since">Since: 1.8</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-connect"></a><h3>cogl_renderer_connect ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
cogl_renderer_connect (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Exception-handling.html#CoglError" title="CoglError"><span class="type">CoglError</span></a> **error</code></em>);</pre>
<p>Connects the configured <em class="parameter"><code>renderer</code></em>
. Renderer connection isn't a
very active process, it basically just means validating that
any given constraint criteria can be satisfied and that a
usable driver and window system backend can be found.</p>
<div class="refsect3">
<a name="cogl-renderer-connect.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>An unconnected <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <a class="link" href="cogl-2.0-experimental-Exception-handling.html#CoglError" title="CoglError"><span class="type">CoglError</span></a> for reporting exceptions</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-renderer-connect.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if there was no error while connecting the
given <em class="parameter"><code>renderer</code></em>
. <code class="literal">FALSE</code> if there was an error.</p>
</div>
<p class="since">Since: 1.10</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-set-winsys-id"></a><h3>cogl_renderer_set_winsys_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_renderer_set_winsys_id (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWinsysID" title="enum CoglWinsysID"><span class="type">CoglWinsysID</span></a> winsys_id</code></em>);</pre>
<p>This allows you to explicitly select a winsys backend to use instead
of letting Cogl automatically select a backend.</p>
<p>if you select an unsupported backend then <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect" title="cogl_renderer_connect ()"><code class="function">cogl_renderer_connect()</code></a>
will fail and report an error.</p>
<p>This may only be called on an un-connected <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a>.</p>
<div class="refsect3">
<a name="cogl-renderer-set-winsys-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>winsys_id</p></td>
<td class="parameter_description"><p>An ID of the winsys you explicitly want to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-get-winsys-id"></a><h3>cogl_renderer_get_winsys_id ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWinsysID" title="enum CoglWinsysID"><span class="returnvalue">CoglWinsysID</span></a>
cogl_renderer_get_winsys_id (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>);</pre>
<p>Queries which window system backend Cogl has chosen to use.</p>
<p>This may only be called on a connected <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a>.</p>
<div class="refsect3">
<a name="cogl-renderer-get-winsys-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-renderer-get-winsys-id.returns"></a><h4>Returns</h4>
<p> The <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWinsysID" title="enum CoglWinsysID"><span class="type">CoglWinsysID</span></a> corresponding to the chosen window
system backend.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-add-constraint"></a><h3>cogl_renderer_add_constraint ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_renderer_add_constraint (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRendererConstraint" title="enum CoglRendererConstraint"><span class="type">CoglRendererConstraint</span></a> constraint</code></em>);</pre>
<p>This adds a renderer selection <em class="parameter"><code>constraint</code></em>
.</p>
<p>Applications should ideally minimize how many of these constraints they
depend on to ensure maximum portability.</p>
<div class="refsect3">
<a name="cogl-renderer-add-constraint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>An unconnected <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>constraint</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRendererConstraint" title="enum CoglRendererConstraint"><span class="type">CoglRendererConstraint</span></a> to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-renderer-remove-constraint"></a><h3>cogl_renderer_remove_constraint ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_renderer_remove_constraint (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRendererConstraint" title="enum CoglRendererConstraint"><span class="type">CoglRendererConstraint</span></a> constraint</code></em>);</pre>
<p>This removes a renderer selection <em class="parameter"><code>constraint</code></em>
.</p>
<p>Applications should ideally minimize how many of these constraints they
depend on to ensure maximum portability.</p>
<div class="refsect3">
<a name="cogl-renderer-remove-constraint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>An unconnected <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>constraint</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRendererConstraint" title="enum CoglRendererConstraint"><span class="type">CoglRendererConstraint</span></a> to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-xlib-renderer-set-foreign-display"></a><h3>cogl_xlib_renderer_set_foreign_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_xlib_renderer_set_foreign_display
(<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">Display</span> *display</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="cogl-xlib-renderer-get-foreign-display"></a><h3>cogl_xlib_renderer_get_foreign_display ()</h3>
<pre class="programlisting"><span class="returnvalue">Display</span> *
cogl_xlib_renderer_get_foreign_display
(<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="CoglXlibFilterFunc"></a><h3>CoglXlibFilterFunc ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
<span class="c_punctuation">(</span>*CoglXlibFilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">XEvent</span> *event</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="cogl-xlib-renderer-add-filter"></a><h3>cogl_xlib_renderer_add_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_xlib_renderer_add_filter (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglXlibFilterFunc" title="CoglXlibFilterFunc ()"><span class="type">CoglXlibFilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="cogl-xlib-renderer-remove-filter"></a><h3>cogl_xlib_renderer_remove_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_xlib_renderer_remove_filter (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglXlibFilterFunc" title="CoglXlibFilterFunc ()"><span class="type">CoglXlibFilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="cogl-xlib-renderer-handle-event"></a><h3>cogl_xlib_renderer_handle_event ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
cogl_xlib_renderer_handle_event (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">XEvent</span> *event</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="CoglWin32FilterFunc"></a><h3>CoglWin32FilterFunc ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
<span class="c_punctuation">(</span>*CoglWin32FilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">MSG</span> *message</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
<p>A callback function that can be registered with
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-add-filter" title="cogl_win32_renderer_add_filter ()"><code class="function">cogl_win32_renderer_add_filter()</code></a>. The function should return
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#COGL-FILTER-REMOVE:CAPS"><code class="literal">COGL_FILTER_REMOVE</code></a> if it wants to prevent further processing or
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#COGL-FILTER-CONTINUE:CAPS"><code class="literal">COGL_FILTER_CONTINUE</code></a> otherwise.</p>
<div class="refsect3">
<a name="CoglWin32FilterFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>A pointer to a win32 MSG struct</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The data that was given when the filter was added</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-win32-renderer-add-filter"></a><h3>cogl_win32_renderer_add_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_win32_renderer_add_filter (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWin32FilterFunc" title="CoglWin32FilterFunc ()"><span class="type">CoglWin32FilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
<p>Adds a callback function that will receive all native events. The
function can stop further processing of the event by return
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#COGL-FILTER-REMOVE:CAPS"><code class="literal">COGL_FILTER_REMOVE</code></a>.</p>
<div class="refsect3">
<a name="cogl-win32-renderer-add-filter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data passed to <em class="parameter"><code>func</code></em>
when called</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-win32-renderer-remove-filter"></a><h3>cogl_win32_renderer_remove_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_win32_renderer_remove_filter (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWin32FilterFunc" title="CoglWin32FilterFunc ()"><span class="type">CoglWin32FilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
<p>Removes a callback that was previously added with
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-add-filter" title="cogl_win32_renderer_add_filter ()"><code class="function">cogl_win32_renderer_add_filter()</code></a>.</p>
<div class="refsect3">
<a name="cogl-win32-renderer-remove-filter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data given when the callback was installed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-win32-renderer-handle-event"></a><h3>cogl_win32_renderer_handle_event ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="returnvalue">CoglFilterReturn</span></a>
cogl_win32_renderer_handle_event (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">MSG</span> *message</code></em>);</pre>
<p>This function processes a single event; it can be used to hook into
external event retrieval (for example that done by Clutter or
GDK).</p>
<div class="refsect3">
<a name="cogl-win32-renderer-handle-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>A pointer to a win32 MSG struct</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-win32-renderer-handle-event.returns"></a><h4>Returns</h4>
<p> <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglFilterReturn" title="enum CoglFilterReturn"><span class="type">CoglFilterReturn</span></a>. <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#COGL-FILTER-REMOVE:CAPS"><code class="literal">COGL_FILTER_REMOVE</code></a> indicates that
Cogl has internally handled the event and the caller should do no
further processing. <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#COGL-FILTER-CONTINUE:CAPS"><code class="literal">COGL_FILTER_CONTINUE</code></a> indicates that Cogl is
either not interested in the event, or has used the event to update
internal state without taking any exclusive action.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-win32-renderer-set-event-retrieval-enabled"></a><h3>cogl_win32_renderer_set_event_retrieval_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_win32_renderer_set_event_retrieval_enabled
(<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="type">CoglBool</span></a> enable</code></em>);</pre>
<p>Sets whether Cogl should automatically retrieve messages from
Windows. It defaults to <code class="literal">TRUE</code>. It can be set to <code class="literal">FALSE</code> if the
application wants to handle its own message retrieval. Note that
Cogl still needs to see all of the messages to function properly so
the application should call <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-win32-renderer-handle-event" title="cogl_win32_renderer_handle_event ()"><code class="function">cogl_win32_renderer_handle_event()</code></a> for
each message if it disables automatic event retrieval.</p>
<div class="refsect3">
<a name="cogl-win32-renderer-set-event-retrieval-enabled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>The new value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-wayland-renderer-set-foreign-display"></a><h3>cogl_wayland_renderer_set_foreign_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_wayland_renderer_set_foreign_display
(<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">struct wl_display</span> *display</code></em>);</pre>
<p>Allows you to explicitly control what Wayland display you want Cogl
to work with instead of leaving Cogl to automatically connect to a
wayland compositor.</p>
<div class="refsect3">
<a name="cogl-wayland-renderer-set-foreign-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>A Wayland display</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.8</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-wayland-renderer-set-event-dispatch-enabled"></a><h3>cogl_wayland_renderer_set_event_dispatch_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_wayland_renderer_set_event_dispatch_enabled
(<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="type">CoglBool</span></a> enable</code></em>);</pre>
<p>Sets whether Cogl should handle calling <code class="function">wl_display_dispatch()</code> and
<code class="function">wl_display_flush()</code> as part of its main loop integration via
<a class="link" href="cogl-2.0-experimental-Main-loop-integration.html#cogl-poll-renderer-get-info" title="cogl_poll_renderer_get_info ()"><code class="function">cogl_poll_renderer_get_info()</code></a> and <a class="link" href="cogl-2.0-experimental-Main-loop-integration.html#cogl-poll-renderer-dispatch" title="cogl_poll_renderer_dispatch ()"><code class="function">cogl_poll_renderer_dispatch()</code></a>.
The default value is <code class="literal">TRUE</code>. When it is enabled the application can
register listeners for Wayland interfaces and the callbacks will be
invoked during <a class="link" href="cogl-2.0-experimental-Main-loop-integration.html#cogl-poll-renderer-dispatch" title="cogl_poll_renderer_dispatch ()"><code class="function">cogl_poll_renderer_dispatch()</code></a>. If the application
wants to integrate with its own code that is already handling
reading from the Wayland display socket, it should disable this to
avoid having competing code read from the socket.</p>
<div class="refsect3">
<a name="cogl-wayland-renderer-set-event-dispatch-enabled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>The new value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-wayland-renderer-get-display"></a><h3>cogl_wayland_renderer_get_display ()</h3>
<pre class="programlisting">struct <span class="returnvalue">wl_display</span> *
cogl_wayland_renderer_get_display (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>);</pre>
<p>Retrieves the Wayland display that Cogl is using. If a foreign
display has been specified using
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-wayland-renderer-set-foreign-display" title="cogl_wayland_renderer_set_foreign_display ()"><code class="function">cogl_wayland_renderer_set_foreign_display()</code></a> then that display will
be returned. If no foreign display has been specified then the
display that Cogl creates internally will be returned unless the
renderer has not yet been connected (either implicitly or explicitly by
calling <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect" title="cogl_renderer_connect ()"><code class="function">cogl_renderer_connect()</code></a>) in which case <code class="literal">NULL</code> is returned.</p>
<div class="refsect3">
<a name="cogl-wayland-renderer-get-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>renderer</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-wayland-renderer-get-display.returns"></a><h4>Returns</h4>
<p> The wayland display currently associated with <em class="parameter"><code>renderer</code></em>
,
or <code class="literal">NULL</code> if the renderer hasn't yet been connected and no
foreign display has been specified.</p>
</div>
<p class="since">Since: 1.8</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CoglRenderer"></a><h3>CoglRenderer</h3>
<pre class="programlisting">typedef struct _CoglRenderer CoglRenderer;</pre>
</div>
<hr>
<div class="refsect2">
<a name="CoglWinsysID"></a><h3>enum CoglWinsysID</h3>
<p>Identifies specific window system backends that Cogl supports.</p>
<p>These can be used to query what backend Cogl is using or to try and
explicitly select a backend to use.</p>
<div class="refsect3">
<a name="CoglWinsysID.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-ANY:CAPS"></a>COGL_WINSYS_ID_ANY</p></td>
<td class="enum_member_description">
<p>Implies no preference for which backend is used</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-STUB:CAPS"></a>COGL_WINSYS_ID_STUB</p></td>
<td class="enum_member_description">
<p>Use the no-op stub backend</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-GLX:CAPS"></a>COGL_WINSYS_ID_GLX</p></td>
<td class="enum_member_description">
<p>Use the GLX window system binding API</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-XLIB:CAPS"></a>COGL_WINSYS_ID_EGL_XLIB</p></td>
<td class="enum_member_description">
<p>Use EGL with the X window system via XLib</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-NULL:CAPS"></a>COGL_WINSYS_ID_EGL_NULL</p></td>
<td class="enum_member_description">
<p>Use EGL with the PowerVR NULL window system</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-GDL:CAPS"></a>COGL_WINSYS_ID_EGL_GDL</p></td>
<td class="enum_member_description">
<p>Use EGL with the GDL platform</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-WAYLAND:CAPS"></a>COGL_WINSYS_ID_EGL_WAYLAND</p></td>
<td class="enum_member_description">
<p>Use EGL with the Wayland window system</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-KMS:CAPS"></a>COGL_WINSYS_ID_EGL_KMS</p></td>
<td class="enum_member_description">
<p>Use EGL with the KMS platform</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-ANDROID:CAPS"></a>COGL_WINSYS_ID_EGL_ANDROID</p></td>
<td class="enum_member_description">
<p>Use EGL with the Android platform</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-EGL-MIR:CAPS"></a>COGL_WINSYS_ID_EGL_MIR</p></td>
<td class="enum_member_description">
<p>Use EGL with the Mir server</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-WGL:CAPS"></a>COGL_WINSYS_ID_WGL</p></td>
<td class="enum_member_description">
<p>Use the Microsoft Windows WGL binding API</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-WINSYS-ID-SDL:CAPS"></a>COGL_WINSYS_ID_SDL</p></td>
<td class="enum_member_description">
<p>Use the SDL window system</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="CoglRendererConstraint"></a><h3>enum CoglRendererConstraint</h3>
<p>These constraint flags are hard-coded features of the different renderer
backends. Sometimes a platform may support multiple rendering options which
Cogl will usually choose from automatically. Some of these features are
important to higher level applications and frameworks though, such as
whether a renderer is X11 based because an application might only support
X11 based input handling. An application might also need to ensure EGL is
used internally too if they depend on access to an EGLDisplay for some
purpose.</p>
<p>Applications should ideally minimize how many of these constraints
they depend on to ensure maximum portability.</p>
<div class="refsect3">
<a name="CoglRendererConstraint.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="COGL-RENDERER-CONSTRAINT-USES-X11:CAPS"></a>COGL_RENDERER_CONSTRAINT_USES_X11</p></td>
<td class="enum_member_description">
<p>Require the renderer to be X11 based</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-RENDERER-CONSTRAINT-USES-XLIB:CAPS"></a>COGL_RENDERER_CONSTRAINT_USES_XLIB</p></td>
<td class="enum_member_description">
<p>Require the renderer to be X11
based and use Xlib</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-RENDERER-CONSTRAINT-USES-EGL:CAPS"></a>COGL_RENDERER_CONSTRAINT_USES_EGL</p></td>
<td class="enum_member_description">
<p>Require the renderer to be EGL based</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-RENDERER-CONSTRAINT-SUPPORTS-COGL-GLES2:CAPS"></a>COGL_RENDERER_CONSTRAINT_SUPPORTS_COGL_GLES2</p></td>
<td class="enum_member_description">
<p>Require that the
renderer supports creating a <a class="link" href="cogl-2.0-experimental-GLES-2.0-context.html#CoglGLES2Context" title="CoglGLES2Context"><span class="type">CoglGLES2Context</span></a> via
<a class="link" href="cogl-2.0-experimental-GLES-2.0-context.html#cogl-gles2-context-new" title="cogl_gles2_context_new ()"><code class="function">cogl_gles2_context_new()</code></a>. This can be used to integrate GLES 2.0
code into Cogl based applications.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="CoglFilterReturn"></a><h3>enum CoglFilterReturn</h3>
<p>Return values for the <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglXlibFilterFunc" title="CoglXlibFilterFunc ()"><span class="type">CoglXlibFilterFunc</span></a> and <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglWin32FilterFunc" title="CoglWin32FilterFunc ()"><span class="type">CoglWin32FilterFunc</span></a> functions.</p>
<div class="refsect3">
<a name="CoglFilterReturn.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="COGL-FILTER-CONTINUE:CAPS"></a>COGL_FILTER_CONTINUE</p></td>
<td class="enum_member_description">
<p>The event was not handled, continues the
processing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-FILTER-REMOVE:CAPS"></a>COGL_FILTER_REMOVE</p></td>
<td class="enum_member_description">
<p>Remove the event, stops the processing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|