/usr/share/gir-1.0/GdkPixbuf-2.0.gir is in libgdk-pixbuf2.0-dev 2.36.5-2+deb9u2.
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 | <?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="GModule" version="2.0"/>
<include name="Gio" version="2.0"/>
<package name="gdk-pixbuf-2.0"/>
<c:include name="gdk-pixbuf/gdk-pixbuf.h"/>
<namespace name="GdkPixbuf"
version="2.0"
shared-library="libgdk_pixbuf-2.0.so.0"
c:identifier-prefixes="Gdk"
c:symbol-prefixes="gdk">
<enumeration name="Colorspace"
glib:type-name="GdkColorspace"
glib:get-type="gdk_colorspace_get_type"
c:type="GdkColorspace">
<doc xml:space="preserve">This enumeration defines the color spaces that are supported by
the gdk-pixbuf library. Currently only RGB is supported.</doc>
<member name="rgb"
value="0"
c:identifier="GDK_COLORSPACE_RGB"
glib:nick="rgb">
<doc xml:space="preserve">Indicates a red/green/blue additive color space.</doc>
</member>
</enumeration>
<enumeration name="InterpType"
glib:type-name="GdkInterpType"
glib:get-type="gdk_interp_type_get_type"
c:type="GdkInterpType">
<doc xml:space="preserve">This enumeration describes the different interpolation modes that
can be used with the scaling functions. @GDK_INTERP_NEAREST is
the fastest scaling method, but has horrible quality when
scaling down. @GDK_INTERP_BILINEAR is the best choice if you
aren't sure what to choose, it has a good speed/quality balance.
<note>
Cubic filtering is missing from the list; hyperbolic
interpolation is just as fast and results in higher quality.
</note></doc>
<member name="nearest"
value="0"
c:identifier="GDK_INTERP_NEAREST"
glib:nick="nearest">
<doc xml:space="preserve">Nearest neighbor sampling; this is the fastest
and lowest quality mode. Quality is normally unacceptable when scaling
down, but may be OK when scaling up.</doc>
</member>
<member name="tiles"
value="1"
c:identifier="GDK_INTERP_TILES"
glib:nick="tiles">
<doc xml:space="preserve">This is an accurate simulation of the PostScript
image operator without any interpolation enabled. Each pixel is
rendered as a tiny parallelogram of solid color, the edges of which
are implemented with antialiasing. It resembles nearest neighbor for
enlargement, and bilinear for reduction.</doc>
</member>
<member name="bilinear"
value="2"
c:identifier="GDK_INTERP_BILINEAR"
glib:nick="bilinear">
<doc xml:space="preserve">Best quality/speed balance; use this mode by
default. Bilinear interpolation. For enlargement, it is
equivalent to point-sampling the ideal bilinear-interpolated image.
For reduction, it is equivalent to laying down small tiles and
integrating over the coverage area.</doc>
</member>
<member name="hyper"
value="3"
c:identifier="GDK_INTERP_HYPER"
glib:nick="hyper">
<doc xml:space="preserve">This is the slowest and highest quality
reconstruction function. It is derived from the hyperbolic filters in
Wolberg's "Digital Image Warping", and is formally defined as the
hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
image (the filter is designed to be idempotent for 1:1 pixel mapping).</doc>
</member>
</enumeration>
<constant name="PIXBUF_FEATURES_H"
value="1"
c:type="GDK_PIXBUF_FEATURES_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="PIXBUF_MAGIC_NUMBER"
value="1197763408"
c:type="GDK_PIXBUF_MAGIC_NUMBER">
<doc xml:space="preserve">Magic number for #GdkPixdata structures.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="PIXBUF_MAJOR" value="2" c:type="GDK_PIXBUF_MAJOR">
<doc xml:space="preserve">Major version of gdk-pixbuf library, that is the "0" in
"0.8.2" for example.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="PIXBUF_MICRO" value="5" c:type="GDK_PIXBUF_MICRO">
<doc xml:space="preserve">Micro version of gdk-pixbuf library, that is the "2" in
"0.8.2" for example.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="PIXBUF_MINOR" value="36" c:type="GDK_PIXBUF_MINOR">
<doc xml:space="preserve">Minor version of gdk-pixbuf library, that is the "8" in
"0.8.2" for example.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="PIXBUF_VERSION" value="2.36.5" c:type="GDK_PIXBUF_VERSION">
<doc xml:space="preserve">Contains the full version of the gdk-pixbuf header as a string.
This is the version being compiled against; contrast with
#gdk_pixbuf_version.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="PIXDATA_HEADER_LENGTH"
value="24"
c:type="GDK_PIXDATA_HEADER_LENGTH">
<doc xml:space="preserve">The length of a #GdkPixdata structure without the @pixel_data pointer.</doc>
<type name="gint" c:type="gint"/>
</constant>
<class name="Pixbuf"
c:symbol-prefix="pixbuf"
c:type="GdkPixbuf"
parent="GObject.Object"
glib:type-name="GdkPixbuf"
glib:get-type="gdk_pixbuf_get_type">
<doc xml:space="preserve">This is the main structure in the gdk-pixbuf library. It is
used to represent images. It contains information about the
image's pixel data, its color space, bits per sample, width and
height, and the rowstride (the number of bytes between the start of
one row and the start of the next).</doc>
<implements name="Gio.Icon"/>
<implements name="Gio.LoadableIcon"/>
<constructor name="new" c:identifier="gdk_pixbuf_new">
<doc xml:space="preserve">Creates a new #GdkPixbuf structure and allocates a buffer for it. The
buffer has an optimal rowstride. Note that the buffer is not cleared;
you will have to fill it completely yourself.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created #GdkPixbuf with a reference count of 1, or
%NULL if not enough memory could be allocated for the image buffer.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="colorspace" transfer-ownership="none">
<doc xml:space="preserve">Color space for image</doc>
<type name="Colorspace" c:type="GdkColorspace"/>
</parameter>
<parameter name="has_alpha" transfer-ownership="none">
<doc xml:space="preserve">Whether the image should have transparency information</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="bits_per_sample" transfer-ownership="none">
<doc xml:space="preserve">Number of bits per color sample</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of image in pixels, must be > 0</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of image in pixels, must be > 0</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_bytes"
c:identifier="gdk_pixbuf_new_from_bytes"
version="2.32">
<doc xml:space="preserve">Creates a new #GdkPixbuf out of in-memory readonly image data.
Currently only RGB images with 8 bits per sample are supported.
This is the #GBytes variant of gdk_pixbuf_new_from_data().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created #GdkPixbuf structure with a reference count of 1.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">Image data in 8-bit/sample packed format inside a #GBytes</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
<parameter name="colorspace" transfer-ownership="none">
<doc xml:space="preserve">Colorspace for the image data</doc>
<type name="Colorspace" c:type="GdkColorspace"/>
</parameter>
<parameter name="has_alpha" transfer-ownership="none">
<doc xml:space="preserve">Whether the data has an opacity channel</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="bits_per_sample" transfer-ownership="none">
<doc xml:space="preserve">Number of bits per sample</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of the image in pixels, must be > 0</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of the image in pixels, must be > 0</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">Distance in bytes between row starts</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_data"
c:identifier="gdk_pixbuf_new_from_data">
<doc xml:space="preserve">Creates a new #GdkPixbuf out of in-memory image data. Currently only RGB
images with 8 bits per sample are supported.
Since you are providing a pre-allocated pixel buffer, you must also
specify a way to free that data. This is done with a function of
type #GdkPixbufDestroyNotify. When a pixbuf created with is
finalized, your destroy notification function will be called, and
it is its responsibility to free the pixel array.
See also gdk_pixbuf_new_from_bytes().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created #GdkPixbuf structure with a reference count of 1.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">Image data in 8-bit/sample packed format</doc>
<array zero-terminated="0" c:type="guchar*">
<type name="guint8" c:type="guchar"/>
</array>
</parameter>
<parameter name="colorspace" transfer-ownership="none">
<doc xml:space="preserve">Colorspace for the image data</doc>
<type name="Colorspace" c:type="GdkColorspace"/>
</parameter>
<parameter name="has_alpha" transfer-ownership="none">
<doc xml:space="preserve">Whether the data has an opacity channel</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="bits_per_sample" transfer-ownership="none">
<doc xml:space="preserve">Number of bits per sample</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of the image in pixels, must be > 0</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of the image in pixels, must be > 0</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="rowstride" transfer-ownership="none">
<doc xml:space="preserve">Distance in bytes between row starts</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="destroy_fn"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="8">
<doc xml:space="preserve">Function used to free the data when the pixbuf's reference count
drops to zero, or %NULL if the data should not be freed</doc>
<type name="PixbufDestroyNotify" c:type="GdkPixbufDestroyNotify"/>
</parameter>
<parameter name="destroy_fn_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">Closure data to pass to the destroy notification function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_file"
c:identifier="gdk_pixbuf_new_from_file"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from a file. The file format is
detected automatically. If %NULL is returned, then @error will be set.
Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or %NULL if
any of several error conditions occurred: the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_file_at_scale"
c:identifier="gdk_pixbuf_new_from_file_at_scale"
version="2.6"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from a file. The file format is
detected automatically. If %NULL is returned, then @error will be set.
Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
The image will be scaled to fit in the requested size, optionally preserving
the image's aspect ratio.
When preserving the aspect ratio, a @width of -1 will cause the image
to be scaled to the exact given height, and a @height of -1 will cause
the image to be scaled to the exact given width. When not preserving
aspect ratio, a @width or @height of -1 means to not scale the image
at all in that dimension. Negative values for @width and @height are
allowed since 2.8.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or %NULL
if any of several error conditions occurred: the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="preserve_aspect_ratio" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_file_at_size"
c:identifier="gdk_pixbuf_new_from_file_at_size"
version="2.4"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from a file.
The file format is detected automatically. If %NULL is returned, then
@error will be set. Possible errors are in the #GDK_PIXBUF_ERROR and
#G_FILE_ERROR domains.
The image will be scaled to fit in the requested size, preserving
the image's aspect ratio. Note that the returned pixbuf may be smaller
than @width x @height, if the aspect ratio requires it. To load
and image at the requested size, regardless of aspect ratio, use
gdk_pixbuf_new_from_file_at_scale().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or
%NULL if any of several error conditions occurred: the file could not
be opened, there was no loader for the file's format, there was not
enough memory to allocate the image buffer, or the image file contained
invalid data.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_inline"
c:identifier="gdk_pixbuf_new_from_inline"
deprecated="1"
deprecated-version="2.32"
throws="1">
<doc xml:space="preserve">Create a #GdkPixbuf from a flat representation that is suitable for
storing as inline data in a program. This is useful if you want to
ship a program with images, but don't want to depend on any
external files.
gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource],
which allows for conversion of #GdkPixbufs into such a inline representation.
In almost all cases, you should pass the `--raw` option to
`gdk-pixbuf-csource`. A sample invocation would be:
|[
gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
]|
For the typical case where the inline pixbuf is read-only static data,
you don't need to copy the pixel data unless you intend to write to
it, so you can pass %FALSE for @copy_pixels. (If you pass `--rle` to
`gdk-pixbuf-csource`, a copy will be made even if @copy_pixels is %FALSE,
so using this option is generally a bad idea.)
If you create a pixbuf from const inline data compiled into your
program, it's probably safe to ignore errors and disable length checks,
since things will always succeed:
|[
pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
]|
For non-const inline data, you could get out of memory. For untrusted
inline data located at runtime, you could have corrupt inline data in
addition.</doc>
<doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created #GdkPixbuf structure with a reference,
count of 1, or %NULL if an error occurred.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="data_length" transfer-ownership="none">
<doc xml:space="preserve">Length in bytes of the @data argument or -1 to
disable length checks</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">Byte data containing a
serialized #GdkPixdata structure</doc>
<array length="0" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="copy_pixels" transfer-ownership="none">
<doc xml:space="preserve">Whether to copy the pixel data, or use direct pointers
@data for the resulting pixbuf</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_resource"
c:identifier="gdk_pixbuf_new_from_resource"
version="2.26"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from an resource.
The file format is detected automatically. If %NULL is returned, then
@error will be set.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="resource_path" transfer-ownership="none">
<doc xml:space="preserve">the path of the resource file</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_resource_at_scale"
c:identifier="gdk_pixbuf_new_from_resource_at_scale"
version="2.26"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from an resource.
The file format is detected automatically. If %NULL is returned, then
@error will be set.
The image will be scaled to fit in the requested size, optionally
preserving the image's aspect ratio. When preserving the aspect ratio,
a @width of -1 will cause the image to be scaled to the exact given
height, and a @height of -1 will cause the image to be scaled to the
exact given width. When not preserving aspect ratio, a @width or
@height of -1 means to not scale the image at all in that dimension.
The stream is not closed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="resource_path" transfer-ownership="none">
<doc xml:space="preserve">the path of the resource file</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="preserve_aspect_ratio" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_stream"
c:identifier="gdk_pixbuf_new_from_stream"
version="2.14"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from an input stream.
The file format is detected automatically. If %NULL is returned, then
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
The stream is not closed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GInputStream to load the pixbuf from</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_stream_at_scale"
c:identifier="gdk_pixbuf_new_from_stream_at_scale"
version="2.14"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf by loading an image from an input stream.
The file format is detected automatically. If %NULL is returned, then
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
The image will be scaled to fit in the requested size, optionally
preserving the image's aspect ratio.
When preserving the aspect ratio, a @width of -1 will cause the image to be
scaled to the exact given height, and a @height of -1 will cause the image
to be scaled to the exact given width. If both @width and @height are
given, this function will behave as if the smaller of the two values
is passed as -1.
When not preserving aspect ratio, a @width or @height of -1 means to not
scale the image at all in that dimension.
The stream is not closed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GInputStream to load the pixbuf from</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="preserve_aspect_ratio" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_stream_finish"
c:identifier="gdk_pixbuf_new_from_stream_finish"
version="2.24"
throws="1">
<doc xml:space="preserve">Finishes an asynchronous pixbuf creation operation started with
gdk_pixbuf_new_from_stream_async().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GdkPixbuf or %NULL on error. Free the returned
object with g_object_unref().</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="async_result" transfer-ownership="none">
<doc xml:space="preserve">a #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_xpm_data"
c:identifier="gdk_pixbuf_new_from_xpm_data">
<doc xml:space="preserve">Creates a new pixbuf by parsing XPM data in memory. This data is commonly
the result of including an XPM file into a program's C source.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf with a reference count of 1.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">Pointer to inline XPM data.</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
</parameters>
</constructor>
<function name="from_pixdata"
c:identifier="gdk_pixbuf_from_pixdata"
deprecated="1"
deprecated-version="2.32"
throws="1">
<doc xml:space="preserve">Converts a #GdkPixdata to a #GdkPixbuf. If @copy_pixels is %TRUE or
if the pixel data is run-length-encoded, the pixel data is copied into
newly-allocated memory; otherwise it is reused.</doc>
<doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<parameter name="pixdata" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixdata to convert into a #GdkPixbuf.</doc>
<type name="Pixdata" c:type="const GdkPixdata*"/>
</parameter>
<parameter name="copy_pixels" transfer-ownership="none">
<doc xml:space="preserve">whether to copy raw pixel data; run-length encoded
pixel data is always copied.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="get_file_info"
c:identifier="gdk_pixbuf_get_file_info"
version="2.4">
<doc xml:space="preserve">Parses an image file far enough to determine its format and size.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">A #GdkPixbufFormat describing
the image format of the file or %NULL if the image format wasn't
recognized. The return value is owned by #GdkPixbuf and should
not be freed.</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">The name of the file to identify.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">Return location for the width of the
image, or %NULL</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">Return location for the height of the
image, or %NULL</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</function>
<function name="get_file_info_async"
c:identifier="gdk_pixbuf_get_file_info_async"
version="2.32">
<doc xml:space="preserve">Asynchronously parses an image file far enough to determine its
format and size.
For more details see gdk_pixbuf_get_file_info(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the
main thread. You can then call gdk_pixbuf_get_file_info_finish() to
get the result of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">The name of the file to identify</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when the file info is available</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the data to pass to the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="get_file_info_finish"
c:identifier="gdk_pixbuf_get_file_info_finish"
version="2.32"
throws="1">
<doc xml:space="preserve">Finishes an asynchronous pixbuf parsing operation started with
gdk_pixbuf_get_file_info_async().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #GdkPixbufFormat describing the image
format of the file or %NULL if the image format wasn't
recognized. The return value is owned by GdkPixbuf and should
not be freed.</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</return-value>
<parameters>
<parameter name="async_result" transfer-ownership="none">
<doc xml:space="preserve">a #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">Return location for the width of the image, or %NULL</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">Return location for the height of the image, or %NULL</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</function>
<function name="get_formats"
c:identifier="gdk_pixbuf_get_formats"
version="2.2">
<doc xml:space="preserve">Obtains the available information about the image formats supported
by GdkPixbuf.</doc>
<return-value transfer-ownership="container">
<doc xml:space="preserve">A list of
#GdkPixbufFormats describing the supported image formats. The list should
be freed when it is no longer needed, but the structures themselves are
owned by #GdkPixbuf and should not be freed.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="PixbufFormat"/>
</type>
</return-value>
</function>
<function name="new_from_stream_async"
c:identifier="gdk_pixbuf_new_from_stream_async"
version="2.24">
<doc xml:space="preserve">Creates a new pixbuf by asynchronously loading an image from an input stream.
For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GInputStream from which to load the pixbuf</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when the pixbuf is loaded</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the data to pass to the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="new_from_stream_at_scale_async"
c:identifier="gdk_pixbuf_new_from_stream_at_scale_async"
version="2.24">
<doc xml:space="preserve">Creates a new pixbuf by asynchronously loading an image from an input stream.
For more details see gdk_pixbuf_new_from_stream_at_scale(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GInputStream from which to load the pixbuf</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the width the image should have or -1 to not constrain the width</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the height the image should have or -1 to not constrain the height</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="preserve_aspect_ratio" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="6">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when the pixbuf is loaded</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the data to pass to the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="save_to_stream_finish"
c:identifier="gdk_pixbuf_save_to_stream_finish"
version="2.24"
throws="1">
<doc xml:space="preserve">Finishes an asynchronous pixbuf save operation started with
gdk_pixbuf_save_to_stream_async().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the pixbuf was saved successfully, %FALSE if an error was set.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="async_result" transfer-ownership="none">
<doc xml:space="preserve">a #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</function>
<method name="add_alpha" c:identifier="gdk_pixbuf_add_alpha">
<doc xml:space="preserve">Takes an existing pixbuf and adds an alpha channel to it.
If the existing pixbuf already had an alpha channel, the channel
values are copied from the original; otherwise, the alpha channel
is initialized to 255 (full opacity).
If @substitute_color is %TRUE, then the color specified by (@r, @g, @b) will be
assigned zero opacity. That is, if you pass (255, 255, 255) for the
substitute color, all white pixels will become fully transparent.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf with a reference count of 1.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="substitute_color" transfer-ownership="none">
<doc xml:space="preserve">Whether to set a color to zero opacity. If this
is %FALSE, then the (@r, @g, @b) arguments will be ignored.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="r" transfer-ownership="none">
<doc xml:space="preserve">Red value to substitute.</doc>
<type name="guint8" c:type="guchar"/>
</parameter>
<parameter name="g" transfer-ownership="none">
<doc xml:space="preserve">Green value to substitute.</doc>
<type name="guint8" c:type="guchar"/>
</parameter>
<parameter name="b" transfer-ownership="none">
<doc xml:space="preserve">Blue value to substitute.</doc>
<type name="guint8" c:type="guchar"/>
</parameter>
</parameters>
</method>
<method name="apply_embedded_orientation"
c:identifier="gdk_pixbuf_apply_embedded_orientation"
version="2.12">
<doc xml:space="preserve">Takes an existing pixbuf and checks for the presence of an
associated "orientation" option, which may be provided by the
jpeg loader (which reads the exif orientation tag) or the
tiff loader (which reads the tiff orientation tag, and
compensates it for the partial transforms performed by
libtiff). If an orientation option/tag is present, the
appropriate transform will be performed so that the pixbuf
is oriented correctly.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf, %NULL if
not enough memory could be allocated for it, or a reference to the
input pixbuf (with an increased reference count).</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="composite" c:identifier="gdk_pixbuf_composite">
<doc xml:space="preserve">Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y.
This gives an image in the coordinates of the destination pixbuf.
The rectangle (@dest_x, @dest_y, @dest_width, @dest_height)
is then alpha blended onto the corresponding rectangle of the
original destination image.
When the destination rectangle contains parts not in the source
image, the data at the edges of the source image is replicated
to infinity.
</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">the #GdkPixbuf into which to render the results</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
<parameter name="dest_x" transfer-ownership="none">
<doc xml:space="preserve">the left coordinate for region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_y" transfer-ownership="none">
<doc xml:space="preserve">the top coordinate for region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_width" transfer-ownership="none">
<doc xml:space="preserve">the width of the region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_height" transfer-ownership="none">
<doc xml:space="preserve">the height of the region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="offset_x" transfer-ownership="none">
<doc xml:space="preserve">the offset in the X direction (currently rounded to an integer)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="offset_y" transfer-ownership="none">
<doc xml:space="preserve">the offset in the Y direction (currently rounded to an integer)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="scale_x" transfer-ownership="none">
<doc xml:space="preserve">the scale factor in the X direction</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="scale_y" transfer-ownership="none">
<doc xml:space="preserve">the scale factor in the Y direction</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="interp_type" transfer-ownership="none">
<doc xml:space="preserve">the interpolation type for the transformation.</doc>
<type name="InterpType" c:type="GdkInterpType"/>
</parameter>
<parameter name="overall_alpha" transfer-ownership="none">
<doc xml:space="preserve">overall alpha for source image (0..255)</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="composite_color" c:identifier="gdk_pixbuf_composite_color">
<doc xml:space="preserve">Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y,
then alpha blends the rectangle (@dest_x ,@dest_y, @dest_width,
@dest_height) of the resulting image with a checkboard of the
colors @color1 and @color2 and renders it onto the destination
image.
If the source image has no alpha channel, and @overall_alpha is 255, a fast
path is used which omits the alpha blending and just performs the scaling.
See gdk_pixbuf_composite_color_simple() for a simpler variant of this
function suitable for many tasks.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">the #GdkPixbuf into which to render the results</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
<parameter name="dest_x" transfer-ownership="none">
<doc xml:space="preserve">the left coordinate for region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_y" transfer-ownership="none">
<doc xml:space="preserve">the top coordinate for region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_width" transfer-ownership="none">
<doc xml:space="preserve">the width of the region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_height" transfer-ownership="none">
<doc xml:space="preserve">the height of the region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="offset_x" transfer-ownership="none">
<doc xml:space="preserve">the offset in the X direction (currently rounded to an integer)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="offset_y" transfer-ownership="none">
<doc xml:space="preserve">the offset in the Y direction (currently rounded to an integer)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="scale_x" transfer-ownership="none">
<doc xml:space="preserve">the scale factor in the X direction</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="scale_y" transfer-ownership="none">
<doc xml:space="preserve">the scale factor in the Y direction</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="interp_type" transfer-ownership="none">
<doc xml:space="preserve">the interpolation type for the transformation.</doc>
<type name="InterpType" c:type="GdkInterpType"/>
</parameter>
<parameter name="overall_alpha" transfer-ownership="none">
<doc xml:space="preserve">overall alpha for source image (0..255)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="check_x" transfer-ownership="none">
<doc xml:space="preserve">the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="check_y" transfer-ownership="none">
<doc xml:space="preserve">the Y offset for the checkboard</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="check_size" transfer-ownership="none">
<doc xml:space="preserve">the size of checks in the checkboard (must be a power of two)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="color1" transfer-ownership="none">
<doc xml:space="preserve">the color of check at upper left</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
<parameter name="color2" transfer-ownership="none">
<doc xml:space="preserve">the color of the other check</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="composite_color_simple"
c:identifier="gdk_pixbuf_composite_color_simple">
<doc xml:space="preserve">Creates a new #GdkPixbuf by scaling @src to @dest_width x
@dest_height and alpha blending the result with a checkboard of colors
@color1 and @color2.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #GdkPixbuf, or %NULL if not enough memory could be
allocated for it.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest_width" transfer-ownership="none">
<doc xml:space="preserve">the width of destination image</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_height" transfer-ownership="none">
<doc xml:space="preserve">the height of destination image</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="interp_type" transfer-ownership="none">
<doc xml:space="preserve">the interpolation type for the transformation.</doc>
<type name="InterpType" c:type="GdkInterpType"/>
</parameter>
<parameter name="overall_alpha" transfer-ownership="none">
<doc xml:space="preserve">overall alpha for source image (0..255)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="check_size" transfer-ownership="none">
<doc xml:space="preserve">the size of checks in the checkboard (must be a power of two)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="color1" transfer-ownership="none">
<doc xml:space="preserve">the color of check at upper left</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
<parameter name="color2" transfer-ownership="none">
<doc xml:space="preserve">the color of the other check</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="copy" c:identifier="gdk_pixbuf_copy">
<doc xml:space="preserve">Creates a new #GdkPixbuf with a copy of the information in the specified
@pixbuf. Note that this does not copy the options set on the original #GdkPixbuf,
use gdk_pixbuf_copy_options() for this.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or %NULL if
not enough memory could be allocated.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="copy_area" c:identifier="gdk_pixbuf_copy_area">
<doc xml:space="preserve">Copies a rectangular area from @src_pixbuf to @dest_pixbuf. Conversion of
pixbuf formats is done automatically.
If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the copy operation.
Therefore, you can not use this function to scroll a pixbuf.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src_pixbuf" transfer-ownership="none">
<doc xml:space="preserve">Source pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="src_x" transfer-ownership="none">
<doc xml:space="preserve">Source X coordinate within @src_pixbuf.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="src_y" transfer-ownership="none">
<doc xml:space="preserve">Source Y coordinate within @src_pixbuf.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of the area to copy.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of the area to copy.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_pixbuf" transfer-ownership="none">
<doc xml:space="preserve">Destination pixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
<parameter name="dest_x" transfer-ownership="none">
<doc xml:space="preserve">X coordinate within @dest_pixbuf.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_y" transfer-ownership="none">
<doc xml:space="preserve">Y coordinate within @dest_pixbuf.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="copy_options"
c:identifier="gdk_pixbuf_copy_options"
version="2.36">
<doc xml:space="preserve">Copy the key/value pair options attached to a #GdkPixbuf to another.
This is useful to keep original metadata after having manipulated
a file. However be careful to remove metadata which you've already
applied, such as the "orientation" option after rotating the image.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="src_pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf to copy options from</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest_pixbuf" transfer-ownership="none">
<doc xml:space="preserve">the #GdkPixbuf to copy options to</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
</parameters>
</method>
<method name="fill" c:identifier="gdk_pixbuf_fill">
<doc xml:space="preserve">Clears a pixbuf to the given RGBA value, converting the RGBA value into
the pixbuf's pixel format. The alpha will be ignored if the pixbuf
doesn't have an alpha channel.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="pixel" transfer-ownership="none">
<doc xml:space="preserve">RGBA pixel to clear to
(0xffffffff is opaque white, 0x00000000 transparent black)</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="flip" c:identifier="gdk_pixbuf_flip" version="2.6">
<doc xml:space="preserve">Flips a pixbuf horizontally or vertically and returns the
result in a new pixbuf.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new #GdkPixbuf, or %NULL
if not enough memory could be allocated for it.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="horizontal" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to flip horizontally, %FALSE to flip vertically</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="get_bits_per_sample"
c:identifier="gdk_pixbuf_get_bits_per_sample">
<doc xml:space="preserve">Queries the number of bits per color sample in a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Number of bits per color sample.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_byte_length"
c:identifier="gdk_pixbuf_get_byte_length"
version="2.26">
<doc xml:space="preserve">Returns the length of the pixel data, in bytes.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The length of the pixel data.</doc>
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_colorspace" c:identifier="gdk_pixbuf_get_colorspace">
<doc xml:space="preserve">Queries the color space of a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Color space.</doc>
<type name="Colorspace" c:type="GdkColorspace"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_has_alpha" c:identifier="gdk_pixbuf_get_has_alpha">
<doc xml:space="preserve">Queries whether a pixbuf has an alpha channel (opacity information).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if it has an alpha channel, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_height" c:identifier="gdk_pixbuf_get_height">
<doc xml:space="preserve">Queries the height of a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Height in pixels.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_n_channels" c:identifier="gdk_pixbuf_get_n_channels">
<doc xml:space="preserve">Queries the number of channels of a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Number of channels.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_option" c:identifier="gdk_pixbuf_get_option">
<doc xml:space="preserve">Looks up @key in the list of options that may have been attached to the
@pixbuf when it was loaded, or that may have been attached by another
function using gdk_pixbuf_set_option().
For instance, the ANI loader provides "Title" and "Artist" options.
The ICO, XBM, and XPM loaders provide "x_hot" and "y_hot" hot-spot
options for cursor definitions. The PNG loader provides the tEXt ancillary
chunk key/value pairs as options. Since 2.12, the TIFF and JPEG loaders
return an "orientation" option string that corresponds to the embedded
TIFF/Exif orientation tag (if present). Since 2.32, the TIFF loader sets
the "multipage" option string to "yes" when a multi-page TIFF is loaded.
Since 2.32 the JPEG and PNG loaders set "x-dpi" and "y-dpi" if the file
contains image density information in dots per inch.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the value associated with @key. This is a nul-terminated
string that should not be freed or %NULL if @key was not found.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">a nul-terminated string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_options"
c:identifier="gdk_pixbuf_get_options"
version="2.32">
<doc xml:space="preserve">Returns a #GHashTable with a list of all the options that may have been
attached to the @pixbuf when it was loaded, or that may have been
attached by another function using gdk_pixbuf_set_option().
See gdk_pixbuf_get_option() for more details.</doc>
<return-value transfer-ownership="container">
<doc xml:space="preserve">a #GHashTable of key/values</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixels"
c:identifier="gdk_pixbuf_get_pixels"
shadowed-by="get_pixels_with_length">
<doc xml:space="preserve">Queries a pointer to the pixel data of a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A pointer to the pixbuf's pixel data.
Please see the section on [image data](image-data) for information
about how the pixel data is stored in memory.
This function will cause an implicit copy of the pixbuf data if the
pixbuf was created from read-only data.</doc>
<array zero-terminated="0" c:type="guchar*">
<type name="guint8" c:type="guchar"/>
</array>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixels_with_length"
c:identifier="gdk_pixbuf_get_pixels_with_length"
shadows="get_pixels"
version="2.26">
<doc xml:space="preserve">Queries a pointer to the pixel data of a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A pointer to the pixbuf's
pixel data. Please see the section on [image data](image-data)
for information about how the pixel data is stored in memory.
This function will cause an implicit copy of the pixbuf data if the
pixbuf was created from read-only data.</doc>
<array length="0" zero-terminated="0" c:type="guchar*">
<type name="guint8" c:type="guchar"/>
</array>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="length"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">The length of the binary data.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</method>
<method name="get_rowstride" c:identifier="gdk_pixbuf_get_rowstride">
<doc xml:space="preserve">Queries the rowstride of a pixbuf, which is the number of bytes between
the start of a row and the start of the next row.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Distance between row starts.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width" c:identifier="gdk_pixbuf_get_width">
<doc xml:space="preserve">Queries the width of a pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Width in pixels.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="new_subpixbuf" c:identifier="gdk_pixbuf_new_subpixbuf">
<doc xml:space="preserve">Creates a new pixbuf which represents a sub-region of @src_pixbuf.
The new pixbuf shares its pixels with the original pixbuf, so
writing to one affects both. The new pixbuf holds a reference to
@src_pixbuf, so @src_pixbuf will not be finalized until the new
pixbuf is finalized.
Note that if @src_pixbuf is read-only, this function will force it
to be mutable.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new pixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="src_pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="src_x" transfer-ownership="none">
<doc xml:space="preserve">X coord in @src_pixbuf</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="src_y" transfer-ownership="none">
<doc xml:space="preserve">Y coord in @src_pixbuf</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width of region in @src_pixbuf</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height of region in @src_pixbuf</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="read_pixel_bytes"
c:identifier="gdk_pixbuf_read_pixel_bytes"
version="2.32">
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new reference to a read-only copy of
the pixel data. Note that for mutable pixbufs, this function will
incur a one-time copy of the pixel data for conversion into the
returned #GBytes.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="read_pixels"
c:identifier="gdk_pixbuf_read_pixels"
version="2.32">
<doc xml:space="preserve">Returns a read-only pointer to the raw pixel data; must not be
modified. This function allows skipping the implicit copy that
must be made if gdk_pixbuf_get_pixels() is called on a read-only
pixbuf.</doc>
<return-value transfer-ownership="none">
<type name="guint8" c:type="const guint8*"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="ref"
c:identifier="gdk_pixbuf_ref"
introspectable="0"
deprecated="1"
deprecated-version="2.0">
<doc xml:space="preserve">Adds a reference to a pixbuf.</doc>
<doc-deprecated xml:space="preserve">Use g_object_ref().</doc-deprecated>
<return-value>
<doc xml:space="preserve">The same as the @pixbuf argument.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="remove_option"
c:identifier="gdk_pixbuf_remove_option"
version="2.36">
<doc xml:space="preserve">Remove the key/value pair option attached to a #GdkPixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if an option was removed, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">a nul-terminated string representing the key to remove.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="rotate_simple"
c:identifier="gdk_pixbuf_rotate_simple"
version="2.6">
<doc xml:space="preserve">Rotates a pixbuf by a multiple of 90 degrees, and returns the
result in a new pixbuf.
If @angle is 0, a copy of @src is returned, avoiding any rotation.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new #GdkPixbuf, or %NULL
if not enough memory could be allocated for it.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="angle" transfer-ownership="none">
<doc xml:space="preserve">the angle to rotate by</doc>
<type name="PixbufRotation" c:type="GdkPixbufRotation"/>
</parameter>
</parameters>
</method>
<method name="saturate_and_pixelate"
c:identifier="gdk_pixbuf_saturate_and_pixelate">
<doc xml:space="preserve">Modifies saturation and optionally pixelates @src, placing the result in
@dest. @src and @dest may be the same pixbuf with no ill effects. If
@saturation is 1.0 then saturation is not changed. If it's less than 1.0,
saturation is reduced (the image turns toward grayscale); if greater than
1.0, saturation is increased (the image gets more vivid colors). If @pixelate
is %TRUE, then pixels are faded in a checkerboard pattern to create a
pixelated image. @src and @dest must have the same image format, size, and
rowstride.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">source image</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">place to write modified version of @src</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
<parameter name="saturation" transfer-ownership="none">
<doc xml:space="preserve">saturation factor</doc>
<type name="gfloat" c:type="gfloat"/>
</parameter>
<parameter name="pixelate" transfer-ownership="none">
<doc xml:space="preserve">whether to pixelate</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="save" c:identifier="gdk_pixbuf_save" introspectable="0">
<doc xml:space="preserve">Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico"
and "bmp" are possible file formats to save in, but more formats may be
installed. The list of all writable formats can be determined in the
following way:
|[
void add_if_writable (GdkPixbufFormat *data, GSList **list)
{
if (gdk_pixbuf_format_is_writable (data))
*list = g_slist_prepend (*list, data);
}
GSList *formats = gdk_pixbuf_get_formats ();
GSList *writable_formats = NULL;
g_slist_foreach (formats, add_if_writable, &writable_formats);
g_slist_free (formats);
]|
If @error is set, %FALSE will be returned. Possible errors include
those in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain.
The variable argument list should be %NULL-terminated; if not empty,
it should contain pairs of strings that modify the save
parameters. For example:
|[
gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL);
]|
Currently only few parameters exist. JPEG images can be saved with a
"quality" parameter; its value should be in the range [0,100]. JPEG
and PNG density can be set by setting the "x-dpi" and "y-dpi" parameters
to the appropriate values in dots per inch.
Text chunks can be attached to PNG images by specifying parameters of
the form "tEXt::key", where key is an ASCII string of length 1-79.
The values are UTF-8 encoded strings. The PNG compression level can
be specified using the "compression" parameter; it's value is in an
integer in the range of [0,9].
ICC color profiles can also be embedded into PNG, JPEG and TIFF images.
The "icc-profile" value should be the complete ICC profile encoded
into base64.
|[
gchar *contents;
gchar *contents_encode;
gsize length;
g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL);
contents_encode = g_base64_encode ((const guchar *) contents, length);
gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode, NULL);
]|
TIFF images recognize: (1) a "bits-per-sample" option (integer) which
can be either 1 for saving bi-level CCITTFAX4 images, or 8 for saving
8-bits per sample; (2) a "compression" option (integer) which can be
1 for no compression, 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for
DEFLATE (see the libtiff documentation and tiff.h for all supported
codec values); (3) an "icc-profile" option (zero-terminated string)
containing a base64 encoded ICC color profile.
ICO images can be saved in depth 16, 24, or 32, by using the "depth"
parameter. When the ICO saver is given "x_hot" and "y_hot" parameters,
it produces a CUR instead of an ICO.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether an error was set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">name of file to save.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="error"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">return location for error, or %NULL</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">list of key-value save options, followed by %NULL</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="save_to_buffer"
c:identifier="gdk_pixbuf_save_to_buffer"
version="2.4"
introspectable="0">
<doc xml:space="preserve">Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
"png", "tiff", "ico" or "bmp". This is a convenience function that uses
gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer
is not nul-terminated and may contain embedded nuls.
If @error is set, %FALSE will be returned and @buffer will be set to
%NULL. Possible errors include those in the #GDK_PIXBUF_ERROR
domain.
See gdk_pixbuf_save() for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether an error was set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="buffer"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">location to receive a pointer
to the new buffer.</doc>
<array length="1" zero-terminated="0" c:type="gchar**">
<type name="guint8"/>
</array>
</parameter>
<parameter name="buffer_size"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">location to receive the size of the new buffer.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="error"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">return location for error, or %NULL</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">list of key-value save options</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="save_to_bufferv"
c:identifier="gdk_pixbuf_save_to_bufferv"
version="2.4"
throws="1">
<doc xml:space="preserve">Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
"tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer()
for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether an error was set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="buffer"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">
location to receive a pointer to the new buffer.</doc>
<array length="1" zero-terminated="0" c:type="gchar**">
<type name="guint8"/>
</array>
</parameter>
<parameter name="buffer_size"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">location to receive the size of the new buffer.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="option_keys" transfer-ownership="none">
<doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
<parameter name="option_values" transfer-ownership="none">
<doc xml:space="preserve">values for named options</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
</parameters>
</method>
<method name="save_to_callback"
c:identifier="gdk_pixbuf_save_to_callback"
version="2.4"
introspectable="0">
<doc xml:space="preserve">Saves pixbuf in format @type by feeding the produced data to a
callback. Can be used when you want to store the image to something
other than a file, such as an in-memory buffer or a socket.
If @error is set, %FALSE will be returned. Possible errors
include those in the #GDK_PIXBUF_ERROR domain and whatever the save
function generates.
See gdk_pixbuf_save() for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether an error was set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="save_func"
transfer-ownership="none"
scope="call"
closure="1">
<doc xml:space="preserve">a function that is called to save each block of data that
the save routine generates.</doc>
<type name="PixbufSaveFunc" c:type="GdkPixbufSaveFunc"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data to pass to the save function.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="error"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">return location for error, or %NULL</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">list of key-value save options</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="save_to_callbackv"
c:identifier="gdk_pixbuf_save_to_callbackv"
version="2.4"
throws="1">
<doc xml:space="preserve">Saves pixbuf to a callback in format @type, which is currently "jpeg",
"png", "tiff", "ico" or "bmp". If @error is set, %FALSE will be returned. See
gdk_pixbuf_save_to_callback () for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether an error was set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="save_func"
transfer-ownership="none"
scope="call"
closure="1">
<doc xml:space="preserve">a function that is called to save each block of data that
the save routine generates.</doc>
<type name="PixbufSaveFunc" c:type="GdkPixbufSaveFunc"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data to pass to the save function.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="option_keys" transfer-ownership="none">
<doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
<array c:type="char**">
<type name="utf8"/>
</array>
</parameter>
<parameter name="option_values" transfer-ownership="none">
<doc xml:space="preserve">values for named options</doc>
<array c:type="char**">
<type name="utf8"/>
</array>
</parameter>
</parameters>
</method>
<method name="save_to_stream"
c:identifier="gdk_pixbuf_save_to_stream"
version="2.14"
introspectable="0">
<doc xml:space="preserve">Saves @pixbuf to an output stream.
Supported file formats are currently "jpeg", "tiff", "png", "ico" or
"bmp". See gdk_pixbuf_save_to_buffer() for more details.
The @cancellable can be used to abort the operation from another
thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED
will be returned. Other possible errors are in the #GDK_PIXBUF_ERROR
and %G_IO_ERROR domains.
The stream is not closed.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the pixbuf was saved successfully, %FALSE if an
error was set.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GOutputStream to save the pixbuf to</doc>
<type name="Gio.OutputStream" c:type="GOutputStream*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="error"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">return location for error, or %NULL</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">list of key-value save options</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="save_to_stream_async"
c:identifier="gdk_pixbuf_save_to_stream_async"
version="2.24"
introspectable="0">
<doc xml:space="preserve">Saves @pixbuf to an output stream asynchronously.
For more details see gdk_pixbuf_save_to_stream(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GOutputStream to which to save the pixbuf</doc>
<type name="Gio.OutputStream" c:type="GOutputStream*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="4">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when the pixbuf is saved</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the data to pass to the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">list of key-value save options</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="save_to_streamv"
c:identifier="gdk_pixbuf_save_to_streamv"
version="2.36"
throws="1">
<doc xml:space="preserve">Saves @pixbuf to an output stream.
Supported file formats are currently "jpeg", "tiff", "png", "ico" or
"bmp". See gdk_pixbuf_save_to_stream() for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the pixbuf was saved successfully, %FALSE if an
error was set.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GOutputStream to save the pixbuf to</doc>
<type name="Gio.OutputStream" c:type="GOutputStream*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="option_keys" transfer-ownership="none">
<doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
<parameter name="option_values" transfer-ownership="none">
<doc xml:space="preserve">values for named options</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="save_to_streamv_async"
c:identifier="gdk_pixbuf_save_to_streamv_async"
version="2.36">
<doc xml:space="preserve">Saves @pixbuf to an output stream asynchronously.
For more details see gdk_pixbuf_save_to_streamv(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GOutputStream to which to save the pixbuf</doc>
<type name="Gio.OutputStream" c:type="GOutputStream*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="option_keys" transfer-ownership="none">
<doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
<array c:type="gchar**">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
<parameter name="option_values" transfer-ownership="none">
<doc xml:space="preserve">values for named options</doc>
<array c:type="gchar**">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="6">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when the pixbuf is saved</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the data to pass to the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="savev" c:identifier="gdk_pixbuf_savev" throws="1">
<doc xml:space="preserve">Saves pixbuf to a file in @type, which is currently "jpeg", "png", "tiff", "ico" or "bmp".
If @error is set, %FALSE will be returned.
See gdk_pixbuf_save () for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether an error was set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">name of file to save.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">name of file format.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="option_keys" transfer-ownership="none">
<doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
<parameter name="option_values" transfer-ownership="none">
<doc xml:space="preserve">values for named options</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
</parameters>
</method>
<method name="scale" c:identifier="gdk_pixbuf_scale">
<doc xml:space="preserve">Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y,
then renders the rectangle (@dest_x, @dest_y, @dest_width,
@dest_height) of the resulting image onto the destination image
replacing the previous contents.
Try to use gdk_pixbuf_scale_simple() first, this function is
the industrial-strength power tool you can fall back to if
gdk_pixbuf_scale_simple() isn't powerful enough.
If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the scaling which
results in rendering artifacts.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">the #GdkPixbuf into which to render the results</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
<parameter name="dest_x" transfer-ownership="none">
<doc xml:space="preserve">the left coordinate for region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_y" transfer-ownership="none">
<doc xml:space="preserve">the top coordinate for region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_width" transfer-ownership="none">
<doc xml:space="preserve">the width of the region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_height" transfer-ownership="none">
<doc xml:space="preserve">the height of the region to render</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="offset_x" transfer-ownership="none">
<doc xml:space="preserve">the offset in the X direction (currently rounded to an integer)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="offset_y" transfer-ownership="none">
<doc xml:space="preserve">the offset in the Y direction (currently rounded to an integer)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="scale_x" transfer-ownership="none">
<doc xml:space="preserve">the scale factor in the X direction</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="scale_y" transfer-ownership="none">
<doc xml:space="preserve">the scale factor in the Y direction</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="interp_type" transfer-ownership="none">
<doc xml:space="preserve">the interpolation type for the transformation.</doc>
<type name="InterpType" c:type="GdkInterpType"/>
</parameter>
</parameters>
</method>
<method name="scale_simple" c:identifier="gdk_pixbuf_scale_simple">
<doc xml:space="preserve">Create a new #GdkPixbuf containing a copy of @src scaled to
@dest_width x @dest_height. Leaves @src unaffected. @interp_type
should be #GDK_INTERP_NEAREST if you want maximum speed (but when
scaling down #GDK_INTERP_NEAREST is usually unusably ugly). The
default @interp_type should be #GDK_INTERP_BILINEAR which offers
reasonable quality and speed.
You can scale a sub-portion of @src by creating a sub-pixbuf
pointing into @src; see gdk_pixbuf_new_subpixbuf().
If @dest_width and @dest_height are equal to the @src width and height, a
copy of @src is returned, avoiding any scaling.
For more complicated scaling/alpha blending see gdk_pixbuf_scale()
and gdk_pixbuf_composite().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #GdkPixbuf, or %NULL if not enough memory could be
allocated for it.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</instance-parameter>
<parameter name="dest_width" transfer-ownership="none">
<doc xml:space="preserve">the width of destination image</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest_height" transfer-ownership="none">
<doc xml:space="preserve">the height of destination image</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="interp_type" transfer-ownership="none">
<doc xml:space="preserve">the interpolation type for the transformation.</doc>
<type name="InterpType" c:type="GdkInterpType"/>
</parameter>
</parameters>
</method>
<method name="set_option"
c:identifier="gdk_pixbuf_set_option"
version="2.2">
<doc xml:space="preserve">Attaches a key/value pair as an option to a #GdkPixbuf. If @key already
exists in the list of options attached to @pixbuf, the new value is
ignored and %FALSE is returned.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbuf</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">a nul-terminated string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a nul-terminated string.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="unref"
c:identifier="gdk_pixbuf_unref"
introspectable="0"
deprecated="1"
deprecated-version="2.0">
<doc xml:space="preserve">Removes a reference from a pixbuf.</doc>
<doc-deprecated xml:space="preserve">Use g_object_unref().</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<property name="bits-per-sample"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The number of bits per sample.
Currently only 8 bit per sample are supported.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="colorspace"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Colorspace"/>
</property>
<property name="has-alpha"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="height"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="n-channels"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The number of samples per pixel.
Currently, only 3 or 4 samples per pixel are supported.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="pixel-bytes"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="GLib.Bytes"/>
</property>
<property name="pixels"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="rowstride"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The number of bytes between the start of a row and
the start of the next row. This number must (obviously)
be at least as large as the width of the pixbuf.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="width"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
</class>
<enumeration name="PixbufAlphaMode"
glib:type-name="GdkPixbufAlphaMode"
glib:get-type="gdk_pixbuf_alpha_mode_get_type"
c:type="GdkPixbufAlphaMode">
<doc xml:space="preserve">These values can be passed to
gdk_pixbuf_xlib_render_to_drawable_alpha() to control how the alpha
channel of an image should be handled. This function can create a
bilevel clipping mask (black and white) and use it while painting
the image. In the future, when the X Window System gets an alpha
channel extension, it will be possible to do full alpha
compositing onto arbitrary drawables. For now both cases fall
back to a bilevel clipping mask.</doc>
<member name="bilevel"
value="0"
c:identifier="GDK_PIXBUF_ALPHA_BILEVEL"
glib:nick="bilevel">
<doc xml:space="preserve">A bilevel clipping mask (black and white)
will be created and used to draw the image. Pixels below 0.5 opacity
will be considered fully transparent, and all others will be
considered fully opaque.</doc>
</member>
<member name="full"
value="1"
c:identifier="GDK_PIXBUF_ALPHA_FULL"
glib:nick="full">
<doc xml:space="preserve">For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
In the future it will do full alpha compositing.</doc>
</member>
</enumeration>
<class name="PixbufAnimation"
c:symbol-prefix="pixbuf_animation"
c:type="GdkPixbufAnimation"
parent="GObject.Object"
glib:type-name="GdkPixbufAnimation"
glib:get-type="gdk_pixbuf_animation_get_type">
<doc xml:space="preserve">An opaque struct representing an animation.</doc>
<constructor name="new_from_file"
c:identifier="gdk_pixbuf_animation_new_from_file"
throws="1">
<doc xml:space="preserve">Creates a new animation by loading it from a file. The file format is
detected automatically. If the file's format does not support multi-frame
images, then an animation with a single frame will be created. Possible errors
are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created animation with a reference count of 1, or %NULL
if any of several error conditions ocurred: the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_resource"
c:identifier="gdk_pixbuf_animation_new_from_resource"
version="2.28"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf animation by loading an image from an resource.
The file format is detected automatically. If %NULL is returned, then
@error will be set.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created animation, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</return-value>
<parameters>
<parameter name="resource_path" transfer-ownership="none">
<doc xml:space="preserve">the path of the resource file</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_stream"
c:identifier="gdk_pixbuf_animation_new_from_stream"
version="2.28"
throws="1">
<doc xml:space="preserve">Creates a new animation by loading it from an input stream.
The file format is detected automatically. If %NULL is returned, then
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
The stream is not closed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
conditions occurred: the file could not be opened, the image format is
not supported, there was not enough memory to allocate the image buffer,
the stream contained invalid data, or the operation was cancelled.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GInputStream to load the pixbuf from</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_stream_finish"
c:identifier="gdk_pixbuf_animation_new_from_stream_finish"
version="2.28"
throws="1">
<doc xml:space="preserve">Finishes an asynchronous pixbuf animation creation operation started with
gdk_pixbuf_animation_new_from_stream_async().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GdkPixbufAnimation or %NULL on error. Free the returned
object with g_object_unref().</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</return-value>
<parameters>
<parameter name="async_result" transfer-ownership="none">
<doc xml:space="preserve">a #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</constructor>
<function name="new_from_stream_async"
c:identifier="gdk_pixbuf_animation_new_from_stream_async"
version="2.28">
<doc xml:space="preserve">Creates a new animation by asynchronously loading an image from an input stream.
For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the main thread.
You can then call gdk_pixbuf_animation_new_from_stream_finish() to get the
result of the operation.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GInputStream from which to load the animation</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">a #GAsyncReadyCallback to call when the pixbuf is loaded</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the data to pass to the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<method name="get_height" c:identifier="gdk_pixbuf_animation_get_height">
<doc xml:space="preserve">Queries the height of the bounding box of a pixbuf animation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Height of the bounding box of the animation.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">An animation.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_iter" c:identifier="gdk_pixbuf_animation_get_iter">
<doc xml:space="preserve">Get an iterator for displaying an animation. The iterator provides
the frames that should be displayed at a given time. It should be
freed after use with g_object_unref().
@start_time would normally come from g_get_current_time(), and marks
the beginning of animation playback. After creating an iterator, you
should immediately display the pixbuf returned by
gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install
a timeout (with g_timeout_add()) or by some other mechanism ensure
that you'll update the image after
gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time
the image is updated, you should reinstall the timeout with the new,
possibly-changed delay time.
As a shortcut, if @start_time is %NULL, the result of
g_get_current_time() will be used automatically.
To update the image (i.e. possibly change the result of
gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation),
call gdk_pixbuf_animation_iter_advance().
If you're using #GdkPixbufLoader, in addition to updating the image
after the delay time, you should also update it whenever you
receive the area_updated signal and
gdk_pixbuf_animation_iter_on_currently_loading_frame() returns
%TRUE. In this case, the frame currently being fed into the loader
has received new data, so needs to be refreshed. The delay time for
a frame may also be modified after an area_updated signal, for
example if the delay time for a frame is encoded in the data after
the frame itself. So your timeout should be reinstalled after any
area_updated signal.
A delay time of -1 is possible, indicating "infinite."</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">an iterator to move over the animation</doc>
<type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufAnimation</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
<parameter name="start_time"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">time when the animation starts playing</doc>
<type name="GLib.TimeVal" c:type="const GTimeVal*"/>
</parameter>
</parameters>
</method>
<method name="get_static_image"
c:identifier="gdk_pixbuf_animation_get_static_image">
<doc xml:space="preserve">If an animation is really just a plain image (has only one frame),
this function returns that image. If the animation is an animation,
this function returns a reasonable thing to display as a static
unanimated image, which might be the first frame, or something more
sophisticated. If an animation hasn't loaded any frames yet, this
function will return %NULL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">unanimated image representing the animation</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufAnimation</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_width" c:identifier="gdk_pixbuf_animation_get_width">
<doc xml:space="preserve">Queries the width of the bounding box of a pixbuf animation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Width of the bounding box of the animation.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">An animation.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_static_image"
c:identifier="gdk_pixbuf_animation_is_static_image">
<doc xml:space="preserve">If you load a file with gdk_pixbuf_animation_new_from_file() and it
turns out to be a plain, unanimated image, then this function will
return %TRUE. Use gdk_pixbuf_animation_get_static_image() to retrieve
the image.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the "animation" was really just an image</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufAnimation</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
</parameters>
</method>
<method name="ref"
c:identifier="gdk_pixbuf_animation_ref"
introspectable="0"
deprecated="1"
deprecated-version="2.0">
<doc xml:space="preserve">Adds a reference to an animation.</doc>
<doc-deprecated xml:space="preserve">Use g_object_ref().</doc-deprecated>
<return-value>
<doc xml:space="preserve">The same as the @animation argument.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">An animation.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
</parameters>
</method>
<method name="unref"
c:identifier="gdk_pixbuf_animation_unref"
introspectable="0"
deprecated="1"
deprecated-version="2.0">
<doc xml:space="preserve">Removes a reference from an animation.</doc>
<doc-deprecated xml:space="preserve">Use g_object_unref().</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">An animation.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</instance-parameter>
</parameters>
</method>
</class>
<class name="PixbufAnimationIter"
c:symbol-prefix="pixbuf_animation_iter"
c:type="GdkPixbufAnimationIter"
parent="GObject.Object"
glib:type-name="GdkPixbufAnimationIter"
glib:get-type="gdk_pixbuf_animation_iter_get_type">
<doc xml:space="preserve">An opaque struct representing an iterator which points to a
certain position in an animation.</doc>
<method name="advance" c:identifier="gdk_pixbuf_animation_iter_advance">
<doc xml:space="preserve">Possibly advances an animation to a new frame. Chooses the frame based
on the start time passed to gdk_pixbuf_animation_get_iter().
@current_time would normally come from g_get_current_time(), and
must be greater than or equal to the time passed to
gdk_pixbuf_animation_get_iter(), and must increase or remain
unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is
called. That is, you can't go backward in time; animations only
play forward.
As a shortcut, pass %NULL for the current time and g_get_current_time()
will be invoked on your behalf. So you only need to explicitly pass
@current_time if you're doing something odd like playing the animation
at double speed.
If this function returns %FALSE, there's no need to update the animation
display, assuming the display had been rendered prior to advancing;
if %TRUE, you need to call gdk_pixbuf_animation_iter_get_pixbuf()
and update the display with the new pixbuf.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the image may need updating</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufAnimationIter</doc>
<type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
</instance-parameter>
<parameter name="current_time"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">current time</doc>
<type name="GLib.TimeVal" c:type="const GTimeVal*"/>
</parameter>
</parameters>
</method>
<method name="get_delay_time"
c:identifier="gdk_pixbuf_animation_iter_get_delay_time">
<doc xml:space="preserve">Gets the number of milliseconds the current pixbuf should be displayed,
or -1 if the current pixbuf should be displayed forever. g_timeout_add()
conveniently takes a timeout in milliseconds, so you can use a timeout
to schedule the next update.
Note that some formats, like GIF, might clamp the timeout values in the
image file to avoid updates that are just too quick. The minimum timeout
for GIF images is currently 20 milliseconds.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">delay time in milliseconds (thousandths of a second)</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">an animation iterator</doc>
<type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixbuf"
c:identifier="gdk_pixbuf_animation_iter_get_pixbuf">
<doc xml:space="preserve">Gets the current pixbuf which should be displayed; the pixbuf might not
be the same size as the animation itself
(gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()).
This pixbuf should be displayed for
gdk_pixbuf_animation_iter_get_delay_time() milliseconds. The caller
of this function does not own a reference to the returned pixbuf;
the returned pixbuf will become invalid when the iterator advances
to the next frame, which may happen anytime you call
gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it
(don't just add a reference), as it may get recycled as you advance
the iterator.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the pixbuf to be displayed</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">an animation iterator</doc>
<type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
</instance-parameter>
</parameters>
</method>
<method name="on_currently_loading_frame"
c:identifier="gdk_pixbuf_animation_iter_on_currently_loading_frame">
<doc xml:space="preserve">Used to determine how to respond to the area_updated signal on
#GdkPixbufLoader when loading an animation. area_updated is emitted
for an area of the frame currently streaming in to the loader. So if
you're on the currently loading frame, you need to redraw the screen for
the updated area.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the frame we're on is partially loaded, or the last frame</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufAnimationIter</doc>
<type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
</instance-parameter>
</parameters>
</method>
</class>
<callback name="PixbufDestroyNotify" c:type="GdkPixbufDestroyNotify">
<doc xml:space="preserve">A function of this type is responsible for freeing the pixel array
of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
pass in a pre-allocated pixel array so that a pixbuf can be
created from it; in this case you will need to pass in a function
of #GdkPixbufDestroyNotify so that the pixel data can be freed
when the pixbuf is finalized.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="pixels" transfer-ownership="none">
<doc xml:space="preserve">The pixel array of the pixbuf
that is being finalized.</doc>
<array zero-terminated="0" c:type="guchar*">
<type name="guint8"/>
</array>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="1">
<doc xml:space="preserve">User closure data.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<enumeration name="PixbufError"
glib:type-name="GdkPixbufError"
glib:get-type="gdk_pixbuf_error_get_type"
c:type="GdkPixbufError"
glib:error-domain="gdk-pixbuf-error-quark">
<doc xml:space="preserve">An error code in the #GDK_PIXBUF_ERROR domain. Many gdk-pixbuf
operations can cause errors in this domain, or in the #G_FILE_ERROR
domain.</doc>
<member name="corrupt_image"
value="0"
c:identifier="GDK_PIXBUF_ERROR_CORRUPT_IMAGE"
glib:nick="corrupt-image">
<doc xml:space="preserve">An image file was broken somehow.</doc>
</member>
<member name="insufficient_memory"
value="1"
c:identifier="GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY"
glib:nick="insufficient-memory">
<doc xml:space="preserve">Not enough memory.</doc>
</member>
<member name="bad_option"
value="2"
c:identifier="GDK_PIXBUF_ERROR_BAD_OPTION"
glib:nick="bad-option">
<doc xml:space="preserve">A bad option was passed to a pixbuf save module.</doc>
</member>
<member name="unknown_type"
value="3"
c:identifier="GDK_PIXBUF_ERROR_UNKNOWN_TYPE"
glib:nick="unknown-type">
<doc xml:space="preserve">Unknown image type.</doc>
</member>
<member name="unsupported_operation"
value="4"
c:identifier="GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION"
glib:nick="unsupported-operation">
<doc xml:space="preserve">Don't know how to perform the
given operation on the type of image at hand.</doc>
</member>
<member name="failed"
value="5"
c:identifier="GDK_PIXBUF_ERROR_FAILED"
glib:nick="failed">
<doc xml:space="preserve">Generic failure code, something went wrong.</doc>
</member>
<member name="incomplete_animation"
value="6"
c:identifier="GDK_PIXBUF_ERROR_INCOMPLETE_ANIMATION"
glib:nick="incomplete-animation">
<doc xml:space="preserve">Only part of the animation was loaded.</doc>
</member>
<function name="quark" c:identifier="gdk_pixbuf_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<record name="PixbufFormat"
c:type="GdkPixbufFormat"
glib:type-name="GdkPixbufFormat"
glib:get-type="gdk_pixbuf_format_get_type"
c:symbol-prefix="pixbuf_format">
<method name="copy" c:identifier="gdk_pixbuf_format_copy" version="2.22">
<doc xml:space="preserve">Creates a copy of @format</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly allocated copy of a #GdkPixbufFormat. Use
gdk_pixbuf_format_free() to free the resources when done</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="const GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="gdk_pixbuf_format_free" version="2.22">
<doc xml:space="preserve">Frees the resources allocated when copying a #GdkPixbufFormat
using gdk_pixbuf_format_copy()</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="gdk_pixbuf_format_get_description"
version="2.2">
<doc xml:space="preserve">Returns a description of the format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a description of the format.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_extensions"
c:identifier="gdk_pixbuf_format_get_extensions"
version="2.2">
<doc xml:space="preserve">Returns the filename extensions typically used for files in the
given format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a %NULL-terminated array of filename extensions which must be
freed with g_strfreev() when it is no longer needed.</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_license"
c:identifier="gdk_pixbuf_format_get_license"
version="2.6">
<doc xml:space="preserve">Returns information about the license of the image loader for the format. The
returned string should be a shorthand for a wellknown license, e.g. "LGPL",
"GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. This
string should be freed with g_free() when it's no longer needed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a string describing the license of @format.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_mime_types"
c:identifier="gdk_pixbuf_format_get_mime_types"
version="2.2">
<doc xml:space="preserve">Returns the mime types supported by the format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a %NULL-terminated array of mime types which must be freed with
g_strfreev() when it is no longer needed.</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="gdk_pixbuf_format_get_name"
version="2.2">
<doc xml:space="preserve">Returns the name of the format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the name of the format.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_disabled"
c:identifier="gdk_pixbuf_format_is_disabled"
version="2.6">
<doc xml:space="preserve">Returns whether this image format is disabled. See
gdk_pixbuf_format_set_disabled().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether this image format is disabled.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_save_option_supported"
c:identifier="gdk_pixbuf_format_is_save_option_supported"
version="2.36">
<doc xml:space="preserve">Returns %TRUE if the save option specified by @option_key is supported when
saving a pixbuf using the module implementing @format.
See gdk_pixbuf_save() for more information about option keys.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the specified option is supported</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
<parameter name="option_key" transfer-ownership="none">
<doc xml:space="preserve">the name of an option</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="is_scalable"
c:identifier="gdk_pixbuf_format_is_scalable"
version="2.6">
<doc xml:space="preserve">Returns whether this image format is scalable. If a file is in a
scalable format, it is preferable to load it at the desired size,
rather than loading it at the default size and scaling the
resulting pixbuf to the desired size.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether this image format is scalable.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_writable"
c:identifier="gdk_pixbuf_format_is_writable"
version="2.2">
<doc xml:space="preserve">Returns whether pixbufs can be saved in the given format.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether pixbufs can be saved in the given format.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_disabled"
c:identifier="gdk_pixbuf_format_set_disabled"
version="2.6">
<doc xml:space="preserve">Disables or enables an image format. If a format is disabled,
gdk-pixbuf won't use the image loader for this format to load
images. Applications can use this to avoid using image loaders
with an inappropriate license, see gdk_pixbuf_format_get_license().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufFormat</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</instance-parameter>
<parameter name="disabled" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to disable the format @format</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
</record>
<class name="PixbufLoader"
c:symbol-prefix="pixbuf_loader"
c:type="GdkPixbufLoader"
parent="GObject.Object"
glib:type-name="GdkPixbufLoader"
glib:get-type="gdk_pixbuf_loader_get_type"
glib:type-struct="PixbufLoaderClass">
<doc xml:space="preserve">The GdkPixbufLoader struct contains only private
fields.</doc>
<constructor name="new" c:identifier="gdk_pixbuf_loader_new">
<doc xml:space="preserve">Creates a new pixbuf loader object.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</return-value>
</constructor>
<constructor name="new_with_mime_type"
c:identifier="gdk_pixbuf_loader_new_with_mime_type"
version="2.4"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf loader object that always attempts to parse
image data as if it were an image of mime type @mime_type, instead of
identifying the type automatically. Useful if you want an error if
the image isn't the expected mime type, for loading image formats
that can't be reliably identified by looking at the data, or if
the user manually forces a specific mime type.
The list of supported mime types depends on what image loaders
are installed, but typically "image/png", "image/jpeg", "image/gif",
"image/tiff" and "image/x-xpixmap" are among the supported mime types.
To obtain the full list of supported mime types, call
gdk_pixbuf_format_get_mime_types() on each of the #GdkPixbufFormat
structs returned by gdk_pixbuf_get_formats().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</return-value>
<parameters>
<parameter name="mime_type" transfer-ownership="none">
<doc xml:space="preserve">the mime type to be loaded</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_with_type"
c:identifier="gdk_pixbuf_loader_new_with_type"
throws="1">
<doc xml:space="preserve">Creates a new pixbuf loader object that always attempts to parse
image data as if it were an image of type @image_type, instead of
identifying the type automatically. Useful if you want an error if
the image isn't the expected type, for loading image formats
that can't be reliably identified by looking at the data, or if
the user manually forces a specific type.
The list of supported image formats depends on what image loaders
are installed, but typically "png", "jpeg", "gif", "tiff" and
"xpm" are among the supported formats. To obtain the full list of
supported image formats, call gdk_pixbuf_format_get_name() on each
of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-created pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</return-value>
<parameters>
<parameter name="image_type" transfer-ownership="none">
<doc xml:space="preserve">name of the image format to be loaded with the image</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="area_prepared">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="area_updated">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<type name="gint" c:type="int"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<type name="gint" c:type="int"/>
</parameter>
<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>
</virtual-method>
<virtual-method name="closed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="size_prepared">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
<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>
</virtual-method>
<method name="close" c:identifier="gdk_pixbuf_loader_close" throws="1">
<doc xml:space="preserve">Informs a pixbuf loader that no further writes with
gdk_pixbuf_loader_write() will occur, so that it can free its
internal loading structures. Also, tries to parse any data that
hasn't yet been parsed; if the remaining data is partial or
corrupt, an error will be returned. If %FALSE is returned, @error
will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR
domains. If you're just cancelling a load rather than expecting it
to be finished, passing %NULL for @error to ignore it is
reasonable.
Remember that this does not unref the loader, so if you plan not to
use it anymore, please g_object_unref() it.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if all image data written so far was successfully
passed out via the update_area signal</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_animation"
c:identifier="gdk_pixbuf_loader_get_animation">
<doc xml:space="preserve">Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.
In general it only makes sense to call this function after the "area-prepared"
signal has been emitted by the loader. If the loader doesn't have enough
bytes yet (hasn't emitted the "area-prepared" signal) this function will
return %NULL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GdkPixbufAnimation that the loader is loading, or %NULL if
not enough data has been read to determine the information.</doc>
<type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_format"
c:identifier="gdk_pixbuf_loader_get_format"
version="2.2">
<doc xml:space="preserve">Obtains the available information about the format of the
currently loading image file.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">A #GdkPixbufFormat or
%NULL. The return value is owned by GdkPixbuf and should not be
freed.</doc>
<type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixbuf" c:identifier="gdk_pixbuf_loader_get_pixbuf">
<doc xml:space="preserve">Queries the #GdkPixbuf that a pixbuf loader is currently creating.
In general it only makes sense to call this function after the
"area-prepared" signal has been emitted by the loader; this means
that enough data has been read to know the size of the image that
will be allocated. If the loader has not received enough data via
gdk_pixbuf_loader_write(), then this function returns %NULL. The
returned pixbuf will be the same in all future calls to the loader,
so simply calling g_object_ref() should be sufficient to continue
using it. Additionally, if the loader is an animation, it will
return the "static image" of the animation
(see gdk_pixbuf_animation_get_static_image()).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GdkPixbuf that the loader is creating, or %NULL if not
enough data has been read to determine how to create the image buffer.</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_size"
c:identifier="gdk_pixbuf_loader_set_size"
version="2.2">
<doc xml:space="preserve">Causes the image to be scaled while it is loaded. The desired
image size can be determined relative to the original size of
the image by calling gdk_pixbuf_loader_set_size() from a
signal handler for the ::size-prepared signal.
Attempts to set the desired image size are ignored after the
emission of the ::size-prepared signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The desired width of the image being loaded.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The desired height of the image being loaded.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="write" c:identifier="gdk_pixbuf_loader_write" throws="1">
<doc xml:space="preserve">This will cause a pixbuf loader to parse the next @count bytes of
an image. It will return %TRUE if the data was loaded successfully,
and %FALSE if an error occurred. In the latter case, the loader
will be closed, and will not accept further writes. If %FALSE is
returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
or #G_FILE_ERROR domains.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the write was successful, or %FALSE if the loader
cannot parse the buffer.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">Pointer to image data.</doc>
<array length="1" zero-terminated="0" c:type="guchar*">
<type name="guint8" c:type="guchar"/>
</array>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">Length of the @buf buffer in bytes.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="write_bytes"
c:identifier="gdk_pixbuf_loader_write_bytes"
version="2.30"
throws="1">
<doc xml:space="preserve">This will cause a pixbuf loader to parse a buffer inside a #GBytes
for an image. It will return %TRUE if the data was loaded successfully,
and %FALSE if an error occurred. In the latter case, the loader
will be closed, and will not accept further writes. If %FALSE is
returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
or #G_FILE_ERROR domains.
See also: gdk_pixbuf_loader_write()</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the write was successful, or %FALSE if the loader
cannot parse the buffer.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve">A pixbuf loader.</doc>
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">The image data as a #GBytes</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</method>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<glib:signal name="area-prepared" when="last">
<doc xml:space="preserve">This signal is emitted when the pixbuf loader has allocated the
pixbuf in the desired size. After this signal is emitted,
applications can call gdk_pixbuf_loader_get_pixbuf() to fetch
the partially-loaded pixbuf.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="area-updated" when="last">
<doc xml:space="preserve">This signal is emitted when a significant area of the image being
loaded has been updated. Normally it means that a complete
scanline has been read in, but it could be a different area as
well. Applications can use this signal to know when to repaint
areas of an image that is being loaded.</doc>
<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 upper-left corner of the updated area.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Y offset of upper-left corner of the updated area.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Width of updated area.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Height of updated area.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="closed" when="last">
<doc xml:space="preserve">This signal is emitted when gdk_pixbuf_loader_close() is called.
It can be used by different parts of an application to receive
notification when an image loader is closed by the code that
drives it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="size-prepared" when="last">
<doc xml:space="preserve">This signal is emitted when the pixbuf loader has been fed the
initial amount of data that is required to figure out the size
of the image that it will create. Applications can call
gdk_pixbuf_loader_set_size() in response to this signal to set
the desired size to which the image should be scaled.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the original width of the image</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the original height of the image</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="PixbufLoaderClass"
c:type="GdkPixbufLoaderClass"
glib:is-gtype-struct-for="PixbufLoader">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="size_prepared">
<callback name="size_prepared">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</parameter>
<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>
</callback>
</field>
<field name="area_prepared">
<callback name="area_prepared">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="area_updated">
<callback name="area_updated">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<type name="gint" c:type="int"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<type name="gint" c:type="int"/>
</parameter>
<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>
</callback>
</field>
<field name="closed">
<callback name="closed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="loader" transfer-ownership="none">
<type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<enumeration name="PixbufRotation"
glib:type-name="GdkPixbufRotation"
glib:get-type="gdk_pixbuf_rotation_get_type"
c:type="GdkPixbufRotation">
<doc xml:space="preserve">The possible rotations which can be passed to gdk_pixbuf_rotate_simple().
To make them easier to use, their numerical values are the actual degrees.</doc>
<member name="none"
value="0"
c:identifier="GDK_PIXBUF_ROTATE_NONE"
glib:nick="none">
<doc xml:space="preserve">No rotation.</doc>
</member>
<member name="counterclockwise"
value="90"
c:identifier="GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE"
glib:nick="counterclockwise">
<doc xml:space="preserve">Rotate by 90 degrees.</doc>
</member>
<member name="upsidedown"
value="180"
c:identifier="GDK_PIXBUF_ROTATE_UPSIDEDOWN"
glib:nick="upsidedown">
<doc xml:space="preserve">Rotate by 180 degrees.</doc>
</member>
<member name="clockwise"
value="270"
c:identifier="GDK_PIXBUF_ROTATE_CLOCKWISE"
glib:nick="clockwise">
<doc xml:space="preserve">Rotate by 270 degrees.</doc>
</member>
</enumeration>
<callback name="PixbufSaveFunc" c:type="GdkPixbufSaveFunc" version="2.4">
<doc xml:space="preserve">Specifies the type of the function passed to
gdk_pixbuf_save_to_callback(). It is called once for each block of
bytes that is "written" by gdk_pixbuf_save_to_callback(). If
successful it should return %TRUE. If an error occurs it should set
@error and return %FALSE, in which case gdk_pixbuf_save_to_callback()
will fail with the same error.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if successful, %FALSE (with @error set) if failed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">bytes to be written.</doc>
<array length="1" zero-terminated="0" c:type="gchar*">
<type name="guint8"/>
</array>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve">number of bytes in @buf.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="error"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">A location to return an error.</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="3">
<doc xml:space="preserve">user data passed to gdk_pixbuf_save_to_callback().</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="PixbufSimpleAnim"
c:symbol-prefix="pixbuf_simple_anim"
c:type="GdkPixbufSimpleAnim"
parent="PixbufAnimation"
glib:type-name="GdkPixbufSimpleAnim"
glib:get-type="gdk_pixbuf_simple_anim_get_type"
glib:type-struct="PixbufSimpleAnimClass">
<doc xml:space="preserve">An opaque struct representing a simple animation.</doc>
<constructor name="new"
c:identifier="gdk_pixbuf_simple_anim_new"
version="2.8">
<doc xml:space="preserve">Creates a new, empty animation.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly allocated #GdkPixbufSimpleAnim</doc>
<type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
</return-value>
<parameters>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the width of the animation</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the height of the animation</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="rate" transfer-ownership="none">
<doc xml:space="preserve">the speed of the animation, in frames per second</doc>
<type name="gfloat" c:type="gfloat"/>
</parameter>
</parameters>
</constructor>
<method name="add_frame"
c:identifier="gdk_pixbuf_simple_anim_add_frame"
version="2.8">
<doc xml:space="preserve">Adds a new frame to @animation. The @pixbuf must
have the dimensions specified when the animation
was constructed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufSimpleAnim</doc>
<type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
</instance-parameter>
<parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">the pixbuf to add</doc>
<type name="Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
</parameters>
</method>
<method name="get_loop"
c:identifier="gdk_pixbuf_simple_anim_get_loop"
version="2.18">
<doc xml:space="preserve">Gets whether @animation should loop indefinitely when it reaches the end.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the animation loops forever, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufSimpleAnim</doc>
<type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_loop"
c:identifier="gdk_pixbuf_simple_anim_set_loop"
version="2.18">
<doc xml:space="preserve">Sets whether @animation should loop indefinitely when it reaches the end.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="animation" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixbufSimpleAnim</doc>
<type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
</instance-parameter>
<parameter name="loop" transfer-ownership="none">
<doc xml:space="preserve">whether to loop the animation</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<property name="loop"
version="2.18"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Whether the animation should loop when it reaches the end.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
</class>
<record name="PixbufSimpleAnimClass"
c:type="GdkPixbufSimpleAnimClass"
disguised="1"
glib:is-gtype-struct-for="PixbufSimpleAnim">
</record>
<class name="PixbufSimpleAnimIter"
c:symbol-prefix="pixbuf_simple_anim_iter"
parent="PixbufAnimationIter"
glib:type-name="GdkPixbufSimpleAnimIter"
glib:get-type="gdk_pixbuf_simple_anim_iter_get_type">
</class>
<record name="Pixdata" c:type="GdkPixdata">
<doc xml:space="preserve">A #GdkPixdata contains pixbuf information in a form suitable for
serialization and streaming.</doc>
<field name="magic" writable="1">
<doc xml:space="preserve">magic number. A valid #GdkPixdata structure must have
#GDK_PIXBUF_MAGIC_NUMBER here.</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="length" writable="1">
<doc xml:space="preserve">less than 1 to disable length checks, otherwise
#GDK_PIXDATA_HEADER_LENGTH + length of @pixel_data.</doc>
<type name="gint32" c:type="gint32"/>
</field>
<field name="pixdata_type" writable="1">
<doc xml:space="preserve">information about colorspace, sample width and
encoding, in a #GdkPixdataType.</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="rowstride" writable="1">
<doc xml:space="preserve">Distance in bytes between rows.</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="width" writable="1">
<doc xml:space="preserve">Width of the image in pixels.</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="height" writable="1">
<doc xml:space="preserve">Height of the image in pixels.</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="pixel_data" writable="1">
<doc xml:space="preserve">@width x @height pixels, encoded according to @pixdata_type
and @rowstride.</doc>
<array zero-terminated="0" c:type="guint8*">
<type name="guint8"/>
</array>
</field>
<method name="deserialize"
c:identifier="gdk_pixdata_deserialize"
deprecated="1"
deprecated-version="2.32"
throws="1">
<doc xml:space="preserve">Deserializes (reconstruct) a #GdkPixdata structure from a byte stream.
The byte stream consists of a straightforward writeout of the
#GdkPixdata fields in network byte order, plus the @pixel_data
bytes the structure points to.
The @pixdata contents are reconstructed byte by byte and are checked
for validity. This function may fail with %GDK_PIXBUF_ERROR_CORRUPT_IMAGE
or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE.</doc>
<doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Upon successful deserialization %TRUE is returned,
%FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pixdata" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixdata structure to be filled in.</doc>
<type name="Pixdata" c:type="GdkPixdata*"/>
</instance-parameter>
<parameter name="stream_length" transfer-ownership="none">
<doc xml:space="preserve">length of the stream used for deserialization.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">stream of bytes containing a
serialized #GdkPixdata structure.</doc>
<array length="0" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
</parameters>
</method>
<method name="from_pixbuf"
c:identifier="gdk_pixdata_from_pixbuf"
introspectable="0"
deprecated="1"
deprecated-version="2.32">
<doc xml:space="preserve">Converts a #GdkPixbuf to a #GdkPixdata. If @use_rle is %TRUE, the
pixel data is run-length encoded into newly-allocated memory and a
pointer to that memory is returned.</doc>
<doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">If @use_rle is %TRUE, a pointer to the
newly-allocated memory for the run-length encoded pixel data,
otherwise %NULL.</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="pixdata" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixdata to fill.</doc>
<type name="Pixdata" c:type="GdkPixdata*"/>
</instance-parameter>
<parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve">the data to fill @pixdata with.</doc>
<type name="Pixbuf" c:type="const GdkPixbuf*"/>
</parameter>
<parameter name="use_rle" transfer-ownership="none">
<doc xml:space="preserve">whether to use run-length encoding for the pixel data.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="serialize"
c:identifier="gdk_pixdata_serialize"
deprecated="1"
deprecated-version="2.32">
<doc xml:space="preserve">Serializes a #GdkPixdata structure into a byte stream.
The byte stream consists of a straightforward writeout of the
#GdkPixdata fields in network byte order, plus the @pixel_data
bytes the structure points to.</doc>
<doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A
newly-allocated string containing the serialized #GdkPixdata
structure.</doc>
<array length="0" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="pixdata" transfer-ownership="none">
<doc xml:space="preserve">a valid #GdkPixdata structure to serialize.</doc>
<type name="Pixdata" c:type="const GdkPixdata*"/>
</instance-parameter>
<parameter name="stream_length_p"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">location to store the resulting stream length in.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</method>
<method name="to_csource"
c:identifier="gdk_pixdata_to_csource"
deprecated="1"
deprecated-version="2.32">
<doc xml:space="preserve">Generates C source code suitable for compiling images directly
into programs.
gdk-pixbuf ships with a program called
[gdk-pixbuf-csource][gdk-pixbuf-csource], which offers a command
line interface to this function.</doc>
<doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly-allocated string containing the C source form
of @pixdata.</doc>
<type name="GLib.String" c:type="GString*"/>
</return-value>
<parameters>
<instance-parameter name="pixdata" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixdata to convert to C source.</doc>
<type name="Pixdata" c:type="GdkPixdata*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">used for naming generated data structures or macros.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="dump_type" transfer-ownership="none">
<doc xml:space="preserve">a #GdkPixdataDumpType determining the kind of C
source to be generated.</doc>
<type name="PixdataDumpType" c:type="GdkPixdataDumpType"/>
</parameter>
</parameters>
</method>
</record>
<bitfield name="PixdataDumpType" c:type="GdkPixdataDumpType">
<doc xml:space="preserve">An enumeration which is used by gdk_pixdata_to_csource() to
determine the form of C source to be generated. The three values
@GDK_PIXDATA_DUMP_PIXDATA_STREAM, @GDK_PIXDATA_DUMP_PIXDATA_STRUCT
and @GDK_PIXDATA_DUMP_MACROS are mutually exclusive, as are
@GDK_PIXBUF_DUMP_GTYPES and @GDK_PIXBUF_DUMP_CTYPES. The remaining
elements are optional flags that can be freely added.</doc>
<member name="pixdata_stream"
value="0"
c:identifier="GDK_PIXDATA_DUMP_PIXDATA_STREAM">
<doc xml:space="preserve">Generate pixbuf data stream (a single
string containing a serialized #GdkPixdata structure in network byte
order).</doc>
</member>
<member name="pixdata_struct"
value="1"
c:identifier="GDK_PIXDATA_DUMP_PIXDATA_STRUCT">
<doc xml:space="preserve">Generate #GdkPixdata structure (needs
the #GdkPixdata structure definition from gdk-pixdata.h).</doc>
</member>
<member name="macros" value="2" c:identifier="GDK_PIXDATA_DUMP_MACROS">
<doc xml:space="preserve">Generate <function>*_ROWSTRIDE</function>,
<function>*_WIDTH</function>, <function>*_HEIGHT</function>,
<function>*_BYTES_PER_PIXEL</function> and
<function>*_RLE_PIXEL_DATA</function> or <function>*_PIXEL_DATA</function>
macro definitions for the image.</doc>
</member>
<member name="gtypes" value="0" c:identifier="GDK_PIXDATA_DUMP_GTYPES">
<doc xml:space="preserve">Generate GLib data types instead of
standard C data types.</doc>
</member>
<member name="ctypes" value="256" c:identifier="GDK_PIXDATA_DUMP_CTYPES">
<doc xml:space="preserve">Generate standard C data types instead of
GLib data types.</doc>
</member>
<member name="static" value="512" c:identifier="GDK_PIXDATA_DUMP_STATIC">
<doc xml:space="preserve">Generate static symbols.</doc>
</member>
<member name="const" value="1024" c:identifier="GDK_PIXDATA_DUMP_CONST">
<doc xml:space="preserve">Generate const symbols.</doc>
</member>
<member name="rle_decoder"
value="65536"
c:identifier="GDK_PIXDATA_DUMP_RLE_DECODER">
<doc xml:space="preserve">Provide a <function>*_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp)</function>
macro definition to decode run-length encoded image data.</doc>
</member>
</bitfield>
<bitfield name="PixdataType" c:type="GdkPixdataType">
<doc xml:space="preserve">An enumeration containing three sets of flags for a #GdkPixdata struct:
one for the used colorspace, one for the width of the samples and one
for the encoding of the pixel data.</doc>
<member name="color_type_rgb"
value="1"
c:identifier="GDK_PIXDATA_COLOR_TYPE_RGB">
<doc xml:space="preserve">each pixel has red, green and blue samples.</doc>
</member>
<member name="color_type_rgba"
value="2"
c:identifier="GDK_PIXDATA_COLOR_TYPE_RGBA">
<doc xml:space="preserve">each pixel has red, green and blue samples
and an alpha value.</doc>
</member>
<member name="color_type_mask"
value="255"
c:identifier="GDK_PIXDATA_COLOR_TYPE_MASK">
<doc xml:space="preserve">mask for the colortype flags of the enum.</doc>
</member>
<member name="sample_width_8"
value="65536"
c:identifier="GDK_PIXDATA_SAMPLE_WIDTH_8">
<doc xml:space="preserve">each sample has 8 bits.</doc>
</member>
<member name="sample_width_mask"
value="983040"
c:identifier="GDK_PIXDATA_SAMPLE_WIDTH_MASK">
<doc xml:space="preserve">mask for the sample width flags of the enum.</doc>
</member>
<member name="encoding_raw"
value="16777216"
c:identifier="GDK_PIXDATA_ENCODING_RAW">
<doc xml:space="preserve">the pixel data is in raw form.</doc>
</member>
<member name="encoding_rle"
value="33554432"
c:identifier="GDK_PIXDATA_ENCODING_RLE">
<doc xml:space="preserve">the pixel data is run-length encoded. Runs may
be up to 127 bytes long; their length is stored in a single byte
preceding the pixel data for the run. If a run is constant, its length
byte has the high bit set and the pixel data consists of a single pixel
which must be repeated.</doc>
</member>
<member name="encoding_mask"
value="251658240"
c:identifier="GDK_PIXDATA_ENCODING_MASK">
<doc xml:space="preserve">mask for the encoding flags of the enum.</doc>
</member>
</bitfield>
<function name="pixbuf_error_quark"
c:identifier="gdk_pixbuf_error_quark"
moved-to="PixbufError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</namespace>
</repository>
|