/usr/share/gtk-doc/html/libvips/VipsForeignSave.html is in libvips-doc 8.4.5-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VipsForeignSave: VIPS Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="VIPS Reference Manual">
<link rel="up" href="ch03.html" title="VIPS operation API by section">
<link rel="prev" href="libvips-convolution.html" title="convolution">
<link rel="next" href="libvips-freqfilt.html" title="freqfilt">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#VipsForeignSave.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#VipsForeignSave.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#VipsForeignSave.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libvips-convolution.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libvips-freqfilt.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="VipsForeignSave"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="VipsForeignSave.top_of_page"></a>VipsForeignSave</span></h2>
<p>VipsForeignSave — load and save images in a variety of formats</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="VipsForeignSave.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="VipsForeignSave.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span> *
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-map" title="vips_foreign_map ()">vips_foreign_map</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-find-load" title="vips_foreign_find_load ()">vips_foreign_find_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-find-load-buffer" title="vips_foreign_find_load_buffer ()">vips_foreign_find_load_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsForeignSave.html#VipsForeignFlags" title="enum VipsForeignFlags"><span class="returnvalue">VipsForeignFlags</span></a>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-flags" title="vips_foreign_flags ()">vips_foreign_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-is-a" title="vips_foreign_is_a ()">vips_foreign_is_a</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-is-a-buffer" title="vips_foreign_is_a_buffer ()">vips_foreign_is_a_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-find-save" title="vips_foreign_find_save ()">vips_foreign_find_save</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-foreign-find-save-buffer" title="vips_foreign_find_save_buffer ()">vips_foreign_find_save_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-vipsload" title="vips_vipsload ()">vips_vipsload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-vipssave" title="vips_vipssave ()">vips_vipssave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-openslideload" title="vips_openslideload ()">vips_openslideload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-jpegload" title="vips_jpegload ()">vips_jpegload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-jpegload-buffer" title="vips_jpegload_buffer ()">vips_jpegload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-jpegsave" title="vips_jpegsave ()">vips_jpegsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-jpegsave-buffer" title="vips_jpegsave_buffer ()">vips_jpegsave_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-jpegsave-mime" title="vips_jpegsave_mime ()">vips_jpegsave_mime</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-webpload" title="vips_webpload ()">vips_webpload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-webpload-buffer" title="vips_webpload_buffer ()">vips_webpload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-webpsave" title="vips_webpsave ()">vips_webpsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-webpsave-buffer" title="vips_webpsave_buffer ()">vips_webpsave_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-webpsave-mime" title="vips_webpsave_mime ()">vips_webpsave_mime</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-tiffload" title="vips_tiffload ()">vips_tiffload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-tiffload-buffer" title="vips_tiffload_buffer ()">vips_tiffload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-tiffsave" title="vips_tiffsave ()">vips_tiffsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-openexrload" title="vips_openexrload ()">vips_openexrload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-fitsload" title="vips_fitsload ()">vips_fitsload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-fitssave" title="vips_fitssave ()">vips_fitssave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-analyzeload" title="vips_analyzeload ()">vips_analyzeload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-rawload" title="vips_rawload ()">vips_rawload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-rawsave" title="vips_rawsave ()">vips_rawsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-rawsave-fd" title="vips_rawsave_fd ()">vips_rawsave_fd</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-csvload" title="vips_csvload ()">vips_csvload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-csvsave" title="vips_csvsave ()">vips_csvsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-matrixload" title="vips_matrixload ()">vips_matrixload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-matrixsave" title="vips_matrixsave ()">vips_matrixsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-matrixprint" title="vips_matrixprint ()">vips_matrixprint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-magickload" title="vips_magickload ()">vips_magickload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-magickload-buffer" title="vips_magickload_buffer ()">vips_magickload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-pngload" title="vips_pngload ()">vips_pngload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-pngload-buffer" title="vips_pngload_buffer ()">vips_pngload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-pngsave" title="vips_pngsave ()">vips_pngsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-pngsave-buffer" title="vips_pngsave_buffer ()">vips_pngsave_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-ppmload" title="vips_ppmload ()">vips_ppmload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-ppmsave" title="vips_ppmsave ()">vips_ppmsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-matload" title="vips_matload ()">vips_matload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-radload" title="vips_radload ()">vips_radload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-radsave" title="vips_radsave ()">vips_radsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-radsave-buffer" title="vips_radsave_buffer ()">vips_radsave_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-pdfload" title="vips_pdfload ()">vips_pdfload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-pdfload-buffer" title="vips_pdfload_buffer ()">vips_pdfload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-svgload" title="vips_svgload ()">vips_svgload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-svgload-buffer" title="vips_svgload_buffer ()">vips_svgload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-gifload" title="vips_gifload ()">vips_gifload</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-gifload-buffer" title="vips_gifload_buffer ()">vips_gifload_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="VipsForeignSave.html#vips-dzsave" title="vips_dzsave ()">vips_dzsave</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="VipsForeignSave.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a class="link" href="VipsImage.html#VipsAccess" title="enum VipsAccess"><span class="type">VipsAccess</span></a></td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignLoad--access" title="The “access” property">access</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignLoad--disc" title="The “disc” property">disc</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="VipsForeignSave.html#VipsForeignFlags" title="enum VipsForeignFlags"><span class="type">VipsForeignFlags</span></a></td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignLoad--flags" title="The “flags” property">flags</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *</td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignLoad--out" title="The “out” property">out</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignLoad--sequential" title="The “sequential” property">sequential</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="libvips-type.html#VipsArrayDouble"><span class="type">VipsArrayDouble</span></a> *</td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignSave--background" title="The “background” property">background</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *</td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignSave--in" title="The “in” property">in</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="VipsForeignSave.html#VipsForeignSave--strip" title="The “strip” property">strip</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="VipsForeign"></a><a name="VipsForeignLoad"></a><div class="refsect1">
<a name="VipsForeignSave.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignFlags" title="enum VipsForeignFlags">VipsForeignFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsSaveable" title="enum VipsSaveable">VipsSaveable</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignWebpPreset" title="enum VipsForeignWebpPreset">VipsForeignWebpPreset</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignTiffCompression" title="enum VipsForeignTiffCompression">VipsForeignTiffCompression</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignTiffPredictor" title="enum VipsForeignTiffPredictor">VipsForeignTiffPredictor</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignTiffResunit" title="enum VipsForeignTiffResunit">VipsForeignTiffResunit</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignPngFilter" title="enum VipsForeignPngFilter">VipsForeignPngFilter</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignDzLayout" title="enum VipsForeignDzLayout">VipsForeignDzLayout</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignDzDepth" title="enum VipsForeignDzDepth">VipsForeignDzDepth</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsForeignSave.html#VipsForeignDzContainer" title="enum VipsForeignDzContainer">VipsForeignDzContainer</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="VipsForeignSave.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="VipsObject.html" title="VipsObject">VipsObject</a>
<span class="lineart">╰──</span> <a class="link" href="VipsOperation.html" title="VipsOperation">VipsOperation</a>
<span class="lineart">╰──</span> VipsForeign
<span class="lineart">├──</span> VipsForeignLoad
<span class="lineart">╰──</span> VipsForeignSave
</pre>
</div>
<div class="refsect1">
<a name="VipsForeignSave.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <vips/vips.h>
</pre>
</div>
<div class="refsect1">
<a name="VipsForeignSave.description"></a><h2>Description</h2>
<p>This set of operations load and save images in a variety of formats. </p>
<p>The operations share a base class that offers a simple way to search for a
subclass of <a class="link" href="VipsForeignSave.html#VipsForeign"><span class="type">VipsForeign</span></a> which can load a certain file (see
<a class="link" href="VipsForeignSave.html#vips-foreign-find-load" title="vips_foreign_find_load ()"><code class="function">vips_foreign_find_load()</code></a>) or buffer (see <a class="link" href="VipsForeignSave.html#vips-foreign-find-load-buffer" title="vips_foreign_find_load_buffer ()"><code class="function">vips_foreign_find_load_buffer()</code></a>),
or which could be used to save an image to a
certain file type (see <a class="link" href="VipsForeignSave.html#vips-foreign-find-save" title="vips_foreign_find_save ()"><code class="function">vips_foreign_find_save()</code></a> and
<a class="link" href="VipsForeignSave.html#vips-foreign-find-save-buffer" title="vips_foreign_find_save_buffer ()"><code class="function">vips_foreign_find_save_buffer()</code></a>). You can then run these
operations using <a class="link" href="VipsOperation.html#vips-call" title="vips_call ()"><code class="function">vips_call()</code></a> and friends to perform the load or save.</p>
<p>vips_image_write_to_file() and <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a> and friends use
these functions to automate file load and save. </p>
<p>You can also invoke the operations directly, for example:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="VipsForeignSave.html#vips-tiffsave">vips_tiffsave</a></span> <span class="gtkdoc opt">(</span>my_image<span class="gtkdoc opt">,</span> <span class="string">"frank.anything"</span><span class="gtkdoc opt">,</span>
<span class="string">"compression"</span><span class="gtkdoc opt">,</span> VIPS_FOREIGN_TIFF_COMPRESSION_JPEG<span class="gtkdoc opt">,</span>
NULL<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>To add support for a new file format to vips, simply define a new subclass
of <a class="link" href="VipsForeignSave.html#VipsForeignLoad"><span class="type">VipsForeignLoad</span></a> or <a class="link" href="VipsForeignSave.html" title="VipsForeignSave"><span class="type">VipsForeignSave</span></a>. </p>
<p>If you define a new operation which is a subclass of <a class="link" href="VipsForeignSave.html#VipsForeign"><span class="type">VipsForeign</span></a>, support
for it automatically appears in all VIPS user-interfaces. It will also be
transparently supported by <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a> and friends.</p>
<p>VIPS comes with VipsForeign for TIFF, JPEG, PNG, Analyze, PPM, OpenEXR, CSV,
Matlab, Radiance, RAW, FITS, WebP, SVG, PDF, GIF and VIPS. It also includes
import filters which can load with libMagick and with OpenSlide. </p>
<div class="refsect3">
<a name="id-1.4.6.11.11"></a><h4>Writing a new loader</h4>
<p>Add a new loader to VIPS by subclassing <a class="link" href="VipsForeignSave.html#VipsForeignLoad"><span class="type">VipsForeignLoad</span></a>. Subclasses need to
implement at least <em class="parameter"><code><code class="function">header()</code></code></em>
.</p>
<p><em class="parameter"><code><code class="function">header()</code></code></em>
must set at least the header fields of <em class="parameter"><code>out</code></em>
. <em class="parameter"><code><code class="function">load()</code></code></em>
, if defined,
must load the pixels to <em class="parameter"><code>real</code></em>
.</p>
<p>The suffix list is used to select a format to save a file in, and to pick a
loader if you don't define <code class="function">is_a()</code>.</p>
<p>You should also define <em class="parameter"><code>nickname</code></em>
and <em class="parameter"><code>description</code></em>
in <a class="link" href="VipsObject.html" title="VipsObject"><span class="type">VipsObject</span></a>. </p>
<p>As a complete example, here's code for a PNG loader, minus the actual
calls to libpng.</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwc">typedef</span> <span class="gtkdoc kwb">struct</span> _VipsForeignLoadPng <span class="gtkdoc opt">{</span>
VipsForeignLoad parent_object<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">char</span> <span class="gtkdoc opt">*</span>filename<span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span> VipsForeignLoadPng<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwc">typedef</span> VipsForeignLoadClass VipsForeignLoadPngClass<span class="gtkdoc opt">;</span>
<span class="function">G_DEFINE_TYPE</span><span class="gtkdoc opt">(</span> VipsForeignLoadPng<span class="gtkdoc opt">,</span> vips_foreign_load_png<span class="gtkdoc opt">,</span>
VIPS_TYPE_FOREIGN_LOAD <span class="gtkdoc opt">);</span>
<span class="gtkdoc kwb">static</span> VipsForeignFlags
<span class="function">vips_foreign_load_png_get_flags_filename</span><span class="gtkdoc opt">(</span> <span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>filename <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
VipsForeignFlags flags<span class="gtkdoc opt">;</span>
flags <span class="gtkdoc opt">=</span> <span class="number">0</span><span class="gtkdoc opt">;</span>
<span class="keyword">if</span><span class="gtkdoc opt">(</span> <span class="function">vips__png_isinterlaced</span><span class="gtkdoc opt">(</span> filename <span class="gtkdoc opt">) )</span>
flags <span class="gtkdoc opt">=</span> VIPS_FOREIGN_PARTIAL<span class="gtkdoc opt">;</span>
<span class="keyword">else</span>
flags <span class="gtkdoc opt">=</span> VIPS_FOREIGN_SEQUENTIAL<span class="gtkdoc opt">;</span>
<span class="keyword">return</span><span class="gtkdoc opt">(</span> flags <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static</span> VipsForeignFlags
<span class="function">vips_foreign_load_png_get_flags</span><span class="gtkdoc opt">(</span> VipsForeignLoad <span class="gtkdoc opt">*</span>load <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
VipsForeignLoadPng <span class="gtkdoc opt">*</span>png <span class="gtkdoc opt">= (</span>VipsForeignLoadPng <span class="gtkdoc opt">*)</span> load<span class="gtkdoc opt">;</span>
<span class="keyword">return</span><span class="gtkdoc opt">(</span> <span class="function">vips_foreign_load_png_get_flags_filename</span><span class="gtkdoc opt">(</span> png<span class="gtkdoc opt">-></span>filename <span class="gtkdoc opt">) );</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static int</span>
<span class="function">vips_foreign_load_png_header</span><span class="gtkdoc opt">(</span> VipsForeignLoad <span class="gtkdoc opt">*</span>load <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
VipsForeignLoadPng <span class="gtkdoc opt">*</span>png <span class="gtkdoc opt">= (</span>VipsForeignLoadPng <span class="gtkdoc opt">*)</span> load<span class="gtkdoc opt">;</span>
<span class="keyword">if</span><span class="gtkdoc opt">(</span> <span class="function">vips__png_header</span><span class="gtkdoc opt">(</span> png<span class="gtkdoc opt">-></span>filename<span class="gtkdoc opt">,</span> load<span class="gtkdoc opt">-></span>out <span class="gtkdoc opt">) )</span>
<span class="keyword">return</span><span class="gtkdoc opt">( -</span><span class="number">1</span> <span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">(</span> <span class="number">0</span> <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static int</span>
<span class="function">vips_foreign_load_png_load</span><span class="gtkdoc opt">(</span> VipsForeignLoad <span class="gtkdoc opt">*</span>load <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
VipsForeignLoadPng <span class="gtkdoc opt">*</span>png <span class="gtkdoc opt">= (</span>VipsForeignLoadPng <span class="gtkdoc opt">*)</span> load<span class="gtkdoc opt">;</span>
<span class="keyword">if</span><span class="gtkdoc opt">(</span> <span class="function">vips__png_read</span><span class="gtkdoc opt">(</span> png<span class="gtkdoc opt">-></span>filename<span class="gtkdoc opt">,</span> load<span class="gtkdoc opt">-></span>real <span class="gtkdoc opt">) )</span>
<span class="keyword">return</span><span class="gtkdoc opt">( -</span><span class="number">1</span> <span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">(</span> <span class="number">0</span> <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">vips_foreign_load_png_class_init</span><span class="gtkdoc opt">(</span> VipsForeignLoadPngClass <span class="gtkdoc opt">*</span><span class="gtkdoc kwc">class</span> <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
GObjectClass <span class="gtkdoc opt">*</span>gobject_class <span class="gtkdoc opt">=</span> <span class="function">G_OBJECT_CLASS</span><span class="gtkdoc opt">(</span> <span class="gtkdoc kwc">class</span> <span class="gtkdoc opt">);</span>
VipsObjectClass <span class="gtkdoc opt">*</span>object_class <span class="gtkdoc opt">= (</span>VipsObjectClass <span class="gtkdoc opt">*)</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">;</span>
VipsForeignClass <span class="gtkdoc opt">*</span>foreign_class <span class="gtkdoc opt">= (</span>VipsForeignClass <span class="gtkdoc opt">*)</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">;</span>
VipsForeignLoadClass <span class="gtkdoc opt">*</span>load_class <span class="gtkdoc opt">= (</span>VipsForeignLoadClass <span class="gtkdoc opt">*)</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">;</span>
gobject_class<span class="gtkdoc opt">-></span>set_property <span class="gtkdoc opt">=</span> vips_object_set_property<span class="gtkdoc opt">;</span>
gobject_class<span class="gtkdoc opt">-></span>get_property <span class="gtkdoc opt">=</span> vips_object_get_property<span class="gtkdoc opt">;</span>
object_class<span class="gtkdoc opt">-></span>nickname <span class="gtkdoc opt">=</span> <span class="string">"pngload"</span><span class="gtkdoc opt">;</span>
object_class<span class="gtkdoc opt">-></span>description <span class="gtkdoc opt">=</span> <span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"load png from file"</span> <span class="gtkdoc opt">);</span>
foreign_class<span class="gtkdoc opt">-></span>suffs <span class="gtkdoc opt">=</span> vips__png_suffs<span class="gtkdoc opt">;</span>
load_class<span class="gtkdoc opt">-></span>is_a <span class="gtkdoc opt">=</span> vips__png_ispng<span class="gtkdoc opt">;</span>
load_class<span class="gtkdoc opt">-></span>get_flags_filename <span class="gtkdoc opt">=</span>
vips_foreign_load_png_get_flags_filename<span class="gtkdoc opt">;</span>
load_class<span class="gtkdoc opt">-></span>get_flags <span class="gtkdoc opt">=</span> vips_foreign_load_png_get_flags<span class="gtkdoc opt">;</span>
load_class<span class="gtkdoc opt">-></span>header <span class="gtkdoc opt">=</span> vips_foreign_load_png_header<span class="gtkdoc opt">;</span>
load_class<span class="gtkdoc opt">-></span>load <span class="gtkdoc opt">=</span> vips_foreign_load_png_load<span class="gtkdoc opt">;</span>
<span class="function"><a href="VipsObject.html#VIPS-ARG-STRING:CAPS">VIPS_ARG_STRING</a></span><span class="gtkdoc opt">(</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">,</span> <span class="string">"filename"</span><span class="gtkdoc opt">,</span> <span class="number">1</span><span class="gtkdoc opt">,</span>
<span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"Filename"</span> <span class="gtkdoc opt">),</span>
<span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"Filename to load from"</span> <span class="gtkdoc opt">),</span>
VIPS_ARGUMENT_REQUIRED_INPUT<span class="gtkdoc opt">,</span>
<span class="function">G_STRUCT_OFFSET</span><span class="gtkdoc opt">(</span> VipsForeignLoadPng<span class="gtkdoc opt">,</span> filename <span class="gtkdoc opt">),</span>
NULL <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">vips_foreign_load_png_init</span><span class="gtkdoc opt">(</span> VipsForeignLoadPng <span class="gtkdoc opt">*</span>png <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<div class="refsect3">
<a name="id-1.4.6.11.12"></a><h4>Writing a new saver</h4>
<p>Call your saver in the class' <em class="parameter"><code><code class="function">build()</code></code></em>
method after chaining up. The
prepared image should be ready for you to save in <em class="parameter"><code>ready</code></em>
. </p>
<p>As a complete example, here's the code for the CSV saver, minus the calls
to the actual save routines.</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwc">typedef</span> <span class="gtkdoc kwb">struct</span> _VipsForeignSaveCsv <span class="gtkdoc opt">{</span>
VipsForeignSave parent_object<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">char</span> <span class="gtkdoc opt">*</span>filename<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>separator<span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span> VipsForeignSaveCsv<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwc">typedef</span> VipsForeignSaveClass VipsForeignSaveCsvClass<span class="gtkdoc opt">;</span>
<span class="function">G_DEFINE_TYPE</span><span class="gtkdoc opt">(</span> VipsForeignSaveCsv<span class="gtkdoc opt">,</span> vips_foreign_save_csv<span class="gtkdoc opt">,</span>
VIPS_TYPE_FOREIGN_SAVE <span class="gtkdoc opt">);</span>
<span class="gtkdoc kwb">static int</span>
<span class="function">vips_foreign_save_csv_build</span><span class="gtkdoc opt">(</span> VipsObject <span class="gtkdoc opt">*</span>object <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
VipsForeignSave <span class="gtkdoc opt">*</span>save <span class="gtkdoc opt">= (</span>VipsForeignSave <span class="gtkdoc opt">*)</span> object<span class="gtkdoc opt">;</span>
VipsForeignSaveCsv <span class="gtkdoc opt">*</span>csv <span class="gtkdoc opt">= (</span>VipsForeignSaveCsv <span class="gtkdoc opt">*)</span> object<span class="gtkdoc opt">;</span>
<span class="keyword">if</span><span class="gtkdoc opt">(</span> <span class="function">VIPS_OBJECT_CLASS</span><span class="gtkdoc opt">(</span> vips_foreign_save_csv_parent_class <span class="gtkdoc opt">)-></span>
<span class="function">build</span><span class="gtkdoc opt">(</span> object <span class="gtkdoc opt">) )</span>
<span class="keyword">return</span><span class="gtkdoc opt">( -</span><span class="number">1</span> <span class="gtkdoc opt">);</span>
<span class="keyword">if</span><span class="gtkdoc opt">(</span> <span class="function">vips__csv_write</span><span class="gtkdoc opt">(</span> save<span class="gtkdoc opt">-></span>ready<span class="gtkdoc opt">,</span> csv<span class="gtkdoc opt">-></span>filename<span class="gtkdoc opt">,</span> csv<span class="gtkdoc opt">-></span>separator <span class="gtkdoc opt">) )</span>
<span class="keyword">return</span><span class="gtkdoc opt">( -</span><span class="number">1</span> <span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">(</span> <span class="number">0</span> <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">vips_foreign_save_csv_class_init</span><span class="gtkdoc opt">(</span> VipsForeignSaveCsvClass <span class="gtkdoc opt">*</span><span class="gtkdoc kwc">class</span> <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
GObjectClass <span class="gtkdoc opt">*</span>gobject_class <span class="gtkdoc opt">=</span> <span class="function">G_OBJECT_CLASS</span><span class="gtkdoc opt">(</span> <span class="gtkdoc kwc">class</span> <span class="gtkdoc opt">);</span>
VipsObjectClass <span class="gtkdoc opt">*</span>object_class <span class="gtkdoc opt">= (</span>VipsObjectClass <span class="gtkdoc opt">*)</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">;</span>
VipsForeignClass <span class="gtkdoc opt">*</span>foreign_class <span class="gtkdoc opt">= (</span>VipsForeignClass <span class="gtkdoc opt">*)</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">;</span>
VipsForeignSaveClass <span class="gtkdoc opt">*</span>save_class <span class="gtkdoc opt">= (</span>VipsForeignSaveClass <span class="gtkdoc opt">*)</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">;</span>
gobject_class<span class="gtkdoc opt">-></span>set_property <span class="gtkdoc opt">=</span> vips_object_set_property<span class="gtkdoc opt">;</span>
gobject_class<span class="gtkdoc opt">-></span>get_property <span class="gtkdoc opt">=</span> vips_object_get_property<span class="gtkdoc opt">;</span>
object_class<span class="gtkdoc opt">-></span>nickname <span class="gtkdoc opt">=</span> <span class="string">"csvsave"</span><span class="gtkdoc opt">;</span>
object_class<span class="gtkdoc opt">-></span>description <span class="gtkdoc opt">=</span> <span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"save image to csv file"</span> <span class="gtkdoc opt">);</span>
object_class<span class="gtkdoc opt">-></span>build <span class="gtkdoc opt">=</span> vips_foreign_save_csv_build<span class="gtkdoc opt">;</span>
foreign_class<span class="gtkdoc opt">-></span>suffs <span class="gtkdoc opt">=</span> vips__foreign_csv_suffs<span class="gtkdoc opt">;</span>
save_class<span class="gtkdoc opt">-></span>saveable <span class="gtkdoc opt">=</span> VIPS_SAVEABLE_MONO<span class="gtkdoc opt">;</span>
<span class="gtkdoc slc">// no need to define ->format_table, we don't want the input </span>
<span class="gtkdoc slc">// cast for us</span>
<span class="function"><a href="VipsObject.html#VIPS-ARG-STRING:CAPS">VIPS_ARG_STRING</a></span><span class="gtkdoc opt">(</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">,</span> <span class="string">"filename"</span><span class="gtkdoc opt">,</span> <span class="number">1</span><span class="gtkdoc opt">,</span>
<span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"Filename"</span> <span class="gtkdoc opt">),</span>
<span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"Filename to save to"</span> <span class="gtkdoc opt">),</span>
VIPS_ARGUMENT_REQUIRED_INPUT<span class="gtkdoc opt">,</span>
<span class="function">G_STRUCT_OFFSET</span><span class="gtkdoc opt">(</span> VipsForeignSaveCsv<span class="gtkdoc opt">,</span> filename <span class="gtkdoc opt">),</span>
NULL <span class="gtkdoc opt">);</span>
<span class="function"><a href="VipsObject.html#VIPS-ARG-STRING:CAPS">VIPS_ARG_STRING</a></span><span class="gtkdoc opt">(</span> <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">,</span> <span class="string">"separator"</span><span class="gtkdoc opt">,</span> <span class="number">13</span><span class="gtkdoc opt">,</span>
<span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"Separator"</span> <span class="gtkdoc opt">),</span>
<span class="function">_</span><span class="gtkdoc opt">(</span> <span class="string">"Separator characters"</span> <span class="gtkdoc opt">),</span>
VIPS_ARGUMENT_OPTIONAL_INPUT<span class="gtkdoc opt">,</span>
<span class="function">G_STRUCT_OFFSET</span><span class="gtkdoc opt">(</span> VipsForeignSaveCsv<span class="gtkdoc opt">,</span> separator <span class="gtkdoc opt">),</span>
<span class="string">"</span><span class="gtkdoc esc">\t</span><span class="string">"</span> <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">vips_foreign_save_csv_init</span><span class="gtkdoc opt">(</span> VipsForeignSaveCsv <span class="gtkdoc opt">*</span>csv <span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
csv<span class="gtkdoc opt">-></span>separator <span class="gtkdoc opt">=</span> <span class="function">g_strdup</span><span class="gtkdoc opt">(</span> <span class="string">"</span><span class="gtkdoc esc">\t</span><span class="string">"</span> <span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
</div>
<div class="refsect1">
<a name="VipsForeignSave.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="vips-foreign-map"></a><h3>vips_foreign_map ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
vips_foreign_map (<em class="parameter"><code>const <span class="type">char</span> *base</code></em>,
<em class="parameter"><code><a class="link" href="libvips-basic.html#VipsSListMap2Fn" title="VipsSListMap2Fn ()"><span class="type">VipsSListMap2Fn</span></a> fn</code></em>,
<em class="parameter"><code><span class="type">void</span> *a</code></em>,
<em class="parameter"><code><span class="type">void</span> *b</code></em>);</pre>
<p>Apply a function to every <span class="type">VipsForeignClass</span> that VIPS knows about. Foreigns
are presented to the function in priority order. </p>
<p>Like all VIPS map functions, if <em class="parameter"><code>fn</code></em>
returns <code class="literal">NULL</code>, iteration continues. If
it returns non-<code class="literal">NULL</code>, iteration terminates and that value is returned. The
map function returns <code class="literal">NULL</code> if all calls return <code class="literal">NULL</code>.</p>
<p>See also: <code class="function">vips_slist_map()</code>.</p>
<div class="refsect3">
<a name="vips-foreign-map.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>base</p></td>
<td class="parameter_description"><p>base class to search below (eg. "VipsForeignLoad")</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fn</p></td>
<td class="parameter_description"><p> function to apply to each <span class="type">VipsForeignClass</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>a</p></td>
<td class="parameter_description"><p>user data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>b</p></td>
<td class="parameter_description"><p>user data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-map.returns"></a><h4>Returns</h4>
<p> the result of iteration. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-find-load"></a><h3>vips_foreign_find_load ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
vips_foreign_find_load (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>Searches for an operation you could use to load <em class="parameter"><code>filename</code></em>
. Any trailing
options on <em class="parameter"><code>filename</code></em>
are stripped and ignored. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-foreign-find-load-buffer" title="vips_foreign_find_load_buffer ()"><code class="function">vips_foreign_find_load_buffer()</code></a>, <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-foreign-find-load.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to find a loader for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-find-load.returns"></a><h4>Returns</h4>
<p> the name of an operation on success, <code class="literal">NULL</code> on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-find-load-buffer"></a><h3>vips_foreign_find_load_buffer ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
vips_foreign_find_load_buffer (<em class="parameter"><code>const <span class="type">void</span> *data</code></em>,
<em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
<p>Searches for an operation you could use to load a memory buffer. To see the
range of buffer loaders supported by your vips, try something like:</p>
<p> vips -l | grep load_buffer</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-buffer" title="vips_image_new_from_buffer ()"><code class="function">vips_image_new_from_buffer()</code></a>.</p>
<div class="refsect3">
<a name="vips-foreign-find-load-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> start of
memory buffer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>number of bytes in <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-find-load-buffer.returns"></a><h4>Returns</h4>
<p> the name of an operation on success, <code class="literal">NULL</code> on
error. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-flags"></a><h3>vips_foreign_flags ()</h3>
<pre class="programlisting"><a class="link" href="VipsForeignSave.html#VipsForeignFlags" title="enum VipsForeignFlags"><span class="returnvalue">VipsForeignFlags</span></a>
vips_foreign_flags (<em class="parameter"><code>const <span class="type">char</span> *loader</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>Return the flags for <em class="parameter"><code>filename</code></em>
using <em class="parameter"><code>loader</code></em>
.
<em class="parameter"><code>loader</code></em>
is something like "tiffload" or "VipsForeignLoadTiff".</p>
<div class="refsect3">
<a name="vips-foreign-flags.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>loader</p></td>
<td class="parameter_description"><p>name of loader to use for test</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to test</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-flags.returns"></a><h4>Returns</h4>
<p> the flags for <em class="parameter"><code>filename</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-is-a"></a><h3>vips_foreign_is_a ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_foreign_is_a (<em class="parameter"><code>const <span class="type">char</span> *loader</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>filename</code></em>
can be loaded by <em class="parameter"><code>loader</code></em>
. <em class="parameter"><code>loader</code></em>
is something
like "tiffload" or "VipsForeignLoadTiff".</p>
<div class="refsect3">
<a name="vips-foreign-is-a.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>loader</p></td>
<td class="parameter_description"><p>name of loader to use for test</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to test</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-is-a.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>filename</code></em>
can be loaded by <em class="parameter"><code>loader</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-is-a-buffer"></a><h3>vips_foreign_is_a_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_foreign_is_a_buffer (<em class="parameter"><code>const <span class="type">char</span> *loader</code></em>,
<em class="parameter"><code>const <span class="type">void</span> *data</code></em>,
<em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>data</code></em>
can be loaded by <em class="parameter"><code>loader</code></em>
. <em class="parameter"><code>loader</code></em>
is something
like "tiffload_buffer" or "VipsForeignLoadTiffBuffer".</p>
<div class="refsect3">
<a name="vips-foreign-is-a-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>loader</p></td>
<td class="parameter_description"><p>name of loader to use for test</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>pointer to the buffer to test</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>size of the buffer to test</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-is-a-buffer.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>data</code></em>
can be loaded by <em class="parameter"><code>loader</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-find-save"></a><h3>vips_foreign_find_save ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
vips_foreign_find_save (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>Searches for an operation you could use to write to <em class="parameter"><code>filename</code></em>
.
Any trailing options on <em class="parameter"><code>filename</code></em>
are stripped and ignored. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-foreign-find-save-buffer" title="vips_foreign_find_save_buffer ()"><code class="function">vips_foreign_find_save_buffer()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-foreign-find-save.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>name to find a saver for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-find-save.returns"></a><h4>Returns</h4>
<p> the name of an operation on success, <code class="literal">NULL</code> on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-foreign-find-save-buffer"></a><h3>vips_foreign_find_save_buffer ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
vips_foreign_find_save_buffer (<em class="parameter"><code>const <span class="type">char</span> *suffix</code></em>);</pre>
<p>Searches for an operation you could use to write to a buffer in <em class="parameter"><code>suffix</code></em>
format. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-buffer" title="vips_image_write_to_buffer ()"><code class="function">vips_image_write_to_buffer()</code></a>.</p>
<div class="refsect3">
<a name="vips-foreign-find-save-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>suffix</p></td>
<td class="parameter_description"><p>name to find a saver for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-foreign-find-save-buffer.returns"></a><h4>Returns</h4>
<p> the name of an operation on success, <code class="literal">NULL</code> on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-vipsload"></a><h3>vips_vipsload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_vipsload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read in a vips image. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-vipssave" title="vips_vipssave ()"><code class="function">vips_vipssave()</code></a>.</p>
<div class="refsect3">
<a name="vips-vipsload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-vipsload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-vipssave"></a><h3>vips_vipssave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_vipssave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Write <em class="parameter"><code>in</code></em>
to <em class="parameter"><code>filename</code></em>
in VIPS format.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-vipsload" title="vips_vipsload ()"><code class="function">vips_vipsload()</code></a>.</p>
<div class="refsect3">
<a name="vips-vipssave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-vipssave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-openslideload"></a><h3>vips_openslideload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_openslideload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>level</code></em>
: load this level</p></li>
<li class="listitem"><p><em class="parameter"><code>associated</code></em>
: load this associated image</p></li>
<li class="listitem"><p><em class="parameter"><code>autocrop</code></em>
: crop to image bounds</p></li>
</ul></div>
<p>Read a virtual slide supported by the OpenSlide library into a VIPS image.
OpenSlide supports images in Aperio, Hamamatsu, MIRAX, Sakura, Trestle,
and Ventana formats.</p>
<p>To facilitate zooming, virtual slide formats include multiple scaled-down
versions of the high-resolution image. These are typically called
"levels". By default, <a class="link" href="VipsForeignSave.html#vips-openslideload" title="vips_openslideload ()"><code class="function">vips_openslideload()</code></a> reads the highest-resolution
level (level 0). Set <em class="parameter"><code>level</code></em>
to the level number you want.</p>
<p>In addition to the slide image itself, virtual slide formats sometimes
include additional images, such as a scan of the slide's barcode.
OpenSlide calls these "associated images". To read an associated image,
set <em class="parameter"><code>associated</code></em>
to the image's name.
A slide's associated images are listed in the
"slide-associated-images" metadata item.</p>
<p>The output of this operator is always RGBA.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-openslideload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-openslideload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-jpegload"></a><h3>vips_jpegload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_jpegload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>shrink</code></em>
: <code class="literal">gint</code>, shrink by this much on load</p></li>
<li class="listitem"><p><em class="parameter"><code>fail</code></em>
: <code class="literal">gboolean</code>, fail on warnings</p></li>
<li class="listitem"><p><em class="parameter"><code>autorotate</code></em>
: <code class="literal">gboolean</code>, use exif Orientation tag to rotate the image
during load</p></li>
</ul></div>
<p>Read a JPEG file into a VIPS image. It can read most 8-bit JPEG images,
including CMYK and YCbCr.</p>
<p><em class="parameter"><code>shrink</code></em>
means shrink by this integer factor during load. Possible values
are 1, 2, 4 and 8. Shrinking during read is very much faster than
decompressing the whole image and then shrinking later.</p>
<p>Setting <em class="parameter"><code>fail</code></em>
to <code class="literal">TRUE</code> makes the JPEG reader fail on any warnings.
This can be useful for detecting truncated files, for example. Normally
reading these produces a warning, but no fatal error. </p>
<p>Setting <em class="parameter"><code>autorotate</code></em>
to <code class="literal">TRUE</code> will make the loader interpret the
orientation tag and automatically rotate the image appropriately during
load. </p>
<p>If <em class="parameter"><code>autorotate</code></em>
is <code class="literal">FALSE</code>, the metadata field <a class="link" href="libvips-header.html#VIPS-META-ORIENTATION:CAPS" title="VIPS_META_ORIENTATION"><span class="type">VIPS_META_ORIENTATION</span></a> is set
to the value of the orientation tag. Applications may read and interpret
this field
as they wish later in processing. See <a class="link" href="libvips-conversion.html#vips-autorot" title="vips_autorot ()"><code class="function">vips_autorot()</code></a>. Save
operations will use <a class="link" href="libvips-header.html#VIPS-META-ORIENTATION:CAPS" title="VIPS_META_ORIENTATION"><span class="type">VIPS_META_ORIENTATION</span></a>, if present, to set the
orientation of output images. </p>
<p>Example:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="VipsForeignSave.html#vips-jpegload">vips_jpegload</a></span><span class="gtkdoc opt">(</span> <span class="string">"fred.jpg"</span><span class="gtkdoc opt">, &</span>out<span class="gtkdoc opt">,</span>
<span class="string">"shrink"</span><span class="gtkdoc opt">,</span> <span class="number">8</span><span class="gtkdoc opt">,</span>
<span class="string">"fail"</span><span class="gtkdoc opt">,</span> TRUE<span class="gtkdoc opt">,</span>
NULL <span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>Any embedded ICC profiles are ignored: you always just get the RGB from
the file. Instead, the embedded profile will be attached to the image as
<a class="link" href="libvips-header.html#VIPS-META-ICC-NAME:CAPS" title="VIPS_META_ICC_NAME"><span class="type">VIPS_META_ICC_NAME</span></a>. You need to use something like
<a class="link" href="libvips-colour.html#vips-icc-import" title="vips_icc_import ()"><code class="function">vips_icc_import()</code></a> to get CIE values from the file. </p>
<p>EXIF metadata is attached as <a class="link" href="libvips-header.html#VIPS-META-EXIF-NAME:CAPS" title="VIPS_META_EXIF_NAME"><span class="type">VIPS_META_EXIF_NAME</span></a>, IPCT as
<a class="link" href="libvips-header.html#VIPS-META-IPCT-NAME:CAPS" title="VIPS_META_IPCT_NAME"><span class="type">VIPS_META_IPCT_NAME</span></a>, and XMP as <a class="link" href="libvips-header.html#VIPS-META-XMP-NAME:CAPS" title="VIPS_META_XMP_NAME"><span class="type">VIPS_META_XMP_NAME</span></a>.</p>
<p>The int metadata item "jpeg-multiscan" is set to the result of
<code class="function">jpeg_has_multiple_scans()</code>. Interlaced jpeg images need a large amount of
memory to load, so this field gives callers a chance to handle these
images differently.</p>
<p>The EXIF thumbnail, if present, is attached to the image as
"jpeg-thumbnail-data". See <a class="link" href="libvips-header.html#vips-image-get-blob" title="vips_image_get_blob ()"><code class="function">vips_image_get_blob()</code></a>.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-jpegload-buffer" title="vips_jpegload_buffer ()"><code class="function">vips_jpegload_buffer()</code></a>, <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>, <a class="link" href="libvips-conversion.html#vips-autorot" title="vips_autorot ()"><code class="function">vips_autorot()</code></a>.</p>
<div class="refsect3">
<a name="vips-jpegload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-jpegload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-jpegload-buffer"></a><h3>vips_jpegload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_jpegload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>shrink</code></em>
: <code class="literal">gint</code>, shrink by this much on load</p></li>
<li class="listitem"><p><em class="parameter"><code>fail</code></em>
: <code class="literal">gboolean</code>, fail on warnings</p></li>
<li class="listitem"><p><em class="parameter"><code>autorotate</code></em>
: <code class="literal">gboolean</code>, use exif Orientation tag to rotate the image
during load</p></li>
</ul></div>
<p>Read a JPEG-formatted memory block into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-jpegload" title="vips_jpegload ()"><code class="function">vips_jpegload()</code></a>, but read from a memory buffer. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-jpegload" title="vips_jpegload ()"><code class="function">vips_jpegload()</code></a>.</p>
<div class="refsect3">
<a name="vips-jpegload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-jpegload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-jpegsave"></a><h3>vips_jpegsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_jpegsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code>, quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>profile</code></em>
: filename of ICC profile to attach</p></li>
<li class="listitem"><p><em class="parameter"><code>optimize_coding</code></em>
: <code class="literal">gboolean</code>, compute optimal Huffman coding tables</p></li>
<li class="listitem"><p><em class="parameter"><code>interlace</code></em>
: <code class="literal">gboolean</code>, write an interlaced (progressive) jpeg</p></li>
<li class="listitem"><p><em class="parameter"><code>strip</code></em>
: <code class="literal">gboolean</code>, remove all metadata from image</p></li>
<li class="listitem"><p><em class="parameter"><code>no_subsample</code></em>
: <code class="literal">gboolean</code>, disable chroma subsampling</p></li>
<li class="listitem"><p><em class="parameter"><code>trellis_quant</code></em>
: <code class="literal">gboolean</code>, apply trellis quantisation to each 8x8 block</p></li>
<li class="listitem"><p><em class="parameter"><code>overshoot_deringing</code></em>
: <code class="literal">gboolean</code>, overshoot samples with extreme values</p></li>
<li class="listitem"><p><em class="parameter"><code>optimize_scans</code></em>
: <code class="literal">gboolean</code>, split DCT coefficients into separate scans</p></li>
<li class="listitem"><p><em class="parameter"><code>quant_table</code></em>
: <code class="literal">gint</code>, quantization table index</p></li>
</ul></div>
<p>Write a VIPS image to a file as JPEG.</p>
<p>Use <em class="parameter"><code>Q</code></em>
to set the JPEG compression factor. Default 75.</p>
<p>Use <em class="parameter"><code>profile</code></em>
to give the filename of a profile to be embedded in the JPEG.
This does not affect the pixels which are written, just the way
they are tagged. You can use the special string "none" to mean
"don't attach a profile".</p>
<p>If no profile is specified and the VIPS header
contains an ICC profile named <a class="link" href="libvips-header.html#VIPS-META-ICC-NAME:CAPS" title="VIPS_META_ICC_NAME"><span class="type">VIPS_META_ICC_NAME</span></a>, the
profile from the VIPS header will be attached.</p>
<p>If <em class="parameter"><code>optimize_coding</code></em>
is set, the Huffman tables are optimised. This is
sllightly slower and produces slightly smaller files. </p>
<p>If <em class="parameter"><code>interlace</code></em>
is set, the jpeg files will be interlaced (progressive jpeg,
in jpg parlance). These files may be better for display over a slow network
conection, but need much more memory to encode and decode. </p>
<p>If <em class="parameter"><code>strip</code></em>
is set, no EXIF data, IPCT data, ICC profile or XMP metadata is
written into the output file. </p>
<p>If <em class="parameter"><code>no_subsample</code></em>
is set, chrominance subsampling is disabled. This will
improve quality at the cost of larger file size. Useful for high Q factors. </p>
<p>If <em class="parameter"><code>trellis_quant</code></em>
is set and the version of libjpeg supports it
(e.g. mozjpeg >= 3.0), apply trellis quantisation to each 8x8 block.
Reduces file size but increases compression time.</p>
<p>If <em class="parameter"><code>overshoot_deringing</code></em>
is set and the version of libjpeg supports it
(e.g. mozjpeg >= 3.0), apply overshooting to samples with extreme values
for example 0 and 255 for 8-bit. Overshooting may reduce ringing artifacts
from compression, in particular in areas where black text appears on a
white background.</p>
<p>If <em class="parameter"><code>optimize_scans</code></em>
is set and the version of libjpeg supports it
(e.g. mozjpeg >= 3.0), split the spectrum of DCT coefficients into
separate scans. Reduces file size but increases compression time.</p>
<p>If <em class="parameter"><code>quant_table</code></em>
is set and the version of libjpeg supports it
(e.g. mozjpeg >= 3.0) it selects the quantization table to use:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>0 — Tables from JPEG Annex K (vips and libjpeg default)</p></li>
<li class="listitem"><p>1 — Flat table</p></li>
<li class="listitem"><p>2 — Table tuned for MSSIM on Kodak image set</p></li>
<li class="listitem"><p>3 — Table from ImageMagick by N. Robidoux (current mozjpeg default)</p></li>
<li class="listitem"><p>4 — Table tuned for PSNR-HVS-M on Kodak image set</p></li>
<li class="listitem"><p>5 — Table from Relevance of Human Vision to JPEG-DCT Compression (1992)</p></li>
<li class="listitem"><p>6 — Table from DCTune Perceptual Optimization of Compressed Dental
X-Rays (1997)</p></li>
<li class="listitem"><p>7 — Table from A Visual Detection Model for DCT Coefficient
Quantization (1993)</p></li>
<li class="listitem"><p>8 — Table from An Improved Detection Model for DCT Coefficient
Quantization (1993)</p></li>
</ul></div>
<p>Quantization table 0 is the default in vips and libjpeg(-turbo), but it
tends to favor detail over color accuracy, producting colored patches and
stripes as well as heavy banding in flat areas at high compression ratios.
Quantization table 2 is a good candidate to try if the default quantization
table produces banding or color shifts and is well suited for hires images.
Quantization table 3 is the default in mozjpeg and has been tuned to produce
good results at the default quality setting; banding at high compression.
Quantization table 4 is the most accurate at the cost of compression ratio.
Tables 5-7 are based on older research papers, but generally achieve worse
compression ratios and/or quality than 2 or 4.</p>
<p>The image is automatically converted to RGB, Monochrome or CMYK before
saving. </p>
<p>EXIF data is constructed from <a class="link" href="libvips-header.html#VIPS-META-EXIF-NAME:CAPS" title="VIPS_META_EXIF_NAME"><span class="type">VIPS_META_EXIF_NAME</span></a>, then
modified with any other related tags on the image before being written to
the file. <a class="link" href="libvips-header.html#VIPS-META-RESOLUTION-UNIT:CAPS" title="VIPS_META_RESOLUTION_UNIT"><span class="type">VIPS_META_RESOLUTION_UNIT</span></a> is used to set the EXIF resolution
unit. <a class="link" href="libvips-header.html#VIPS-META-ORIENTATION:CAPS" title="VIPS_META_ORIENTATION"><span class="type">VIPS_META_ORIENTATION</span></a> is used to set the EXIF orientation tag. </p>
<p>IPCT as <a class="link" href="libvips-header.html#VIPS-META-IPCT-NAME:CAPS" title="VIPS_META_IPCT_NAME"><span class="type">VIPS_META_IPCT_NAME</span></a> and XMP as <a class="link" href="libvips-header.html#VIPS-META-XMP-NAME:CAPS" title="VIPS_META_XMP_NAME"><span class="type">VIPS_META_XMP_NAME</span></a>
are coded and attached. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-jpegsave-buffer" title="vips_jpegsave_buffer ()"><code class="function">vips_jpegsave_buffer()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-jpegsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-jpegsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-jpegsave-buffer"></a><h3>vips_jpegsave_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_jpegsave_buffer (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code><span class="type">void</span> **buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *len</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code>, quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>profile</code></em>
: filename of ICC profile to attach</p></li>
<li class="listitem"><p><em class="parameter"><code>optimize_coding</code></em>
: <code class="literal">gboolean</code>, compute optimal Huffman coding tables</p></li>
<li class="listitem"><p><em class="parameter"><code>interlace</code></em>
: <code class="literal">gboolean</code>, write an interlaced (progressive) jpeg</p></li>
<li class="listitem"><p><em class="parameter"><code>strip</code></em>
: <code class="literal">gboolean</code>, remove all metadata from image</p></li>
<li class="listitem"><p><em class="parameter"><code>no_subsample</code></em>
: <code class="literal">gboolean</code>, disable chroma subsampling</p></li>
<li class="listitem"><p><em class="parameter"><code>trellis_quant</code></em>
: <code class="literal">gboolean</code>, apply trellis quantisation to each 8x8 block</p></li>
<li class="listitem"><p><em class="parameter"><code>overshoot_deringing</code></em>
: <code class="literal">gboolean</code>, overshoot samples with extreme values</p></li>
<li class="listitem"><p><em class="parameter"><code>optimize_scans</code></em>
: <code class="literal">gboolean</code>, split DCT coefficients into separate scans</p></li>
<li class="listitem"><p><em class="parameter"><code>quant_table</code></em>
: <code class="literal">gint</code>, quantization table index</p></li>
</ul></div>
<p>As <a class="link" href="VipsForeignSave.html#vips-jpegsave" title="vips_jpegsave ()"><code class="function">vips_jpegsave()</code></a>, but save to a memory buffer. </p>
<p>The address of the buffer is returned in <em class="parameter"><code>obuf</code></em>
, the length of the buffer in
<em class="parameter"><code>olen</code></em>
. You are responsible for freeing the buffer with <code class="function">g_free()</code> when you
are done with it.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-jpegsave" title="vips_jpegsave ()"><code class="function">vips_jpegsave()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-jpegsave-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>return output buffer here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>return output length here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-jpegsave-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-jpegsave-mime"></a><h3>vips_jpegsave_mime ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_jpegsave_mime (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code>, quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>profile</code></em>
: filename of ICC profile to attach</p></li>
<li class="listitem"><p><em class="parameter"><code>optimize_coding</code></em>
: <code class="literal">gboolean</code>, compute optimal Huffman coding tables</p></li>
<li class="listitem"><p><em class="parameter"><code>interlace</code></em>
: <code class="literal">gboolean</code>, write an interlaced (progressive) jpeg</p></li>
<li class="listitem"><p><em class="parameter"><code>strip</code></em>
: <code class="literal">gboolean</code>, remove all metadata from image</p></li>
<li class="listitem"><p><em class="parameter"><code>no_subsample</code></em>
: <code class="literal">gboolean</code>, disable chroma subsampling</p></li>
<li class="listitem"><p><em class="parameter"><code>trellis_quant</code></em>
: <code class="literal">gboolean</code>, apply trellis quantisation to each 8x8 block</p></li>
<li class="listitem"><p><em class="parameter"><code>overshoot_deringing</code></em>
: <code class="literal">gboolean</code>, overshoot samples with extreme values</p></li>
<li class="listitem"><p><em class="parameter"><code>optimize_scans</code></em>
: <code class="literal">gboolean</code>, split DCT coefficients into separate scans</p></li>
<li class="listitem"><p><em class="parameter"><code>quant_table</code></em>
: <code class="literal">gint</code>, quantization table index</p></li>
</ul></div>
<p>As <a class="link" href="VipsForeignSave.html#vips-jpegsave" title="vips_jpegsave ()"><code class="function">vips_jpegsave()</code></a>, but save as a mime jpeg on stdout.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-jpegsave" title="vips_jpegsave ()"><code class="function">vips_jpegsave()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-jpegsave-mime.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-jpegsave-mime.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-webpload"></a><h3>vips_webpload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_webpload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>shrink</code></em>
: <code class="literal">gint</code>, shrink by this much on load</p></li></ul></div>
<p>Read a WebP file into a VIPS image. </p>
<p>Use <em class="parameter"><code>shrink</code></em>
to specify a shrink-on-load factor.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-webpload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-webpload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-webpload-buffer"></a><h3>vips_webpload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_webpload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>shrink</code></em>
: <code class="literal">gint</code>, shrink by this much on load</p></li></ul></div>
<p>Read a WebP-formatted memory block into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-webpload" title="vips_webpload ()"><code class="function">vips_webpload()</code></a>, but read from a memory buffer. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-webpload" title="vips_webpload ()"><code class="function">vips_webpload()</code></a></p>
<div class="refsect3">
<a name="vips-webpload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-webpload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-webpsave"></a><h3>vips_webpsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_webpsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code> quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>lossless</code></em>
: <code class="literal">gboolean</code> enables lossless compression</p></li>
<li class="listitem"><p><em class="parameter"><code>preset</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignWebpPreset" title="enum VipsForeignWebpPreset"><span class="type">VipsForeignWebpPreset</span></a> choose lossy compression preset</p></li>
<li class="listitem"><p><em class="parameter"><code>smart_subsample</code></em>
: <code class="literal">gboolean</code> enables high quality chroma subsampling</p></li>
<li class="listitem"><p><em class="parameter"><code>near_lossless</code></em>
: <code class="literal">gboolean</code> preprocess in lossless mode (controlled by Q)</p></li>
<li class="listitem"><p><em class="parameter"><code>alpha_q</code></em>
: <code class="literal">gint</code> set alpha quality in lossless mode</p></li>
</ul></div>
<p>Write an image to a file in WebP format. </p>
<p>By default, images are saved in lossy format, with
<em class="parameter"><code>Q</code></em>
giving the WebP quality factor. It has the range 0 - 100, with the
default 75.</p>
<p>Use <em class="parameter"><code>preset</code></em>
to hint the image type to the lossy compressor. The default is
<a class="link" href="VipsForeignSave.html#VIPS-FOREIGN-WEBP-PRESET-DEFAULT:CAPS"><span class="type">VIPS_FOREIGN_WEBP_PRESET_DEFAULT</span></a>.
Set <em class="parameter"><code>smart_subsample</code></em>
to enable high quality chroma subsampling.
Use <em class="parameter"><code>alpha_q</code></em>
to set the quality for the alpha channel in lossy mode. It has
the range 1 - 100, with the default 100.</p>
<p>Set <em class="parameter"><code>lossless</code></em>
to use lossless compression, or combine <em class="parameter"><code>near_lossless</code></em>
with <em class="parameter"><code>Q</code></em>
80, 60, 40 or 20 to apply increasing amounts of preprocessing
which improves the near-lossless compression ratio by up to 50%.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-webpload" title="vips_webpload ()"><code class="function">vips_webpload()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-webpsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-webpsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-webpsave-buffer"></a><h3>vips_webpsave_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_webpsave_buffer (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code><span class="type">void</span> **buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *len</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code> quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>lossless</code></em>
: <code class="literal">gboolean</code> enables lossless compression</p></li>
<li class="listitem"><p><em class="parameter"><code>preset</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignWebpPreset" title="enum VipsForeignWebpPreset"><span class="type">VipsForeignWebpPreset</span></a> choose lossy compression preset</p></li>
<li class="listitem"><p><em class="parameter"><code>smart_subsample</code></em>
: <code class="literal">gboolean</code> enables high quality chroma subsampling</p></li>
<li class="listitem"><p><em class="parameter"><code>near_lossless</code></em>
: <code class="literal">gboolean</code> preprocess in lossless mode (controlled by Q)</p></li>
<li class="listitem"><p><em class="parameter"><code>alpha_q</code></em>
: <code class="literal">gint</code> set alpha quality in lossless mode</p></li>
</ul></div>
<p>As <a class="link" href="VipsForeignSave.html#vips-webpsave" title="vips_webpsave ()"><code class="function">vips_webpsave()</code></a>, but save to a memory buffer.</p>
<p>The address of the buffer is returned in <em class="parameter"><code>buf</code></em>
, the length of the buffer in
<em class="parameter"><code>len</code></em>
. You are responsible for freeing the buffer with <code class="function">g_free()</code> when you
are done with it. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-webpsave" title="vips_webpsave ()"><code class="function">vips_webpsave()</code></a>.</p>
<div class="refsect3">
<a name="vips-webpsave-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>return output buffer here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>return output length here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-webpsave-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-webpsave-mime"></a><h3>vips_webpsave_mime ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_webpsave_mime (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code> quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>lossless</code></em>
: <code class="literal">gboolean</code> enables lossless compression</p></li>
<li class="listitem"><p><em class="parameter"><code>preset</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignWebpPreset" title="enum VipsForeignWebpPreset"><span class="type">VipsForeignWebpPreset</span></a> choose lossy compression preset</p></li>
<li class="listitem"><p><em class="parameter"><code>smart_subsample</code></em>
: <code class="literal">gboolean</code> enables high quality chroma subsampling</p></li>
<li class="listitem"><p><em class="parameter"><code>near_lossless</code></em>
: <code class="literal">gboolean</code> preprocess in lossless mode (controlled by Q)</p></li>
<li class="listitem"><p><em class="parameter"><code>alpha_q</code></em>
: <code class="literal">gint</code> set alpha quality in lossless mode</p></li>
</ul></div>
<p>As <a class="link" href="VipsForeignSave.html#vips-webpsave" title="vips_webpsave ()"><code class="function">vips_webpsave()</code></a>, but save as a mime webp on stdout.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-webpsave" title="vips_webpsave ()"><code class="function">vips_webpsave()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-webpsave-mime.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-webpsave-mime.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-tiffload"></a><h3>vips_tiffload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_tiffload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>page</code></em>
: <code class="literal">gint</code>, load this page</p></li>
<li class="listitem"><p><em class="parameter"><code>autorotate</code></em>
: <code class="literal">gboolean</code>, use orientation tag to rotate the image
during load</p></li>
</ul></div>
<p>Read a TIFF file into a VIPS image. It is a full baseline TIFF 6 reader,
with extensions for tiled images, multipage images, LAB colour space,
pyramidal images and JPEG compression. including CMYK and YCbCr.</p>
<p><em class="parameter"><code>page</code></em>
means load this page from the file. By default the first page (page
0) is read.</p>
<p>Setting <em class="parameter"><code>autorotate</code></em>
to <code class="literal">TRUE</code> will make the loader interpret the
orientation tag and automatically rotate the image appropriately during
load. </p>
<p>If <em class="parameter"><code>autorotate</code></em>
is <code class="literal">FALSE</code>, the metadata field <a class="link" href="libvips-header.html#VIPS-META-ORIENTATION:CAPS" title="VIPS_META_ORIENTATION"><span class="type">VIPS_META_ORIENTATION</span></a> is set
to the value of the orientation tag. Applications may read and interpret
this field
as they wish later in processing. See <a class="link" href="libvips-conversion.html#vips-autorot" title="vips_autorot ()"><code class="function">vips_autorot()</code></a>. Save
operations will use <a class="link" href="libvips-header.html#VIPS-META-ORIENTATION:CAPS" title="VIPS_META_ORIENTATION"><span class="type">VIPS_META_ORIENTATION</span></a>, if present, to set the
orientation of output images. </p>
<p>Any ICC profile is read and attached to the VIPS image as
<a class="link" href="libvips-header.html#VIPS-META-ICC-NAME:CAPS" title="VIPS_META_ICC_NAME"><span class="type">VIPS_META_ICC_NAME</span></a>. Any XMP metadata is read and attached to the image
as <a class="link" href="libvips-header.html#VIPS-META-XMP-NAME:CAPS" title="VIPS_META_XMP_NAME"><span class="type">VIPS_META_XMP_NAME</span></a>. Any IPCT is attached as <a class="link" href="libvips-header.html#VIPS-META-IPCT-NAME:CAPS" title="VIPS_META_IPCT_NAME"><span class="type">VIPS_META_IPCT_NAME</span></a>. The
image description is
attached as <a class="link" href="libvips-header.html#VIPS-META-IMAGEDESCRIPTION:CAPS" title="VIPS_META_IMAGEDESCRIPTION"><span class="type">VIPS_META_IMAGEDESCRIPTION</span></a>. Data in the photoshop tag is
attached as <a class="link" href="libvips-header.html#VIPS-META-PHOTOSHOP-NAME:CAPS" title="VIPS_META_PHOTOSHOP_NAME"><span class="type">VIPS_META_PHOTOSHOP_NAME</span></a>.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>, <a class="link" href="libvips-conversion.html#vips-autorot" title="vips_autorot ()"><code class="function">vips_autorot()</code></a>.</p>
<div class="refsect3">
<a name="vips-tiffload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-tiffload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-tiffload-buffer"></a><h3>vips_tiffload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_tiffload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>page</code></em>
: <code class="literal">gint</code>, load this page</p></li>
<li class="listitem"><p><em class="parameter"><code>autorotate</code></em>
: <code class="literal">gboolean</code>, use orientation tag to rotate the image
during load</p></li>
</ul></div>
<p>Read a TIFF-formatted memory block into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-tiffload" title="vips_tiffload ()"><code class="function">vips_tiffload()</code></a>, but read from a memory source. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-tiffload" title="vips_tiffload ()"><code class="function">vips_tiffload()</code></a>.</p>
<div class="refsect3">
<a name="vips-tiffload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-tiffload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-tiffsave"></a><h3>vips_tiffsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_tiffsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>compression</code></em>
: use this <a class="link" href="VipsForeignSave.html#VipsForeignTiffCompression" title="enum VipsForeignTiffCompression"><span class="type">VipsForeignTiffCompression</span></a></p></li>
<li class="listitem"><p><em class="parameter"><code>Q</code></em>
: <code class="literal">gint</code> quality factor</p></li>
<li class="listitem"><p><em class="parameter"><code>predictor</code></em>
: use this <a class="link" href="VipsForeignSave.html#VipsForeignTiffPredictor" title="enum VipsForeignTiffPredictor"><span class="type">VipsForeignTiffPredictor</span></a></p></li>
<li class="listitem"><p><em class="parameter"><code>profile</code></em>
: filename of ICC profile to attach</p></li>
<li class="listitem"><p><em class="parameter"><code>tile</code></em>
: set <code class="literal">TRUE</code> to write a tiled tiff</p></li>
<li class="listitem"><p><em class="parameter"><code>tile_width</code></em>
: <code class="literal">gint</code> for tile size</p></li>
<li class="listitem"><p><em class="parameter"><code>tile_height</code></em>
: <code class="literal">gint</code> for tile size</p></li>
<li class="listitem"><p><em class="parameter"><code>pyramid</code></em>
: set <code class="literal">TRUE</code> to write an image pyramid</p></li>
<li class="listitem"><p><em class="parameter"><code>squash</code></em>
: set <code class="literal">TRUE</code> to squash 8-bit images down to 1 bit</p></li>
<li class="listitem"><p><em class="parameter"><code>miniswhite</code></em>
: set <code class="literal">TRUE</code> to write 1-bit images as MINISWHITE</p></li>
<li class="listitem"><p><em class="parameter"><code>resunit</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignTiffResunit" title="enum VipsForeignTiffResunit"><span class="type">VipsForeignTiffResunit</span></a> for resolution unit</p></li>
<li class="listitem"><p><em class="parameter"><code>xres</code></em>
: <code class="literal">gdouble</code> horizontal resolution in pixels/mm</p></li>
<li class="listitem"><p><em class="parameter"><code>yres</code></em>
: <code class="literal">gdouble</code> vertical resolution in pixels/mm</p></li>
<li class="listitem"><p><em class="parameter"><code>bigtiff</code></em>
: set <code class="literal">TRUE</code> to write a BigTiff file</p></li>
<li class="listitem"><p><em class="parameter"><code>properties</code></em>
: set <code class="literal">TRUE</code> to write an IMAGEDESCRIPTION tag</p></li>
<li class="listitem"><p><em class="parameter"><code>strip</code></em>
: set <code class="literal">TRUE</code> to block metadata save</p></li>
</ul></div>
<p>Write a VIPS image to a file as TIFF.</p>
<p>Use <em class="parameter"><code>compression</code></em>
to set the tiff compression. Currently jpeg, packbits,
fax4, lzw, none and deflate are supported. The default is no compression.
JPEG compression is a good lossy compressor for photographs, packbits is
good for 1-bit images, and deflate is the best lossless compression TIFF
can do. </p>
<p>Use <em class="parameter"><code>Q</code></em>
to set the JPEG compression factor. Default 75.</p>
<p>Use <em class="parameter"><code>predictor</code></em>
to set the predictor for lzw and deflate compression. </p>
<p>Predictor is not set by default. There are three predictor values recognised
at the moment (2007, July): 1 is no prediction, 2 is a horizontal
differencing and 3 is a floating point predictor. Refer to the libtiff
specifications for further discussion of various predictors. In short,
predictor helps to better compress image, especially in case of digital
photos or scanned images and bit depths > 8. Try it to find whether it
works for your images.</p>
<p>Use <em class="parameter"><code>profile</code></em>
to give the filename of a profile to be embedded in the TIFF.
This does not affect the pixels which are written, just the way
they are tagged. You can use the special string "none" to mean
"don't attach a profile".</p>
<p>If no profile is specified and the VIPS header
contains an ICC profile named <a class="link" href="libvips-header.html#VIPS-META-ICC-NAME:CAPS" title="VIPS_META_ICC_NAME"><span class="type">VIPS_META_ICC_NAME</span></a>, the
profile from the VIPS header will be attached.</p>
<p>Set <em class="parameter"><code>tile</code></em>
to TRUE to write a tiled tiff. By default tiff are written in
strips. Use <em class="parameter"><code>tile_width</code></em>
and <em class="parameter"><code>tile_height</code></em>
to set the tile size. The defaiult
is 128 by 128.</p>
<p>Set <em class="parameter"><code>pyramid</code></em>
to write the image as a set of images, one per page, of
decreasing size. </p>
<p>Set <em class="parameter"><code>squash</code></em>
to make 8-bit uchar images write as 1-bit TIFFs. Values >128
are written as white, values <=128 as black. Normally vips will write
MINISBLACK TIFFs where black is a 0 bit, but if you set <em class="parameter"><code>miniswhite</code></em>
, it
will use 0 for a white bit. Many pre-press applications only work with
images which use this sense. <em class="parameter"><code>miniswhite</code></em>
only affects one-bit images, it
does nothing for greyscale images. </p>
<p>Use <em class="parameter"><code>resunit</code></em>
to override the default resolution unit.
The default
resolution unit is taken from the header field
<a class="link" href="libvips-header.html#VIPS-META-RESOLUTION-UNIT:CAPS" title="VIPS_META_RESOLUTION_UNIT"><span class="type">VIPS_META_RESOLUTION_UNIT</span></a>. If this field is not set, then
VIPS defaults to cm.</p>
<p>Use <em class="parameter"><code>xres</code></em>
and <em class="parameter"><code>yres</code></em>
to override the default horizontal and vertical
resolutions. By default these values are taken from the VIPS image header.
libvips resolution is always in pixels per millimetre.</p>
<p>Set <em class="parameter"><code>bigtiff</code></em>
to attempt to write a bigtiff.
Bigtiff is a variant of the TIFF
format that allows more than 4GB in a file.</p>
<p>Set <em class="parameter"><code>properties</code></em>
to write all vips metadata to the IMAGEDESCRIPTION tag as
xml. If <em class="parameter"><code>properties</code></em>
is not set, the value of <a class="link" href="libvips-header.html#VIPS-META-IMAGEDESCRIPTION:CAPS" title="VIPS_META_IMAGEDESCRIPTION"><span class="type">VIPS_META_IMAGEDESCRIPTION</span></a> is
used instead.</p>
<p>The value of <a class="link" href="libvips-header.html#VIPS-META-XMP-NAME:CAPS" title="VIPS_META_XMP_NAME"><span class="type">VIPS_META_XMP_NAME</span></a> is written to
the XMP tag. <a class="link" href="libvips-header.html#VIPS-META-ORIENTATION:CAPS" title="VIPS_META_ORIENTATION"><span class="type">VIPS_META_ORIENTATION</span></a> (if set) is used to set the value of
the orientation
tag. <span class="type">VIPS_META_IPCT</span> (if set) is used to set the value of the IPCT tag.
<a class="link" href="libvips-header.html#VIPS-META-PHOTOSHOP-NAME:CAPS" title="VIPS_META_PHOTOSHOP_NAME"><span class="type">VIPS_META_PHOTOSHOP_NAME</span></a> (if set) is used to set the value of the PHOTOSHOP
tag.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-tiffload" title="vips_tiffload ()"><code class="function">vips_tiffload()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-tiffsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-tiffsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-openexrload"></a><h3>vips_openexrload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_openexrload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a OpenEXR file into a VIPS image. </p>
<p>The reader can handle scanline and tiled OpenEXR images. It can't handle
OpenEXR colour management, image attributes, many pixel formats, anything
other than RGBA.</p>
<p>This reader uses the rather limited OpenEXR C API. It should really be
redone in C++.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-openexrload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-openexrload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-fitsload"></a><h3>vips_fitsload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_fitsload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a FITS image file into a VIPS image. </p>
<p>This operation can read images with up to three dimensions. Any higher
dimensions must be empty. </p>
<p>It can read 8, 16 and 32-bit integer images, signed and unsigned, float and
double. </p>
<p>FITS metadata is attached with the "fits-" prefix.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-fitsload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-fitsload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-fitssave"></a><h3>vips_fitssave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_fitssave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Write a VIPS image to a file in FITS format.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-fitssave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-fitssave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-analyzeload"></a><h3>vips_analyzeload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_analyzeload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Load an Analyze 6.0 file. If <em class="parameter"><code>filename</code></em>
is "fred.img", this will look for
an image header called "fred.hdr" and pixel data in "fred.img". You can
also load "fred" or "fred.hdr".</p>
<p>Images are
loaded lazilly and byte-swapped, if necessary. The Analyze metadata is read
and attached.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-analyzeload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-analyzeload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-rawload"></a><h3>vips_rawload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_rawload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code><span class="type">int</span> width</code></em>,
<em class="parameter"><code><span class="type">int</span> height</code></em>,
<em class="parameter"><code><span class="type">int</span> bands</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>offset</code></em>
: <code class="literal">guint64</code>, offset in bytes from start of file</p></li></ul></div>
<p>This operation mmaps the file, setting up <em class="parameter"><code>out</code></em>
so that access to that
image will read from the file. </p>
<p><em class="parameter"><code>out</code></em>
will be a 8-bit uchar image with <em class="parameter"><code>bands</code></em>
image bands, so <em class="parameter"><code>bands</code></em>
can
be thought of as meaning "number of bytes per pixel". Use functions
like <a class="link" href="libvips-conversion.html#vips-copy" title="vips_copy ()"><code class="function">vips_copy()</code></a> to set the exact band format, number of bands,
and so on. Use <a class="link" href="libvips-conversion.html#vips-byteswap" title="vips_byteswap ()"><code class="function">vips_byteswap()</code></a> to reverse the byte ordering. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>, <a class="link" href="libvips-conversion.html#vips-copy" title="vips_copy ()"><code class="function">vips_copy()</code></a>, <a class="link" href="libvips-conversion.html#vips-byteswap" title="vips_byteswap ()"><code class="function">vips_byteswap()</code></a>.</p>
<div class="refsect3">
<a name="vips-rawload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>width of image in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>height of image in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bands</p></td>
<td class="parameter_description"><p>number of image bands</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-rawload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-rawsave"></a><h3>vips_rawsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_rawsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Writes the pixels in <em class="parameter"><code>in</code></em>
to the file <em class="parameter"><code>filename</code></em>
with no header or other
metadata. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-rawsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-rawsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-rawsave-fd"></a><h3>vips_rawsave_fd ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_rawsave_fd (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code><span class="type">int</span> fd</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Writes the pixels in <em class="parameter"><code>in</code></em>
to the <em class="parameter"><code>fd</code></em>
with no header or other
metadata. Handy for implementing other savers.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-rawsave" title="vips_rawsave ()"><code class="function">vips_rawsave()</code></a>.</p>
<div class="refsect3">
<a name="vips-rawsave-fd.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fd</p></td>
<td class="parameter_description"><p>file to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-rawsave-fd.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-csvload"></a><h3>vips_csvload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_csvload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>skip</code></em>
: skip this many lines at start of file</p></li>
<li class="listitem"><p><em class="parameter"><code>lines</code></em>
: read this many lines from file</p></li>
<li class="listitem"><p><em class="parameter"><code>whitespace</code></em>
: set of whitespace characters</p></li>
<li class="listitem"><p><em class="parameter"><code>separator</code></em>
: set of separator characters</p></li>
</ul></div>
<p>Load a CSV (comma-separated values) file. The output image is always 1
band (monochrome), <a class="link" href="VipsImage.html#VIPS-FORMAT-DOUBLE:CAPS"><span class="type">VIPS_FORMAT_DOUBLE</span></a>. Use <a class="link" href="libvips-conversion.html#vips-bandfold" title="vips_bandfold ()"><code class="function">vips_bandfold()</code></a> to turn
RGBRGBRGB mono images into colour iamges. </p>
<p>Items in lines can be either floating point numbers in the C locale, or
strings enclosed in double-quotes ("), or empty.
You can use a <code class="function">backslash()</code> within the quotes to escape special characters,
such as quote marks.</p>
<p>The reader is deliberately rather fussy: it will fail if there are any
short lines, or if the file is too short. It will ignore lines that are
too long.</p>
<p><em class="parameter"><code>skip</code></em>
sets the number of lines to skip at the start of the file.
Default zero.</p>
<p><em class="parameter"><code>lines</code></em>
sets the number of lines to read from the file. Default -1,
meaning read all lines to end of file.</p>
<p><em class="parameter"><code>whitespace</code></em>
sets the skippable whitespace characters.
Default <span class="emphasis"><em>space</em></span>.
Whitespace characters are always run together.</p>
<p><em class="parameter"><code>separator</code></em>
sets the characters that separate fields.
Default ;,<span class="emphasis"><em>tab</em></span>. Separators are never run together.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>, <a class="link" href="libvips-conversion.html#vips-bandfold" title="vips_bandfold ()"><code class="function">vips_bandfold()</code></a>.</p>
<div class="refsect3">
<a name="vips-csvload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-csvload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-csvsave"></a><h3>vips_csvsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_csvsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>separator</code></em>
: separator string</p></li></ul></div>
<p>Writes the pixels in <em class="parameter"><code>in</code></em>
to the <em class="parameter"><code>filename</code></em>
as CSV (comma-separated values).
The image is written
one line of text per scanline. Complex numbers are written as
"(real,imaginary)" and will need extra parsing I guess. Only the first band
is written. </p>
<p><em class="parameter"><code>separator</code></em>
gives the string to use to separate numbers in the output.
The default is "\t" (tab).</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-csvsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-csvsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-matrixload"></a><h3>vips_matrixload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_matrixload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Reads a matrix from a file.</p>
<p>Matrix files have a simple format that's supposed to be easy to create with
a text editor or a spreadsheet. </p>
<p>The first line has four numbers for width, height, scale and
offset (scale and offset may be omitted, in which case they default to 1.0
and 0.0). Scale must be non-zero. Width and height must be positive
integers. The numbers are separated by any mixture of spaces, commas,
tabs and quotation marks ("). The scale and offset fields may be
floating-point, and must use '.'
as a decimal separator.</p>
<p>Subsequent lines each hold one row of matrix data, with numbers again
separated by any mixture of spaces, commas,
tabs and quotation marks ("). The numbers may be floating-point, and must
use '.'
as a decimal separator.</p>
<p>Extra characters at the ends of lines or at the end of the file are
ignored.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-csvload" title="vips_csvload ()"><code class="function">vips_csvload()</code></a>.</p>
<div class="refsect3">
<a name="vips-matrixload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-matrixload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-matrixsave"></a><h3>vips_matrixsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_matrixsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Write <em class="parameter"><code>in</code></em>
to <em class="parameter"><code>filename</code></em>
in matrix format. See <a class="link" href="VipsForeignSave.html#vips-matrixload" title="vips_matrixload ()"><code class="function">vips_matrixload()</code></a> for a
description of the format.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-matrixload" title="vips_matrixload ()"><code class="function">vips_matrixload()</code></a>.</p>
<div class="refsect3">
<a name="vips-matrixsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-matrixsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-matrixprint"></a><h3>vips_matrixprint ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_matrixprint (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Print <em class="parameter"><code>in</code></em>
to <code class="literal">stdout</code> in matrix format. See <a class="link" href="VipsForeignSave.html#vips-matrixload" title="vips_matrixload ()"><code class="function">vips_matrixload()</code></a> for a
description of the format.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-matrixload" title="vips_matrixload ()"><code class="function">vips_matrixload()</code></a>.</p>
<div class="refsect3">
<a name="vips-matrixprint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to print </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-matrixprint.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-magickload"></a><h3>vips_magickload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_magickload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>all_frames</code></em>
: <code class="literal">gboolean</code>, load all frames in sequence</p></li>
<li class="listitem"><p><em class="parameter"><code>density</code></em>
: string, canvas resolution for rendering vector formats like SVG</p></li>
</ul></div>
<p>Read in an image using libMagick, the ImageMagick library. This library can
read more than 80 file formats, including SVG, BMP, EPS, DICOM and many
others.
The reader can handle any ImageMagick image, including the float and double
formats. It will work with any quantum size, including HDR. Any metadata
attached to the libMagick image is copied on to the VIPS image.</p>
<p>The reader should also work with most versions of GraphicsMagick. See the
"--with-magickpackage" configure option.</p>
<p>Normally it will only load the first image in a many-image sequence (such
as a GIF). Set <em class="parameter"><code>all_frames</code></em>
to true to read the whole image sequence. </p>
<p><em class="parameter"><code>density</code></em>
is "WxH" in DPI, e.g. "600x300" or "600" (default is "72x72"). See
the <a class="ulink" href="http://www.imagemagick.org/script/command-line-options.php#density" target="_top">density
docs</a>
on the imagemagick website.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-magickload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-magickload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-magickload-buffer"></a><h3>vips_magickload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_magickload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>all_frames</code></em>
: <code class="literal">gboolean</code>, load all frames in sequence</p></li>
<li class="listitem"><p><em class="parameter"><code>density</code></em>
: string, canvas resolution for rendering vector formats like SVG</p></li>
</ul></div>
<p>Read an image memory block using libMagick into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-magickload" title="vips_magickload ()"><code class="function">vips_magickload()</code></a>, but read from a memory source. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-magickload" title="vips_magickload ()"><code class="function">vips_magickload()</code></a>.</p>
<div class="refsect3">
<a name="vips-magickload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-magickload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-pngload"></a><h3>vips_pngload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_pngload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a PNG file into a VIPS image. It can read all png images, including 8-
and 16-bit images, 1 and 3 channel, with and without an alpha channel.</p>
<p>Any ICC profile is read and attached to the VIPS image.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-pngload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>decompressed image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-pngload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-pngload-buffer"></a><h3>vips_pngload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_pngload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a PNG-formatted memory block into a VIPS image. It can read all png
images, including 8- and 16-bit images, 1 and 3 channel, with and without
an alpha channel.</p>
<p>Any ICC profile is read and attached to the VIPS image.</p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-pngload" title="vips_pngload ()"><code class="function">vips_pngload()</code></a>.</p>
<div class="refsect3">
<a name="vips-pngload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-pngload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-pngsave"></a><h3>vips_pngsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_pngsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>compression</code></em>
: compression level</p></li>
<li class="listitem"><p><em class="parameter"><code>interlace</code></em>
: interlace image</p></li>
<li class="listitem"><p><em class="parameter"><code>profile</code></em>
: ICC profile to embed</p></li>
<li class="listitem"><p><em class="parameter"><code>filter</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignPngFilter" title="enum VipsForeignPngFilter"><span class="type">VipsForeignPngFilter</span></a> row filter flag(s)</p></li>
</ul></div>
<p>Write a VIPS image to a file as PNG.</p>
<p><em class="parameter"><code>compression</code></em>
means compress with this much effort (0 - 9). Default 6.</p>
<p>Set <em class="parameter"><code>interlace</code></em>
to <code class="literal">TRUE</code> to interlace the image with ADAM7
interlacing. Beware
than an interlaced PNG can be up to 7 times slower to write than a
non-interlaced image.</p>
<p>Use <em class="parameter"><code>profile</code></em>
to give the filename of a profile to be embedded in the PNG.
This does not affect the pixels which are written, just the way
they are tagged. You can use the special string "none" to mean
"don't attach a profile".</p>
<p>If <em class="parameter"><code>profile</code></em>
is specified and the VIPS header
contains an ICC profile named VIPS_META_ICC_NAME ("icc-profile-data"), the
profile from the VIPS header will be attached.</p>
<p>Use <em class="parameter"><code>filter</code></em>
to specify one or more filters (instead of adaptive filtering),
see <a class="link" href="VipsForeignSave.html#VipsForeignPngFilter" title="enum VipsForeignPngFilter"><span class="type">VipsForeignPngFilter</span></a>. </p>
<p>The image is automatically converted to RGB, RGBA, Monochrome or Mono +
alpha before saving. Images with more than one byte per band element are
saved as 16-bit PNG, others are saved as 8-bit PNG.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-pngsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-pngsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-pngsave-buffer"></a><h3>vips_pngsave_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_pngsave_buffer (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code><span class="type">void</span> **buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *len</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>compression</code></em>
: compression level</p></li>
<li class="listitem"><p><em class="parameter"><code>interlace</code></em>
: interlace image</p></li>
<li class="listitem"><p><em class="parameter"><code>profile</code></em>
: ICC profile to embed</p></li>
<li class="listitem"><p><em class="parameter"><code>filter</code></em>
: libpng row filter flag(s)</p></li>
</ul></div>
<p>As <a class="link" href="VipsForeignSave.html#vips-pngsave" title="vips_pngsave ()"><code class="function">vips_pngsave()</code></a>, but save to a memory buffer. </p>
<p>The address of the buffer is returned in <em class="parameter"><code>buf</code></em>
, the length of the buffer in
<em class="parameter"><code>len</code></em>
. You are responsible for freeing the buffer with <code class="function">g_free()</code> when you
are done with it.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-pngsave" title="vips_pngsave ()"><code class="function">vips_pngsave()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-pngsave-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>return output buffer here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>return output length here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-pngsave-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-ppmload"></a><h3>vips_ppmload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_ppmload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a PPM/PBM/PGM/PFM file into a VIPS image. </p>
<p>It can read 1, 8, 16 and 32 bit images, colour or monochrome,
stored in binary or in ASCII. One bit images become 8 bit VIPS images,
with 0 and 255 for 0 and 1.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-ppmload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-ppmload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-ppmsave"></a><h3>vips_ppmsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_ppmsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>ascii</code></em>
: save as ASCII rather than binary</p></li>
<li class="listitem"><p><em class="parameter"><code>squash</code></em>
: squash 8-bit images down to one bit</p></li>
</ul></div>
<p>Write a VIPS image to a file as PPM. It can write 1, 8, 16 or
32 bit unsigned integer images, float images, colour or monochrome,
stored as binary or ASCII.
Integer images of more than 8 bits can only be stored in ASCII.</p>
<p>When writing float (PFM) images the scale factor is set from the
"pfm-scale" metadata.</p>
<p>Set <em class="parameter"><code>ascii</code></em>
to <code class="literal">TRUE</code> to write as human-readable ASCII. Normally data is
written in binary. </p>
<p>Set <em class="parameter"><code>squash</code></em>
to <code class="literal">TRUE</code> to squash 8-bit images down to one bit. The saver does
no dithering, that's up to you.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-ppmsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-ppmsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-matload"></a><h3>vips_matload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_matload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a Matlab save file into a VIPS image. </p>
<p>This operation searches the save
file for the first array variable with between 1 and 3 dimensions and loads
it as an image. It will not handle complex images. It does not handle
sparse matrices. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-matload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-matload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-radload"></a><h3>vips_radload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_radload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Read a Radiance (HDR) file into a VIPS image. </p>
<p>Radiance files are read as <a class="link" href="VipsImage.html#VIPS-CODING-RAD:CAPS"><span class="type">VIPS_CODING_RAD</span></a>. They have one byte for each of
red, green and blue, and one byte of shared exponent. Some operations (like
<a class="link" href="libvips-conversion.html#vips-extract-area" title="vips_extract_area ()"><code class="function">vips_extract_area()</code></a>) can work directly with images in this format, but
mmany (all the arithmetic operations, for example) will not. Unpack
<a class="link" href="VipsImage.html#VIPS-CODING-RAD:CAPS"><span class="type">VIPS_CODING_RAD</span></a> images to 3 band float with <a class="link" href="libvips-colour.html#vips-rad2float" title="vips_rad2float ()"><code class="function">vips_rad2float()</code></a> if
you want to do arithmetic on them.</p>
<p>This operation ignores some header fields, like VIEW and DATE. It will not
rotate/flip as the FORMAT string asks.</p>
<p>Sections of this reader from Greg Ward and Radiance with kind permission. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-radload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-radload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-radsave"></a><h3>vips_radsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_radsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Write a VIPS image in Radiance (HDR) format.</p>
<p>Sections of this reader from Greg Ward and Radiance with kind permission. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-radsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-radsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-radsave-buffer"></a><h3>vips_radsave_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_radsave_buffer (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code><span class="type">void</span> **buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *len</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>As <a class="link" href="VipsForeignSave.html#vips-radsave" title="vips_radsave ()"><code class="function">vips_radsave()</code></a>, but save to a memory buffer. </p>
<p>The address of the buffer is returned in <em class="parameter"><code>buf</code></em>
, the length of the buffer in
<em class="parameter"><code>len</code></em>
. You are responsible for freeing the buffer with <code class="function">g_free()</code> when you
are done with it.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-radsave" title="vips_radsave ()"><code class="function">vips_radsave()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()"><code class="function">vips_image_write_to_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-radsave-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>return output buffer here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>return output length here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-radsave-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-pdfload"></a><h3>vips_pdfload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_pdfload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>page</code></em>
: <code class="literal">gint</code>, load this page, numbered from zero</p></li>
<li class="listitem"><p><em class="parameter"><code>n</code></em>
: <code class="literal">gint</code>, load this many pages</p></li>
<li class="listitem"><p><em class="parameter"><code>dpi</code></em>
: <code class="literal">gdouble</code>, render at this DPI</p></li>
<li class="listitem"><p><em class="parameter"><code>scale</code></em>
: <code class="literal">gdouble</code>, scale render by this factor</p></li>
</ul></div>
<p>Render a PDF file into a VIPS image. Rendering uses the libpoppler library
and should be fast. </p>
<p>The output image is always RGBA --- CMYK PDFs will be
converted. If you need CMYK bitmaps, you should use <a class="link" href="VipsForeignSave.html#vips-magickload" title="vips_magickload ()"><code class="function">vips_magickload()</code></a>
instead.</p>
<p>Rendering is progressive, that is, the image is rendered in strips equal in
height to the tile height. If your PDF contains large image files and
they span several strips in the output image, they will be decoded multiple
times. To fix this, increase the the tile height, for example:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting">vips copy huge<span class="gtkdoc opt">.</span>pdf x<span class="gtkdoc opt">.</span>png <span class="gtkdoc opt">--</span>vips<span class="gtkdoc opt">-</span>tile<span class="gtkdoc opt">-</span>height<span class="gtkdoc opt">=</span><span class="number">1024</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>Will process images in 1024-pixel high strips, potentially much faster,
though of course also using a lot more memory.</p>
<p>Use <em class="parameter"><code>page</code></em>
to select a page to render, numbering from zero.</p>
<p>Use <em class="parameter"><code>n</code></em>
to select the number of pages to render. The default is 1. Pages are
rendered in a vertical column, with each individual page aligned to the
left. Set to -1 to mean "until the end of the document". Use <a class="link" href="libvips-conversion.html#vips-grid" title="vips_grid ()"><code class="function">vips_grid()</code></a>
to change page layout.</p>
<p>Use <em class="parameter"><code>dpi</code></em>
to set the rendering resolution. The default is 72. Alternatively,
you can scale the rendering from the default 1 point == 1 pixel by
setting <em class="parameter"><code>scale</code></em>
.</p>
<p>The operation fills a number of header fields with metadata, for example
"pdf-author". They may be useful. </p>
<p>This function only reads the image header and does not render any pixel
data. Rendering occurs when pixels are accessed.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>, <a class="link" href="VipsForeignSave.html#vips-magickload" title="vips_magickload ()"><code class="function">vips_magickload()</code></a>.</p>
<div class="refsect3">
<a name="vips-pdfload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-pdfload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-pdfload-buffer"></a><h3>vips_pdfload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_pdfload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>page</code></em>
: <code class="literal">gint</code>, load this page, numbered from zero</p></li>
<li class="listitem"><p><em class="parameter"><code>n</code></em>
: <code class="literal">gint</code>, load this many pages</p></li>
<li class="listitem"><p><em class="parameter"><code>dpi</code></em>
: <code class="literal">gdouble</code>, render at this DPI</p></li>
<li class="listitem"><p><em class="parameter"><code>scale</code></em>
: <code class="literal">gdouble</code>, scale render by this factor</p></li>
</ul></div>
<p>Read a PDF-formatted memory block into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-pdfload" title="vips_pdfload ()"><code class="function">vips_pdfload()</code></a>, but read from a memory buffer. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-pdfload" title="vips_pdfload ()"><code class="function">vips_pdfload()</code></a>.</p>
<div class="refsect3">
<a name="vips-pdfload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-pdfload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-svgload"></a><h3>vips_svgload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_svgload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>dpi</code></em>
: <code class="literal">gdouble</code>, render at this DPI</p></li>
<li class="listitem"><p><em class="parameter"><code>scale</code></em>
: <code class="literal">gdouble</code>, scale render by this factor</p></li>
</ul></div>
<p>Render a SVG file into a VIPS image. Rendering uses the librsvg library
and should be fast.</p>
<p>Use <em class="parameter"><code>dpi</code></em>
to set the rendering resolution. The default is 72. Alternatively,
you can scale the rendering from the default 1 point == 1 pixel by <em class="parameter"><code>scale</code></em>
.</p>
<p>This function only reads the image header and does not render any pixel
data. Rendering occurs when pixels are accessed.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-svgload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-svgload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-svgload-buffer"></a><h3>vips_svgload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_svgload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>dpi</code></em>
: <code class="literal">gdouble</code>, render at this DPI</p></li>
<li class="listitem"><p><em class="parameter"><code>scale</code></em>
: <code class="literal">gdouble</code>, scale render by this factor</p></li>
</ul></div>
<p>Read a SVG-formatted memory block into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-svgload" title="vips_svgload ()"><code class="function">vips_svgload()</code></a>, but read from a memory buffer. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-svgload" title="vips_svgload ()"><code class="function">vips_svgload()</code></a>.</p>
<div class="refsect3">
<a name="vips-svgload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-svgload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-gifload"></a><h3>vips_gifload ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_gifload (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>page</code></em>
: <code class="literal">gint</code>, page (frame) to read</p></li></ul></div>
<p>Read a GIF file into a VIPS image. Rendering uses the giflib library.</p>
<p>Use <em class="parameter"><code>page</code></em>
to set page number (frame number) to read.</p>
<p>The whole GIF is rendered into memory on header access. The output image
will be 1, 2, 3 or 4 bands depending on what the reader finds in the file. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()"><code class="function">vips_image_new_from_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-gifload.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>output image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-gifload.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-gifload-buffer"></a><h3>vips_gifload_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_gifload_buffer (<em class="parameter"><code><span class="type">void</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>page</code></em>
: <code class="literal">gint</code>, page (frame) to read</p></li></ul></div>
<p>Read a GIF-formatted memory block into a VIPS image. Exactly as
<a class="link" href="VipsForeignSave.html#vips-gifload" title="vips_gifload ()"><code class="function">vips_gifload()</code></a>, but read from a memory buffer. </p>
<p>You must not free the buffer while <em class="parameter"><code>out</code></em>
is active. The
<a class="link" href="VipsObject.html#VipsObject-postclose" title="The “postclose” signal"><span class="type">“postclose”</span></a> signal on <em class="parameter"><code>out</code></em>
is a good place to free. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-gifload" title="vips_gifload ()"><code class="function">vips_gifload()</code></a>.</p>
<div class="refsect3">
<a name="vips-gifload-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>memory area to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>size of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-gifload-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-dzsave"></a><h3>vips_dzsave ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_dzsave (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *in</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Optional arguments:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><em class="parameter"><code>layout</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignDzLayout" title="enum VipsForeignDzLayout"><span class="type">VipsForeignDzLayout</span></a> directory layout convention</p></li>
<li class="listitem"><p><em class="parameter"><code>suffix</code></em>
: suffix for tile tiles </p></li>
<li class="listitem"><p><em class="parameter"><code>overlap</code></em>
: <code class="literal">gint</code> set tile overlap </p></li>
<li class="listitem"><p><em class="parameter"><code>tile_size</code></em>
: <code class="literal">gint</code> set tile size </p></li>
<li class="listitem"><p><em class="parameter"><code>background</code></em>
: <a class="link" href="libvips-type.html#VipsArrayDouble"><span class="type">VipsArrayDouble</span></a> background colour</p></li>
<li class="listitem"><p><em class="parameter"><code>depth</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignDzDepth" title="enum VipsForeignDzDepth"><span class="type">VipsForeignDzDepth</span></a> how deep to make the pyramid</p></li>
<li class="listitem"><p><em class="parameter"><code>centre</code></em>
: <code class="literal">gboolean</code> centre the tiles </p></li>
<li class="listitem"><p><em class="parameter"><code>angle</code></em>
: <a class="link" href="libvips-conversion.html#VipsAngle" title="enum VipsAngle"><span class="type">VipsAngle</span></a> rotate the image by this much</p></li>
<li class="listitem"><p><em class="parameter"><code>container</code></em>
: <a class="link" href="VipsForeignSave.html#VipsForeignDzContainer" title="enum VipsForeignDzContainer"><span class="type">VipsForeignDzContainer</span></a> set container type</p></li>
<li class="listitem"><p><em class="parameter"><code>properties</code></em>
: <code class="literal">gboolean</code> write a properties file</p></li>
<li class="listitem"><p><em class="parameter"><code>compression</code></em>
: <code class="literal">gint</code> zip deflate compression level</p></li>
</ul></div>
<p>Save an image as a set of tiles at various resolutions. By default dzsave
uses DeepZoom layout -- use <em class="parameter"><code>layout</code></em>
to pick other conventions.</p>
<p>vips_dzsave() creates a directory called <em class="parameter"><code>name</code></em>
to hold the tiles. If <em class="parameter"><code>name</code></em>
ends <code class="literal">.zip</code>, <a class="link" href="VipsForeignSave.html#vips-dzsave" title="vips_dzsave ()"><code class="function">vips_dzsave()</code></a> will create a zip file called <em class="parameter"><code>name</code></em>
to hold the
tiles. You can use <em class="parameter"><code>container</code></em>
to force zip file output. </p>
<p>You can set <em class="parameter"><code>suffix</code></em>
to something like <code class="literal">".jpg[Q=85]"</code> to control the tile
write options. </p>
<p>In Google layout mode, edge tiles are expanded to <em class="parameter"><code>tile_size</code></em>
by <em class="parameter"><code>tile_size</code></em>
pixels. Normally they are filled with white, but you can set another colour
with <em class="parameter"><code>background</code></em>
. Images are usually placed at the top-left of the tile,
but you can have them centred by turning on <em class="parameter"><code>centre</code></em>
. </p>
<p>You can set the size and overlap of tiles with <em class="parameter"><code>tile_size</code></em>
and <em class="parameter"><code>overlap</code></em>
.
They default to the correct settings for the selected <em class="parameter"><code>layout</code></em>
. The deepzoom
defaults produce 256x256 jpeg files for centre tiles, the most efficient
size.</p>
<p>Use <em class="parameter"><code>depth</code></em>
to control how low the pyramid goes. This defaults to the
correct setting for the <em class="parameter"><code>layout</code></em>
you select.</p>
<p>If <em class="parameter"><code>properties</code></em>
is <code class="literal">TRUE</code>, <a class="link" href="VipsForeignSave.html#vips-dzsave" title="vips_dzsave ()"><code class="function">vips_dzsave()</code></a> will write a file called
<code class="literal">vips-properties.xml</code> to the output directory. This file lists all of the
metadata attached to <em class="parameter"><code>in</code></em>
in an obvious manner. It can be useful for viewing
programs which wish to use fields from source files loaded via
<a class="link" href="VipsForeignSave.html#vips-openslideload" title="vips_openslideload ()"><code class="function">vips_openslideload()</code></a>. </p>
<p>If <em class="parameter"><code>container</code></em>
is set to <code class="literal">zip</code>, you can set a compression level from -1
(use zlib default), 0 (store, compression disabled) to 9 (max compression).
If no value is given, the default is to store files without compression.</p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-tiffsave" title="vips_tiffsave ()"><code class="function">vips_tiffsave()</code></a>.</p>
<div class="refsect3">
<a name="vips-dzsave.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>image to save </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name to save to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list of optional named arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-dzsave.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="VipsForeignSave.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="VipsForeignFlags"></a><h3>enum VipsForeignFlags</h3>
<p>Some hints about the image loader.</p>
<p><a class="link" href="VipsForeignSave.html#VIPS-FOREIGN-PARTIAL:CAPS"><span class="type">VIPS_FOREIGN_PARTIAL</span></a> means that the image can be read directly from the
file without needing to be unpacked to a temporary image first. </p>
<p><a class="link" href="VipsForeignSave.html#VIPS-FOREIGN-SEQUENTIAL:CAPS"><span class="type">VIPS_FOREIGN_SEQUENTIAL</span></a> means that the loader supports lazy reading, but
only top-to-bottom (sequential) access. Formats like PNG can read sets of
scanlines, for example, but only in order. </p>
<p>If neither PARTIAL or SEQUENTIAL is set, the loader only supports whole
image read. Setting both PARTIAL and SEQUENTIAL is an error.</p>
<p><a class="link" href="VipsForeignSave.html#VIPS-FOREIGN-BIGENDIAN:CAPS"><span class="type">VIPS_FOREIGN_BIGENDIAN</span></a> means that image pixels are most-significant byte
first. Depending on the native byte order of the host machine, you may
need to swap bytes. See <a class="link" href="libvips-conversion.html#vips-copy" title="vips_copy ()"><code class="function">vips_copy()</code></a>.</p>
<div class="refsect3">
<a name="VipsForeignFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-NONE:CAPS"></a>VIPS_FOREIGN_NONE</p></td>
<td class="enum_member_description">
<p>no flags set</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PARTIAL:CAPS"></a>VIPS_FOREIGN_PARTIAL</p></td>
<td class="enum_member_description">
<p>the image may be read lazilly</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-BIGENDIAN:CAPS"></a>VIPS_FOREIGN_BIGENDIAN</p></td>
<td class="enum_member_description">
<p>image pixels are most-significant byte first</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-SEQUENTIAL:CAPS"></a>VIPS_FOREIGN_SEQUENTIAL</p></td>
<td class="enum_member_description">
<p>top-to-bottom lazy reading</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-ALL:CAPS"></a>VIPS_FOREIGN_ALL</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsSaveable"></a><h3>enum VipsSaveable</h3>
<p>See also: <a class="link" href="VipsForeignSave.html" title="VipsForeignSave"><span class="type">VipsForeignSave</span></a>.</p>
<div class="refsect3">
<a name="VipsSaveable.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-MONO:CAPS"></a>VIPS_SAVEABLE_MONO</p></td>
<td class="enum_member_description">
<p>1 band (eg. CSV)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-RGB:CAPS"></a>VIPS_SAVEABLE_RGB</p></td>
<td class="enum_member_description">
<p>1 or 3 bands (eg. PPM) </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-RGBA:CAPS"></a>VIPS_SAVEABLE_RGBA</p></td>
<td class="enum_member_description">
<p>1, 2, 3 or 4 bands (eg. PNG)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-RGBA-ONLY:CAPS"></a>VIPS_SAVEABLE_RGBA_ONLY</p></td>
<td class="enum_member_description">
<p>3 or 4 bands (eg. WEBP)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-RGB-CMYK:CAPS"></a>VIPS_SAVEABLE_RGB_CMYK</p></td>
<td class="enum_member_description">
<p>1, 3 or 4 bands (eg. JPEG)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-ANY:CAPS"></a>VIPS_SAVEABLE_ANY</p></td>
<td class="enum_member_description">
<p>any number of bands (eg. TIFF)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-SAVEABLE-LAST:CAPS"></a>VIPS_SAVEABLE_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignWebpPreset"></a><h3>enum VipsForeignWebpPreset</h3>
<p>Tune lossy encoder settings for different image types.</p>
<div class="refsect3">
<a name="VipsForeignWebpPreset.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-DEFAULT:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_DEFAULT</p></td>
<td class="enum_member_description">
<p>default preset</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-PICTURE:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_PICTURE</p></td>
<td class="enum_member_description">
<p>digital picture, like portrait, inner shot</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-PHOTO:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_PHOTO</p></td>
<td class="enum_member_description">
<p>outdoor photograph, with natural lighting</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-DRAWING:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_DRAWING</p></td>
<td class="enum_member_description">
<p>hand or line drawing, with high-contrast details</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-ICON:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_ICON</p></td>
<td class="enum_member_description">
<p>small-sized colorful images</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-TEXT:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_TEXT</p></td>
<td class="enum_member_description">
<p>text-like</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-WEBP-PRESET-LAST:CAPS"></a>VIPS_FOREIGN_WEBP_PRESET_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignTiffCompression"></a><h3>enum VipsForeignTiffCompression</h3>
<p>The compression types supported by the tiff writer.</p>
<p>Use <em class="parameter"><code>Q</code></em>
to set the jpeg compression level, default 75.</p>
<p>Use <em class="parameter"><code>prediction</code></em>
to set the lzw or deflate prediction, default none.</p>
<div class="refsect3">
<a name="VipsForeignTiffCompression.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-NONE:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_NONE</p></td>
<td class="enum_member_description">
<p>no compression</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-JPEG:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_JPEG</p></td>
<td class="enum_member_description">
<p>jpeg compression</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-DEFLATE:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_DEFLATE</p></td>
<td class="enum_member_description">
<p>deflate (zip) compression</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-PACKBITS:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_PACKBITS</p></td>
<td class="enum_member_description">
<p>packbits compression</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-CCITTFAX4:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_CCITTFAX4</p></td>
<td class="enum_member_description">
<p>fax4 compression</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-LZW:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_LZW</p></td>
<td class="enum_member_description">
<p>LZW compression</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-COMPRESSION-LAST:CAPS"></a>VIPS_FOREIGN_TIFF_COMPRESSION_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignTiffPredictor"></a><h3>enum VipsForeignTiffPredictor</h3>
<p>The predictor can help deflate and lzw compression. The values are fixed by
the tiff library.</p>
<div class="refsect3">
<a name="VipsForeignTiffPredictor.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-PREDICTOR-NONE:CAPS"></a>VIPS_FOREIGN_TIFF_PREDICTOR_NONE</p></td>
<td class="enum_member_description">
<p>no prediction</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-PREDICTOR-HORIZONTAL:CAPS"></a>VIPS_FOREIGN_TIFF_PREDICTOR_HORIZONTAL</p></td>
<td class="enum_member_description">
<p>horizontal differencing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-PREDICTOR-FLOAT:CAPS"></a>VIPS_FOREIGN_TIFF_PREDICTOR_FLOAT</p></td>
<td class="enum_member_description">
<p>float predictor</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-PREDICTOR-LAST:CAPS"></a>VIPS_FOREIGN_TIFF_PREDICTOR_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignTiffResunit"></a><h3>enum VipsForeignTiffResunit</h3>
<p>Use inches or centimeters as the resolution unit for a tiff file.</p>
<div class="refsect3">
<a name="VipsForeignTiffResunit.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-RESUNIT-CM:CAPS"></a>VIPS_FOREIGN_TIFF_RESUNIT_CM</p></td>
<td class="enum_member_description">
<p>use centimeters</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-RESUNIT-INCH:CAPS"></a>VIPS_FOREIGN_TIFF_RESUNIT_INCH</p></td>
<td class="enum_member_description">
<p>use inches</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-TIFF-RESUNIT-LAST:CAPS"></a>VIPS_FOREIGN_TIFF_RESUNIT_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignPngFilter"></a><h3>enum VipsForeignPngFilter</h3>
<p>http://www.w3.org/TR/PNG-Filters.html
The values mirror those of png.h in libpng.</p>
<div class="refsect3">
<a name="VipsForeignPngFilter.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PNG-FILTER-NONE:CAPS"></a>VIPS_FOREIGN_PNG_FILTER_NONE</p></td>
<td class="enum_member_description">
<p>no filtering</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PNG-FILTER-SUB:CAPS"></a>VIPS_FOREIGN_PNG_FILTER_SUB</p></td>
<td class="enum_member_description">
<p>difference to the left</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PNG-FILTER-UP:CAPS"></a>VIPS_FOREIGN_PNG_FILTER_UP</p></td>
<td class="enum_member_description">
<p>difference up</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PNG-FILTER-AVG:CAPS"></a>VIPS_FOREIGN_PNG_FILTER_AVG</p></td>
<td class="enum_member_description">
<p>average of left and up</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PNG-FILTER-PAETH:CAPS"></a>VIPS_FOREIGN_PNG_FILTER_PAETH</p></td>
<td class="enum_member_description">
<p>pick best neighbor predictor automatically</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-PNG-FILTER-ALL:CAPS"></a>VIPS_FOREIGN_PNG_FILTER_ALL</p></td>
<td class="enum_member_description">
<p>adaptive</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignDzLayout"></a><h3>enum VipsForeignDzLayout</h3>
<p>What directory layout and metadata standard to use.</p>
<div class="refsect3">
<a name="VipsForeignDzLayout.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-LAYOUT-DZ:CAPS"></a>VIPS_FOREIGN_DZ_LAYOUT_DZ</p></td>
<td class="enum_member_description">
<p>use DeepZoom directory layout</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-LAYOUT-ZOOMIFY:CAPS"></a>VIPS_FOREIGN_DZ_LAYOUT_ZOOMIFY</p></td>
<td class="enum_member_description">
<p>use Zoomify directory layout</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-LAYOUT-GOOGLE:CAPS"></a>VIPS_FOREIGN_DZ_LAYOUT_GOOGLE</p></td>
<td class="enum_member_description">
<p>use Google maps directory layout</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-LAYOUT-LAST:CAPS"></a>VIPS_FOREIGN_DZ_LAYOUT_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignDzDepth"></a><h3>enum VipsForeignDzDepth</h3>
<p>How many pyramid layers to create.</p>
<div class="refsect3">
<a name="VipsForeignDzDepth.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-DEPTH-ONEPIXEL:CAPS"></a>VIPS_FOREIGN_DZ_DEPTH_ONEPIXEL</p></td>
<td class="enum_member_description">
<p>create layers down to 1x1 pixel</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-DEPTH-ONETILE:CAPS"></a>VIPS_FOREIGN_DZ_DEPTH_ONETILE</p></td>
<td class="enum_member_description">
<p>create layers down to 1x1 tile</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-DEPTH-ONE:CAPS"></a>VIPS_FOREIGN_DZ_DEPTH_ONE</p></td>
<td class="enum_member_description">
<p>only create a single layer</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-DEPTH-LAST:CAPS"></a>VIPS_FOREIGN_DZ_DEPTH_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignDzContainer"></a><h3>enum VipsForeignDzContainer</h3>
<p>How many pyramid layers to create.</p>
<div class="refsect3">
<a name="VipsForeignDzContainer.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-CONTAINER-FS:CAPS"></a>VIPS_FOREIGN_DZ_CONTAINER_FS</p></td>
<td class="enum_member_description">
<p>write tiles to the filesystem</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-CONTAINER-ZIP:CAPS"></a>VIPS_FOREIGN_DZ_CONTAINER_ZIP</p></td>
<td class="enum_member_description">
<p>write tiles to a zip file</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FOREIGN-DZ-CONTAINER-LAST:CAPS"></a>VIPS_FOREIGN_DZ_CONTAINER_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="VipsForeignSave.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="VipsForeignLoad--access"></a><h3>The <code class="literal">“access”</code> property</h3>
<pre class="programlisting"> “access” <a class="link" href="VipsImage.html#VipsAccess" title="enum VipsAccess"><span class="type">VipsAccess</span></a></pre>
<p>Required access pattern for this file.</p>
<p>Flags: Read / Write</p>
<p>Default value: VIPS_ACCESS_RANDOM</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignLoad--disc"></a><h3>The <code class="literal">“disc”</code> property</h3>
<pre class="programlisting"> “disc” <span class="type">gboolean</span></pre>
<p>Open to disc.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignLoad--flags"></a><h3>The <code class="literal">“flags”</code> property</h3>
<pre class="programlisting"> “flags” <a class="link" href="VipsForeignSave.html#VipsForeignFlags" title="enum VipsForeignFlags"><span class="type">VipsForeignFlags</span></a></pre>
<p>Flags for this file.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignLoad--out"></a><h3>The <code class="literal">“out”</code> property</h3>
<pre class="programlisting"> “out” <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *</pre>
<p>Output image.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignLoad--sequential"></a><h3>The <code class="literal">“sequential”</code> property</h3>
<pre class="programlisting"> “sequential” <span class="type">gboolean</span></pre>
<p>Sequential read only.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignSave--background"></a><h3>The <code class="literal">“background”</code> property</h3>
<pre class="programlisting"> “background” <a class="link" href="libvips-type.html#VipsArrayDouble"><span class="type">VipsArrayDouble</span></a> *</pre>
<p>Background value.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignSave--in"></a><h3>The <code class="literal">“in”</code> property</h3>
<pre class="programlisting"> “in” <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *</pre>
<p>Image to save.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsForeignSave--strip"></a><h3>The <code class="literal">“strip”</code> property</h3>
<pre class="programlisting"> “strip” <span class="type">gboolean</span></pre>
<p>Strip all metadata from image.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="VipsForeignSave.see-also"></a><h2>See Also</h2>
image
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|