/usr/lib/x86_64-linux-gnu/mutter/Cogl-2.gir is in libmutter-2-dev 3.28.1-1ubuntu1.
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 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GL" version="1.0"/>
<include name="GObject" version="2.0"/>
<package name="mutter-cogl-2"/>
<c:include name="cogl/cogl.h"/>
<namespace name="Cogl"
version="2"
shared-library="libmutter-cogl-2.so"
c:identifier-prefixes="Cogl"
c:symbol-prefixes="cogl">
<alias name="Angle" c:type="CoglAngle">
<doc xml:space="preserve">Integer representation of an angle such that 1024 corresponds to
full circle (i.e., 2 * pi).</doc>
<type name="gint32" c:type="int32_t"/>
</alias>
<alias name="Bool" c:type="CoglBool" stability="Stable">
<doc xml:space="preserve">A boolean data type used throughout the Cogl C api. This should be
used in conjunction with the %TRUE and %FALSE macro defines for
setting and testing boolean values.</doc>
<type name="gint" c:type="int"/>
</alias>
<alias name="Handle" c:type="CoglHandle">
<doc xml:space="preserve">Type used for storing references to cogl objects, the CoglHandle is
a fully opaque type without any public data members.</doc>
<type name="gpointer" c:type="void*"/>
</alias>
<constant name="AFIRST_BIT" value="64" c:type="COGL_AFIRST_BIT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="A_BIT" value="16" c:type="COGL_A_BIT">
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="AttributeType" version="1.0" c:type="CoglAttributeType">
<doc xml:space="preserve">Data types for the components of a vertex attribute.</doc>
<member name="byte" value="5120" c:identifier="COGL_ATTRIBUTE_TYPE_BYTE">
<doc xml:space="preserve">Data is the same size of a byte</doc>
</member>
<member name="unsigned_byte"
value="5121"
c:identifier="COGL_ATTRIBUTE_TYPE_UNSIGNED_BYTE">
<doc xml:space="preserve">Data is the same size of an
unsigned byte</doc>
</member>
<member name="short"
value="5122"
c:identifier="COGL_ATTRIBUTE_TYPE_SHORT">
<doc xml:space="preserve">Data is the same size of a short integer</doc>
</member>
<member name="unsigned_short"
value="5123"
c:identifier="COGL_ATTRIBUTE_TYPE_UNSIGNED_SHORT">
<doc xml:space="preserve">Data is the same size of
an unsigned short integer</doc>
</member>
<member name="float"
value="5126"
c:identifier="COGL_ATTRIBUTE_TYPE_FLOAT">
<doc xml:space="preserve">Data is the same size of a float</doc>
</member>
</enumeration>
<constant name="BGR_BIT" value="32" c:type="COGL_BGR_BIT">
<type name="gint" c:type="gint"/>
</constant>
<class name="Bitmap"
c:symbol-prefix="bitmap"
c:type="CoglBitmap"
glib:type-name="CoglBitmap"
glib:get-type="cogl_bitmap_get_gtype"
glib:fundamental="1">
<constructor name="new_for_data"
c:identifier="cogl_bitmap_new_for_data"
version="1.10"
introspectable="0"
stability="Unstable">
<doc xml:space="preserve">Creates a bitmap using some existing data. The data is not copied
so the application must keep the buffer alive for the lifetime of
the #CoglBitmap. This can be used for example with
cogl_framebuffer_read_pixels_into_bitmap() to read data directly
into an application buffer with the specified rowstride.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #CoglBitmap.</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #CoglContext</doc>
<type c:type="CoglContext*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width of the bitmap.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height of the bitmap.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">The format of the pixel data.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">The rowstride of the bitmap (the number of bytes from
the start of one row of the bitmap to the next).</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">A pointer to the data. The bitmap will take ownership of this data.</doc>
<type name="guint8" c:type="uint8_t*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_buffer"
c:identifier="cogl_bitmap_new_from_buffer"
version="1.8"
introspectable="0"
stability="Unstable">
<doc xml:space="preserve">Wraps some image data that has been uploaded into a #CoglBuffer as
a #CoglBitmap. The data is not copied in this process.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #CoglBitmap encapsulating the given @buffer.</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBuffer containing image data</doc>
<type c:type="CoglBuffer*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">The #CoglPixelFormat defining the format of the image data
in the given @buffer.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width of the image data in the given @buffer.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height of the image data in the given @buffer.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">The rowstride in bytes of the image data in the given @buffer.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<doc xml:space="preserve">The offset into the given @buffer to the first pixel that
should be considered part of the #CoglBitmap.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_file"
c:identifier="cogl_bitmap_new_from_file"
version="1.0"
throws="1">
<doc xml:space="preserve">Loads an image file from disk. This function can be safely called from
within a thread.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #CoglBitmap to the new loaded
image data, or %NULL if loading the image failed.</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the file to load.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_with_size"
c:identifier="cogl_bitmap_new_with_size"
version="1.10"
introspectable="0"
stability="Unstable">
<doc xml:space="preserve">Creates a new #CoglBitmap with the given width, height and format.
The initial contents of the bitmap are undefined.
The data for the bitmap will be stored in a newly created
#CoglPixelBuffer. You can get a pointer to the pixel buffer using
cogl_bitmap_get_buffer(). The #CoglBuffer API can then be
used to fill the bitmap with data.
<note>Cogl will try its best to provide a hardware array you can
map, write into and effectively do a zero copy upload when creating
a texture from it with cogl_texture_new_from_bitmap(). For various
reasons, such arrays are likely to have a stride larger than width
* bytes_per_pixel. The user must take the stride into account when
writing into it. The stride can be retrieved with
cogl_bitmap_get_rowstride().</note></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #CoglPixelBuffer representing the
newly created array or %NULL on failure</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #CoglContext</doc>
<type c:type="CoglContext*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of the bitmap in pixels</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of the bitmap in pixels</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the format of the pixels the array will store</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</constructor>
<function name="error_quark" c:identifier="cogl_bitmap_error_quark">
<return-value transfer-ownership="none">
<type name="guint32" c:type="uint32_t"/>
</return-value>
</function>
<function name="get_size_from_file"
c:identifier="cogl_bitmap_get_size_from_file"
version="1.0">
<doc xml:space="preserve">Parses an image file enough to extract the width and height
of the bitmap.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the image was successfully parsed</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the file to check</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for the bitmap width, or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for the bitmap height, or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</function>
<method name="get_buffer"
c:identifier="cogl_bitmap_get_buffer"
version="1.10"
introspectable="0"
stability="Unstable">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelBuffer that this
buffer uses for storage. Note that if the bitmap was created with
cogl_bitmap_new_from_file() then it will not actually be using a
pixel buffer and this function will return %NULL.</doc>
<type c:type="CoglPixelBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_format"
c:identifier="cogl_bitmap_get_format"
version="1.10"
stability="Unstable">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat that the data for the bitmap is in.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</return-value>
<parameters>
<instance-parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_height"
c:identifier="cogl_bitmap_get_height"
version="1.10"
stability="Unstable">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the height of the bitmap</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_rowstride"
c:identifier="cogl_bitmap_get_rowstride"
version="1.10"
stability="Unstable">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the rowstride of the bitmap. This is the number of
bytes between the address of start of one row to the address of the
next row in the image.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width"
c:identifier="cogl_bitmap_get_width"
version="1.10"
stability="Unstable">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the width of the bitmap</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</instance-parameter>
</parameters>
</method>
</class>
<enumeration name="BitmapError" version="1.4" c:type="CoglBitmapError">
<doc xml:space="preserve">Error codes that can be thrown when performing bitmap
operations. Note that gdk_pixbuf_new_from_file() can also throw
errors directly from the underlying image loading library. For
example, if GdkPixbuf is used then errors #GdkPixbufError<!-- -->s
will be used directly.</doc>
<member name="failed" value="0" c:identifier="COGL_BITMAP_ERROR_FAILED">
<doc xml:space="preserve">Generic failure code, something went
wrong.</doc>
</member>
<member name="unknown_type"
value="1"
c:identifier="COGL_BITMAP_ERROR_UNKNOWN_TYPE">
<doc xml:space="preserve">Unknown image type.</doc>
</member>
<member name="corrupt_image"
value="2"
c:identifier="COGL_BITMAP_ERROR_CORRUPT_IMAGE">
<doc xml:space="preserve">An image file was broken somehow.</doc>
</member>
</enumeration>
<enumeration name="BlendStringError"
version="1.0"
c:type="CoglBlendStringError">
<doc xml:space="preserve">Error enumeration for the blend strings parser</doc>
<member name="parse_error"
value="0"
c:identifier="COGL_BLEND_STRING_ERROR_PARSE_ERROR">
<doc xml:space="preserve">Generic parse error</doc>
</member>
<member name="argument_parse_error"
value="1"
c:identifier="COGL_BLEND_STRING_ERROR_ARGUMENT_PARSE_ERROR">
<doc xml:space="preserve">Argument parse error</doc>
</member>
<member name="invalid_error"
value="2"
c:identifier="COGL_BLEND_STRING_ERROR_INVALID_ERROR">
<doc xml:space="preserve">Internal parser error</doc>
</member>
<member name="gpu_unsupported_error"
value="3"
c:identifier="COGL_BLEND_STRING_ERROR_GPU_UNSUPPORTED_ERROR">
<doc xml:space="preserve">Blend string not
supported by the GPU</doc>
</member>
</enumeration>
<bitfield name="BufferBit" version="1.0" c:type="CoglBufferBit">
<doc xml:space="preserve">Types of auxiliary buffers</doc>
<member name="color" value="1" c:identifier="COGL_BUFFER_BIT_COLOR">
<doc xml:space="preserve">Selects the primary color buffer</doc>
</member>
<member name="depth" value="2" c:identifier="COGL_BUFFER_BIT_DEPTH">
<doc xml:space="preserve">Selects the depth buffer</doc>
</member>
<member name="stencil" value="4" c:identifier="COGL_BUFFER_BIT_STENCIL">
<doc xml:space="preserve">Selects the stencil buffer</doc>
</member>
</bitfield>
<bitfield name="BufferTarget" version="0.8" c:type="CoglBufferTarget">
<doc xml:space="preserve">Target flags for FBOs.</doc>
<member name="window_buffer" value="2" c:identifier="COGL_WINDOW_BUFFER">
<doc xml:space="preserve">FIXME</doc>
</member>
<member name="offscreen_buffer"
value="4"
c:identifier="COGL_OFFSCREEN_BUFFER">
<doc xml:space="preserve">FIXME</doc>
</member>
</bitfield>
<record name="Color"
c:type="CoglColor"
version="1.0"
glib:type-name="CoglColor"
glib:get-type="cogl_color_get_gtype"
c:symbol-prefix="color">
<doc xml:space="preserve">A structure for holding a color definition. The contents of
the CoglColor structure are private and should never by accessed
directly.</doc>
<field name="private_member_red" readable="0" private="1">
<type name="guint8" c:type="uint8_t"/>
</field>
<field name="private_member_green" readable="0" private="1">
<type name="guint8" c:type="uint8_t"/>
</field>
<field name="private_member_blue" readable="0" private="1">
<type name="guint8" c:type="uint8_t"/>
</field>
<field name="private_member_alpha" readable="0" private="1">
<type name="guint8" c:type="uint8_t"/>
</field>
<field name="private_member_padding0" readable="0" private="1">
<type name="guint32" c:type="uint32_t"/>
</field>
<field name="private_member_padding1" readable="0" private="1">
<type name="guint32" c:type="uint32_t"/>
</field>
<field name="private_member_padding2" readable="0" private="1">
<type name="guint32" c:type="uint32_t"/>
</field>
<constructor name="new" c:identifier="cogl_color_new" version="1.0">
<doc xml:space="preserve">Creates a new (empty) color</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly-allocated #CoglColor. Use cogl_color_free()
to free the allocated resources</doc>
<type name="Color" c:type="CoglColor*"/>
</return-value>
</constructor>
<method name="copy" c:identifier="cogl_color_copy" version="1.0">
<doc xml:space="preserve">Creates a copy of @color</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly-allocated #CoglColor. Use cogl_color_free()
to free the allocate resources</doc>
<type name="Color" c:type="CoglColor*"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">the color to copy</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="cogl_color_free" version="1.0">
<doc xml:space="preserve">Frees the resources allocated by cogl_color_new() and cogl_color_copy()</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">the color to free</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_alpha"
c:identifier="cogl_color_get_alpha"
version="1.0">
<doc xml:space="preserve">Retrieves the alpha channel of @color as a fixed point
value between 0 and 1.0.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the alpha channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_alpha_byte"
c:identifier="cogl_color_get_alpha_byte"
version="1.0">
<doc xml:space="preserve">Retrieves the alpha channel of @color as a byte value
between 0 and 255</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the alpha channel of the passed color</doc>
<type name="guint8" c:type="unsigned char"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_alpha_float"
c:identifier="cogl_color_get_alpha_float"
version="1.0">
<doc xml:space="preserve">Retrieves the alpha channel of @color as a floating point
value between 0.0 and 1.0</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the alpha channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_blue" c:identifier="cogl_color_get_blue" version="1.0">
<doc xml:space="preserve">Retrieves the blue channel of @color as a fixed point
value between 0 and 1.0.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the blue channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_blue_byte"
c:identifier="cogl_color_get_blue_byte"
version="1.0">
<doc xml:space="preserve">Retrieves the blue channel of @color as a byte value
between 0 and 255</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the blue channel of the passed color</doc>
<type name="guint8" c:type="unsigned char"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_blue_float"
c:identifier="cogl_color_get_blue_float"
version="1.0">
<doc xml:space="preserve">Retrieves the blue channel of @color as a floating point
value between 0.0 and 1.0</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the blue channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_green"
c:identifier="cogl_color_get_green"
version="1.0">
<doc xml:space="preserve">Retrieves the green channel of @color as a fixed point
value between 0 and 1.0.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the green channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_green_byte"
c:identifier="cogl_color_get_green_byte"
version="1.0">
<doc xml:space="preserve">Retrieves the green channel of @color as a byte value
between 0 and 255</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the green channel of the passed color</doc>
<type name="guint8" c:type="unsigned char"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_green_float"
c:identifier="cogl_color_get_green_float"
version="1.0">
<doc xml:space="preserve">Retrieves the green channel of @color as a floating point
value between 0.0 and 1.0</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the green channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_red" c:identifier="cogl_color_get_red" version="1.0">
<doc xml:space="preserve">Retrieves the red channel of @color as a fixed point
value between 0 and 1.0.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the red channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_red_byte"
c:identifier="cogl_color_get_red_byte"
version="1.0">
<doc xml:space="preserve">Retrieves the red channel of @color as a byte value
between 0 and 255</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the red channel of the passed color</doc>
<type name="guint8" c:type="unsigned char"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_red_float"
c:identifier="cogl_color_get_red_float"
version="1.0">
<doc xml:space="preserve">Retrieves the red channel of @color as a floating point
value between 0.0 and 1.0</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the red channel of the passed color</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="init_from_4f"
c:identifier="cogl_color_init_from_4f"
version="1.4">
<doc xml:space="preserve">Sets the values of the passed channels into a #CoglColor</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #CoglColor to initialize</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">value of the red channel, between 0 and 1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">value of the green channel, between 0 and 1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">value of the blue channel, between 0 and 1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">value of the alpha channel, between 0 and 1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="init_from_4fv"
c:identifier="cogl_color_init_from_4fv"
version="1.4">
<doc xml:space="preserve">Sets the values of the passed channels into a #CoglColor</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #CoglColor to initialize</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="color_array" transfer-ownership="none">
<doc xml:space="preserve">a pointer to an array of 4 float color components</doc>
<type name="gfloat" c:type="const float*"/>
</parameter>
</parameters>
</method>
<method name="init_from_4ub"
c:identifier="cogl_color_init_from_4ub"
version="1.4">
<doc xml:space="preserve">Sets the values of the passed channels into a #CoglColor.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #CoglColor to initialize</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">value of the red channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">value of the green channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">value of the blue channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">value of the alpha channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
</parameters>
</method>
<method name="premultiply"
c:identifier="cogl_color_premultiply"
version="1.0">
<doc xml:space="preserve">Converts a non-premultiplied color to a pre-multiplied color. For
example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied
and (0.5, 0, 0, 0.5) when premultiplied.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">the color to premultiply</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_alpha"
c:identifier="cogl_color_set_alpha"
version="1.4">
<doc xml:space="preserve">Sets the alpha channel of @color to @alpha.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_alpha_byte"
c:identifier="cogl_color_set_alpha_byte"
version="1.4">
<doc xml:space="preserve">Sets the alpha channel of @color to @alpha.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">a byte value between 0 and 255</doc>
<type name="guint8" c:type="unsigned char"/>
</parameter>
</parameters>
</method>
<method name="set_alpha_float"
c:identifier="cogl_color_set_alpha_float"
version="1.4">
<doc xml:space="preserve">Sets the alpha channel of @color to @alpha.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_blue" c:identifier="cogl_color_set_blue" version="1.4">
<doc xml:space="preserve">Sets the blue channel of @color to @blue.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_blue_byte"
c:identifier="cogl_color_set_blue_byte"
version="1.4">
<doc xml:space="preserve">Sets the blue channel of @color to @blue.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">a byte value between 0 and 255</doc>
<type name="guint8" c:type="unsigned char"/>
</parameter>
</parameters>
</method>
<method name="set_blue_float"
c:identifier="cogl_color_set_blue_float"
version="1.4">
<doc xml:space="preserve">Sets the blue channel of @color to @blue.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_from_4f"
c:identifier="cogl_color_set_from_4f"
version="1.0"
deprecated="1"
deprecated-version="1.4">
<doc xml:space="preserve">Sets the values of the passed channels into a #CoglColor</doc>
<doc-deprecated xml:space="preserve">Use cogl_color_init_from_4f instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #CoglColor to initialize</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">value of the red channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">value of the green channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">value of the blue channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">value of the alpha channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_from_4ub"
c:identifier="cogl_color_set_from_4ub"
version="1.0"
deprecated="1"
deprecated-version="1.4">
<doc xml:space="preserve">Sets the values of the passed channels into a #CoglColor.</doc>
<doc-deprecated xml:space="preserve">Use cogl_color_init_from_4ub instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #CoglColor to initialize</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">value of the red channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">value of the green channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">value of the blue channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">value of the alpha channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
</parameters>
</method>
<method name="set_green"
c:identifier="cogl_color_set_green"
version="1.4">
<doc xml:space="preserve">Sets the green channel of @color to @green.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_green_byte"
c:identifier="cogl_color_set_green_byte"
version="1.4">
<doc xml:space="preserve">Sets the green channel of @color to @green.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">a byte value between 0 and 255</doc>
<type name="guint8" c:type="unsigned char"/>
</parameter>
</parameters>
</method>
<method name="set_green_float"
c:identifier="cogl_color_set_green_float"
version="1.4">
<doc xml:space="preserve">Sets the green channel of @color to @green.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_red" c:identifier="cogl_color_set_red" version="1.4">
<doc xml:space="preserve">Sets the red channel of @color to @red.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_red_byte"
c:identifier="cogl_color_set_red_byte"
version="1.4">
<doc xml:space="preserve">Sets the red channel of @color to @red.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">a byte value between 0 and 255</doc>
<type name="guint8" c:type="unsigned char"/>
</parameter>
</parameters>
</method>
<method name="set_red_float"
c:identifier="cogl_color_set_red_float"
version="1.4">
<doc xml:space="preserve">Sets the red channel of @color to @red.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">a float value between 0.0f and 1.0f</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="to_hsl" c:identifier="cogl_color_to_hsl" version="1.16">
<doc xml:space="preserve">Converts @color to the HLS format.
The @hue value is in the 0 .. 360 range. The @luminance and
@saturation values are in the 0 .. 1 range.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</instance-parameter>
<parameter name="hue"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for the hue value or %NULL</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
<parameter name="saturation"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for the saturation value or %NULL</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
<parameter name="luminance"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for the luminance value or %NULL</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
</parameters>
</method>
<method name="unpremultiply"
c:identifier="cogl_color_unpremultiply"
version="1.4">
<doc xml:space="preserve">Converts a pre-multiplied color to a non-premultiplied color. For
example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied
and (1.0, 0, 0, 0.5) when non-premultiplied.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">the color to unpremultiply</doc>
<type name="Color" c:type="CoglColor*"/>
</instance-parameter>
</parameters>
</method>
<function name="equal" c:identifier="cogl_color_equal" version="1.0">
<doc xml:space="preserve">Compares two #CoglColor<!-- -->s and checks if they are the same.
This function can be passed to g_hash_table_new() as the @key_equal_func
parameter, when using #CoglColor<!-- -->s as keys in a #GHashTable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the two colors are the same.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="v1"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="v2"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="init_from_hsl"
c:identifier="cogl_color_init_from_hsl"
version="1.16">
<doc xml:space="preserve">Converts a color expressed in HLS (hue, luminance and saturation)
values into a #CoglColor.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="color"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">return location for a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
<parameter name="hue" transfer-ownership="none">
<doc xml:space="preserve">hue value, in the 0 .. 360 range</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="saturation" transfer-ownership="none">
<doc xml:space="preserve">saturation value, in the 0 .. 1 range</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="luminance" transfer-ownership="none">
<doc xml:space="preserve">luminance value, in the 0 .. 1 range</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
</record>
<bitfield name="ColorMask" c:type="CoglColorMask">
<doc xml:space="preserve">Defines a bit mask of color channels. This can be used with
cogl_pipeline_set_color_mask() for example to define which color
channels should be written to the current framebuffer when
drawing something.</doc>
<member name="none" value="0" c:identifier="COGL_COLOR_MASK_NONE">
<doc xml:space="preserve">None of the color channels are masked</doc>
</member>
<member name="red" value="1" c:identifier="COGL_COLOR_MASK_RED">
<doc xml:space="preserve">Masks the red color channel</doc>
</member>
<member name="green" value="2" c:identifier="COGL_COLOR_MASK_GREEN">
<doc xml:space="preserve">Masks the green color channel</doc>
</member>
<member name="blue" value="4" c:identifier="COGL_COLOR_MASK_BLUE">
<doc xml:space="preserve">Masks the blue color channel</doc>
</member>
<member name="alpha" value="8" c:identifier="COGL_COLOR_MASK_ALPHA">
<doc xml:space="preserve">Masks the alpha color channel</doc>
</member>
<member name="all" value="15" c:identifier="COGL_COLOR_MASK_ALL">
<doc xml:space="preserve">All of the color channels are masked</doc>
</member>
</bitfield>
<constant name="DEPTH_BIT" value="256" c:type="COGL_DEPTH_BIT">
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="DepthTestFunction" c:type="CoglDepthTestFunction">
<doc xml:space="preserve">When using depth testing one of these functions is used to compare
the depth of an incoming fragment against the depth value currently
stored in the depth buffer. The function is changed using
cogl_depth_state_set_test_function().
The test is only done when depth testing is explicitly enabled. (See
cogl_depth_state_set_test_enabled())</doc>
<member name="never"
value="512"
c:identifier="COGL_DEPTH_TEST_FUNCTION_NEVER">
<doc xml:space="preserve">Never passes.</doc>
</member>
<member name="less"
value="513"
c:identifier="COGL_DEPTH_TEST_FUNCTION_LESS">
<doc xml:space="preserve">Passes if the fragment's depth
value is less than the value currently in the depth buffer.</doc>
</member>
<member name="equal"
value="514"
c:identifier="COGL_DEPTH_TEST_FUNCTION_EQUAL">
<doc xml:space="preserve">Passes if the fragment's depth
value is equal to the value currently in the depth buffer.</doc>
</member>
<member name="lequal"
value="515"
c:identifier="COGL_DEPTH_TEST_FUNCTION_LEQUAL">
<doc xml:space="preserve">Passes if the fragment's depth
value is less or equal to the value currently in the depth buffer.</doc>
</member>
<member name="greater"
value="516"
c:identifier="COGL_DEPTH_TEST_FUNCTION_GREATER">
<doc xml:space="preserve">Passes if the fragment's depth
value is greater than the value currently in the depth buffer.</doc>
</member>
<member name="notequal"
value="517"
c:identifier="COGL_DEPTH_TEST_FUNCTION_NOTEQUAL">
<doc xml:space="preserve">Passes if the fragment's depth
value is not equal to the value currently in the depth buffer.</doc>
</member>
<member name="gequal"
value="518"
c:identifier="COGL_DEPTH_TEST_FUNCTION_GEQUAL">
<doc xml:space="preserve">Passes if the fragment's depth
value greater than or equal to the value currently in the depth buffer.</doc>
</member>
<member name="always"
value="519"
c:identifier="COGL_DEPTH_TEST_FUNCTION_ALWAYS">
<doc xml:space="preserve">Always passes.</doc>
</member>
</enumeration>
<record name="Euler" c:type="CoglEuler" disguised="1">
</record>
<bitfield name="FeatureFlags" version="0.8" c:type="CoglFeatureFlags">
<doc xml:space="preserve">Flags for the supported features.</doc>
<member name="texture_rectangle"
value="2"
c:identifier="COGL_FEATURE_TEXTURE_RECTANGLE">
<doc xml:space="preserve">ARB_texture_rectangle support</doc>
</member>
<member name="texture_npot"
value="4"
c:identifier="COGL_FEATURE_TEXTURE_NPOT">
<doc xml:space="preserve">Non power of two textures are supported
by the hardware. This is a equivalent to the
%COGL_FEATURE_TEXTURE_NPOT_BASIC, %COGL_FEATURE_TEXTURE_NPOT_MIPMAP
and %COGL_FEATURE_TEXTURE_NPOT_REPEAT features combined.</doc>
</member>
<member name="texture_yuv"
value="8"
c:identifier="COGL_FEATURE_TEXTURE_YUV">
<doc xml:space="preserve">ycbcr conversion support</doc>
</member>
<member name="texture_read_pixels"
value="16"
c:identifier="COGL_FEATURE_TEXTURE_READ_PIXELS">
<doc xml:space="preserve">glReadPixels() support</doc>
</member>
<member name="shaders_glsl"
value="32"
c:identifier="COGL_FEATURE_SHADERS_GLSL">
<doc xml:space="preserve">GLSL support</doc>
</member>
<member name="offscreen"
value="64"
c:identifier="COGL_FEATURE_OFFSCREEN">
<doc xml:space="preserve">FBO support</doc>
</member>
<member name="offscreen_multisample"
value="128"
c:identifier="COGL_FEATURE_OFFSCREEN_MULTISAMPLE">
<doc xml:space="preserve">Multisample support on FBOs</doc>
</member>
<member name="offscreen_blit"
value="256"
c:identifier="COGL_FEATURE_OFFSCREEN_BLIT">
<doc xml:space="preserve">Blit support on FBOs</doc>
</member>
<member name="four_clip_planes"
value="512"
c:identifier="COGL_FEATURE_FOUR_CLIP_PLANES">
<doc xml:space="preserve">At least 4 clip planes available</doc>
</member>
<member name="stencil_buffer"
value="1024"
c:identifier="COGL_FEATURE_STENCIL_BUFFER">
<doc xml:space="preserve">Stencil buffer support</doc>
</member>
<member name="vbos" value="2048" c:identifier="COGL_FEATURE_VBOS">
<doc xml:space="preserve">VBO support</doc>
</member>
<member name="pbos" value="4096" c:identifier="COGL_FEATURE_PBOS">
<doc xml:space="preserve">PBO support</doc>
</member>
<member name="unsigned_int_indices"
value="8192"
c:identifier="COGL_FEATURE_UNSIGNED_INT_INDICES">
<doc xml:space="preserve">Set if
%COGL_INDICES_TYPE_UNSIGNED_INT is supported in
cogl_vertex_buffer_indices_new().</doc>
</member>
<member name="depth_range"
value="16384"
c:identifier="COGL_FEATURE_DEPTH_RANGE">
<doc xml:space="preserve">cogl_material_set_depth_range() support</doc>
</member>
<member name="texture_npot_basic"
value="32768"
c:identifier="COGL_FEATURE_TEXTURE_NPOT_BASIC">
<doc xml:space="preserve">The hardware supports non power
of two textures, but you also need to check the
%COGL_FEATURE_TEXTURE_NPOT_MIPMAP and %COGL_FEATURE_TEXTURE_NPOT_REPEAT
features to know if the hardware supports npot texture mipmaps
or repeat modes other than
%COGL_PIPELINE_WRAP_MODE_CLAMP_TO_EDGE respectively.</doc>
</member>
<member name="texture_npot_mipmap"
value="65536"
c:identifier="COGL_FEATURE_TEXTURE_NPOT_MIPMAP">
<doc xml:space="preserve">Mipmapping is supported in
conjuntion with non power of two textures.</doc>
</member>
<member name="texture_npot_repeat"
value="131072"
c:identifier="COGL_FEATURE_TEXTURE_NPOT_REPEAT">
<doc xml:space="preserve">Repeat modes other than
%COGL_PIPELINE_WRAP_MODE_CLAMP_TO_EDGE are supported by the
hardware.</doc>
</member>
<member name="point_sprite"
value="262144"
c:identifier="COGL_FEATURE_POINT_SPRITE">
<doc xml:space="preserve">Whether
cogl_material_set_layer_point_sprite_coords_enabled() is supported.</doc>
</member>
<member name="texture_3d"
value="524288"
c:identifier="COGL_FEATURE_TEXTURE_3D">
<doc xml:space="preserve">3D texture support</doc>
</member>
<member name="shaders_arbfp"
value="1048576"
c:identifier="COGL_FEATURE_SHADERS_ARBFP">
<doc xml:space="preserve">ARBFP support</doc>
</member>
<member name="map_buffer_for_read"
value="2097152"
c:identifier="COGL_FEATURE_MAP_BUFFER_FOR_READ">
<doc xml:space="preserve">Whether cogl_buffer_map() is
supported with CoglBufferAccess including read support.</doc>
</member>
<member name="map_buffer_for_write"
value="4194304"
c:identifier="COGL_FEATURE_MAP_BUFFER_FOR_WRITE">
<doc xml:space="preserve">Whether cogl_buffer_map() is
supported with CoglBufferAccess including write support.</doc>
</member>
<member name="onscreen_multiple"
value="8388608"
c:identifier="COGL_FEATURE_ONSCREEN_MULTIPLE">
</member>
<member name="depth_texture"
value="16777216"
c:identifier="COGL_FEATURE_DEPTH_TEXTURE">
<doc xml:space="preserve">Whether #CoglFramebuffer support rendering the
depth buffer to a texture.</doc>
</member>
</bitfield>
<enumeration name="FilterReturn"
stability="Unstable"
c:type="CoglFilterReturn">
<doc xml:space="preserve">Return values for the #CoglXlibFilterFunc and #CoglWin32FilterFunc functions.</doc>
<member name="continue" value="0" c:identifier="COGL_FILTER_CONTINUE">
<doc xml:space="preserve">The event was not handled, continues the
processing</doc>
</member>
<member name="remove" value="1" c:identifier="COGL_FILTER_REMOVE">
<doc xml:space="preserve">Remove the event, stops the processing</doc>
</member>
</enumeration>
<enumeration name="FogMode" version="1.0" c:type="CoglFogMode">
<doc xml:space="preserve">The fog mode determines the equation used to calculate the fogging blend
factor while fogging is enabled. The simplest %COGL_FOG_MODE_LINEAR mode
determines f as:
|[
f = end - eye_distance / end - start
]|
Where eye_distance is the distance of the current fragment in eye
coordinates from the origin.</doc>
<member name="linear" value="0" c:identifier="COGL_FOG_MODE_LINEAR">
<doc xml:space="preserve">Calculates the fog blend factor as:
|[
f = end - eye_distance / end - start
]|</doc>
</member>
<member name="exponential"
value="1"
c:identifier="COGL_FOG_MODE_EXPONENTIAL">
<doc xml:space="preserve">Calculates the fog blend factor as:
|[
f = e ^ -(density * eye_distance)
]|</doc>
</member>
<member name="exponential_squared"
value="2"
c:identifier="COGL_FOG_MODE_EXPONENTIAL_SQUARED">
<doc xml:space="preserve">Calculates the fog blend factor as:
|[
f = e ^ -(density * eye_distance)^2
]|</doc>
</member>
</enumeration>
<callback name="FuncPtr" c:type="CoglFuncPtr">
<doc xml:space="preserve">The type used by cogl for function pointers, note that this type
is used as a generic catch-all cast for function pointers and the
actual arguments and return type may be different.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
<enumeration name="IndicesType" c:type="CoglIndicesType">
<doc xml:space="preserve">You should aim to use the smallest data type that gives you enough
range, since it reduces the size of your index array and can help
reduce the demand on memory bandwidth.
Note that %COGL_INDICES_TYPE_UNSIGNED_INT is only supported if the
%COGL_FEATURE_ID_UNSIGNED_INT_INDICES feature is available. This
should always be available on OpenGL but on OpenGL ES it will only
be available if the GL_OES_element_index_uint extension is
advertized.</doc>
<member name="byte"
value="0"
c:identifier="COGL_INDICES_TYPE_UNSIGNED_BYTE">
<doc xml:space="preserve">Your indices are unsigned bytes</doc>
</member>
<member name="short"
value="1"
c:identifier="COGL_INDICES_TYPE_UNSIGNED_SHORT">
<doc xml:space="preserve">Your indices are unsigned shorts</doc>
</member>
<member name="int"
value="2"
c:identifier="COGL_INDICES_TYPE_UNSIGNED_INT">
<doc xml:space="preserve">Your indices are unsigned ints</doc>
</member>
</enumeration>
<record name="Material"
c:type="CoglMaterial"
glib:type-name="CoglMaterial"
glib:get-type="cogl_material_get_type"
c:symbol-prefix="material">
<constructor name="new"
c:identifier="cogl_material_new"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Allocates and initializes a blank white material</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_new() instead</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a pointer to a new #CoglMaterial</doc>
<type name="Material" c:type="CoglMaterial*"/>
</return-value>
</constructor>
<method name="copy"
c:identifier="cogl_material_copy"
version="1.2"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Creates a new material with the configuration copied from the
source material.
We would strongly advise developers to always aim to use
cogl_material_copy() instead of cogl_material_new() whenever there will
be any similarity between two materials. Copying a material helps Cogl
keep track of a materials ancestry which we may use to help minimize GPU
state changes.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_copy() instead</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a pointer to the newly allocated #CoglMaterial</doc>
<type name="Material" c:type="CoglMaterial*"/>
</return-value>
<parameters>
<instance-parameter name="source" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object to copy</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
</parameters>
</method>
<method name="foreach_layer"
c:identifier="cogl_material_foreach_layer"
version="1.4"
deprecated="1"
deprecated-version="1.16"
stability="Unstable">
<doc xml:space="preserve">Iterates all the layer indices of the given @material.</doc>
<doc-deprecated xml:space="preserve">No replacement</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="callback"
transfer-ownership="none"
scope="call"
closure="1">
<doc xml:space="preserve">A #CoglMaterialLayerCallback to be called for each
layer index</doc>
<type name="MaterialLayerCallback"
c:type="CoglMaterialLayerCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">Private data that will be passed to the callback</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</method>
<method name="get_ambient"
c:identifier="cogl_material_get_ambient"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the current ambient color for @material</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="ambient" transfer-ownership="none">
<doc xml:space="preserve">The location to store the ambient color</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="get_color"
c:identifier="cogl_material_get_color"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the current material color.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_color() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="color"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">The location to store the color</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="get_depth_state"
c:identifier="cogl_material_get_depth_state"
version="2.0"
introspectable="0"
deprecated="1"
deprecated-version="1.16"
stability="Unstable">
<doc xml:space="preserve">Retrieves the current depth state configuration for the given
@pipeline as previously set using cogl_pipeline_set_depth_state().</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_depth_state() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="state_out" transfer-ownership="none">
<doc xml:space="preserve">A destination #CoglDepthState struct</doc>
<type c:type="CoglDepthState*"/>
</parameter>
</parameters>
</method>
<method name="get_diffuse"
c:identifier="cogl_material_get_diffuse"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the current diffuse color for @material</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="diffuse" transfer-ownership="none">
<doc xml:space="preserve">The location to store the diffuse color</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="get_emission"
c:identifier="cogl_material_get_emission"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the materials current emission color.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="emission" transfer-ownership="none">
<doc xml:space="preserve">The location to store the emission color</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="get_layer_point_sprite_coords_enabled"
c:identifier="cogl_material_get_layer_point_sprite_coords_enabled"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets whether point sprite coordinate generation is enabled for this
texture layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_layer_point_sprite_coords_enabled()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the texture coordinates will be replaced with
point sprite coordinates.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle to a material.</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to check.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="get_layer_wrap_mode_p"
c:identifier="cogl_material_get_layer_wrap_mode_p"
version="1.6"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Returns the wrap mode for the 'p' coordinate of texture lookups on this
layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_layer_wrap_mode_p() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the wrap mode for the 'p' coordinate of texture lookups on
this layer.</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="get_layer_wrap_mode_s"
c:identifier="cogl_material_get_layer_wrap_mode_s"
version="1.6"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Returns the wrap mode for the 's' coordinate of texture lookups on this
layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_layer_wrap_mode_s() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the wrap mode for the 's' coordinate of texture lookups on
this layer.</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="get_layer_wrap_mode_t"
c:identifier="cogl_material_get_layer_wrap_mode_t"
version="1.6"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Returns the wrap mode for the 't' coordinate of texture lookups on this
layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_layer_wrap_mode_t() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the wrap mode for the 't' coordinate of texture lookups on
this layer.</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="get_layers" c:identifier="cogl_material_get_layers">
<doc xml:space="preserve">This function lets you access a material's internal list of layers
for iteration.
<note>You should avoid using this API if possible since it was only
made public by mistake and will be deprecated when we have
suitable alternative.</note>
<note>It's important to understand that the list returned may not
remain valid if you modify the material or any of the layers in any
way and so you would have to re-get the list in that
situation.</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A
list of #CoglMaterialLayer<!-- -->'s that can be passed to the
cogl_material_layer_* functions. The list is owned by Cogl and it
should not be modified or freed
Deprecated: 1.16: Use cogl_pipeline_get_layers() instead</doc>
<type name="GLib.List" c:type="const GList*">
<type name="MaterialLayer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_n_layers"
c:identifier="cogl_material_get_n_layers"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the number of layers defined for the given @material</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_n_layers() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of layers</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_point_size"
c:identifier="cogl_material_get_point_size"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Get the size of points drawn when %COGL_VERTICES_MODE_POINTS is
used with the vertex buffer API.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_point_size() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the point size of the material.</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle to a material.</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_shininess"
c:identifier="cogl_material_get_shininess"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the materials current emission color.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The materials current shininess value</doc>
<type name="gfloat" c:type="float"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_specular"
c:identifier="cogl_material_get_specular"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the materials current specular color.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="specular" transfer-ownership="none">
<doc xml:space="preserve">The location to store the specular color</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="get_user_program"
c:identifier="cogl_material_get_user_program"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Queries what user program has been associated with the given
@material using cogl_material_set_user_program().</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current user program
or %COGL_INVALID_HANDLE.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object.</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
</parameters>
</method>
<method name="remove_layer"
c:identifier="cogl_material_remove_layer"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This function removes a layer from your material</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_remove_layer() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">Specifies the layer you want to remove</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="set_alpha_test_function"
c:identifier="cogl_material_set_alpha_test_function"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Before a primitive is blended with the framebuffer, it goes through an
alpha test stage which lets you discard fragments based on the current
alpha value. This function lets you change the function used to evaluate
the alpha channel, and thus determine which fragments are discarded
and which continue on to the blending stage.
The default is %COGL_MATERIAL_ALPHA_FUNC_ALWAYS</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_alpha_test_function() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="alpha_func" transfer-ownership="none">
<doc xml:space="preserve">A @CoglMaterialAlphaFunc constant</doc>
<type name="MaterialAlphaFunc" c:type="CoglMaterialAlphaFunc"/>
</parameter>
<parameter name="alpha_reference" transfer-ownership="none">
<doc xml:space="preserve">A reference point that the chosen alpha function uses
to compare incoming fragments to.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_ambient"
c:identifier="cogl_material_set_ambient"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the material's ambient color, in the standard OpenGL lighting
model. The ambient color affects the overall color of the object.
Since the diffuse color will be intense when the light hits the surface
directly, the ambient will be most apparent where the light hits at a
slant.
The default value is (0.2, 0.2, 0.2, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="ambient" transfer-ownership="none">
<doc xml:space="preserve">The components of the desired ambient color</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_ambient_and_diffuse"
c:identifier="cogl_material_set_ambient_and_diffuse"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Conveniently sets the diffuse and ambient color of @material at the same
time. See cogl_material_set_ambient() and cogl_material_set_diffuse().
The default ambient color is (0.2, 0.2, 0.2, 1.0)
The default diffuse color is (0.8, 0.8, 0.8, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">The components of the desired ambient and diffuse colors</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_blend"
c:identifier="cogl_material_set_blend"
version="1.0"
deprecated="1"
deprecated-version="1.16"
throws="1">
<doc xml:space="preserve">If not already familiar; please refer <link linkend="cogl-Blend-Strings">here</link>
for an overview of what blend strings are, and their syntax.
Blending occurs after the alpha test function, and combines fragments with
the framebuffer.
Currently the only blend function Cogl exposes is ADD(). So any valid
blend statements will be of the form:
|[
&lt;channel-mask&gt;=ADD(SRC_COLOR*(&lt;factor&gt;), DST_COLOR*(&lt;factor&gt;))
]|
<warning>The brackets around blend factors are currently not
optional!</warning>
This is the list of source-names usable as blend factors:
<itemizedlist>
<listitem><para>SRC_COLOR: The color of the in comming fragment</para></listitem>
<listitem><para>DST_COLOR: The color of the framebuffer</para></listitem>
<listitem><para>CONSTANT: The constant set via cogl_material_set_blend_constant()</para></listitem>
</itemizedlist>
The source names can be used according to the
<link linkend="cogl-Blend-String-syntax">color-source and factor syntax</link>,
so for example "(1-SRC_COLOR[A])" would be a valid factor, as would
"(CONSTANT[RGB])"
These can also be used as factors:
<itemizedlist>
<listitem>0: (0, 0, 0, 0)</listitem>
<listitem>1: (1, 1, 1, 1)</listitem>
<listitem>SRC_ALPHA_SATURATE_FACTOR: (f,f,f,1) where f = MIN(SRC_COLOR[A],1-DST_COLOR[A])</listitem>
</itemizedlist>
<note>Remember; all color components are normalized to the range [0, 1]
before computing the result of blending.</note>
<example id="cogl-Blend-Strings-blend-unpremul">
<title>Blend Strings/1</title>
<para>Blend a non-premultiplied source over a destination with
premultiplied alpha:</para>
<programlisting>
"RGB = ADD(SRC_COLOR*(SRC_COLOR[A]), DST_COLOR*(1-SRC_COLOR[A]))"
"A = ADD(SRC_COLOR, DST_COLOR*(1-SRC_COLOR[A]))"
</programlisting>
</example>
<example id="cogl-Blend-Strings-blend-premul">
<title>Blend Strings/2</title>
<para>Blend a premultiplied source over a destination with
premultiplied alpha</para>
<programlisting>
"RGBA = ADD(SRC_COLOR, DST_COLOR*(1-SRC_COLOR[A]))"
</programlisting>
</example>
The default blend string is:
|[
RGBA = ADD (SRC_COLOR, DST_COLOR*(1-SRC_COLOR[A]))
]|
That gives normal alpha-blending when the calculated color for the material
is in premultiplied form.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_blend() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the blend string was successfully parsed, and the
described blending is supported by the underlying driver/hardware. If
there was an error, %FALSE is returned and @error is set accordingly (if
present).</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="blend_string" transfer-ownership="none">
<doc xml:space="preserve">A <link linkend="cogl-Blend-Strings">Cogl blend string</link>
describing the desired blend function.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_blend_constant"
c:identifier="cogl_material_set_blend_constant"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">When blending is setup to reference a CONSTANT blend factor then
blending will depend on the constant set with this function.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_blend_constant() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="constant_color" transfer-ownership="none">
<doc xml:space="preserve">The constant color you want</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_color"
c:identifier="cogl_material_set_color"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the basic color of the material, used when no lighting is enabled.
Note that if you don't add any layers to the material then the color
will be blended unmodified with the destination; the default blend
expects premultiplied colors: for example, use (0.5, 0.0, 0.0, 0.5) for
semi-transparent red. See cogl_color_premultiply().
The default value is (1.0, 1.0, 1.0, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_color() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">The components of the color</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_color4f"
c:identifier="cogl_material_set_color4f"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the basic color of the material, used when no lighting is enabled.
The default value is (1.0, 1.0, 1.0, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_color4f() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">The red component</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">The green component</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">The blue component</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">The alpha component</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_color4ub"
c:identifier="cogl_material_set_color4ub"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the basic color of the material, used when no lighting is enabled.
The default value is (0xff, 0xff, 0xff, 0xff)</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_color4ub() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">The red component</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">The green component</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">The blue component</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">The alpha component</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
</parameters>
</method>
<method name="set_depth_state"
c:identifier="cogl_material_set_depth_state"
version="1.8"
introspectable="0"
deprecated="1"
deprecated-version="1.16"
stability="Unstable"
throws="1">
<doc xml:space="preserve">This commits all the depth state configured in @state struct to the
given @material. The configuration values are copied into the
material so there is no requirement to keep the #CoglDepthState
struct around if you don't need it any more.
Note: Since some platforms do not support the depth range feature
it is possible for this function to fail and report an @error.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_depth_state() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the GPU supports all the given @state else %FALSE
and returns an @error.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve">A #CoglDepthState struct</doc>
<type c:type="const CoglDepthState*"/>
</parameter>
</parameters>
</method>
<method name="set_diffuse"
c:identifier="cogl_material_set_diffuse"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the material's diffuse color, in the standard OpenGL lighting
model. The diffuse color is most intense where the light hits the
surface directly - perpendicular to the surface.
The default value is (0.8, 0.8, 0.8, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="diffuse" transfer-ownership="none">
<doc xml:space="preserve">The components of the desired diffuse color</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_emission"
c:identifier="cogl_material_set_emission"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the material's emissive color, in the standard OpenGL lighting
model. It will look like the surface is a light source emitting this
color.
The default value is (0.0, 0.0, 0.0, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="emission" transfer-ownership="none">
<doc xml:space="preserve">The components of the desired emissive color</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_layer"
c:identifier="cogl_material_set_layer"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">In addition to the standard OpenGL lighting model a Cogl material may have
one or more layers comprised of textures that can be blended together in
order, with a number of different texture combine modes. This function
defines a new texture layer.
The index values of multiple layers do not have to be consecutive; it is
only their relative order that is important.
<note>In the future, we may define other types of material layers, such
as purely GLSL based layers.</note></doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the index of the layer</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for the layer object</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</method>
<method name="set_layer_combine"
c:identifier="cogl_material_set_layer_combine"
version="1.0"
deprecated="1"
deprecated-version="1.16"
throws="1">
<doc xml:space="preserve">If not already familiar; you can refer
<link linkend="cogl-Blend-Strings">here</link> for an overview of what blend
strings are and there syntax.
These are all the functions available for texture combining:
<itemizedlist>
<listitem>REPLACE(arg0) = arg0</listitem>
<listitem>MODULATE(arg0, arg1) = arg0 x arg1</listitem>
<listitem>ADD(arg0, arg1) = arg0 + arg1</listitem>
<listitem>ADD_SIGNED(arg0, arg1) = arg0 + arg1 - 0.5</listitem>
<listitem>INTERPOLATE(arg0, arg1, arg2) = arg0 x arg2 + arg1 x (1 - arg2)</listitem>
<listitem>SUBTRACT(arg0, arg1) = arg0 - arg1</listitem>
<listitem>
<programlisting>
DOT3_RGB(arg0, arg1) = 4 x ((arg0[R] - 0.5)) * (arg1[R] - 0.5) +
(arg0[G] - 0.5)) * (arg1[G] - 0.5) +
(arg0[B] - 0.5)) * (arg1[B] - 0.5))
</programlisting>
</listitem>
<listitem>
<programlisting>
DOT3_RGBA(arg0, arg1) = 4 x ((arg0[R] - 0.5)) * (arg1[R] - 0.5) +
(arg0[G] - 0.5)) * (arg1[G] - 0.5) +
(arg0[B] - 0.5)) * (arg1[B] - 0.5))
</programlisting>
</listitem>
</itemizedlist>
Refer to the
<link linkend="cogl-Blend-String-syntax">color-source syntax</link> for
describing the arguments. The valid source names for texture combining
are:
<variablelist>
<varlistentry>
<term>TEXTURE</term>
<listitem>Use the color from the current texture layer</listitem>
</varlistentry>
<varlistentry>
<term>TEXTURE_0, TEXTURE_1, etc</term>
<listitem>Use the color from the specified texture layer</listitem>
</varlistentry>
<varlistentry>
<term>CONSTANT</term>
<listitem>Use the color from the constant given with
cogl_material_set_layer_constant()</listitem>
</varlistentry>
<varlistentry>
<term>PRIMARY</term>
<listitem>Use the color of the material as set with
cogl_material_set_color()</listitem>
</varlistentry>
<varlistentry>
<term>PREVIOUS</term>
<listitem>Either use the texture color from the previous layer, or
if this is layer 0, use the color of the material as set with
cogl_material_set_color()</listitem>
</varlistentry>
</variablelist>
<refsect2 id="cogl-Layer-Combine-Examples">
<title>Layer Combine Examples</title>
<para>This is effectively what the default blending is:</para>
<informalexample><programlisting>
RGBA = MODULATE (PREVIOUS, TEXTURE)
</programlisting></informalexample>
<para>This could be used to cross-fade between two images, using
the alpha component of a constant as the interpolator. The constant
color is given by calling cogl_material_set_layer_constant.</para>
<informalexample><programlisting>
RGBA = INTERPOLATE (PREVIOUS, TEXTURE, CONSTANT[A])
</programlisting></informalexample>
</refsect2>
<note>You can't give a multiplication factor for arguments as you can
with blending.</note></doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_combine() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the blend string was successfully parsed, and the
described texture combining is supported by the underlying driver and
or hardware. On failure, %FALSE is returned and @error is set</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">Specifies the layer you want define a combine function for</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="blend_string" transfer-ownership="none">
<doc xml:space="preserve">A <link linkend="cogl-Blend-Strings">Cogl blend string</link>
describing the desired texture combine function.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_layer_combine_constant"
c:identifier="cogl_material_set_layer_combine_constant"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">When you are using the 'CONSTANT' color source in a layer combine
description then you can use this function to define its value.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_combine_constant()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">Specifies the layer you want to specify a constant used
for texture combining</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="constant" transfer-ownership="none">
<doc xml:space="preserve">The constant color you want</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_layer_filters"
c:identifier="cogl_material_set_layer_filters"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the decimation and interpolation filters used when a texture is
drawn at other scales than 100%.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_filters() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="min_filter" transfer-ownership="none">
<doc xml:space="preserve">the filter used when scaling a texture down.</doc>
<type name="MaterialFilter" c:type="CoglMaterialFilter"/>
</parameter>
<parameter name="mag_filter" transfer-ownership="none">
<doc xml:space="preserve">the filter used when magnifying a texture.</doc>
<type name="MaterialFilter" c:type="CoglMaterialFilter"/>
</parameter>
</parameters>
</method>
<method name="set_layer_matrix"
c:identifier="cogl_material_set_layer_matrix"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This function lets you set a matrix that can be used to e.g. translate
and rotate a single layer of a material used to fill your geometry.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_matrix() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the index for the layer inside @material</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">the transformation matrix for the layer</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</parameter>
</parameters>
</method>
<method name="set_layer_point_sprite_coords_enabled"
c:identifier="cogl_material_set_layer_point_sprite_coords_enabled"
version="1.4"
deprecated="1"
deprecated-version="1.16"
throws="1">
<doc xml:space="preserve">When rendering points, if @enable is %TRUE then the texture
coordinates for this layer will be replaced with coordinates that
vary from 0.0 to 1.0 across the primitive. The top left of the
point will have the coordinates 0.0,0.0 and the bottom right will
have 1.0,1.0. If @enable is %FALSE then the coordinates will be
fixed for the entire point.
This function will only work if %COGL_FEATURE_POINT_SPRITE is
available. If the feature is not available then the function will
return %FALSE and set @error.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_point_sprite_coords_enabled()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the function succeeds, %FALSE otherwise.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle to a material.</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve">whether to enable point sprite coord generation.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</method>
<method name="set_layer_wrap_mode"
c:identifier="cogl_material_set_layer_wrap_mode"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the wrap mode for all three coordinates of texture lookups on
this layer. This is equivalent to calling
cogl_material_set_layer_wrap_mode_s(),
cogl_material_set_layer_wrap_mode_t() and
cogl_material_set_layer_wrap_mode_p() separately.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_wrap_mode() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the new wrap mode</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</parameter>
</parameters>
</method>
<method name="set_layer_wrap_mode_p"
c:identifier="cogl_material_set_layer_wrap_mode_p"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the wrap mode for the 'p' coordinate of texture lookups on
this layer. 'p' is the third coordinate.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_wrap_mode_p() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the new wrap mode</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</parameter>
</parameters>
</method>
<method name="set_layer_wrap_mode_s"
c:identifier="cogl_material_set_layer_wrap_mode_s"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the wrap mode for the 's' coordinate of texture lookups on this layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_wrap_mode_s() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the new wrap mode</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</parameter>
</parameters>
</method>
<method name="set_layer_wrap_mode_t"
c:identifier="cogl_material_set_layer_wrap_mode_t"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the wrap mode for the 't' coordinate of texture lookups on this layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_layer_wrap_mode_t() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">the layer number to change.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the new wrap mode</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</parameter>
</parameters>
</method>
<method name="set_point_size"
c:identifier="cogl_material_set_point_size"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the size of points drawn when %COGL_VERTICES_MODE_POINTS is
used with the vertex buffer API. Note that typically the GPU will
only support a limited minimum and maximum range of point sizes. If
the chosen point size is outside that range then the nearest value
within that range will be used instead. The size of a point is in
screen space so it will be the same regardless of any
transformations. The default point size is 1.0.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_point_size() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a material.</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="point_size" transfer-ownership="none">
<doc xml:space="preserve">the new point size.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_shininess"
c:identifier="cogl_material_set_shininess"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the shininess of the material, in the standard OpenGL lighting
model, which determines the size of the specular highlights. A
higher @shininess will produce smaller highlights which makes the
object appear more shiny.
The default value is 0.0</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="shininess" transfer-ownership="none">
<doc xml:space="preserve">The desired shininess; must be >= 0.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="set_specular"
c:identifier="cogl_material_set_specular"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets the material's specular color, in the standard OpenGL lighting
model. The intensity of the specular color depends on the viewport
position, and is brightest along the lines of reflection.
The default value is (0.0, 0.0, 0.0, 1.0)</doc>
<doc-deprecated xml:space="preserve">Use the #CoglSnippet shader api for lighting</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterial object</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="specular" transfer-ownership="none">
<doc xml:space="preserve">The components of the desired specular color</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</method>
<method name="set_user_program"
c:identifier="cogl_material_set_user_program"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Associates a linked CoglProgram with the given material so that the
program can take full control of vertex and/or fragment processing.
This is an example of how it can be used to associate an ARBfp
program with a #CoglMaterial:
|[
CoglHandle shader;
CoglHandle program;
CoglMaterial *material;
shader = cogl_create_shader (COGL_SHADER_TYPE_FRAGMENT);
cogl_shader_source (shader,
"!!ARBfp1.0\n"
"MOV result.color,fragment.color;\n"
"END\n");
cogl_shader_compile (shader);
program = cogl_create_program ();
cogl_program_attach_shader (program, shader);
cogl_program_link (program);
material = cogl_material_new ();
cogl_material_set_user_program (material, program);
cogl_set_source_color4ub (0xff, 0x00, 0x00, 0xff);
cogl_rectangle (0, 0, 100, 100);
]|
It is possibly worth keeping in mind that this API is not part of
the long term design for how we want to expose shaders to Cogl
developers (We are planning on deprecating the cogl_program and
cogl_shader APIs in favour of a "snippet" framework) but in the
meantime we hope this will handle most practical GLSL and ARBfp
requirements.
Also remember you need to check for either the
%COGL_FEATURE_SHADERS_GLSL or %COGL_FEATURE_SHADERS_ARBFP before
using the cogl_program or cogl_shader API.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object.</doc>
<type name="Material" c:type="CoglMaterial*"/>
</instance-parameter>
<parameter name="program" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle to a linked CoglProgram</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</method>
<function name="ref"
c:identifier="cogl_material_ref"
version="1.0"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Increment the reference count for a #CoglMaterial.</doc>
<doc-deprecated xml:space="preserve">Use cogl_object_ref() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the @material.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="unref"
c:identifier="cogl_material_unref"
version="1.0"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Decrement the reference count for a #CoglMaterial.</doc>
<doc-deprecated xml:space="preserve">Use cogl_object_unref() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
</record>
<enumeration name="MaterialAlphaFunc" c:type="CoglMaterialAlphaFunc">
<doc xml:space="preserve">Alpha testing happens before blending primitives with the framebuffer and
gives an opportunity to discard fragments based on a comparison with the
incoming alpha value and a reference alpha value. The #CoglMaterialAlphaFunc
determines how the comparison is done.</doc>
<member name="never"
value="512"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_NEVER">
<doc xml:space="preserve">Never let the fragment through.</doc>
</member>
<member name="less"
value="513"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_LESS">
<doc xml:space="preserve">Let the fragment through if the incoming
alpha value is less than the reference alpha value</doc>
</member>
<member name="equal"
value="514"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_EQUAL">
<doc xml:space="preserve">Let the fragment through if the incoming
alpha value equals the reference alpha value</doc>
</member>
<member name="lequal"
value="515"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_LEQUAL">
<doc xml:space="preserve">Let the fragment through if the incoming
alpha value is less than or equal to the reference alpha value</doc>
</member>
<member name="greater"
value="516"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_GREATER">
<doc xml:space="preserve">Let the fragment through if the incoming
alpha value is greater than the reference alpha value</doc>
</member>
<member name="notequal"
value="517"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_NOTEQUAL">
<doc xml:space="preserve">Let the fragment through if the incoming
alpha value does not equal the reference alpha value</doc>
</member>
<member name="gequal"
value="518"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_GEQUAL">
<doc xml:space="preserve">Let the fragment through if the incoming
alpha value is greater than or equal to the reference alpha value.</doc>
</member>
<member name="always"
value="519"
c:identifier="COGL_MATERIAL_ALPHA_FUNC_ALWAYS">
<doc xml:space="preserve">Always let the fragment through.</doc>
</member>
</enumeration>
<enumeration name="MaterialFilter" c:type="CoglMaterialFilter">
<doc xml:space="preserve">Texture filtering is used whenever the current pixel maps either to more
than one texture element (texel) or less than one. These filter enums
correspond to different strategies used to come up with a pixel color, by
possibly referring to multiple neighbouring texels and taking a weighted
average or simply using the nearest texel.</doc>
<member name="nearest"
value="9728"
c:identifier="COGL_MATERIAL_FILTER_NEAREST">
<doc xml:space="preserve">Measuring in manhatten distance from the,
current pixel center, use the nearest texture texel</doc>
</member>
<member name="linear"
value="9729"
c:identifier="COGL_MATERIAL_FILTER_LINEAR">
<doc xml:space="preserve">Use the weighted average of the 4 texels
nearest the current pixel center</doc>
</member>
<member name="nearest_mipmap_nearest"
value="9984"
c:identifier="COGL_MATERIAL_FILTER_NEAREST_MIPMAP_NEAREST">
<doc xml:space="preserve">Select the mimap level whose
texel size most closely matches the current pixel, and use the
%COGL_MATERIAL_FILTER_NEAREST criterion</doc>
</member>
<member name="linear_mipmap_nearest"
value="9985"
c:identifier="COGL_MATERIAL_FILTER_LINEAR_MIPMAP_NEAREST">
<doc xml:space="preserve">Select the mimap level whose
texel size most closely matches the current pixel, and use the
%COGL_MATERIAL_FILTER_LINEAR criterion</doc>
</member>
<member name="nearest_mipmap_linear"
value="9986"
c:identifier="COGL_MATERIAL_FILTER_NEAREST_MIPMAP_LINEAR">
<doc xml:space="preserve">Select the two mimap levels
whose texel size most closely matches the current pixel, use
the %COGL_MATERIAL_FILTER_NEAREST criterion on each one and take
their weighted average</doc>
</member>
<member name="linear_mipmap_linear"
value="9987"
c:identifier="COGL_MATERIAL_FILTER_LINEAR_MIPMAP_LINEAR">
<doc xml:space="preserve">Select the two mimap levels
whose texel size most closely matches the current pixel, use
the %COGL_MATERIAL_FILTER_LINEAR criterion on each one and take
their weighted average</doc>
</member>
</enumeration>
<record name="MaterialLayer" c:type="CoglMaterialLayer" disguised="1">
<method name="get_mag_filter"
c:identifier="cogl_material_layer_get_mag_filter"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Queries the currently set downscaling filter for a material later</doc>
<doc-deprecated xml:space="preserve">No replacement</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the current downscaling filter</doc>
<type name="MaterialFilter" c:type="CoglMaterialFilter"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterialLayer object</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_min_filter"
c:identifier="cogl_material_layer_get_min_filter"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Queries the currently set downscaling filter for a material layer</doc>
<doc-deprecated xml:space="preserve">No replacement</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the current downscaling filter</doc>
<type name="MaterialFilter" c:type="CoglMaterialFilter"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a material layer</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_texture"
c:identifier="cogl_material_layer_get_texture"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Extracts a texture handle for a specific layer.
<note>In the future Cogl may support purely GLSL based layers; for those
layers this function which will likely return %COGL_INVALID_HANDLE if you
try to get the texture handle from them. Considering this scenario, you
should call cogl_material_layer_get_type() first in order check it is of
type %COGL_MATERIAL_LAYER_TYPE_TEXTURE before calling this function.</note></doc>
<doc-deprecated xml:space="preserve">No replacement</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for the texture inside the layer</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterialLayer object</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_type"
c:identifier="cogl_material_layer_get_type"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the type of the layer
Currently there is only one type of layer defined:
%COGL_MATERIAL_LAYER_TYPE_TEXTURE, but considering we may add purely GLSL
based layers in the future, you should write code that checks the type
first.</doc>
<doc-deprecated xml:space="preserve">No replacement</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the type of the layer</doc>
<type name="MaterialLayerType" c:type="CoglMaterialLayerType"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterialLayer object</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wrap_mode_p"
c:identifier="cogl_material_layer_get_wrap_mode_p"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets the wrap mode for the 'p' coordinate of texture lookups on
this layer. 'p' is the third coordinate.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_layer_get_wrap_mode_p() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the wrap mode value for the p coordinate.</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterialLayer object</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wrap_mode_s"
c:identifier="cogl_material_layer_get_wrap_mode_s"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets the wrap mode for the 's' coordinate of texture lookups on this layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_layer_get_wrap_mode_s() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the wrap mode value for the s coordinate.</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterialLayer object</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wrap_mode_t"
c:identifier="cogl_material_layer_get_wrap_mode_t"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets the wrap mode for the 't' coordinate of texture lookups on this layer.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_layer_get_wrap_mode_t() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the wrap mode value for the t coordinate.</doc>
<type name="MaterialWrapMode" c:type="CoglMaterialWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMaterialLayer object</doc>
<type name="MaterialLayer" c:type="CoglMaterialLayer*"/>
</instance-parameter>
</parameters>
</method>
</record>
<callback name="MaterialLayerCallback"
c:type="CoglMaterialLayerCallback"
version="1.4"
deprecated="1"
deprecated-version="1.16"
stability="Unstable">
<doc xml:space="preserve">The callback prototype used with cogl_material_foreach_layer() for
iterating all the layers of a @material.</doc>
<return-value transfer-ownership="none">
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">The #CoglMaterial whos layers are being iterated</doc>
<type name="Material" c:type="CoglMaterial*"/>
</parameter>
<parameter name="layer_index" transfer-ownership="none">
<doc xml:space="preserve">The current layer index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="2">
<doc xml:space="preserve">The private data passed to cogl_material_foreach_layer()</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</callback>
<enumeration name="MaterialLayerType"
version="1.0"
c:type="CoglMaterialLayerType">
<doc xml:space="preserve">Available types of layers for a #CoglMaterial. This enumeration
might be expanded in later versions.</doc>
<member name="material_layer_type_texture"
value="0"
c:identifier="COGL_MATERIAL_LAYER_TYPE_TEXTURE">
<doc xml:space="preserve">The layer represents a
<link linkend="cogl-Textures">texture</link></doc>
</member>
</enumeration>
<enumeration name="MaterialWrapMode"
version="1.4"
c:type="CoglMaterialWrapMode">
<doc xml:space="preserve">The wrap mode specifies what happens when texture coordinates
outside the range 0→1 are used. Note that if the filter mode is
anything but %COGL_MATERIAL_FILTER_NEAREST then texels outside the
range 0→1 might be used even when the coordinate is exactly 0 or 1
because OpenGL will try to sample neighbouring pixels. For example
if you are trying to render the full texture then you may get
artifacts around the edges when the pixels from the other side are
merged in if the wrap mode is set to repeat.</doc>
<member name="repeat"
value="10497"
c:identifier="COGL_MATERIAL_WRAP_MODE_REPEAT">
<doc xml:space="preserve">The texture will be repeated. This
is useful for example to draw a tiled background.</doc>
</member>
<member name="clamp_to_edge"
value="33071"
c:identifier="COGL_MATERIAL_WRAP_MODE_CLAMP_TO_EDGE">
<doc xml:space="preserve">The coordinates outside the
range 0→1 will sample copies of the edge pixels of the
texture. This is useful to avoid artifacts if only one copy of
the texture is being rendered.</doc>
</member>
<member name="automatic"
value="519"
c:identifier="COGL_MATERIAL_WRAP_MODE_AUTOMATIC">
<doc xml:space="preserve">Cogl will try to automatically
decide which of the above two to use. For cogl_rectangle(), it
will use repeat mode if any of the texture coordinates are
outside the range 0→1, otherwise it will use clamp to edge. For
cogl_polygon() it will always use repeat mode. For
cogl_vertex_buffer_draw() it will use repeat mode except for
layers that have point sprite coordinate generation enabled. This
is the default value.</doc>
</member>
</enumeration>
<record name="Matrix"
c:type="CoglMatrix"
glib:type-name="CoglMatrix"
glib:get-type="cogl_matrix_get_gtype"
c:symbol-prefix="matrix">
<doc xml:space="preserve">A CoglMatrix holds a 4x4 transform matrix. This is a single precision,
column-major matrix which means it is compatible with what OpenGL expects.
A CoglMatrix can represent transforms such as, rotations, scaling,
translation, sheering, and linear projections. You can combine these
transforms by multiplying multiple matrices in the order you want them
applied.
The transformation of a vertex (x, y, z, w) by a CoglMatrix is given by:
|[
x_new = xx * x + xy * y + xz * z + xw * w
y_new = yx * x + yy * y + yz * z + yw * w
z_new = zx * x + zy * y + zz * z + zw * w
w_new = wx * x + wy * y + wz * z + ww * w
]|
Where w is normally 1
<note>You must consider the members of the CoglMatrix structure read only,
and all matrix modifications must be done via the cogl_matrix API. This
allows Cogl to annotate the matrices internally. Violation of this will give
undefined results. If you need to initialize a matrix with a constant other
than the identity matrix you can use cogl_matrix_init_from_array().</note></doc>
<field name="xx" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="yx" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="zx" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="wx" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="xy" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="yy" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="zy" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="wy" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="xz" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="yz" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="zz" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="wz" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="xw" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="yw" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="zw" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="ww" writable="1">
<type name="gfloat" c:type="float"/>
</field>
<field name="private_member_inv" readable="0" private="1">
<array zero-terminated="0" c:type="float" fixed-size="16">
<type name="gfloat" c:type="float"/>
</array>
</field>
<field name="private_member_type" readable="0" private="1">
<type name="guint" c:type="unsigned"/>
</field>
<field name="private_member_flags" readable="0" private="1">
<type name="guint" c:type="unsigned"/>
</field>
<field name="private_member__padding3" readable="0" private="1">
<type name="guint" c:type="unsigned"/>
</field>
<method name="copy" c:identifier="cogl_matrix_copy" version="1.6">
<doc xml:space="preserve">Allocates a new #CoglMatrix on the heap and initializes it with
the same values as @matrix.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly allocated #CoglMatrix which
should be freed using cogl_matrix_free()</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix you want to copy</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="cogl_matrix_free" version="1.6">
<doc xml:space="preserve">Frees a #CoglMatrix that was previously allocated via a call to
cogl_matrix_copy().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix you want to free</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
</parameters>
</method>
<method name="frustum" c:identifier="cogl_matrix_frustum">
<doc xml:space="preserve">Multiplies @matrix by the given frustum perspective matrix.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="left" transfer-ownership="none">
<doc xml:space="preserve">X position of the left clipping plane where it
intersects the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="right" transfer-ownership="none">
<doc xml:space="preserve">X position of the right clipping plane where it
intersects the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="bottom" transfer-ownership="none">
<doc xml:space="preserve">Y position of the bottom clipping plane where it
intersects the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="top" transfer-ownership="none">
<doc xml:space="preserve">Y position of the top clipping plane where it intersects
the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">The distance to the near clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_far" transfer-ownership="none">
<doc xml:space="preserve">The distance to the far clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="get_array" c:identifier="cogl_matrix_get_array">
<doc xml:space="preserve">Casts @matrix to a float array which can be directly passed to OpenGL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a pointer to the float array</doc>
<type name="gfloat" c:type="const float*"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_inverse"
c:identifier="cogl_matrix_get_inverse"
version="1.2">
<doc xml:space="preserve">Gets the inverse transform of a given matrix and uses it to initialize
a new #CoglMatrix.
<note>Although the first parameter is annotated as const to indicate
that the transform it represents isn't modified this function may
technically save a copy of the inverse transform within the given
#CoglMatrix so that subsequent requests for the inverse transform may
avoid costly inversion calculations.</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the inverse was successfully calculated or %FALSE
for degenerate transformations that can't be inverted (in this case the
@inverse matrix will simply be initialized with the identity matrix)</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
<parameter name="inverse"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">The destination for a 4x4 inverse transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</parameter>
</parameters>
</method>
<method name="init_from_array"
c:identifier="cogl_matrix_init_from_array">
<doc xml:space="preserve">Initializes @matrix with the contents of @array</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="array" transfer-ownership="none">
<doc xml:space="preserve">A linear array of 16 floats (column-major order)</doc>
<type name="gfloat" c:type="const float*"/>
</parameter>
</parameters>
</method>
<method name="init_from_euler"
c:identifier="cogl_matrix_init_from_euler">
<doc xml:space="preserve">Initializes @matrix from a #CoglEuler rotation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="euler" transfer-ownership="none">
<doc xml:space="preserve">A #CoglEuler</doc>
<type name="Euler" c:type="const CoglEuler*"/>
</parameter>
</parameters>
</method>
<method name="init_from_quaternion"
c:identifier="cogl_matrix_init_from_quaternion">
<doc xml:space="preserve">Initializes @matrix from a #CoglQuaternion rotation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="quaternion" transfer-ownership="none">
<doc xml:space="preserve">A #CoglQuaternion</doc>
<type name="Quaternion" c:type="const CoglQuaternion*"/>
</parameter>
</parameters>
</method>
<method name="init_identity" c:identifier="cogl_matrix_init_identity">
<doc xml:space="preserve">Resets matrix to the identity matrix:
|[
.xx=1; .xy=0; .xz=0; .xw=0;
.yx=0; .yy=1; .yz=0; .yw=0;
.zx=0; .zy=0; .zz=1; .zw=0;
.wx=0; .wy=0; .wz=0; .ww=1;
]|</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
</parameters>
</method>
<method name="init_translation"
c:identifier="cogl_matrix_init_translation"
version="2.0">
<doc xml:space="preserve">Resets matrix to the (tx, ty, tz) translation matrix:
|[
.xx=1; .xy=0; .xz=0; .xw=tx;
.yx=0; .yy=1; .yz=0; .yw=ty;
.zx=0; .zy=0; .zz=1; .zw=tz;
.wx=0; .wy=0; .wz=0; .ww=1;
]|</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="tx" transfer-ownership="none">
<doc xml:space="preserve">x coordinate of the translation vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="ty" transfer-ownership="none">
<doc xml:space="preserve">y coordinate of the translation vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="tz" transfer-ownership="none">
<doc xml:space="preserve">z coordinate of the translation vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="is_identity"
c:identifier="cogl_matrix_is_identity"
version="1.8">
<doc xml:space="preserve">Determines if the given matrix is an identity matrix.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @matrix is an identity matrix else %FALSE</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMatrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
</parameters>
</method>
<method name="look_at"
c:identifier="cogl_matrix_look_at"
version="1.8"
stability="Unstable">
<doc xml:space="preserve">Applies a view transform @matrix that positions the camera at
the coordinate (@eye_position_x, @eye_position_y, @eye_position_z)
looking towards an object at the coordinate (@object_x, @object_y,
@object_z). The top of the camera is aligned to the given world up
vector, which is normally simply (0, 1, 0) to map up to the
positive direction of the y axis.
Because there is a lot of missleading documentation online for
gluLookAt regarding the up vector we want to try and be a bit
clearer here.
The up vector should simply be relative to your world coordinates
and does not need to change as you move the eye and object
positions. Many online sources may claim that the up vector needs
to be perpendicular to the vector between the eye and object
position (partly because the man page is somewhat missleading) but
that is not necessary for this function.
<note>You should never look directly along the world-up
vector.</note>
<note>It is assumed you are using a typical projection matrix where
your origin maps to the center of your viewport.</note>
<note>Almost always when you use this function it should be the first
transform applied to a new modelview transform</note></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="eye_position_x" transfer-ownership="none">
<doc xml:space="preserve">The X coordinate to look from</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="eye_position_y" transfer-ownership="none">
<doc xml:space="preserve">The Y coordinate to look from</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="eye_position_z" transfer-ownership="none">
<doc xml:space="preserve">The Z coordinate to look from</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="object_x" transfer-ownership="none">
<doc xml:space="preserve">The X coordinate of the object to look at</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="object_y" transfer-ownership="none">
<doc xml:space="preserve">The Y coordinate of the object to look at</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="object_z" transfer-ownership="none">
<doc xml:space="preserve">The Z coordinate of the object to look at</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="world_up_x" transfer-ownership="none">
<doc xml:space="preserve">The X component of the world's up direction vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="world_up_y" transfer-ownership="none">
<doc xml:space="preserve">The Y component of the world's up direction vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="world_up_z" transfer-ownership="none">
<doc xml:space="preserve">The Z component of the world's up direction vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="multiply" c:identifier="cogl_matrix_multiply">
<doc xml:space="preserve">Multiplies the two supplied matrices together and stores
the resulting matrix inside @result.
<note>It is possible to multiply the @a matrix in-place, so
@result can be equal to @a but can't be equal to @b.</note></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">The address of a 4x4 matrix to store the result in</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="a" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</parameter>
<parameter name="b" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</parameter>
</parameters>
</method>
<method name="ortho"
c:identifier="cogl_matrix_ortho"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Multiplies @matrix by a parallel projection matrix.</doc>
<doc-deprecated xml:space="preserve">Use cogl_matrix_orthographic()</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="left" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the left clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="right" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the right clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="bottom" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the bottom clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="top" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the top clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="near" transfer-ownership="none">
<doc xml:space="preserve">The <emphasis>distance</emphasis> to the near clipping
plane (will be <emphasis>negative</emphasis> if the plane is
behind the viewer)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="far" transfer-ownership="none">
<doc xml:space="preserve">The <emphasis>distance</emphasis> to the far clipping
plane (will be <emphasis>negative</emphasis> if the plane is
behind the viewer)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="orthographic"
c:identifier="cogl_matrix_orthographic"
version="1.10"
stability="Unstable">
<doc xml:space="preserve">Multiplies @matrix by a parallel projection matrix.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="x_1" transfer-ownership="none">
<doc xml:space="preserve">The x coordinate for the first vertical clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y_1" transfer-ownership="none">
<doc xml:space="preserve">The y coordinate for the first horizontal clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="x_2" transfer-ownership="none">
<doc xml:space="preserve">The x coordinate for the second vertical clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y_2" transfer-ownership="none">
<doc xml:space="preserve">The y coordinate for the second horizontal clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="near" transfer-ownership="none">
<doc xml:space="preserve">The <emphasis>distance</emphasis> to the near clipping
plane (will be <emphasis>negative</emphasis> if the plane is
behind the viewer)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="far" transfer-ownership="none">
<doc xml:space="preserve">The <emphasis>distance</emphasis> to the far clipping
plane (will be <emphasis>negative</emphasis> if the plane is
behind the viewer)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="perspective" c:identifier="cogl_matrix_perspective">
<doc xml:space="preserve">Multiplies @matrix by the described perspective matrix
<note>You should be careful not to have to great a @z_far / @z_near
ratio since that will reduce the effectiveness of depth testing
since there wont be enough precision to identify the depth of
objects near to each other.</note></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="fov_y" transfer-ownership="none">
<doc xml:space="preserve">Vertical field of view angle in degrees.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="aspect" transfer-ownership="none">
<doc xml:space="preserve">The (width over height) aspect ratio for display</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">The distance to the near clipping plane (Must be positive,
and must not be 0)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_far" transfer-ownership="none">
<doc xml:space="preserve">The distance to the far clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="project_points"
c:identifier="cogl_matrix_project_points"
stability="Unstable">
<doc xml:space="preserve">Projects an array of input points and writes the result to another
array of output points. The input points can either have 2, 3 or 4
components each. The output points always have 4 components (known
as homogenous coordinates). The output array can simply point to
the input array to do the transform in-place.
Here's an example with differing input/output strides:
|[
typedef struct {
float x,y;
uint8_t r,g,b,a;
float s,t,p;
} MyInVertex;
typedef struct {
uint8_t r,g,b,a;
float x,y,z;
} MyOutVertex;
MyInVertex vertices[N_VERTICES];
MyOutVertex results[N_VERTICES];
CoglMatrix matrix;
my_load_vertices (vertices);
my_get_matrix (&matrix);
cogl_matrix_project_points (&matrix,
2,
sizeof (MyInVertex),
&vertices[0].x,
sizeof (MyOutVertex),
&results[0].x,
N_VERTICES);
]|</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A projection matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
<parameter name="n_components" transfer-ownership="none">
<doc xml:space="preserve">The number of position components for each input point.
(either 2, 3 or 4)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="stride_in" transfer-ownership="none">
<doc xml:space="preserve">The stride in bytes between input points.</doc>
<type name="gsize" c:type="size_t"/>
</parameter>
<parameter name="points_in"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to the first component of the first input point.</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="stride_out" transfer-ownership="none">
<doc xml:space="preserve">The stride in bytes between output points.</doc>
<type name="gsize" c:type="size_t"/>
</parameter>
<parameter name="points_out"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to the first component of the first output point.</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="n_points" transfer-ownership="none">
<doc xml:space="preserve">The number of points to transform.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="rotate" c:identifier="cogl_matrix_rotate">
<doc xml:space="preserve">Multiplies @matrix with a rotation matrix that applies a rotation
of @angle degrees around the specified 3D vector.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="angle" transfer-ownership="none">
<doc xml:space="preserve">The angle you want to rotate in degrees</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">X component of your rotation vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Y component of your rotation vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z" transfer-ownership="none">
<doc xml:space="preserve">Z component of your rotation vector</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="rotate_euler"
c:identifier="cogl_matrix_rotate_euler"
version="2.0">
<doc xml:space="preserve">Multiplies @matrix with a rotation transformation described by the
given #CoglEuler.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="euler" transfer-ownership="none">
<doc xml:space="preserve">A euler describing a rotation</doc>
<type name="Euler" c:type="const CoglEuler*"/>
</parameter>
</parameters>
</method>
<method name="rotate_quaternion"
c:identifier="cogl_matrix_rotate_quaternion"
version="2.0">
<doc xml:space="preserve">Multiplies @matrix with a rotation transformation described by the
given #CoglQuaternion.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="quaternion" transfer-ownership="none">
<doc xml:space="preserve">A quaternion describing a rotation</doc>
<type name="Quaternion" c:type="const CoglQuaternion*"/>
</parameter>
</parameters>
</method>
<method name="scale" c:identifier="cogl_matrix_scale">
<doc xml:space="preserve">Multiplies @matrix with a transform matrix that scales along the X,
Y and Z axis.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="sx" transfer-ownership="none">
<doc xml:space="preserve">The X scale factor</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="sy" transfer-ownership="none">
<doc xml:space="preserve">The Y scale factor</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="sz" transfer-ownership="none">
<doc xml:space="preserve">The Z scale factor</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="transform_point"
c:identifier="cogl_matrix_transform_point">
<doc xml:space="preserve">Transforms a point whos position is given and returned as four float
components.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
<parameter name="x"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">The X component of your points position</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
<parameter name="y"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">The Y component of your points position</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
<parameter name="z"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">The Z component of your points position</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
<parameter name="w"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">The W component of your points position</doc>
<type name="gfloat" c:type="float*"/>
</parameter>
</parameters>
</method>
<method name="transform_points"
c:identifier="cogl_matrix_transform_points"
stability="Unstable">
<doc xml:space="preserve">Transforms an array of input points and writes the result to
another array of output points. The input points can either have 2
or 3 components each. The output points always have 3 components.
The output array can simply point to the input array to do the
transform in-place.
If you need to transform 4 component points see
cogl_matrix_project_points().
Here's an example with differing input/output strides:
|[
typedef struct {
float x,y;
uint8_t r,g,b,a;
float s,t,p;
} MyInVertex;
typedef struct {
uint8_t r,g,b,a;
float x,y,z;
} MyOutVertex;
MyInVertex vertices[N_VERTICES];
MyOutVertex results[N_VERTICES];
CoglMatrix matrix;
my_load_vertices (vertices);
my_get_matrix (&matrix);
cogl_matrix_transform_points (&matrix,
2,
sizeof (MyInVertex),
&vertices[0].x,
sizeof (MyOutVertex),
&results[0].x,
N_VERTICES);
]|</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A transformation matrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</instance-parameter>
<parameter name="n_components" transfer-ownership="none">
<doc xml:space="preserve">The number of position components for each input point.
(either 2 or 3)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="stride_in" transfer-ownership="none">
<doc xml:space="preserve">The stride in bytes between input points.</doc>
<type name="gsize" c:type="size_t"/>
</parameter>
<parameter name="points_in"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to the first component of the first input point.</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="stride_out" transfer-ownership="none">
<doc xml:space="preserve">The stride in bytes between output points.</doc>
<type name="gsize" c:type="size_t"/>
</parameter>
<parameter name="points_out"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to the first component of the first output point.</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="n_points" transfer-ownership="none">
<doc xml:space="preserve">The number of points to transform.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="translate" c:identifier="cogl_matrix_translate">
<doc xml:space="preserve">Multiplies @matrix with a transform matrix that translates along
the X, Y and Z axis.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">The X translation you want to apply</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">The Y translation you want to apply</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z" transfer-ownership="none">
<doc xml:space="preserve">The Z translation you want to apply</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="transpose"
c:identifier="cogl_matrix_transpose"
version="1.10">
<doc xml:space="preserve">Replaces @matrix with its transpose. Ie, every element (i,j) in the
new matrix is taken from element (j,i) in the old matrix.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMatrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
</parameters>
</method>
<method name="view_2d_in_frustum"
c:identifier="cogl_matrix_view_2d_in_frustum"
version="1.8"
stability="Unstable">
<doc xml:space="preserve">Multiplies @matrix by a view transform that maps the 2D coordinates
(0,0) top left and (@width_2d,@height_2d) bottom right the full viewport
size. Geometry at a depth of 0 will now lie on this 2D plane.
Note: this doesn't multiply the matrix by any projection matrix,
but it assumes you have a perspective projection as defined by
passing the corresponding arguments to cogl_matrix_frustum().
Toolkits such as Clutter that mix 2D and 3D drawing can use this to
create a 2D coordinate system within a 3D perspective projected
view frustum.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="left" transfer-ownership="none">
<doc xml:space="preserve">coord of left vertical clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="right" transfer-ownership="none">
<doc xml:space="preserve">coord of right vertical clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="bottom" transfer-ownership="none">
<doc xml:space="preserve">coord of bottom horizontal clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="top" transfer-ownership="none">
<doc xml:space="preserve">coord of top horizontal clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">The distance to the near clip plane. Never pass 0 and always pass
a positive number.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_2d" transfer-ownership="none">
<doc xml:space="preserve">The distance to the 2D plane. (Should always be positive and
be between @z_near and the z_far value that was passed to
cogl_matrix_frustum())</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="width_2d" transfer-ownership="none">
<doc xml:space="preserve">The width of the 2D coordinate system</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="height_2d" transfer-ownership="none">
<doc xml:space="preserve">The height of the 2D coordinate system</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<method name="view_2d_in_perspective"
c:identifier="cogl_matrix_view_2d_in_perspective"
version="1.8"
stability="Unstable">
<doc xml:space="preserve">Multiplies @matrix by a view transform that maps the 2D coordinates
(0,0) top left and (@width_2d,@height_2d) bottom right the full viewport
size. Geometry at a depth of 0 will now lie on this 2D plane.
Note: this doesn't multiply the matrix by any projection matrix,
but it assumes you have a perspective projection as defined by
passing the corresponding arguments to cogl_matrix_perspective().
Toolkits such as Clutter that mix 2D and 3D drawing can use this to
create a 2D coordinate system within a 3D perspective projected
view frustum.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="matrix" transfer-ownership="none">
<type name="Matrix" c:type="CoglMatrix*"/>
</instance-parameter>
<parameter name="fov_y" transfer-ownership="none">
<doc xml:space="preserve">A field of view angle for the Y axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="aspect" transfer-ownership="none">
<doc xml:space="preserve">The ratio of width to height determining the field of view angle
for the x axis.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">The distance to the near clip plane. Never pass 0 and always pass
a positive number.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_2d" transfer-ownership="none">
<doc xml:space="preserve">The distance to the 2D plane. (Should always be positive and
be between @z_near and the z_far value that was passed to
cogl_matrix_frustum())</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="width_2d" transfer-ownership="none">
<doc xml:space="preserve">The width of the 2D coordinate system</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="height_2d" transfer-ownership="none">
<doc xml:space="preserve">The height of the 2D coordinate system</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</method>
<function name="equal" c:identifier="cogl_matrix_equal" version="1.4">
<doc xml:space="preserve">Compares two matrices to see if they represent the same
transformation. Although internally the matrices may have different
annotations associated with them and may potentially have a cached
inverse matrix these are not considered in the comparison.</doc>
<return-value transfer-ownership="none">
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="v1"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="v2"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
</record>
<class name="Offscreen"
c:symbol-prefix="offscreen"
c:type="CoglOffscreen"
glib:type-name="CoglOffscreen"
glib:get-type="cogl_offscreen_get_gtype"
glib:fundamental="1">
<constructor name="new_to_texture"
c:identifier="cogl_offscreen_new_to_texture"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This creates an offscreen buffer object using the given @texture as the
primary color buffer. It doesn't just initialize the contents of the
offscreen buffer with the @texture; they are tightly bound so that
drawing to the offscreen buffer effectivly updates the contents of the
given texture. You don't need to destroy the offscreen buffer before
you can use the @texture again.
<note>This only works with low-level #CoglTexture types such as
#CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not
with meta-texture types such as #CoglTexture2DSliced.</note></doc>
<doc-deprecated xml:space="preserve">Use cogl_offscreen_new_with_texture instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly instantiated #CoglOffscreen
framebuffer or %NULL if it wasn't possible to create the
buffer.</doc>
<type name="Offscreen" c:type="CoglOffscreen*"/>
</return-value>
<parameters>
<parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">A #CoglTexture pointer</doc>
<type name="Texture" c:type="CoglTexture*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_with_texture"
c:identifier="cogl_offscreen_new_with_texture">
<doc xml:space="preserve">This creates an offscreen framebuffer object using the given
@texture as the primary color buffer. It doesn't just initialize
the contents of the offscreen buffer with the @texture; they are
tightly bound so that drawing to the offscreen buffer effectively
updates the contents of the given texture. You don't need to
destroy the offscreen buffer before you can use the @texture again.
<note>This api only works with low-level #CoglTexture types such as
#CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not
with meta-texture types such as #CoglTexture2DSliced.</note>
The storage for the framebuffer is actually allocated lazily
so this function will never return %NULL to indicate a runtime
error. This means it is still possible to configure the framebuffer
before it is really allocated.
Simple applications without full error handling can simply rely on
Cogl to lazily allocate the storage of framebuffers but you should
be aware that if Cogl encounters an error (such as running out of
GPU memory) then your application will simply abort with an error
message. If you need to be able to catch such exceptions at runtime
then you can explicitly allocate your framebuffer when you have
finished configuring it by calling cogl_framebuffer_allocate() and
passing in a #CoglError argument to catch any exceptions.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly instantiated #CoglOffscreen
framebuffer.</doc>
<type name="Offscreen" c:type="CoglOffscreen*"/>
</return-value>
<parameters>
<parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">A #CoglTexture pointer</doc>
<type name="Texture" c:type="CoglTexture*"/>
</parameter>
</parameters>
</constructor>
<function name="ref"
c:identifier="cogl_offscreen_ref"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Increments the reference count on the @offscreen framebuffer.</doc>
<doc-deprecated xml:space="preserve">cogl_object_ref() should be used in new code.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">For convenience it returns the
given @offscreen</doc>
<type name="gpointer" c:type="void*"/>
</return-value>
<parameters>
<parameter name="offscreen"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to a #CoglOffscreen framebuffer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="unref"
c:identifier="cogl_offscreen_unref"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Decreases the reference count for the @offscreen buffer and frees it when
the count reaches 0.</doc>
<doc-deprecated xml:space="preserve">cogl_object_unref() should be used in new code.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="offscreen"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to a #CoglOffscreen framebuffer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<method name="get_texture"
c:identifier="cogl_offscreen_get_texture"
introspectable="0">
<return-value>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<instance-parameter name="offscreen" transfer-ownership="none">
<type name="Offscreen" c:type="CoglOffscreen*"/>
</instance-parameter>
</parameters>
</method>
</class>
<constant name="PREMULT_BIT" value="128" c:type="COGL_PREMULT_BIT">
<type name="gint" c:type="gint"/>
</constant>
<bitfield name="PixelFormat" version="0.8" c:type="CoglPixelFormat">
<doc xml:space="preserve">Pixel formats used by Cogl. For the formats with a byte per
component, the order of the components specify the order in
increasing memory addresses. So for example
%COGL_PIXEL_FORMAT_RGB_888 would have the red component in the
lowest address, green in the next address and blue after that
regardless of the endianness of the system.
For the formats with non byte aligned components the component
order specifies the order within a 16-bit or 32-bit number from
most significant bit to least significant. So for
%COGL_PIXEL_FORMAT_RGB_565, the red component would be in bits
11-15, the green component would be in 6-11 and the blue component
would be in 1-5. Therefore the order in memory depends on the
endianness of the system.
When uploading a texture %COGL_PIXEL_FORMAT_ANY can be used as the
internal format. Cogl will try to pick the best format to use
internally and convert the texture data if necessary.</doc>
<member name="any" value="0" c:identifier="COGL_PIXEL_FORMAT_ANY">
<doc xml:space="preserve">Any format</doc>
</member>
<member name="a_8" value="17" c:identifier="COGL_PIXEL_FORMAT_A_8">
<doc xml:space="preserve">8 bits alpha mask</doc>
</member>
<member name="rgb_565"
value="4"
c:identifier="COGL_PIXEL_FORMAT_RGB_565">
<doc xml:space="preserve">RGB, 16 bits</doc>
</member>
<member name="rgba_4444"
value="21"
c:identifier="COGL_PIXEL_FORMAT_RGBA_4444">
<doc xml:space="preserve">RGBA, 16 bits</doc>
</member>
<member name="rgba_5551"
value="22"
c:identifier="COGL_PIXEL_FORMAT_RGBA_5551">
<doc xml:space="preserve">RGBA, 16 bits</doc>
</member>
<member name="yuv" value="7" c:identifier="COGL_PIXEL_FORMAT_YUV">
<doc xml:space="preserve">Not currently supported</doc>
</member>
<member name="g_8" value="8" c:identifier="COGL_PIXEL_FORMAT_G_8">
<doc xml:space="preserve">Single luminance component</doc>
</member>
<member name="rg_88" value="9" c:identifier="COGL_PIXEL_FORMAT_RG_88">
<doc xml:space="preserve">RG, 16 bits. Note that red-green textures
are only available if %COGL_FEATURE_ID_TEXTURE_RG is advertised.
See cogl_texture_set_components() for details.</doc>
</member>
<member name="rgb_888"
value="2"
c:identifier="COGL_PIXEL_FORMAT_RGB_888">
<doc xml:space="preserve">RGB, 24 bits</doc>
</member>
<member name="bgr_888"
value="34"
c:identifier="COGL_PIXEL_FORMAT_BGR_888">
<doc xml:space="preserve">BGR, 24 bits</doc>
</member>
<member name="rgba_8888"
value="19"
c:identifier="COGL_PIXEL_FORMAT_RGBA_8888">
<doc xml:space="preserve">RGBA, 32 bits</doc>
</member>
<member name="bgra_8888"
value="51"
c:identifier="COGL_PIXEL_FORMAT_BGRA_8888">
<doc xml:space="preserve">BGRA, 32 bits</doc>
</member>
<member name="argb_8888"
value="83"
c:identifier="COGL_PIXEL_FORMAT_ARGB_8888">
<doc xml:space="preserve">ARGB, 32 bits</doc>
</member>
<member name="abgr_8888"
value="115"
c:identifier="COGL_PIXEL_FORMAT_ABGR_8888">
<doc xml:space="preserve">ABGR, 32 bits</doc>
</member>
<member name="rgba_1010102"
value="29"
c:identifier="COGL_PIXEL_FORMAT_RGBA_1010102">
<doc xml:space="preserve">RGBA, 32 bits, 10 bpc</doc>
</member>
<member name="bgra_1010102"
value="61"
c:identifier="COGL_PIXEL_FORMAT_BGRA_1010102">
<doc xml:space="preserve">BGRA, 32 bits, 10 bpc</doc>
</member>
<member name="argb_2101010"
value="93"
c:identifier="COGL_PIXEL_FORMAT_ARGB_2101010">
<doc xml:space="preserve">ARGB, 32 bits, 10 bpc</doc>
</member>
<member name="abgr_2101010"
value="125"
c:identifier="COGL_PIXEL_FORMAT_ABGR_2101010">
<doc xml:space="preserve">ABGR, 32 bits, 10 bpc</doc>
</member>
<member name="rgba_8888_pre"
value="147"
c:identifier="COGL_PIXEL_FORMAT_RGBA_8888_PRE">
<doc xml:space="preserve">Premultiplied RGBA, 32 bits</doc>
</member>
<member name="bgra_8888_pre"
value="179"
c:identifier="COGL_PIXEL_FORMAT_BGRA_8888_PRE">
<doc xml:space="preserve">Premultiplied BGRA, 32 bits</doc>
</member>
<member name="argb_8888_pre"
value="211"
c:identifier="COGL_PIXEL_FORMAT_ARGB_8888_PRE">
<doc xml:space="preserve">Premultiplied ARGB, 32 bits</doc>
</member>
<member name="abgr_8888_pre"
value="243"
c:identifier="COGL_PIXEL_FORMAT_ABGR_8888_PRE">
<doc xml:space="preserve">Premultiplied ABGR, 32 bits</doc>
</member>
<member name="rgba_4444_pre"
value="149"
c:identifier="COGL_PIXEL_FORMAT_RGBA_4444_PRE">
<doc xml:space="preserve">Premultiplied RGBA, 16 bits</doc>
</member>
<member name="rgba_5551_pre"
value="150"
c:identifier="COGL_PIXEL_FORMAT_RGBA_5551_PRE">
<doc xml:space="preserve">Premultiplied RGBA, 16 bits</doc>
</member>
<member name="rgba_1010102_pre"
value="157"
c:identifier="COGL_PIXEL_FORMAT_RGBA_1010102_PRE">
<doc xml:space="preserve">Premultiplied RGBA, 32 bits, 10 bpc</doc>
</member>
<member name="bgra_1010102_pre"
value="189"
c:identifier="COGL_PIXEL_FORMAT_BGRA_1010102_PRE">
<doc xml:space="preserve">Premultiplied BGRA, 32 bits, 10 bpc</doc>
</member>
<member name="argb_2101010_pre"
value="221"
c:identifier="COGL_PIXEL_FORMAT_ARGB_2101010_PRE">
<doc xml:space="preserve">Premultiplied ARGB, 32 bits, 10 bpc</doc>
</member>
<member name="abgr_2101010_pre"
value="253"
c:identifier="COGL_PIXEL_FORMAT_ABGR_2101010_PRE">
<doc xml:space="preserve">Premultiplied ABGR, 32 bits, 10 bpc</doc>
</member>
<member name="depth_16"
value="265"
c:identifier="COGL_PIXEL_FORMAT_DEPTH_16">
</member>
<member name="depth_32"
value="259"
c:identifier="COGL_PIXEL_FORMAT_DEPTH_32">
</member>
<member name="depth_24_stencil_8"
value="771"
c:identifier="COGL_PIXEL_FORMAT_DEPTH_24_STENCIL_8">
</member>
</bitfield>
<record name="Quaternion" c:type="CoglQuaternion" disguised="1">
</record>
<bitfield name="ReadPixelsFlags"
version="1.0"
c:type="CoglReadPixelsFlags">
<doc xml:space="preserve">Flags for cogl_framebuffer_read_pixels_into_bitmap()</doc>
<member name="read_pixels_color_buffer"
value="1"
c:identifier="COGL_READ_PIXELS_COLOR_BUFFER">
<doc xml:space="preserve">Read from the color buffer</doc>
</member>
</bitfield>
<enumeration name="RendererError" c:type="CoglRendererError">
<member name="xlib_display_open"
value="0"
c:identifier="COGL_RENDERER_ERROR_XLIB_DISPLAY_OPEN">
</member>
<member name="bad_constraint"
value="1"
c:identifier="COGL_RENDERER_ERROR_BAD_CONSTRAINT">
</member>
</enumeration>
<constant name="STENCIL_BIT" value="512" c:type="COGL_STENCIL_BIT">
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="ShaderType" version="1.0" c:type="CoglShaderType">
<doc xml:space="preserve">Types of shaders</doc>
<member name="vertex" value="0" c:identifier="COGL_SHADER_TYPE_VERTEX">
<doc xml:space="preserve">A program for proccessing vertices</doc>
</member>
<member name="fragment"
value="1"
c:identifier="COGL_SHADER_TYPE_FRAGMENT">
<doc xml:space="preserve">A program for processing fragments</doc>
</member>
</enumeration>
<enumeration name="StereoMode" c:type="CoglStereoMode">
<doc xml:space="preserve">Represents how draw should affect the two buffers
of a stereo framebuffer. See cogl_framebuffer_set_stereo_mode().</doc>
<member name="both" value="0" c:identifier="COGL_STEREO_BOTH">
<doc xml:space="preserve">draw to both stereo buffers</doc>
</member>
<member name="left" value="1" c:identifier="COGL_STEREO_LEFT">
<doc xml:space="preserve">draw only to the left stereo buffer</doc>
</member>
<member name="right" value="2" c:identifier="COGL_STEREO_RIGHT">
<doc xml:space="preserve">draw only to the left stereo buffer</doc>
</member>
</enumeration>
<enumeration name="SystemError"
version="1.4"
stability="Unstable"
c:type="CoglSystemError">
<doc xml:space="preserve">Error enumeration for Cogl
The @COGL_SYSTEM_ERROR_UNSUPPORTED error can be thrown for a
variety of reasons. For example:
<itemizedlist>
<listitem><para>You've tried to use a feature that is not
advertised by cogl_has_feature(). This could happen if you create
a 2d texture with a non-power-of-two size when
%COGL_FEATURE_ID_TEXTURE_NPOT is not advertised.</para></listitem>
<listitem><para>The GPU can not handle the configuration you have
requested. An example might be if you try to use too many texture
layers in a single #CoglPipeline</para></listitem>
<listitem><para>The driver does not support some
configuration.</para></listiem>
</itemizedlist>
Currently this is only used by Cogl API marked as experimental so
this enum should also be considered experimental.</doc>
<member name="unsupported"
value="0"
c:identifier="COGL_SYSTEM_ERROR_UNSUPPORTED">
<doc xml:space="preserve">You tried to use a feature or
configuration not currently available.</doc>
</member>
<member name="no_memory"
value="1"
c:identifier="COGL_SYSTEM_ERROR_NO_MEMORY">
<doc xml:space="preserve">You tried to allocate a resource
such as a texture and there wasn't enough memory.</doc>
</member>
</enumeration>
<constant name="TEXTURE_MAX_WASTE"
value="127"
c:type="COGL_TEXTURE_MAX_WASTE">
<type name="gint" c:type="gint"/>
</constant>
<interface name="Texture"
c:symbol-prefix="texture"
c:type="CoglTexture"
glib:type-name="CoglTexture"
glib:get-type="cogl_texture_get_gtype">
<function name="error_quark" c:identifier="cogl_texture_error_quark">
<return-value transfer-ownership="none">
<type name="guint32" c:type="uint32_t"/>
</return-value>
</function>
<function name="new_from_bitmap"
c:identifier="cogl_texture_new_from_bitmap"
version="1.0"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a #CoglTexture from a #CoglBitmap.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_bitmap()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap pointer</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to use for the GPU storage of the
texture</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="new_from_data"
c:identifier="cogl_texture_new_from_data"
version="0.8"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a new #CoglTexture based on data residing in memory.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_data()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of texture in pixels</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of texture in pixels</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat the buffer is stored in in RAM</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat that will be used for storing
the buffer on the GPU. If COGL_PIXEL_FORMAT_ANY is given then a
premultiplied format similar to the format of the source data will
be used. The default blending equations of Cogl expect premultiplied
color data; the main use of passing a non-premultiplied format here
is if you have non-premultiplied source data and are going to adjust
the blend mode (see cogl_material_set_blend()) or use the data for
something other than straight blending.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">the memory offset in bytes between the starts of
scanlines in @data</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">pointer the memory region where the source buffer resides</doc>
<type name="guint8" c:type="const uint8_t*"/>
</parameter>
</parameters>
</function>
<function name="new_from_file"
c:identifier="cogl_texture_new_from_file"
version="0.8"
deprecated="1"
deprecated-version="1.18"
throws="1">
<doc xml:space="preserve">Creates a #CoglTexture from an image file.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_file()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the file to load</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to use for the GPU storage of the
texture. If %COGL_PIXEL_FORMAT_ANY is given then a premultiplied
format similar to the format of the source data will be used. The
default blending equations of Cogl expect premultiplied color data;
the main use of passing a non-premultiplied format here is if you
have non-premultiplied source data and are going to adjust the blend
mode (see cogl_material_set_blend()) or use the data for something
other than straight blending.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="new_from_foreign"
c:identifier="cogl_texture_new_from_foreign"
version="0.8"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a #CoglTexture based on an existing OpenGL texture; the
width, height and format are passed along since it is not always
possible to query these from OpenGL.
The waste arguments allow you to create a Cogl texture that maps to
a region smaller than the real OpenGL texture. For instance if your
hardware only supports power-of-two textures you may load a
non-power-of-two image into a larger power-of-two texture and use
the waste arguments to tell Cogl which region should be mapped to
the texture coordinate range [0:1].</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_foreign()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="gl_handle" transfer-ownership="none">
<doc xml:space="preserve">opengl handle of foreign texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="gl_target" transfer-ownership="none">
<doc xml:space="preserve">opengl target type of foreign texture</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of foreign texture</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of foreign texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="x_pot_waste" transfer-ownership="none">
<doc xml:space="preserve">horizontal waste on the right hand edge of the texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="y_pot_waste" transfer-ownership="none">
<doc xml:space="preserve">vertical waste on the bottom edge of the texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">format of the foreign texture.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="new_with_size"
c:identifier="cogl_texture_new_with_size"
version="0.8"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a new #CoglTexture with the specified dimensions and pixel format.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_with_size()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or %NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of texture in pixels.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of texture in pixels.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to use for the GPU storage of the
texture.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<method name="allocate" c:identifier="cogl_texture_allocate" throws="1">
<doc xml:space="preserve">Explicitly allocates the storage for the given @texture which
allows you to be sure that there is enough memory for the
texture and if not then the error can be handled gracefully.
<note>Normally applications don't need to use this api directly
since the texture will be implicitly allocated when data is set on
the texture, or if the texture is attached to a #CoglOffscreen
framebuffer and rendered too.</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the texture was successfully allocated,
otherwise %FALSE and @error will be updated if it
wasn't %NULL.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">A #CoglTexture</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_components"
c:identifier="cogl_texture_get_components"
version="1.18">
<doc xml:space="preserve">Queries what components the given @texture stores internally as set
via cogl_texture_set_components().
For textures created by the ‘_with_size’ constructors the default
is %COGL_TEXTURE_COMPONENTS_RGBA. The other constructors which take
a %CoglBitmap or a data pointer default to the same components as
the pixel format of the data.</doc>
<return-value transfer-ownership="none">
<type name="TextureComponents" c:type="CoglTextureComponents"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_data" c:identifier="cogl_texture_get_data">
<doc xml:space="preserve">Copies the pixel data from a cogl texture to system memory.
<note>Don't pass the value of cogl_texture_get_rowstride() as the
@rowstride argument, the rowstride should be the rowstride you
want for the destination @data buffer not the rowstride of the
source texture</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the size of the texture data in bytes</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to store the texture as.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">the rowstride of @data in bytes or pass 0 to calculate
from the bytes-per-pixel of @format multiplied by the
@texture width.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">memory location to write the @texture's contents, or %NULL
to only query the data size through the return value.</doc>
<type name="guint8" c:type="uint8_t*"/>
</parameter>
</parameters>
</method>
<method name="get_gl_texture" c:identifier="cogl_texture_get_gl_texture">
<doc xml:space="preserve">Queries the GL handles for a GPU side texture through its #CoglTexture.
If the texture is spliced the data for the first sub texture will be
queried.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle was successfully retrieved, %FALSE
if the handle was invalid</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="out_gl_handle"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">pointer to return location for the
textures GL handle, or %NULL.</doc>
<type name="guint" c:type="unsigned int*"/>
</parameter>
<parameter name="out_gl_target"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">pointer to return location for the
GL target type, or %NULL.</doc>
<type name="guint" c:type="unsigned int*"/>
</parameter>
</parameters>
</method>
<method name="get_height" c:identifier="cogl_texture_get_height">
<doc xml:space="preserve">Queries the height of a cogl texture.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the height of the GPU side texture in pixels</doc>
<type name="guint" c:type="unsigned int"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_max_waste" c:identifier="cogl_texture_get_max_waste">
<doc xml:space="preserve">Queries the maximum wasted (unused) pixels in one dimension of a GPU side
texture.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the maximum waste</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_premultiplied"
c:identifier="cogl_texture_get_premultiplied"
version="1.18">
<doc xml:space="preserve">Queries the pre-multiplied alpha status for internally stored red,
green and blue components for the given @texture as set by
cogl_texture_set_premultiplied().
By default the pre-multipled state is @TRUE.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if red, green and blue components are
internally stored pre-multiplied by the alpha
value or %FALSE if not.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width" c:identifier="cogl_texture_get_width">
<doc xml:space="preserve">Queries the width of a cogl texture.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the width of the GPU side texture in pixels</doc>
<type name="guint" c:type="unsigned int"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_sliced" c:identifier="cogl_texture_is_sliced">
<doc xml:space="preserve">Queries if a texture is sliced (stored as multiple GPU side tecture
objects).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the texture is sliced, %FALSE if the texture
is stored as a single GPU texture</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
</parameters>
</method>
<method name="new_from_sub_texture"
c:identifier="cogl_texture_new_from_sub_texture"
version="1.2"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a new texture which represents a subregion of another
texture. The GL resources will be shared so that no new texture
data is actually allocated.
Sub textures have undefined behaviour texture coordinates outside
of the range [0,1] are used. They also do not work with
CoglVertexBuffers.
The sub texture will keep a reference to the full texture so you do
not need to keep one separately if you only want to use the sub
texture.</doc>
<doc-deprecated xml:space="preserve">Use cogl_sub_texture_new()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<instance-parameter name="full_texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="sub_x" transfer-ownership="none">
<doc xml:space="preserve">X coordinate of the top-left of the subregion</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="sub_y" transfer-ownership="none">
<doc xml:space="preserve">Y coordinate of the top-left of the subregion</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="sub_width" transfer-ownership="none">
<doc xml:space="preserve">Width in pixels of the subregion</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="sub_height" transfer-ownership="none">
<doc xml:space="preserve">Height in pixels of the subregion</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="set_components"
c:identifier="cogl_texture_set_components"
version="1.18">
<doc xml:space="preserve">Affects the internal storage format for this texture by specifying
what components will be required for sampling later.
This api affects how data is uploaded to the GPU since unused
components can potentially be discarded from source data.
For textures created by the ‘_with_size’ constructors the default
is %COGL_TEXTURE_COMPONENTS_RGBA. The other constructors which take
a %CoglBitmap or a data pointer default to the same components as
the pixel format of the data.
Note that the %COGL_TEXTURE_COMPONENTS_RG format is not available
on all drivers. The availability can be determined by checking for
the %COGL_FEATURE_ID_TEXTURE_RG feature. If this format is used on
a driver where it is not available then %COGL_TEXTURE_ERROR_FORMAT
will be raised when the texture is allocated. Even if the feature
is not available then %COGL_PIXEL_FORMAT_RG_88 can still be used as
an image format as long as %COGL_TEXTURE_COMPONENTS_RG isn't used
as the texture's components.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="components" transfer-ownership="none">
<type name="TextureComponents" c:type="CoglTextureComponents"/>
</parameter>
</parameters>
</method>
<method name="set_data" c:identifier="cogl_texture_set_data" throws="1">
<doc xml:space="preserve">@texture a #CoglTexture.
Sets all the pixels for a given mipmap @level by copying the pixel
data pointed to by the @data argument into the given @texture.
@data should point to the first pixel to copy corresponding
to the top left of the mipmap @level being set.
If @rowstride equals 0 then it will be automatically calculated
from the width of the mipmap level and the bytes-per-pixel for the
given @format.
A mipmap @level of 0 corresponds to the largest, base image of a
texture and @level 1 is half the width and height of level 0. If
dividing any dimension of the previous level by two results in a
fraction then round the number down (floor()), but clamp to 1
something like this:
|[
next_width = MAX (1, floor (prev_width));
]|
You can determine the number of mipmap levels for a given texture
like this:
|[
n_levels = 1 + floor (log2 (max_dimension));
]|
Where %max_dimension is the larger of cogl_texture_get_width() and
cogl_texture_get_height().
It is an error to pass a @level number >= the number of levels that
@texture can have according to the above calculation.
<note>Since the storage for a #CoglTexture is allocated lazily then
if the given @texture has not previously been allocated then this
api can return %FALSE and throw an exceptional @error if there is
not enough memory to allocate storage for @texture.</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the data upload was successful, and
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat used in the source @data buffer.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">rowstride of the source @data buffer (computed from
the texture width and @format if it equals 0)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the source data, pointing to the first top-left pixel to set</doc>
<type name="guint8" c:type="const uint8_t*"/>
</parameter>
<parameter name="level" transfer-ownership="none">
<doc xml:space="preserve">The mipmap level to update (Normally 0 for the largest,
base texture)</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="set_premultiplied"
c:identifier="cogl_texture_set_premultiplied"
version="1.18">
<doc xml:space="preserve">Affects the internal storage format for this texture by specifying
whether red, green and blue color components should be stored as
pre-multiplied alpha values.
This api affects how data is uploaded to the GPU since Cogl will
convert source data to have premultiplied or unpremultiplied
components according to this state.
For example if you create a texture via
cogl_texture_2d_new_with_size() and then upload data via
cogl_texture_set_data() passing a source format of
%COGL_PIXEL_FORMAT_RGBA_8888 then Cogl will internally multiply the
red, green and blue components of the source data by the alpha
component, for each pixel so that the internally stored data has
pre-multiplied alpha components. If you instead upload data that
already has pre-multiplied components by passing
%COGL_PIXEL_FORMAT_RGBA_8888_PRE as the source format to
cogl_texture_set_data() then the data can be uploaded without being
converted.
By default the @premultipled state is @TRUE.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="premultiplied" transfer-ownership="none">
<doc xml:space="preserve">Whether any internally stored red, green or blue
components are pre-multiplied by an alpha
component.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</method>
<method name="set_region" c:identifier="cogl_texture_set_region">
<doc xml:space="preserve">Sets the pixels in a rectangular subregion of @texture from an in-memory
buffer containing pixel data.
<note>The region set can't be larger than the source @data</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the subregion upload was successful, and
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture.</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="src_x" transfer-ownership="none">
<doc xml:space="preserve">upper left coordinate to use from source data.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="src_y" transfer-ownership="none">
<doc xml:space="preserve">upper left coordinate to use from source data.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dst_x" transfer-ownership="none">
<doc xml:space="preserve">upper left destination horizontal coordinate.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dst_y" transfer-ownership="none">
<doc xml:space="preserve">upper left destination vertical coordinate.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dst_width" transfer-ownership="none">
<doc xml:space="preserve">width of destination region to write. (Must be less
than or equal to @width)</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="dst_height" transfer-ownership="none">
<doc xml:space="preserve">height of destination region to write. (Must be less
than or equal to @height)</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of source data buffer.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of source data buffer.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat used in the source buffer.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">rowstride of source buffer (computed from width if none
specified)</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the actual pixel data.</doc>
<type name="guint8" c:type="const uint8_t*"/>
</parameter>
</parameters>
</method>
<method name="set_region_from_bitmap"
c:identifier="cogl_texture_set_region_from_bitmap"
version="1.8"
stability="Unstable">
<doc xml:space="preserve">Copies a specified source region from @bitmap to the position
(@src_x, @src_y) of the given destination texture @handle.
<note>The region updated can't be larger than the source
bitmap</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the subregion upload was successful, and
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<instance-parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">a #CoglTexture pointer</doc>
<type name="Texture" c:type="CoglTexture*"/>
</instance-parameter>
<parameter name="src_x" transfer-ownership="none">
<doc xml:space="preserve">upper left coordinate to use from the source bitmap.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="src_y" transfer-ownership="none">
<doc xml:space="preserve">upper left coordinate to use from the source bitmap</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dst_x" transfer-ownership="none">
<doc xml:space="preserve">upper left destination horizontal coordinate.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dst_y" transfer-ownership="none">
<doc xml:space="preserve">upper left destination vertical coordinate.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dst_width" transfer-ownership="none">
<doc xml:space="preserve">width of destination region to write. (Must be less
than or equal to the bitmap width)</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="dst_height" transfer-ownership="none">
<doc xml:space="preserve">height of destination region to write. (Must be less
than or equal to the bitmap height)</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">The source bitmap to read from</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</parameter>
</parameters>
</method>
</interface>
<enumeration name="TextureComponents"
version="1.18"
c:type="CoglTextureComponents">
<doc xml:space="preserve">See cogl_texture_set_components().</doc>
<member name="a" value="1" c:identifier="COGL_TEXTURE_COMPONENTS_A">
<doc xml:space="preserve">Only the alpha component</doc>
</member>
<member name="rg" value="2" c:identifier="COGL_TEXTURE_COMPONENTS_RG">
<doc xml:space="preserve">Red and green components. Note that
this can only be used if the %COGL_FEATURE_ID_TEXTURE_RG feature
is advertised.</doc>
</member>
<member name="rgb" value="3" c:identifier="COGL_TEXTURE_COMPONENTS_RGB">
<doc xml:space="preserve">Red, green and blue components</doc>
</member>
<member name="rgba"
value="4"
c:identifier="COGL_TEXTURE_COMPONENTS_RGBA">
<doc xml:space="preserve">Red, green, blue and alpha components</doc>
</member>
<member name="depth"
value="5"
c:identifier="COGL_TEXTURE_COMPONENTS_DEPTH">
<doc xml:space="preserve">Only a depth component</doc>
</member>
</enumeration>
<enumeration name="TextureError"
version="1.8"
stability="Unstable"
c:type="CoglTextureError">
<doc xml:space="preserve">Error codes that can be thrown when allocating textures.</doc>
<member name="size" value="0" c:identifier="COGL_TEXTURE_ERROR_SIZE">
<doc xml:space="preserve">Unsupported size</doc>
</member>
<member name="format" value="1" c:identifier="COGL_TEXTURE_ERROR_FORMAT">
<doc xml:space="preserve">Unsupported format</doc>
</member>
<member name="bad_parameter"
value="2"
c:identifier="COGL_TEXTURE_ERROR_BAD_PARAMETER">
</member>
<member name="type" value="3" c:identifier="COGL_TEXTURE_ERROR_TYPE">
<doc xml:space="preserve">A primitive texture type that is
unsupported by the driver was used</doc>
</member>
</enumeration>
<bitfield name="TextureFlags" version="1.0" c:type="CoglTextureFlags">
<doc xml:space="preserve">Flags to pass to the cogl_texture_new_* family of functions.</doc>
<member name="none" value="0" c:identifier="COGL_TEXTURE_NONE">
<doc xml:space="preserve">No flags specified</doc>
</member>
<member name="no_auto_mipmap"
value="1"
c:identifier="COGL_TEXTURE_NO_AUTO_MIPMAP">
<doc xml:space="preserve">Disables the automatic generation of
the mipmap pyramid from the base level image whenever it is
updated. The mipmaps are only generated when the texture is
rendered with a mipmap filter so it should be free to leave out
this flag when using other filtering modes</doc>
</member>
<member name="no_slicing"
value="2"
c:identifier="COGL_TEXTURE_NO_SLICING">
<doc xml:space="preserve">Disables the slicing of the texture</doc>
</member>
<member name="no_atlas" value="4" c:identifier="COGL_TEXTURE_NO_ATLAS">
<doc xml:space="preserve">Disables the insertion of the texture inside
the texture atlas used by Cogl</doc>
</member>
</bitfield>
<enumeration name="TextureType"
version="1.10"
stability="Unstable"
c:type="CoglTextureType">
<doc xml:space="preserve">Constants representing the underlying hardware texture type of a
#CoglTexture.</doc>
<member name="2d" value="0" c:identifier="COGL_TEXTURE_TYPE_2D">
<doc xml:space="preserve">A #CoglTexture2D</doc>
</member>
<member name="3d" value="1" c:identifier="COGL_TEXTURE_TYPE_3D">
<doc xml:space="preserve">A #CoglTexture3D</doc>
</member>
<member name="rectangle"
value="2"
c:identifier="COGL_TEXTURE_TYPE_RECTANGLE">
<doc xml:space="preserve">A #CoglTextureRectangle</doc>
</member>
</enumeration>
<record name="TextureVertex" c:type="CoglTextureVertex">
<doc xml:space="preserve">Used to specify vertex information when calling cogl_polygon()</doc>
<field name="x" writable="1">
<doc xml:space="preserve">Model x-coordinate</doc>
<type name="gfloat" c:type="float"/>
</field>
<field name="y" writable="1">
<doc xml:space="preserve">Model y-coordinate</doc>
<type name="gfloat" c:type="float"/>
</field>
<field name="z" writable="1">
<doc xml:space="preserve">Model z-coordinate</doc>
<type name="gfloat" c:type="float"/>
</field>
<field name="tx" writable="1">
<doc xml:space="preserve">Texture x-coordinate</doc>
<type name="gfloat" c:type="float"/>
</field>
<field name="ty" writable="1">
<doc xml:space="preserve">Texture y-coordinate</doc>
<type name="gfloat" c:type="float"/>
</field>
<field name="color" writable="1">
<doc xml:space="preserve">The color to use at this vertex. This is ignored if
use_color is %FALSE when calling cogl_polygon()</doc>
<type name="Color" c:type="CoglColor"/>
</field>
</record>
<enumeration name="VerticesMode" version="1.0" c:type="CoglVerticesMode">
<doc xml:space="preserve">Different ways of interpreting vertices when drawing.</doc>
<member name="points" value="0" c:identifier="COGL_VERTICES_MODE_POINTS">
<doc xml:space="preserve">FIXME, equivalent to
<constant>GL_POINTS</constant></doc>
</member>
<member name="lines" value="1" c:identifier="COGL_VERTICES_MODE_LINES">
<doc xml:space="preserve">FIXME, equivalent to <constant>GL_LINES</constant></doc>
</member>
<member name="line_loop"
value="2"
c:identifier="COGL_VERTICES_MODE_LINE_LOOP">
<doc xml:space="preserve">FIXME, equivalent to
<constant>GL_LINE_LOOP</constant></doc>
</member>
<member name="line_strip"
value="3"
c:identifier="COGL_VERTICES_MODE_LINE_STRIP">
<doc xml:space="preserve">FIXME, equivalent to
<constant>GL_LINE_STRIP</constant></doc>
</member>
<member name="triangles"
value="4"
c:identifier="COGL_VERTICES_MODE_TRIANGLES">
<doc xml:space="preserve">FIXME, equivalent to
<constant>GL_TRIANGLES</constant></doc>
</member>
<member name="triangle_strip"
value="5"
c:identifier="COGL_VERTICES_MODE_TRIANGLE_STRIP">
<doc xml:space="preserve">FIXME, equivalent to
<constant>GL_TRIANGLE_STRIP</constant></doc>
</member>
<member name="triangle_fan"
value="6"
c:identifier="COGL_VERTICES_MODE_TRIANGLE_FAN">
<doc xml:space="preserve">FIXME, equivalent to <constant>GL_TRIANGLE_FAN</constant></doc>
</member>
</enumeration>
<enumeration name="Winding" c:type="CoglWinding">
<doc xml:space="preserve">Enum used to represent the two directions of rotation. This can be
used to set the front face for culling by calling
cogl_pipeline_set_front_face_winding().</doc>
<member name="clockwise" value="0" c:identifier="COGL_WINDING_CLOCKWISE">
<doc xml:space="preserve">Vertices are in a clockwise order</doc>
</member>
<member name="counter_clockwise"
value="1"
c:identifier="COGL_WINDING_COUNTER_CLOCKWISE">
<doc xml:space="preserve">Vertices are in a counter-clockwise order</doc>
</member>
</enumeration>
<enumeration name="WinsysFeature" c:type="CoglWinsysFeature">
<member name="multiple_onscreen"
value="0"
c:identifier="COGL_WINSYS_FEATURE_MULTIPLE_ONSCREEN">
</member>
<member name="swap_throttle"
value="1"
c:identifier="COGL_WINSYS_FEATURE_SWAP_THROTTLE">
</member>
<member name="vblank_counter"
value="2"
c:identifier="COGL_WINSYS_FEATURE_VBLANK_COUNTER">
</member>
<member name="vblank_wait"
value="3"
c:identifier="COGL_WINSYS_FEATURE_VBLANK_WAIT">
</member>
<member name="texture_from_pixmap"
value="4"
c:identifier="COGL_WINSYS_FEATURE_TEXTURE_FROM_PIXMAP">
</member>
<member name="swap_buffers_event"
value="5"
c:identifier="COGL_WINSYS_FEATURE_SWAP_BUFFERS_EVENT">
</member>
<member name="swap_region"
value="6"
c:identifier="COGL_WINSYS_FEATURE_SWAP_REGION">
</member>
<member name="swap_region_throttle"
value="7"
c:identifier="COGL_WINSYS_FEATURE_SWAP_REGION_THROTTLE">
</member>
<member name="swap_region_synchronized"
value="8"
c:identifier="COGL_WINSYS_FEATURE_SWAP_REGION_SYNCHRONIZED">
</member>
<member name="buffer_age"
value="9"
c:identifier="COGL_WINSYS_FEATURE_BUFFER_AGE">
</member>
<member name="sync_and_complete_event"
value="10"
c:identifier="COGL_WINSYS_FEATURE_SYNC_AND_COMPLETE_EVENT">
</member>
<member name="n_features"
value="11"
c:identifier="COGL_WINSYS_FEATURE_N_FEATURES">
</member>
</enumeration>
<callback name="XlibFilterFunc"
c:type="CoglXlibFilterFunc"
introspectable="0">
<return-value transfer-ownership="none">
<type name="FilterReturn" c:type="CoglFilterReturn"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<type c:type="XEvent*"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</callback>
<record name="_ColorSizeCheck" c:type="_CoglColorSizeCheck">
<field name="compile_time_assert_CoglColor_size" writable="1">
<array zero-terminated="0" c:type="char" fixed-size="-1">
<type name="gchar" c:type="char"/>
</array>
</field>
</record>
<record name="_MatrixSizeCheck" c:type="_CoglMatrixSizeCheck">
<field name="compile_time_assert_CoglMatrix_size" writable="1">
<array zero-terminated="0" c:type="char" fixed-size="-1">
<type name="gchar" c:type="char"/>
</array>
</field>
</record>
<record name="_TextureVertexSizeCheck"
c:type="_CoglTextureVertexSizeCheck">
<field name="compile_time_assert_CoglTextureVertex_size" writable="1">
<array zero-terminated="0" c:type="char" fixed-size="-1">
<type name="gchar" c:type="char"/>
</array>
</field>
</record>
<function name="begin_gl"
c:identifier="cogl_begin_gl"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">We do not advise nor reliably support the interleaving of raw GL drawing and
Cogl drawing functions, but if you insist, cogl_begin_gl() and cogl_end_gl()
provide a simple mechanism that may at least give you a fighting chance of
succeeding.
Note: this doesn't help you modify the behaviour of Cogl drawing functions
through the modification of GL state; that will never be reliably supported,
but if you are trying to do something like:
|[
{
- setup some OpenGL state.
- draw using OpenGL (e.g. glDrawArrays() )
- reset modified OpenGL state.
- continue using Cogl to draw
}
]|
You should surround blocks of drawing using raw GL with cogl_begin_gl()
and cogl_end_gl():
|[
{
cogl_begin_gl ();
- setup some OpenGL state.
- draw using OpenGL (e.g. glDrawArrays() )
- reset modified OpenGL state.
cogl_end_gl ();
- continue using Cogl to draw
}
]|
Don't ever try and do:
|[
{
- setup some OpenGL state.
- use Cogl to draw
- reset modified OpenGL state.
}
]|
When the internals of Cogl evolves, this is very liable to break.
This function will flush all batched primitives, and subsequently flush
all internal Cogl state to OpenGL as if it were going to draw something
itself.
The result is that the OpenGL modelview matrix will be setup; the state
corresponding to the current source material will be set up and other world
state such as backface culling, depth and fogging enabledness will be sent
to OpenGL.
<note>No special material state is flushed, so if you want Cogl to setup a
simplified material state it is your responsibility to set a simple source
material before calling cogl_begin_gl(). E.g. by calling
cogl_set_source_color4ub().</note>
<note>It is your responsibility to restore any OpenGL state that you modify
to how it was after calling cogl_begin_gl() if you don't do this then the
result of further Cogl calls is undefined.</note>
<note>You can not nest begin/end blocks.</note>
Again we would like to stress, we do not advise the use of this API and if
possible we would prefer to improve Cogl than have developers require raw
OpenGL.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglGLES2Context api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="blend_string_error_quark"
c:identifier="cogl_blend_string_error_quark">
<return-value transfer-ownership="none">
<type name="guint32" c:type="uint32_t"/>
</return-value>
</function>
<function name="check_extension"
c:identifier="cogl_check_extension"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Check whether @name occurs in list of extensions in @ext.</doc>
<doc-deprecated xml:space="preserve">OpenGL is an implementation detail for Cogl and so it's
not appropriate to expose OpenGL extensions through the Cogl API. This
function can be replaced by the following equivalent code:
|[
CoglBool retval = (strstr (ext, name) != NULL) ? TRUE : FALSE;
]|</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the extension occurs in the list, %FALSE otherwise.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">extension to check for</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="ext" transfer-ownership="none">
<doc xml:space="preserve">list of extensions</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="clear"
c:identifier="cogl_clear"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Clears all the auxiliary buffers identified in the @buffers mask, and if
that includes the color buffer then the specified @color is used.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_clear() api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">Background color to clear to</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
<parameter name="buffers" transfer-ownership="none">
<doc xml:space="preserve">A mask of #CoglBufferBit<!-- -->'s identifying which auxiliary
buffers to clear</doc>
<type name="gulong" c:type="unsigned long"/>
</parameter>
</parameters>
</function>
<function name="clutter_check_extension_CLUTTER"
c:identifier="cogl_clutter_check_extension_CLUTTER">
<return-value transfer-ownership="none">
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="ext" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="clutter_winsys_has_feature_CLUTTER"
c:identifier="cogl_clutter_winsys_has_feature_CLUTTER">
<return-value transfer-ownership="none">
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<type name="WinsysFeature" c:type="CoglWinsysFeature"/>
</parameter>
</parameters>
</function>
<function name="color_equal"
c:identifier="cogl_color_equal"
moved-to="Color.equal"
version="1.0">
<doc xml:space="preserve">Compares two #CoglColor<!-- -->s and checks if they are the same.
This function can be passed to g_hash_table_new() as the @key_equal_func
parameter, when using #CoglColor<!-- -->s as keys in a #GHashTable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the two colors are the same.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="v1"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="v2"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="color_init_from_hsl"
c:identifier="cogl_color_init_from_hsl"
moved-to="Color.init_from_hsl"
version="1.16">
<doc xml:space="preserve">Converts a color expressed in HLS (hue, luminance and saturation)
values into a #CoglColor.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="color"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">return location for a #CoglColor</doc>
<type name="Color" c:type="CoglColor*"/>
</parameter>
<parameter name="hue" transfer-ownership="none">
<doc xml:space="preserve">hue value, in the 0 .. 360 range</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="saturation" transfer-ownership="none">
<doc xml:space="preserve">saturation value, in the 0 .. 1 range</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="luminance" transfer-ownership="none">
<doc xml:space="preserve">luminance value, in the 0 .. 1 range</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="create_program"
c:identifier="cogl_create_program"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Create a new cogl program object that can be used to replace parts of the GL
rendering pipeline with custom code.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a new cogl program.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
</function>
<function name="create_shader"
c:identifier="cogl_create_shader"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Create a new shader handle, use cogl_shader_source() to set the
source code to be used on it.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a new shader handle.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="shader_type" transfer-ownership="none">
<doc xml:space="preserve">COGL_SHADER_TYPE_VERTEX or COGL_SHADER_TYPE_FRAGMENT.</doc>
<type name="ShaderType" c:type="CoglShaderType"/>
</parameter>
</parameters>
</function>
<function name="debug_matrix_print"
c:identifier="cogl_debug_matrix_print"
version="2.0">
<doc xml:space="preserve">Prints the contents of a #CoglMatrix to stdout.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">A #CoglMatrix</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</parameter>
</parameters>
</function>
<function name="disable_fog"
c:identifier="cogl_disable_fog"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This function disables fogging, so primitives drawn afterwards will not be
blended with any previously set fog color.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet shader api for fog</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="end_gl"
c:identifier="cogl_end_gl"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This is the counterpart to cogl_begin_gl() used to delimit blocks of drawing
code using raw OpenGL. Please refer to cogl_begin_gl() for full details.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglGLES2Context api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="features_available"
c:identifier="cogl_features_available"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Checks whether the given COGL features are available. Multiple
features can be checked for by or-ing them together with the '|'
operator. %TRUE is only returned if all of the requested features
are available.</doc>
<doc-deprecated xml:space="preserve">Use cogl_has_feature() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the features are available, %FALSE otherwise.</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="features" transfer-ownership="none">
<doc xml:space="preserve">A bitmask of features to check for</doc>
<type name="FeatureFlags" c:type="CoglFeatureFlags"/>
</parameter>
</parameters>
</function>
<function name="flush" c:identifier="cogl_flush" version="1.0">
<doc xml:space="preserve">This function should only need to be called in exceptional circumstances.
As an optimization Cogl drawing functions may batch up primitives
internally, so if you are trying to use raw GL outside of Cogl you stand a
better chance of being successful if you ask Cogl to flush any batched
geometry before making your state changes.
It only ensure that the underlying driver is issued all the commands
necessary to draw the batched primitives. It provides no guarantees about
when the driver will complete the rendering.
This provides no guarantees about the GL state upon returning and to avoid
confusing Cogl you should aim to restore any changes you make before
resuming use of Cogl.
If you are making state changes with the intention of affecting Cogl drawing
primitives you are 100% on your own since you stand a good chance of
conflicting with Cogl internals. For example clutter-gst which currently
uses direct GL calls to bind ARBfp programs will very likely break when Cogl
starts to use ARBfb programs itself for the material API.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="frustum"
c:identifier="cogl_frustum"
version="0.8.2"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Replaces the current projection matrix with a perspective matrix
for a given viewing frustum defined by 4 side clip planes that
all cross through the origin and 2 near and far clip planes.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_frustum() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="left" transfer-ownership="none">
<doc xml:space="preserve">X position of the left clipping plane where it
intersects the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="right" transfer-ownership="none">
<doc xml:space="preserve">X position of the right clipping plane where it
intersects the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="bottom" transfer-ownership="none">
<doc xml:space="preserve">Y position of the bottom clipping plane where it
intersects the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="top" transfer-ownership="none">
<doc xml:space="preserve">Y position of the top clipping plane where it intersects
the near clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">The distance to the near clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_far" transfer-ownership="none">
<doc xml:space="preserve">The distance to the far clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="get_backface_culling_enabled"
c:identifier="cogl_get_backface_culling_enabled"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Queries if backface culling has been enabled via
cogl_set_backface_culling_enabled()</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_get_cull_face_mode() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if backface culling is enabled, and %FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
</function>
<function name="get_bitmasks"
c:identifier="cogl_get_bitmasks"
deprecated="1"
deprecated-version="1.8">
<doc xml:space="preserve">Gets the number of bitplanes used for each of the color components
in the color buffer. Pass %NULL for any of the arguments if the
value is not required.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_get_red/green/blue/alpha_bits()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="red"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">Return location for the number of red bits or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="green"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">Return location for the number of green bits or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="blue"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">Return location for the number of blue bits or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="alpha"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">Return location for the number of alpha bits or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</function>
<function name="get_depth_test_enabled"
c:identifier="cogl_get_depth_test_enabled"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Queries if depth testing has been enabled via cogl_set_depth_test_enable()</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_depth_state() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if depth testing is enabled, and %FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
</function>
<function name="get_features"
c:identifier="cogl_get_features"
version="0.8"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Returns all of the features supported by COGL.</doc>
<doc-deprecated xml:space="preserve">Use cogl_foreach_feature() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A logical OR of all the supported COGL features.</doc>
<type name="FeatureFlags" c:type="CoglFeatureFlags"/>
</return-value>
</function>
<function name="get_modelview_matrix"
c:identifier="cogl_get_modelview_matrix"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Stores the current model-view matrix in @matrix.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_get_modelview_matrix()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="matrix"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">return location for the model-view matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</parameter>
</parameters>
</function>
<function name="get_option_group"
c:identifier="cogl_get_option_group"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the #GOptionGroup used by Cogl to parse the command
line options. Clutter uses this to handle the Cogl command line
options during its initialization process.</doc>
<doc-deprecated xml:space="preserve">Not replaced</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GOptionGroup</doc>
<type name="GLib.OptionGroup" c:type="GOptionGroup*"/>
</return-value>
</function>
<function name="get_proc_address"
c:identifier="cogl_get_proc_address"
introspectable="0">
<doc xml:space="preserve">Gets a pointer to a given GL or GL ES extension function. This acts
as a wrapper around glXGetProcAddress() or whatever is the
appropriate function for the current backend.
<note>This function should not be used to query core opengl API
symbols since eglGetProcAddress for example doesn't allow this and
and may return a junk pointer if you do.</note></doc>
<return-value>
<doc xml:space="preserve">a pointer to the requested function or %NULL if the
function is not available.</doc>
<type name="FuncPtr" c:type="CoglFuncPtr"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the name of the function.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="get_projection_matrix"
c:identifier="cogl_get_projection_matrix"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Stores the current projection matrix in @matrix.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_get_projection_matrix()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="matrix"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">return location for the projection matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</parameter>
</parameters>
</function>
<function name="get_source"
c:identifier="cogl_get_source"
version="1.6"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Returns the current source material as previously set using
cogl_set_source().
<note>You should typically consider the returned material immutable
and not try to change any of its properties unless you own a
reference to that material. At times you may be able to get a
reference to an internally managed materials and the result of
modifying such materials is undefined.</note></doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">The current source material.</doc>
<type name="gpointer" c:type="void*"/>
</return-value>
</function>
<function name="get_viewport"
c:identifier="cogl_get_viewport"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Stores the current viewport in @v. @v[0] and @v[1] get the x and y
position of the viewport and @v[2] and @v[3] get the width and
height.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_get_viewport4fv()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="v"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">pointer to a 4 element array
of #float<!-- -->s to receive the viewport dimensions.</doc>
<array zero-terminated="0" c:type="float" fixed-size="4">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
</parameters>
</function>
<function name="gtype_matrix_get_type"
c:identifier="cogl_gtype_matrix_get_type"
deprecated="1"
deprecated-version="1.18">
<doc-deprecated xml:space="preserve">Use cogl_matrix_get_gtype() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the GType for the registered "CoglMatrix" boxed type. This
can be used for example to define GObject properties that accept a
#CoglMatrix value.</doc>
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="handle_get_type" c:identifier="cogl_handle_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="handle_ref" c:identifier="cogl_handle_ref">
<doc xml:space="preserve">Increases the reference count of @handle by 1</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the handle, with its reference count increased</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="handle_unref" c:identifier="cogl_handle_unref">
<doc xml:space="preserve">Drecreases the reference count of @handle by 1; if the reference
count reaches 0, the resources allocated by @handle will be freed</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="is_bitmap" c:identifier="cogl_is_bitmap" version="1.0">
<doc xml:space="preserve">Checks whether @object is a #CoglBitmap</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the passed @object represents a bitmap,
and %FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #CoglObject pointer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="is_material"
c:identifier="cogl_is_material"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets whether the given handle references an existing material object.</doc>
<doc-deprecated xml:space="preserve">Use cogl_is_pipeline() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle references a #CoglMaterial,
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="is_offscreen" c:identifier="cogl_is_offscreen">
<doc xml:space="preserve">Determines whether the given #CoglObject references an offscreen
framebuffer object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @object is a #CoglOffscreen framebuffer,
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A pointer to a #CoglObject</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="is_program"
c:identifier="cogl_is_program"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets whether the given handle references an existing program object.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle references a program,
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="is_shader"
c:identifier="cogl_is_shader"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Gets whether the given handle references an existing shader object.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle references a shader,
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="is_texture" c:identifier="cogl_is_texture">
<doc xml:space="preserve">Gets whether the given object references a texture object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the @object references a texture, and
%FALSE otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #CoglObject pointer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="is_vertex_buffer"
c:identifier="cogl_is_vertex_buffer"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Checks whether @handle is a Vertex Buffer Object</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle is a VBO, and %FALSE
otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a vertex buffer object</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="is_vertex_buffer_indices"
c:identifier="cogl_is_vertex_buffer_indices"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Checks whether @handle is a handle to the indices for a vertex
buffer object</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle is indices, and %FALSE
otherwise</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="material_ref"
c:identifier="cogl_material_ref"
moved-to="Material.ref"
version="1.0"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Increment the reference count for a #CoglMaterial.</doc>
<doc-deprecated xml:space="preserve">Use cogl_object_ref() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the @material.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="material_unref"
c:identifier="cogl_material_unref"
moved-to="Material.unref"
version="1.0"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Decrement the reference count for a #CoglMaterial.</doc>
<doc-deprecated xml:space="preserve">Use cogl_object_unref() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="material" transfer-ownership="none">
<doc xml:space="preserve">a #CoglMaterial object.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="matrix_equal"
c:identifier="cogl_matrix_equal"
moved-to="Matrix.equal"
version="1.4">
<doc xml:space="preserve">Compares two matrices to see if they represent the same
transformation. Although internally the matrices may have different
annotations associated with them and may potentially have a cached
inverse matrix these are not considered in the comparison.</doc>
<return-value transfer-ownership="none">
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="v1"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
<parameter name="v2"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A 4x4 transformation matrix</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="onscreen_clutter_backend_set_size_CLUTTER"
c:identifier="cogl_onscreen_clutter_backend_set_size_CLUTTER">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="ortho"
c:identifier="cogl_ortho"
version="1.0"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Replaces the current projection matrix with an orthographic projection
matrix. See <xref linkend="cogl-ortho-matrix"/> to see how the matrix is
calculated.
<figure id="cogl-ortho-matrix">
<title></title>
<graphic fileref="cogl_ortho.png" format="PNG"/>
</figure>
<note>This function copies the arguments from OpenGL's glOrtho() even
though they are unnecessarily confusing due to the z near and z far
arguments actually being a "distance" from the origin, where
negative values are behind the viewer, instead of coordinates for
the z clipping planes which would have been consistent with the
left, right bottom and top arguments.</note></doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_orthographic() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="left" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the left clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="right" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the right clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="bottom" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the bottom clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="top" transfer-ownership="none">
<doc xml:space="preserve">The coordinate for the top clipping plane</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="near" transfer-ownership="none">
<doc xml:space="preserve">The <emphasis>distance</emphasis> to the near clipping
plane (negative if the plane is behind the viewer)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="far" transfer-ownership="none">
<doc xml:space="preserve">The <emphasis>distance</emphasis> for the far clipping
plane (negative if the plane is behind the viewer)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="perspective"
c:identifier="cogl_perspective"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Replaces the current projection matrix with a perspective matrix
based on the provided values.
<note>You should be careful not to have to great a @z_far / @z_near
ratio since that will reduce the effectiveness of depth testing
since there wont be enough precision to identify the depth of
objects near to each other.</note></doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_perspective() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="fovy" transfer-ownership="none">
<doc xml:space="preserve">Vertical field of view angle in degrees.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="aspect" transfer-ownership="none">
<doc xml:space="preserve">The (width over height) aspect ratio for display</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">The distance to the near clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_far" transfer-ownership="none">
<doc xml:space="preserve">The distance to the far clipping plane (Must be positive)</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="polygon" c:identifier="cogl_polygon" version="1.0">
<doc xml:space="preserve">Draws a convex polygon using the current source material to fill / texture
with according to the texture coordinates passed.
If @use_color is %TRUE then the color will be changed for each vertex using
the value specified in the color member of #CoglTextureVertex. This can be
used for example to make the texture fade out by setting the alpha value of
the color.
All of the texture coordinates must be in the range [0,1] and repeating the
texture is not supported.
Because of the way this function is implemented it will currently
only work if either the texture is not sliced or the backend is not
OpenGL ES and the minifying and magnifying functions are both set
to COGL_MATERIAL_FILTER_NEAREST.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="vertices" transfer-ownership="none">
<doc xml:space="preserve">An array of #CoglTextureVertex structs</doc>
<type name="TextureVertex" c:type="const CoglTextureVertex*"/>
</parameter>
<parameter name="n_vertices" transfer-ownership="none">
<doc xml:space="preserve">The length of the vertices array</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="use_color" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the color member of #CoglTextureVertex should be used</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</function>
<function name="pop_matrix"
c:identifier="cogl_pop_matrix"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Restores the current model-view matrix from the matrix stack.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_pop_matrix() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="pop_source"
c:identifier="cogl_pop_source"
version="1.6"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Removes the material at the top of the source stack. The material
at the top of this stack defines the GPU state used to process
later primitives as defined by cogl_set_source().</doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="program_attach_shader"
c:identifier="cogl_program_attach_shader"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Attaches a shader to a program object. A program can have multiple
vertex or fragment shaders but only one of them may provide a
main() function. It is allowed to use a program with only a vertex
shader or only a fragment shader.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="program_handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a shdaer program.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="shader_handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a vertex of fragment shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="program_get_uniform_location"
c:identifier="cogl_program_get_uniform_location"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieve the location (offset) of a uniform variable in a shader program,
a uniform is a variable that is constant for all vertices/fragments for a
shader object and is possible to modify as an external parameter.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the offset of a uniform in a specified program.
This uniform can be set using cogl_program_uniform_1f() when the
program is in use.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a shader program.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="uniform_name" transfer-ownership="none">
<doc xml:space="preserve">the name of a uniform.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="program_link"
c:identifier="cogl_program_link"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Links a program making it ready for use. Note that calling this
function is optional. If it is not called the program will
automatically be linked the first time it is used.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a shader program.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="program_ref"
c:identifier="cogl_program_ref"
deprecated="1"
deprecated-version="1.0">
<doc xml:space="preserve">Add an extra reference to a program.</doc>
<doc-deprecated xml:space="preserve">Please use cogl_object_ref() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle to a program.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="program_set_uniform_1f"
c:identifier="cogl_program_set_uniform_1f"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a floating point uniform for the given linked
@program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="program" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle for a linked program</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="uniform_location" transfer-ownership="none">
<doc xml:space="preserve">the uniform location retrieved from
cogl_program_get_uniform_location().</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="program_set_uniform_1i"
c:identifier="cogl_program_set_uniform_1i"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of an integer uniform for the given linked
@program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="program" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle for a linked program</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="uniform_location" transfer-ownership="none">
<doc xml:space="preserve">the uniform location retrieved from
cogl_program_get_uniform_location().</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="program_set_uniform_float"
c:identifier="cogl_program_set_uniform_float"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a float vector uniform, or uniform array for
the given linked @program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="program" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle for a linked program</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="uniform_location" transfer-ownership="none">
<doc xml:space="preserve">the uniform location retrieved from
cogl_program_get_uniform_location().</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="n_components" transfer-ownership="none">
<doc xml:space="preserve">The number of components for the uniform. For
example with glsl you'd use 3 for a vec3 or 4 for a vec4.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">For uniform arrays this is the array length otherwise just
pass 1</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform[s].</doc>
<array length="3" zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
</parameters>
</function>
<function name="program_set_uniform_int"
c:identifier="cogl_program_set_uniform_int"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a int vector uniform, or uniform array for
the given linked @program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="program" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle for a linked program</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="uniform_location" transfer-ownership="none">
<doc xml:space="preserve">the uniform location retrieved from
cogl_program_get_uniform_location().</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="n_components" transfer-ownership="none">
<doc xml:space="preserve">The number of components for the uniform. For
example with glsl you'd use 3 for a vec3 or 4 for a vec4.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">For uniform arrays this is the array length otherwise just
pass 1</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform[s].</doc>
<array length="3" zero-terminated="0" c:type="int*">
<type name="gint" c:type="int"/>
</array>
</parameter>
</parameters>
</function>
<function name="program_set_uniform_matrix"
c:identifier="cogl_program_set_uniform_matrix"
version="1.4"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a matrix uniform, or uniform array in the
given linked @program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="program" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle for a linked program</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="uniform_location" transfer-ownership="none">
<doc xml:space="preserve">the uniform location retrieved from
cogl_program_get_uniform_location().</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dimensions" transfer-ownership="none">
<doc xml:space="preserve">The dimensions of the matrix. So for for example pass
2 for a 2x2 matrix or 3 for 3x3.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">For uniform arrays this is the array length otherwise just
pass 1</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="transpose" transfer-ownership="none">
<doc xml:space="preserve">Whether to transpose the matrix when setting the uniform.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<array length="3" zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
</parameters>
</function>
<function name="program_uniform_1f"
c:identifier="cogl_program_uniform_1f"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a floating point uniform in the currently
used (see cogl_program_use()) shader program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uniform_no" transfer-ownership="none">
<doc xml:space="preserve">the uniform to set.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="program_uniform_1i"
c:identifier="cogl_program_uniform_1i"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of an integer uniform in the currently
used (see cogl_program_use()) shader program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uniform_no" transfer-ownership="none">
<doc xml:space="preserve">the uniform to set.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="program_uniform_float"
c:identifier="cogl_program_uniform_float"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a float vector uniform, or uniform array in the
currently used (see cogl_program_use()) shader program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uniform_no" transfer-ownership="none">
<doc xml:space="preserve">the uniform to set.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">Size of float vector.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">Size of array of uniforms.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<array length="2" zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
</parameters>
</function>
<function name="program_uniform_int"
c:identifier="cogl_program_uniform_int"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a int vector uniform, or uniform array in the
currently used (see cogl_program_use()) shader program.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uniform_no" transfer-ownership="none">
<doc xml:space="preserve">the uniform to set.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">Size of int vector.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">Size of array of uniforms.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<array length="2" zero-terminated="0" c:type="int*">
<type name="gint" c:type="int"/>
</array>
</parameter>
</parameters>
</function>
<function name="program_uniform_matrix"
c:identifier="cogl_program_uniform_matrix"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Changes the value of a matrix uniform, or uniform array in the
currently used (see cogl_program_use()) shader program. The @size
parameter is used to determine the square size of the matrix.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="uniform_no" transfer-ownership="none">
<doc xml:space="preserve">the uniform to set.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">Size of matrix.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">Size of array of uniforms.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="transpose" transfer-ownership="none">
<doc xml:space="preserve">Whether to transpose the matrix when setting the uniform.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of the uniform.</doc>
<array length="2" zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
</parameters>
</function>
<function name="program_unref"
c:identifier="cogl_program_unref"
deprecated="1"
deprecated-version="1.0">
<doc xml:space="preserve">Removes a reference to a program. If it was the last reference the
program object will be destroyed.</doc>
<doc-deprecated xml:space="preserve">Please use cogl_object_unref() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle to a program.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="program_use"
c:identifier="cogl_program_use"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Activate a specific shader program replacing that part of the GL
rendering pipeline, if passed in %COGL_INVALID_HANDLE the default
behavior of GL is reinstated.
This function affects the global state of the current Cogl
context. It is much more efficient to attach the shader to a
specific material used for rendering instead by calling
cogl_material_set_user_program().</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a #CoglHandle for a shader program or %COGL_INVALID_HANDLE.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="push_matrix"
c:identifier="cogl_push_matrix"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Stores the current model-view matrix on the matrix stack. The matrix
can later be restored with cogl_pop_matrix().</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_push_matrix() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<function name="push_source"
c:identifier="cogl_push_source"
version="1.6"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Pushes the given @material to the top of the source stack. The
material at the top of this stack defines the GPU state used to
process later primitives as defined by cogl_set_source().</doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="material"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #CoglMaterial</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="rectangle" c:identifier="cogl_rectangle">
<doc xml:space="preserve">Fills a rectangle at the given coordinates with the current source material</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="x_1" transfer-ownership="none">
<doc xml:space="preserve">X coordinate of the top-left corner</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y_1" transfer-ownership="none">
<doc xml:space="preserve">Y coordinate of the top-left corner</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="x_2" transfer-ownership="none">
<doc xml:space="preserve">X coordinate of the bottom-right corner</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y_2" transfer-ownership="none">
<doc xml:space="preserve">Y coordinate of the bottom-right corner</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="rectangle_with_multitexture_coords"
c:identifier="cogl_rectangle_with_multitexture_coords"
version="1.0">
<doc xml:space="preserve">This function draws a rectangle using the current source material to
texture or fill with. As a material may contain multiple texture layers
this interface lets you supply texture coordinates for each layer of the
material.
The first pair of coordinates are for the first layer (with the smallest
layer index) and if you supply less texture coordinates than there are
layers in the current source material then default texture coordinates
(0.0, 0.0, 1.0, 1.0) are generated.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="x1" transfer-ownership="none">
<doc xml:space="preserve">x coordinate upper left on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y1" transfer-ownership="none">
<doc xml:space="preserve">y coordinate upper left on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="x2" transfer-ownership="none">
<doc xml:space="preserve">x coordinate lower right on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y2" transfer-ownership="none">
<doc xml:space="preserve">y coordinate lower right on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="tex_coords" transfer-ownership="none">
<doc xml:space="preserve">An array containing groups of
4 float values: [tx1, ty1, tx2, ty2] that are interpreted as two texture
coordinates; one for the upper left texel, and one for the lower right
texel. Each value should be between 0.0 and 1.0, where the coordinate
(0.0, 0.0) represents the top left of the texture, and (1.0, 1.0) the
bottom right.</doc>
<array zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
<parameter name="tex_coords_len" transfer-ownership="none">
<doc xml:space="preserve">The length of the tex_coords array. (e.g. for one layer
and one group of texture coordinates, this would be 4)</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="rectangle_with_texture_coords"
c:identifier="cogl_rectangle_with_texture_coords"
version="1.0">
<doc xml:space="preserve">Draw a rectangle using the current material and supply texture coordinates
to be used for the first texture layer of the material. To draw the entire
texture pass in @tx1=0.0 @ty1=0.0 @tx2=1.0 @ty2=1.0.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="x1" transfer-ownership="none">
<doc xml:space="preserve">x coordinate upper left on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y1" transfer-ownership="none">
<doc xml:space="preserve">y coordinate upper left on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="x2" transfer-ownership="none">
<doc xml:space="preserve">x coordinate lower right on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y2" transfer-ownership="none">
<doc xml:space="preserve">y coordinate lower right on screen.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="tx1" transfer-ownership="none">
<doc xml:space="preserve">x part of texture coordinate to use for upper left pixel</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="ty1" transfer-ownership="none">
<doc xml:space="preserve">y part of texture coordinate to use for upper left pixel</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="tx2" transfer-ownership="none">
<doc xml:space="preserve">x part of texture coordinate to use for lower right pixel</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="ty2" transfer-ownership="none">
<doc xml:space="preserve">y part of texture coordinate to use for left pixel</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="rectangles" c:identifier="cogl_rectangles" version="1.0">
<doc xml:space="preserve">Draws a series of rectangles in the same way that
cogl_rectangle() does. In some situations it can give a
significant performance boost to use this function rather than
calling cogl_rectangle() separately for each rectangle.
@verts should point to an array of #float<!-- -->s with
@n_rects * 4 elements. Each group of 4 values corresponds to the
parameters x1, y1, x2, and y2, and have the same
meaning as in cogl_rectangle().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="verts" transfer-ownership="none">
<doc xml:space="preserve">an array of vertices</doc>
<array zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
<parameter name="n_rects" transfer-ownership="none">
<doc xml:space="preserve">number of rectangles to draw</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
</parameters>
</function>
<function name="rectangles_with_texture_coords"
c:identifier="cogl_rectangles_with_texture_coords"
version="0.8.6">
<doc xml:space="preserve">Draws a series of rectangles in the same way that
cogl_rectangle_with_texture_coords() does. In some situations it can give a
significant performance boost to use this function rather than
calling cogl_rectangle_with_texture_coords() separately for each rectangle.
@verts should point to an array of #float<!-- -->s with
@n_rects * 8 elements. Each group of 8 values corresponds to the
parameters x1, y1, x2, y2, tx1, ty1, tx2 and ty2 and have the same
meaning as in cogl_rectangle_with_texture_coords().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="verts" transfer-ownership="none">
<doc xml:space="preserve">an array of vertices</doc>
<array zero-terminated="0" c:type="float*">
<type name="gfloat" c:type="float"/>
</array>
</parameter>
<parameter name="n_rects" transfer-ownership="none">
<doc xml:space="preserve">number of rectangles to draw</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
</parameters>
</function>
<function name="rotate"
c:identifier="cogl_rotate"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Multiplies the current model-view matrix by one that rotates the
model around the vertex specified by @x, @y and @z. The rotation
follows the right-hand thumb rule so for example rotating by 10
degrees about the vertex (0, 0, 1) causes a small counter-clockwise
rotation.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_rotate() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="angle" transfer-ownership="none">
<doc xml:space="preserve">Angle in degrees to rotate.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">X-component of vertex to rotate around.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Y-component of vertex to rotate around.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z" transfer-ownership="none">
<doc xml:space="preserve">Z-component of vertex to rotate around.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="scale"
c:identifier="cogl_scale"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Multiplies the current model-view matrix by one that scales the x,
y and z axes by the given values.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_pop_matrix() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Amount to scale along the x-axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Amount to scale along the y-axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z" transfer-ownership="none">
<doc xml:space="preserve">Amount to scale along the z-axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="set_backface_culling_enabled"
c:identifier="cogl_set_backface_culling_enabled"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets whether textures positioned so that their backface is showing
should be hidden. This can be used to efficiently draw two-sided
textures or fully closed cubes without enabling depth testing. This
only affects calls to the cogl_rectangle* family of functions and
cogl_vertex_buffer_draw*. Backface culling is disabled by default.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_cull_face_mode() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="setting" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to enable backface culling or %FALSE to disable.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</function>
<function name="set_depth_test_enabled"
c:identifier="cogl_set_depth_test_enabled"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Sets whether depth testing is enabled. If it is disabled then the
order that actors are layered on the screen depends solely on the
order specified using clutter_actor_raise() and
clutter_actor_lower(), otherwise it will also take into account the
actor's depth. Depth testing is disabled by default.</doc>
<doc-deprecated xml:space="preserve">Use cogl_pipeline_set_depth_state() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="setting" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to enable depth testing or %FALSE to disable.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</function>
<function name="set_fog"
c:identifier="cogl_set_fog"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Enables fogging. Fogging causes vertices that are further away from the eye
to be rendered with a different color. The color is determined according to
the chosen fog mode; at it's simplest the color is linearly interpolated so
that vertices at @z_near are drawn fully with their original color and
vertices at @z_far are drawn fully with @fog_color. Fogging will remain
enabled until you call cogl_disable_fog().
<note>The fogging functions only work correctly when primitives use
unmultiplied alpha colors. By default Cogl will premultiply textures
and cogl_set_source_color() will premultiply colors, so unless you
explicitly load your textures requesting an unmultiplied internal format
and use cogl_material_set_color() you can only use fogging with fully
opaque primitives. This might improve in the future when we can depend
on fragment shaders.</note></doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet shader api for fog</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="fog_color" transfer-ownership="none">
<doc xml:space="preserve">The color of the fog</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">A #CoglFogMode that determines the equation used to calculate the
fogging blend factor.</doc>
<type name="FogMode" c:type="CoglFogMode"/>
</parameter>
<parameter name="density" transfer-ownership="none">
<doc xml:space="preserve">Used by %COGL_FOG_MODE_EXPONENTIAL and by
%COGL_FOG_MODE_EXPONENTIAL_SQUARED equations.</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_near" transfer-ownership="none">
<doc xml:space="preserve">Position along Z axis where no fogging should be applied</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z_far" transfer-ownership="none">
<doc xml:space="preserve">Position along Z axis where full fogging should be applied</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="set_modelview_matrix"
c:identifier="cogl_set_modelview_matrix"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Loads @matrix as the new model-view matrix.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_set_modelview_matrix()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">the new model-view matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</parameter>
</parameters>
</function>
<function name="set_projection_matrix"
c:identifier="cogl_set_projection_matrix"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Loads matrix as the new projection matrix.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_set_projection_matrix()
instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">the new projection matrix</doc>
<type name="Matrix" c:type="CoglMatrix*"/>
</parameter>
</parameters>
</function>
<function name="set_source"
c:identifier="cogl_set_source"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This function changes the material at the top of the source stack.
The material at the top of this stack defines the GPU state used to
process subsequent primitives, such as rectangles drawn with
cogl_rectangle() or vertices drawn using cogl_vertex_buffer_draw().</doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="material"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #CoglMaterial</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="set_source_color"
c:identifier="cogl_set_source_color"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This is a convenience function for creating a solid fill source material
from the given color. This color will be used for any subsequent drawing
operation.
The color will be premultiplied by Cogl, so the color should be
non-premultiplied. For example: use (1.0, 0.0, 0.0, 0.5) for
semi-transparent red.
See also cogl_set_source_color4ub() and cogl_set_source_color4f()
if you already have the color components.</doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a #CoglColor</doc>
<type name="Color" c:type="const CoglColor*"/>
</parameter>
</parameters>
</function>
<function name="set_source_color4f"
c:identifier="cogl_set_source_color4f"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This is a convenience function for creating a solid fill source material
from the given color using normalized values for each component. This color
will be used for any subsequent drawing operation.
The value for each component is a fixed point number in the range
between 0 and %1.0. If the values passed in are outside that
range, they will be clamped.</doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">value of the red channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">value of the green channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">value of the blue channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">value of the alpha channel, between 0 and %1.0</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="set_source_color4ub"
c:identifier="cogl_set_source_color4ub"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This is a convenience function for creating a solid fill source material
from the given color using unsigned bytes for each component. This
color will be used for any subsequent drawing operation.
The value for each component is an unsigned byte in the range
between 0 and 255.</doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="red" transfer-ownership="none">
<doc xml:space="preserve">value of the red channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="green" transfer-ownership="none">
<doc xml:space="preserve">value of the green channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="blue" transfer-ownership="none">
<doc xml:space="preserve">value of the blue channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="alpha" transfer-ownership="none">
<doc xml:space="preserve">value of the alpha channel, between 0 and 255</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
</parameters>
</function>
<function name="set_source_texture"
c:identifier="cogl_set_source_texture"
version="1.0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This is a convenience function for creating a material with the first
layer set to @texture and setting that material as the source with
cogl_set_source.
Note: There is no interaction between calls to cogl_set_source_color
and cogl_set_source_texture. If you need to blend a texture with a color then
you can create a simple material like this:
<programlisting>
material = cogl_material_new ();
cogl_material_set_color4ub (material, 0xff, 0x00, 0x00, 0x80);
cogl_material_set_layer (material, 0, tex_handle);
cogl_set_source (material);
</programlisting></doc>
<doc-deprecated xml:space="preserve">Latest drawing apis all take an explicit
#CoglPipeline argument so this stack of
#CoglMaterial<!-- -->s shouldn't be used.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="texture" transfer-ownership="none">
<doc xml:space="preserve">The #CoglTexture you want as your source</doc>
<type name="Texture" c:type="CoglTexture*"/>
</parameter>
</parameters>
</function>
<function name="set_viewport"
c:identifier="cogl_set_viewport"
version="1.2"
deprecated="1"
deprecated-version="1.8">
<doc xml:space="preserve">Replaces the current viewport with the given values.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_set_viewport() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">X offset of the viewport</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Y offset of the viewport</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of the viewport</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of the viewport</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="shader_compile"
c:identifier="cogl_shader_compile"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Compiles the shader, no return value, but the shader is now ready
for linking into a program. Note that calling this function is
optional. If it is not called then the shader will be automatically
compiled when it is linked.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">#CoglHandle for a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="shader_get_info_log"
c:identifier="cogl_shader_get_info_log"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the information log for a coglobject, can be used in conjunction
with cogl_shader_get_parameteriv() to retrieve the compiler warnings/error
messages that caused a shader to not compile correctly, mainly useful for
debugging purposes.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly allocated string containing the info log. Use
g_free() to free it</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">#CoglHandle for a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="shader_get_type"
c:identifier="cogl_shader_get_type"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the type of a shader #CoglHandle</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%COGL_SHADER_TYPE_VERTEX if the shader is a vertex processor
or %COGL_SHADER_TYPE_FRAGMENT if the shader is a frament processor</doc>
<type name="ShaderType" c:type="CoglShaderType"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">#CoglHandle for a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="shader_is_compiled"
c:identifier="cogl_shader_is_compiled"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves whether a shader #CoglHandle has been compiled</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the shader object has sucessfully be compiled</doc>
<type name="Bool" c:type="CoglBool"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">#CoglHandle for a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="shader_ref"
c:identifier="cogl_shader_ref"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Add an extra reference to a shader.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle to a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="shader_source"
c:identifier="cogl_shader_source"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Replaces the current source associated with a shader with a new
one.
Please see <link
linkend="cogl-Shaders-and-Programmable-Pipeline.description">above</link>
for a description of the recommended format for the shader code.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="shader" transfer-ownership="none">
<doc xml:space="preserve">#CoglHandle for a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="source" transfer-ownership="none">
<doc xml:space="preserve">Shader source.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="shader_unref"
c:identifier="cogl_shader_unref"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Removes a reference to a shader. If it was the last reference the
shader object will be destroyed.</doc>
<doc-deprecated xml:space="preserve">Use #CoglSnippet api</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A #CoglHandle to a shader.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="texture_error_quark"
c:identifier="cogl_texture_error_quark"
moved-to="Texture.error_quark">
<return-value transfer-ownership="none">
<type name="guint32" c:type="uint32_t"/>
</return-value>
</function>
<function name="texture_new_from_bitmap"
c:identifier="cogl_texture_new_from_bitmap"
moved-to="Texture.new_from_bitmap"
version="1.0"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a #CoglTexture from a #CoglBitmap.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_bitmap()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="bitmap" transfer-ownership="none">
<doc xml:space="preserve">A #CoglBitmap pointer</doc>
<type name="Bitmap" c:type="CoglBitmap*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to use for the GPU storage of the
texture</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="texture_new_from_data"
c:identifier="cogl_texture_new_from_data"
moved-to="Texture.new_from_data"
version="0.8"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a new #CoglTexture based on data residing in memory.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_data()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of texture in pixels</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of texture in pixels</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat the buffer is stored in in RAM</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat that will be used for storing
the buffer on the GPU. If COGL_PIXEL_FORMAT_ANY is given then a
premultiplied format similar to the format of the source data will
be used. The default blending equations of Cogl expect premultiplied
color data; the main use of passing a non-premultiplied format here
is if you have non-premultiplied source data and are going to adjust
the blend mode (see cogl_material_set_blend()) or use the data for
something other than straight blending.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">the memory offset in bytes between the starts of
scanlines in @data</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">pointer the memory region where the source buffer resides</doc>
<type name="guint8" c:type="const uint8_t*"/>
</parameter>
</parameters>
</function>
<function name="texture_new_from_file"
c:identifier="cogl_texture_new_from_file"
moved-to="Texture.new_from_file"
version="0.8"
deprecated="1"
deprecated-version="1.18"
throws="1">
<doc xml:space="preserve">Creates a #CoglTexture from an image file.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_file()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the file to load</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to use for the GPU storage of the
texture. If %COGL_PIXEL_FORMAT_ANY is given then a premultiplied
format similar to the format of the source data will be used. The
default blending equations of Cogl expect premultiplied color data;
the main use of passing a non-premultiplied format here is if you
have non-premultiplied source data and are going to adjust the blend
mode (see cogl_material_set_blend()) or use the data for something
other than straight blending.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="texture_new_from_foreign"
c:identifier="cogl_texture_new_from_foreign"
moved-to="Texture.new_from_foreign"
version="0.8"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a #CoglTexture based on an existing OpenGL texture; the
width, height and format are passed along since it is not always
possible to query these from OpenGL.
The waste arguments allow you to create a Cogl texture that maps to
a region smaller than the real OpenGL texture. For instance if your
hardware only supports power-of-two textures you may load a
non-power-of-two image into a larger power-of-two texture and use
the waste arguments to tell Cogl which region should be mapped to
the texture coordinate range [0:1].</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_from_foreign()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or
%NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="gl_handle" transfer-ownership="none">
<doc xml:space="preserve">opengl handle of foreign texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="gl_target" transfer-ownership="none">
<doc xml:space="preserve">opengl target type of foreign texture</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of foreign texture</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of foreign texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="x_pot_waste" transfer-ownership="none">
<doc xml:space="preserve">horizontal waste on the right hand edge of the texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="y_pot_waste" transfer-ownership="none">
<doc xml:space="preserve">vertical waste on the bottom edge of the texture.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">format of the foreign texture.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="texture_new_with_size"
c:identifier="cogl_texture_new_with_size"
moved-to="Texture.new_with_size"
version="0.8"
deprecated="1"
deprecated-version="1.18">
<doc xml:space="preserve">Creates a new #CoglTexture with the specified dimensions and pixel format.</doc>
<doc-deprecated xml:space="preserve">Use specific constructors such as
cogl_texture_2d_new_with_size()</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly created #CoglTexture or %NULL on failure</doc>
<type name="Texture" c:type="CoglTexture*"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of texture in pixels.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of texture in pixels.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">Optional flags for the texture, or %COGL_TEXTURE_NONE</doc>
<type name="TextureFlags" c:type="CoglTextureFlags"/>
</parameter>
<parameter name="internal_format" transfer-ownership="none">
<doc xml:space="preserve">the #CoglPixelFormat to use for the GPU storage of the
texture.</doc>
<type name="PixelFormat" c:type="CoglPixelFormat"/>
</parameter>
</parameters>
</function>
<function name="transform"
c:identifier="cogl_transform"
version="1.4"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Multiplies the current model-view matrix by the given matrix.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_transform() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="matrix" transfer-ownership="none">
<doc xml:space="preserve">the matrix to multiply with the current model-view</doc>
<type name="Matrix" c:type="const CoglMatrix*"/>
</parameter>
</parameters>
</function>
<function name="translate"
c:identifier="cogl_translate"
deprecated="1"
deprecated-version="1.10">
<doc xml:space="preserve">Multiplies the current model-view matrix by one that translates the
model along all three axes according to the given values.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_translate() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Distance to translate along the x-axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Distance to translate along the y-axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
<parameter name="z" transfer-ownership="none">
<doc xml:space="preserve">Distance to translate along the z-axis</doc>
<type name="gfloat" c:type="float"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_add"
c:identifier="cogl_vertex_buffer_add"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Adds an attribute to a buffer, or replaces a previously added
attribute with the same name.
You either can use one of the built-in names such as "gl_Vertex", or
"gl_MultiTexCoord0" to add standard attributes, like positions, colors
and normals, or you can add custom attributes for use in shaders.
The number of vertices declared when calling cogl_vertex_buffer_new()
determines how many attribute values will be read from the supplied
@pointer.
The data for your attribute isn't copied anywhere until you call
cogl_vertex_buffer_submit(), or issue a draw call which automatically
submits pending attribute changes. so the supplied pointer must remain
valid until then. If you are updating an existing attribute (done by
re-adding it) then you still need to re-call cogl_vertex_buffer_submit()
to commit the changes to the GPU. Be carefull to minimize the number
of calls to cogl_vertex_buffer_submit(), though.
<note>If you are interleving attributes it is assumed that each interleaved
attribute starts no farther than +- stride bytes from the other attributes
it is interleved with. I.e. this is ok:
<programlisting>
|-0-0-0-0-0-0-0-0-0-0|
</programlisting>
This is not ok:
<programlisting>
|- - - - -0-0-0-0-0-0 0 0 0 0|
</programlisting>
(Though you can have multiple groups of interleved attributes)</note></doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="attribute_name" transfer-ownership="none">
<doc xml:space="preserve">The name of your attribute. It should be a valid GLSL
variable name and standard attribute types must use one of following
built-in names: (Note: they correspond to the built-in names of GLSL)
<itemizedlist>
<listitem>"gl_Color"</listitem>
<listitem>"gl_Normal"</listitem>
<listitem>"gl_MultiTexCoord0, gl_MultiTexCoord1, ..."</listitem>
<listitem>"gl_Vertex"</listitem>
</itemizedlist>
To support adding multiple variations of the same attribute the name
can have a detail component, E.g. "gl_Color::active" or
"gl_Color::inactive"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="n_components" transfer-ownership="none">
<doc xml:space="preserve">The number of components per attribute and must be 1, 2,
3 or 4</doc>
<type name="guint8" c:type="uint8_t"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #CoglAttributeType specifying the data type of each component.</doc>
<type name="AttributeType" c:type="CoglAttributeType"/>
</parameter>
<parameter name="normalized" transfer-ownership="none">
<doc xml:space="preserve">If %TRUE, this specifies that values stored in an integer
format should be mapped into the range [-1.0, 1.0] or [0.0, 1.0]
for unsigned values. If %FALSE they are converted to floats
directly.</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<doc xml:space="preserve">This specifies the number of bytes from the start of one attribute
value to the start of the next value (for the same attribute). So, for
example, with a position interleved with color like this:
XYRGBAXYRGBAXYRGBA, then if each letter represents a byte, the
stride for both attributes is 6. The special value 0 means the
values are stored sequentially in memory.</doc>
<type name="guint16" c:type="uint16_t"/>
</parameter>
<parameter name="pointer"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">This addresses the first attribute in the vertex array. This
must remain valid until you either call cogl_vertex_buffer_submit() or
issue a draw call.</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_delete"
c:identifier="cogl_vertex_buffer_delete"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Deletes an attribute from a buffer. You will need to call
cogl_vertex_buffer_submit() or issue a draw call to commit this
change to the GPU.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="attribute_name" transfer-ownership="none">
<doc xml:space="preserve">The name of a previously added attribute</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_disable"
c:identifier="cogl_vertex_buffer_disable"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Disables a previosuly added attribute.
Since it can be costly to add and remove new attributes to buffers; to make
individual buffers more reuseable it is possible to enable and disable
attributes before using a buffer for drawing.
You don't need to call cogl_vertex_buffer_submit() after using this
function.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="attribute_name" transfer-ownership="none">
<doc xml:space="preserve">The name of the attribute you want to disable</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_draw"
c:identifier="cogl_vertex_buffer_draw"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Allows you to draw geometry using all or a subset of the
vertices in a vertex buffer.
Any un-submitted attribute changes are automatically submitted before
drawing.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">A #CoglVerticesMode specifying how the vertices should be
interpreted.</doc>
<type name="VerticesMode" c:type="CoglVerticesMode"/>
</parameter>
<parameter name="first" transfer-ownership="none">
<doc xml:space="preserve">Specifies the index of the first vertex you want to draw with</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">Specifies the number of vertices you want to draw.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_draw_elements"
c:identifier="cogl_vertex_buffer_draw_elements"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">This function lets you use an array of indices to specify the vertices
within your vertex buffer that you want to draw. The indices themselves
are created by calling cogl_vertex_buffer_indices_new ()
Any un-submitted attribute changes are automatically submitted before
drawing.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">A #CoglVerticesMode specifying how the vertices should be
interpreted.</doc>
<type name="VerticesMode" c:type="CoglVerticesMode"/>
</parameter>
<parameter name="indices" transfer-ownership="none">
<doc xml:space="preserve">A CoglHandle for a set of indices allocated via
cogl_vertex_buffer_indices_new ()</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="min_index" transfer-ownership="none">
<doc xml:space="preserve">Specifies the minimum vertex index contained in indices</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="max_index" transfer-ownership="none">
<doc xml:space="preserve">Specifies the maximum vertex index contained in indices</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="indices_offset" transfer-ownership="none">
<doc xml:space="preserve">An offset into named indices. The offset marks the first
index to use for drawing.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">Specifies the number of vertices you want to draw.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_enable"
c:identifier="cogl_vertex_buffer_enable"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Enables a previosuly disabled attribute.
Since it can be costly to add and remove new attributes to buffers; to make
individual buffers more reuseable it is possible to enable and disable
attributes before using a buffer for drawing.
You don't need to call cogl_vertex_buffer_submit() after using this function</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
<parameter name="attribute_name" transfer-ownership="none">
<doc xml:space="preserve">The name of the attribute you want to enable</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_get_n_vertices"
c:identifier="cogl_vertex_buffer_get_n_vertices"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Retrieves the number of vertices that @handle represents</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of vertices</doc>
<type name="guint" c:type="unsigned int"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_indices_get_for_quads"
c:identifier="cogl_vertex_buffer_indices_get_for_quads"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Creates a vertex buffer containing the indices needed to draw pairs
of triangles from a list of vertices grouped as quads. There will
be at least @n_indices entries in the buffer (but there may be
more).
The indices will follow this pattern:
0, 1, 2, 0, 2, 3, 4, 5, 6, 4, 6, 7 ... etc
For example, if you submit vertices for a quad like like that shown
in <xref linkend="quad-indices-order"/> then you can request 6
indices to render two triangles like those shown in <xref
linkend="quad-indices-triangles"/>.
<figure id="quad-indices-order">
<title>Example of vertices submitted to form a quad</title>
<graphic fileref="quad-indices-order.png" format="PNG"/>
</figure>
<figure id="quad-indices-triangles">
<title>Illustration of the triangle indices that will be generated</title>
<graphic fileref="quad-indices-triangles.png" format="PNG"/>
</figure></doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A %CoglHandle containing the indices. The handled is
owned by Cogl and should not be modified or unref'd.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="n_indices" transfer-ownership="none">
<doc xml:space="preserve">the number of indices in the vertex buffer.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_indices_get_type"
c:identifier="cogl_vertex_buffer_indices_get_type"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Queries back the data type used for the given indices</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The CoglIndicesType used</doc>
<type name="IndicesType" c:type="CoglIndicesType"/>
</return-value>
<parameters>
<parameter name="indices" transfer-ownership="none">
<doc xml:space="preserve">An indices handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_indices_new"
c:identifier="cogl_vertex_buffer_indices_new"
introspectable="0"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Depending on how much geometry you are submitting it can be worthwhile
optimizing the number of redundant vertices you submit. Using an index
array allows you to reference vertices multiple times, for example
during triangle strips.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A CoglHandle for the indices which you can pass to
cogl_vertex_buffer_draw_elements().</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="indices_type" transfer-ownership="none">
<doc xml:space="preserve">a #CoglIndicesType specifying the data type used for
the indices.</doc>
<type name="IndicesType" c:type="CoglIndicesType"/>
</parameter>
<parameter name="indices_array" transfer-ownership="none">
<doc xml:space="preserve">Specifies the address of
your array of indices</doc>
<array length="2" zero-terminated="0" c:type="void*">
<type name="gpointer" c:type="void"/>
</array>
</parameter>
<parameter name="indices_len" transfer-ownership="none">
<doc xml:space="preserve">The number of indices in indices_array</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_new"
c:identifier="cogl_vertex_buffer_new"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Creates a new vertex buffer that you can use to add attributes.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a new #CoglHandle</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="n_vertices" transfer-ownership="none">
<doc xml:space="preserve">The number of vertices that your attributes will correspond to.</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_ref"
c:identifier="cogl_vertex_buffer_ref"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Increment the reference count for a vertex buffer</doc>
<doc-deprecated xml:space="preserve">Use cogl_object_ref() instead</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the @handle.</doc>
<type name="Handle" c:type="CoglHandle"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a @CoglHandle.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_submit"
c:identifier="cogl_vertex_buffer_submit"
deprecated="1"
deprecated-version="1.16">
<doc xml:space="preserve">Submits all the user added attributes to the GPU; once submitted, the
attributes can be used for drawing.
You should aim to minimize calls to this function since it implies
validating your data; it potentially incurs a transport cost (especially if
you are using GLX indirect rendering) and potentially a format conversion
cost if the GPU doesn't natively support any of the given attribute formats.</doc>
<doc-deprecated xml:space="preserve">Use the #CoglPrimitive api instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">A vertex buffer handle</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="vertex_buffer_unref"
c:identifier="cogl_vertex_buffer_unref"
deprecated="1"
deprecated-version="1.2">
<doc xml:space="preserve">Decrement the reference count for a vertex buffer</doc>
<doc-deprecated xml:space="preserve">Use cogl_object_unref() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a @CoglHandle.</doc>
<type name="Handle" c:type="CoglHandle"/>
</parameter>
</parameters>
</function>
<function name="viewport"
c:identifier="cogl_viewport"
version="0.8.2"
deprecated="1"
deprecated-version="1.8">
<doc xml:space="preserve">Replace the current viewport with the given values.</doc>
<doc-deprecated xml:space="preserve">Use cogl_framebuffer_set_viewport instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of the viewport</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of the viewport</doc>
<type name="guint" c:type="unsigned int"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_add_filter"
c:identifier="cogl_xlib_renderer_add_filter"
introspectable="0">
<doc xml:space="preserve">Adds a callback function that will receive all native events. The
function can stop further processing of the event by return
%COGL_FILTER_REMOVE.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="func" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the callback function</doc>
<type name="XlibFilterFunc" c:type="CoglXlibFilterFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data passed to @func when called</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_get_display"
c:identifier="cogl_xlib_renderer_get_display"
introspectable="0">
<return-value>
<type c:type="Display*"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<type c:type="CoglRenderer*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_get_foreign_display"
c:identifier="cogl_xlib_renderer_get_foreign_display"
introspectable="0">
<return-value>
<doc xml:space="preserve">the foreign Xlib display that will be used by any Xlib based
winsys backend. The display needs to be set with
cogl_xlib_renderer_set_foreign_display() before this function is called.</doc>
<type c:type="Display*"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_get_visual_info"
c:identifier="cogl_xlib_renderer_get_visual_info"
introspectable="0">
<return-value>
<type c:type="XVisualInfo*"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<type c:type="CoglRenderer*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_handle_event"
c:identifier="cogl_xlib_renderer_handle_event"
introspectable="0">
<doc xml:space="preserve">This function processes a single event; it can be used to hook into
external event retrieval (for example that done by Clutter or
GDK).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#CoglFilterReturn. %COGL_FILTER_REMOVE indicates that
Cogl has internally handled the event and the caller should do no
further processing. %COGL_FILTER_CONTINUE indicates that Cogl is
either not interested in the event, or has used the event to update
internal state without taking any exclusive action.</doc>
<type name="FilterReturn" c:type="CoglFilterReturn"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">pointer to an XEvent structure</doc>
<type c:type="XEvent*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_remove_filter"
c:identifier="cogl_xlib_renderer_remove_filter"
introspectable="0">
<doc xml:space="preserve">Removes a callback that was previously added with
cogl_xlib_renderer_add_filter().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="func" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the callback function</doc>
<type name="XlibFilterFunc" c:type="CoglXlibFilterFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data given when the callback was installed</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_request_reset_on_video_memory_purge"
c:identifier="cogl_xlib_renderer_request_reset_on_video_memory_purge"
introspectable="0">
<doc xml:space="preserve">Sets whether Cogl should make use of the
NV_robustness_video_memory_purge extension, if exposed by the
driver, by initializing the GLX context appropriately.
The extension is only useful when running on certain versions of
the NVIDIA driver. Quoting from the spec:
"The NVIDIA OpenGL driver architecture on Linux has a limitation:
resources located in video memory are not persistent across certain
events. VT switches, suspend/resume events, and mode switching
events may erase the contents of video memory. Any resource that
is located exclusively in video memory, such as framebuffer objects
(FBOs), will be lost."
"This extension provides a way for applications to discover when video
memory content has been lost, so that the application can re-populate
the video memory content as necessary."
"Any driver that exposes this extension is a driver that considers
video memory to be volatile. Once the driver stack has been
improved, the extension will no longer be exposed."
cogl_get_graphics_reset_status() needs to be called at least once
every frame to find out if video memory was purged.
Note that this doesn't cause Cogl to enable robust buffer access
but other context reset errors may still happen and be reported via
cogl_get_graphics_reset_status() if external factors cause the
driver to trigger them.
This defaults to %FALSE and is effective only if called before
cogl_display_setup() .</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_set_event_retrieval_enabled"
c:identifier="cogl_xlib_renderer_set_event_retrieval_enabled"
version="1.10"
introspectable="0"
stability="Unstable">
<doc xml:space="preserve">Sets whether Cogl should automatically retrieve events from the X
display. This defaults to %TRUE unless
cogl_xlib_renderer_set_foreign_display() is called. It can be set
to %FALSE if the application wants to handle its own event
retrieval. Note that Cogl still needs to see all of the X events to
function properly so the application should call
cogl_xlib_renderer_handle_event() for each event if it disables
automatic event retrieval.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_set_foreign_display"
c:identifier="cogl_xlib_renderer_set_foreign_display"
introspectable="0">
<doc xml:space="preserve">Sets a foreign Xlib display that Cogl will use for and Xlib based winsys
backend.
Note that calling this function will automatically call
cogl_xlib_renderer_set_event_retrieval_enabled() to disable Cogl's
event retrieval. Cogl still needs to see all of the X events so the
application should also use cogl_xlib_renderer_handle_event() if it
uses this function.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="display" transfer-ownership="none">
<type c:type="Display*"/>
</parameter>
</parameters>
</function>
<function name="xlib_renderer_set_threaded_swap_wait_enabled"
c:identifier="cogl_xlib_renderer_set_threaded_swap_wait_enabled"
introspectable="0"
stability="Unstable">
<doc xml:space="preserve">Sets whether Cogl is allowed to use a separate threaded to wait for the
completion of glXSwapBuffers() and call the frame callback for the
corresponding #CoglOnscreen. This is a way of emulating the
INTEL_swap_event extension, and will only ever be used if
INTEL_swap_event is not present; it will also only be used for
specific white-listed drivers that are known to work correctly with
multiple contexts sharing state between threads.
The advantage of enabling this is that it will allow your main loop
to do other work while waiting for the system to be ready to draw
the next frame, instead of blocking in glXSwapBuffers(). A disadvantage
is that the driver will be prevented from buffering up multiple frames
even if it thinks that it would be advantageous. In general, this
will work best for something like a system compositor that is doing
simple drawing but handling lots of other complex tasks.
If you enable this, you must call XInitThreads() before any other
X11 calls in your program. (See the documentation for XInitThreads())</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve">a #CoglRenderer</doc>
<type c:type="CoglRenderer*"/>
</parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="Bool" c:type="CoglBool"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|