This file is indexed.

/usr/share/gtk-doc/html/libvips/VipsImage.html is in libvips-doc 8.4.5-1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VipsImage: 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="ch02.html" title="Core VIPS API">
<link rel="prev" href="libvips-vips.html" title="vips">
<link rel="next" href="libvips-header.html" title="header">
<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="#VipsImage.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#VipsImage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#VipsImage.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#VipsImage.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libvips-vips.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libvips-header.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="VipsImage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="VipsImage.top_of_page"></a>VipsImage</span></h2>
<p>VipsImage — the VIPS image class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="VipsImage.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="VipsImage.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">
<span class="c_punctuation">(</span><a class="link" href="VipsImage.html#VipsStartFn" title="VipsStartFn ()">*VipsStartFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="VipsImage.html#VipsGenerateFn" title="VipsGenerateFn ()">*VipsGenerateFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="VipsImage.html#VipsStopFn" title="VipsStopFn ()">*VipsStopFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-IMAGE-SIZEOF-ELEMENT:CAPS" title="VIPS_IMAGE_SIZEOF_ELEMENT()">VIPS_IMAGE_SIZEOF_ELEMENT</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-IMAGE-SIZEOF-PEL:CAPS" title="VIPS_IMAGE_SIZEOF_PEL()">VIPS_IMAGE_SIZEOF_PEL</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-IMAGE-SIZEOF-LINE:CAPS" title="VIPS_IMAGE_SIZEOF_LINE()">VIPS_IMAGE_SIZEOF_LINE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-IMAGE-N-ELEMENTS:CAPS" title="VIPS_IMAGE_N_ELEMENTS()">VIPS_IMAGE_N_ELEMENTS</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-IMAGE-N-PELS:CAPS" title="VIPS_IMAGE_N_PELS()">VIPS_IMAGE_N_PELS</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()">VIPS_IMAGE_ADDR</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="VipsImage.html#VIPS-MATRIX:CAPS" title="VIPS_MATRIX()">VIPS_MATRIX</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-progress-set" title="vips_progress_set ()">vips_progress_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-invalidate-all" title="vips_image_invalidate_all ()">vips_image_invalidate_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-minimise-all" title="vips_image_minimise_all ()">vips_image_minimise_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-set-progress" title="vips_image_set_progress ()">vips_image_set_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-filename-get-filename" title="vips_filename_get_filename ()">vips_filename_get_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-filename-get-options" title="vips_filename_get_options ()">vips_filename_get_options</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new" title="vips_image_new ()">vips_image_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-memory" title="vips_image_new_memory ()">vips_image_new_memory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-memory" title="vips_image_memory ()">vips_image_memory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-from-file" title="vips_image_new_from_file ()">vips_image_new_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-from-file-RW" title="vips_image_new_from_file_RW ()">vips_image_new_from_file_RW</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-from-file-raw" title="vips_image_new_from_file_raw ()">vips_image_new_from_file_raw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-from-memory" title="vips_image_new_from_memory ()">vips_image_new_from_memory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-from-memory-copy" title="vips_image_new_from_memory_copy ()">vips_image_new_from_memory_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-from-buffer" title="vips_image_new_from_buffer ()">vips_image_new_from_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-matrix" title="vips_image_new_matrix ()">vips_image_new_matrix</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-matrixv" title="vips_image_new_matrixv ()">vips_image_new_matrixv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-matrix-from-array" title="vips_image_new_matrix_from_array ()">vips_image_new_matrix_from_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-matrix-from-array" title="vips_image_matrix_from_array ()">vips_image_matrix_from_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-set-delete-on-close" title="vips_image_set_delete_on_close ()">vips_image_set_delete_on_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint64</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-get-disc-threshold" title="vips_get_disc_threshold ()">vips_get_disc_threshold</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-new-temp-file" title="vips_image_new_temp_file ()">vips_image_new_temp_file</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="VipsImage.html#vips-image-write" title="vips_image_write ()">vips_image_write</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="VipsImage.html#vips-image-write-to-file" title="vips_image_write_to_file ()">vips_image_write_to_file</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="VipsImage.html#vips-image-write-to-buffer" title="vips_image_write_to_buffer ()">vips_image_write_to_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-write-to-memory" title="vips_image_write_to_memory ()">vips_image_write_to_memory</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="VipsImage.html#vips-image-decode-predict" title="vips_image_decode_predict ()">vips_image_decode_predict</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="VipsImage.html#vips-image-decode" title="vips_image_decode ()">vips_image_decode</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="VipsImage.html#vips-image-encode" title="vips_image_encode ()">vips_image_encode</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="VipsImage.html#vips-image-isMSBfirst" title="vips_image_isMSBfirst ()">vips_image_isMSBfirst</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="VipsImage.html#vips-image-isfile" title="vips_image_isfile ()">vips_image_isfile</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="VipsImage.html#vips-image-ispartial" title="vips_image_ispartial ()">vips_image_ispartial</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-image-copy-memory" title="vips_image_copy_memory ()">vips_image_copy_memory</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="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()">vips_image_wio_input</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="VipsImage.html#vips-image-pio-input" title="vips_image_pio_input ()">vips_image_pio_input</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="VipsImage.html#vips-image-pio-output" title="vips_image_pio_output ()">vips_image_pio_output</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="VipsImage.html#vips-image-inplace" title="vips_image_inplace ()">vips_image_inplace</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="VipsImage.html#vips-image-write-prepare" title="vips_image_write_prepare ()">vips_image_write_prepare</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="VipsImage.html#vips-image-write-line" title="vips_image_write_line ()">vips_image_write_line</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="VipsImage.html#vips-band-format-isint" title="vips_band_format_isint ()">vips_band_format_isint</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="VipsImage.html#vips-band-format-isuint" title="vips_band_format_isuint ()">vips_band_format_isuint</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="VipsImage.html#vips-band-format-is8bit" title="vips_band_format_is8bit ()">vips_band_format_is8bit</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="VipsImage.html#vips-band-format-isfloat" title="vips_band_format_isfloat ()">vips_band_format_isfloat</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="VipsImage.html#vips-band-format-iscomplex" title="vips_band_format_iscomplex ()">vips_band_format_iscomplex</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="VipsImage.html#vips-system" title="vips_system ()">vips_system</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-array-image-new" title="vips_array_image_new ()">vips_array_image_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-array-image-newv" title="vips_array_image_newv ()">vips_array_image_newv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-array-image-new-from-string" title="vips_array_image_new_from_string ()">vips_array_image_new_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-array-image-empty" title="vips_array_image_empty ()">vips_array_image_empty</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-array-image-append" title="vips_array_image_append ()">vips_array_image_append</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> **
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-array-image-get" title="vips_array_image_get ()">vips_array_image_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> **
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-value-get-array-image" title="vips_value_get_array_image ()">vips_value_get_array_image</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="VipsImage.html#vips-value-set-array-image" title="vips_value_set_array_image ()">vips_value_set_array_image</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="VipsImage.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"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--bands" title="The “bands” property">bands</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="VipsImage.html#VipsCoding" title="enum VipsCoding"><span class="type">VipsCoding</span></a></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--coding" title="The “coding” property">coding</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="VipsImage.html#VipsDemandStyle" title="enum VipsDemandStyle"><span class="type">VipsDemandStyle</span></a></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--demand" title="The “demand” property">demand</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--filename" title="The “filename” property">filename</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gpointer</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--foreign-buffer" title="The “foreign-buffer” property">foreign-buffer</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--format" title="The “format” property">format</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--height" title="The “height” property">height</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="VipsImage.html#VipsInterpretation" title="enum VipsInterpretation"><span class="type">VipsInterpretation</span></a></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--interpretation" title="The “interpretation” property">interpretation</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="VipsImage.html#VipsImage--kill" title="The “kill” property">kill</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint64</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--sizeof-header" title="The “sizeof-header” property">sizeof-header</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--width" title="The “width” property">width</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--xoffset" title="The “xoffset” property">xoffset</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gdouble</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--xres" title="The “xres” property">xres</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--yoffset" title="The “yoffset” property">yoffset</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gdouble</span></td>
<td class="property_name"><a class="link" href="VipsImage.html#VipsImage--yres" title="The “yres” property">yres</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="VipsImage.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="VipsImage.html#VipsImage-eval" title="The “eval” signal">eval</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="VipsImage.html#VipsImage-invalidate" title="The “invalidate” signal">invalidate</a></td>
<td class="signal_flags">Action</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="VipsImage.html#VipsImage-minimise" title="The “minimise” signal">minimise</a></td>
<td class="signal_flags">Action</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="VipsImage.html#VipsImage-posteval" title="The “posteval” signal">posteval</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="VipsImage.html#VipsImage-preeval" title="The “preeval” signal">preeval</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="VipsImage.html#VipsImage-written" title="The “written” signal">written</a></td>
<td class="signal_flags">Action</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="VipsImage.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="VipsImage.html#VIPS-MAGIC-INTEL:CAPS" title="VIPS_MAGIC_INTEL">VIPS_MAGIC_INTEL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="VipsImage.html#VIPS-MAGIC-SPARC:CAPS" title="VIPS_MAGIC_SPARC">VIPS_MAGIC_SPARC</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="VipsImage.html#VIPS-MAX-COORD:CAPS" title="VIPS_MAX_COORD">VIPS_MAX_COORD</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsDemandStyle" title="enum VipsDemandStyle">VipsDemandStyle</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsImageType" title="enum VipsImageType">VipsImageType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsInterpretation" title="enum VipsInterpretation">VipsInterpretation</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat">VipsBandFormat</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsCoding" title="enum VipsCoding">VipsCoding</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsAccess" title="enum VipsAccess">VipsAccess</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="VipsImage.html#VipsProgress" title="VipsProgress">VipsProgress</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="VipsImage.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> VipsImage
</pre>
</div>
<div class="refsect1">
<a name="VipsImage.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;vips/vips.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="VipsImage.description"></a><h2>Description</h2>
<p>The image class and associated types and macros.</p>
<p>Images can be created from formatted files on disc, from C-style arrays on
disc, from formatted areas of memory, or from C-style arrays in memory. See
<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. 
Creating an image is fast. VIPS reads just enough of
the image to be able to get the various properties, such as width in
pixels. It delays reading any pixels until they are really needed.</p>
<p>Once you have an image, you can get properties from it in the usual way. 
You can use projection functions, like <a class="link" href="libvips-header.html#vips-image-get-width" title="vips_image_get_width ()"><code class="function">vips_image_get_width()</code></a> or 
<code class="function">g_object_get()</code>, to get <code class="literal">GObject</code> properties. </p>
<p>VIPS images are three-dimensional arrays, the dimensions being width, 
height and bands. Each dimension can be up to 2 ** 31 pixels (or band 
elements). An image has a format, meaning the machine number type used 
to represent each value. VIPS supports 10 formats, from 8-bit unsigned 
integer up to 128-bit double complex, see <a class="link" href="libvips-header.html#vips-image-get-format" title="vips_image_get_format ()"><code class="function">vips_image_get_format()</code></a>. </p>
<p>In VIPS, images are uninterpreted arrays, meaning that from the point of 
view of most operations, they are just large collections of numbers. 
There's no difference between an RGBA (RGB with alpha) image and a CMYK 
image, for example, they are both just four-band images. It's up to the 
user of the library to pass the right sort of image to each operation. </p>
<p>To take an example, VIPS has <a class="link" href="libvips-colour.html#vips-Lab2XYZ" title="vips_Lab2XYZ ()"><code class="function">vips_Lab2XYZ()</code></a>, an operation to transform 
an image from CIE LAB colour space to CIE XYZ space. It assumes the 
first three bands represent pixels in LAB colour space and returns an 
image where the first three bands are transformed to XYZ and any 
remaining bands are just copied. Pass it a RGB image by mistake and 
you'll just get nonsense.</p>
<p>VIPS has a feature to help (a little) with this: it sets a 
<a class="link" href="VipsImage.html#VipsInterpretation" title="enum VipsInterpretation"><span class="type">VipsInterpretation</span></a> hint for each image (see 
<a class="link" href="libvips-header.html#vips-image-get-interpretation" title="vips_image_get_interpretation ()"><code class="function">vips_image_get_interpretation()</code></a>); a hint which says how pixels should
be interpreted. For example, <a class="link" href="libvips-colour.html#vips-Lab2XYZ" title="vips_Lab2XYZ ()"><code class="function">vips_Lab2XYZ()</code></a> will set the
interpretation of the output image to <a class="link" href="VipsImage.html#VIPS-INTERPRETATION-XYZ:CAPS"><span class="type">VIPS_INTERPRETATION_XYZ</span></a>. A
few utility operations will also use interpretation as a guide. For
example, you can give <a class="link" href="libvips-colour.html#vips-colourspace" title="vips_colourspace ()"><code class="function">vips_colourspace()</code></a> an input image and a desired
colourspace and it will use the input's interpretation hint to apply
the best sequence of colourspace transforms to get to the desired space.</p>
<p>Use things like <a class="link" href="libvips-arithmetic.html#vips-invert" title="vips_invert ()"><code class="function">vips_invert()</code></a> to manipulate your images. When you are done,
you can write images to disc files (with <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>),
to formatted memory buffers (with <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>) and to
C-style memory arrays (with <a class="link" href="VipsImage.html#vips-image-write-to-memory" title="vips_image_write_to_memory ()"><code class="function">vips_image_write_to_memory()</code></a>.</p>
<p>You can also write image to other images. Create, for example, a temporary
disc image with <a class="link" href="VipsImage.html#vips-image-new-temp-file" title="vips_image_new_temp_file ()"><code class="function">vips_image_new_temp_file()</code></a>, then write your image to that
with <a class="link" href="VipsImage.html#vips-image-write" title="vips_image_write ()"><code class="function">vips_image_write()</code></a>. You can create several other types of image and
write to them, see <a class="link" href="VipsImage.html#vips-image-new-memory" title="vips_image_new_memory ()"><code class="function">vips_image_new_memory()</code></a>, for example. </p>
<p>See <a class="link" href="VipsOperation.html" title="VipsOperation">operation</a> for an introduction to
running operations on images, see <a class="link" href="libvips-header.html" title="header">header</a> for getting and setting image
metadata. See <a class="link" href="VipsObject.html" title="VipsObject">object</a> for a discussion of
the lower levels.</p>
</div>
<div class="refsect1">
<a name="VipsImage.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="VipsStartFn"></a><h3>VipsStartFn ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
<span class="c_punctuation">(</span>*VipsStartFn<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">struct _VipsImage</span> *out</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>Start a new processing sequence for this generate function. This allocates
per-thread state, such as an input region.</p>
<p>See also: <a class="link" href="libvips-generate.html#vips-start-one" title="vips_start_one ()"><code class="function">vips_start_one()</code></a>, <a class="link" href="libvips-generate.html#vips-start-many" title="vips_start_many ()"><code class="function">vips_start_many()</code></a>.</p>
<div class="refsect3">
<a name="VipsStartFn.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>out</p></td>
<td class="parameter_description"><p>image being calculated</p></td>
<td class="parameter_annotations"> </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="VipsStartFn.returns"></a><h4>Returns</h4>
<p> a new sequence value</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsGenerateFn"></a><h3>VipsGenerateFn ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
<span class="c_punctuation">(</span>*VipsGenerateFn<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">struct _VipsRegion</span> *out</code></em>,
                   <em class="parameter"><code><span class="type">void</span> *seq</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>,
                   <em class="parameter"><code><span class="type">gboolean</span> *stop</code></em>);</pre>
<p>Fill <em class="parameter"><code>out-&gt;valid</code></em>
 with pixels. <em class="parameter"><code>seq</code></em>
 contains per-thread state, such as the
input regions. Set <em class="parameter"><code>stop</code></em>
 to <code class="literal">TRUE</code> to stop processing. </p>
<p>See also: <a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a>, <a class="link" href="libvips-generate.html#vips-stop-many" title="vips_stop_many ()"><code class="function">vips_stop_many()</code></a>.</p>
<div class="refsect3">
<a name="VipsGenerateFn.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>out</p></td>
<td class="parameter_description"><p><a class="link" href="VipsRegion.html" title="VipsRegion"><span class="type">VipsRegion</span></a> to fill</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>seq</p></td>
<td class="parameter_description"><p>sequence value</p></td>
<td class="parameter_annotations"> </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>
<tr>
<td class="parameter_name"><p>stop</p></td>
<td class="parameter_description"><p>set this to stop processing</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VipsGenerateFn.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsStopFn"></a><h3>VipsStopFn ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
<span class="c_punctuation">(</span>*VipsStopFn<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *seq</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>Stop a processing sequence. This frees
per-thread state, such as an input region.</p>
<p>See also: <a class="link" href="libvips-generate.html#vips-stop-one" title="vips_stop_one ()"><code class="function">vips_stop_one()</code></a>, <a class="link" href="libvips-generate.html#vips-stop-many" title="vips_stop_many ()"><code class="function">vips_stop_many()</code></a>.</p>
<div class="refsect3">
<a name="VipsStopFn.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>seq</p></td>
<td class="parameter_description"><p>sequence value</p></td>
<td class="parameter_annotations"> </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="VipsStopFn.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-IMAGE-SIZEOF-ELEMENT:CAPS"></a><h3>VIPS_IMAGE_SIZEOF_ELEMENT()</h3>
<pre class="programlisting">#define             VIPS_IMAGE_SIZEOF_ELEMENT( I )</pre>
<div class="refsect3">
<a name="VIPS-IMAGE-SIZEOF-ELEMENT.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-IMAGE-SIZEOF-ELEMENT.returns"></a><h4>Returns</h4>
<p> <code class="function">sizeof()</code> a band element.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-IMAGE-SIZEOF-PEL:CAPS"></a><h3>VIPS_IMAGE_SIZEOF_PEL()</h3>
<pre class="programlisting">#define             VIPS_IMAGE_SIZEOF_PEL( I )</pre>
<div class="refsect3">
<a name="VIPS-IMAGE-SIZEOF-PEL.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-IMAGE-SIZEOF-PEL.returns"></a><h4>Returns</h4>
<p> <code class="function">sizeof()</code> a pixel.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-IMAGE-SIZEOF-LINE:CAPS"></a><h3>VIPS_IMAGE_SIZEOF_LINE()</h3>
<pre class="programlisting">#define             VIPS_IMAGE_SIZEOF_LINE( I )</pre>
<div class="refsect3">
<a name="VIPS-IMAGE-SIZEOF-LINE.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-IMAGE-SIZEOF-LINE.returns"></a><h4>Returns</h4>
<p> <code class="function">sizeof()</code> a scanline of pixels.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-IMAGE-N-ELEMENTS:CAPS"></a><h3>VIPS_IMAGE_N_ELEMENTS()</h3>
<pre class="programlisting">#define             VIPS_IMAGE_N_ELEMENTS( I )</pre>
<div class="refsect3">
<a name="VIPS-IMAGE-N-ELEMENTS.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-IMAGE-N-ELEMENTS.returns"></a><h4>Returns</h4>
<p> The number of band elements in a scanline.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-IMAGE-N-PELS:CAPS"></a><h3>VIPS_IMAGE_N_PELS()</h3>
<pre class="programlisting">#define             VIPS_IMAGE_N_PELS( I )</pre>
<div class="refsect3">
<a name="VIPS-IMAGE-N-PELS.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-IMAGE-N-PELS.returns"></a><h4>Returns</h4>
<p> The number of pels in an image. A 64-bit unsigned int.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-IMAGE-ADDR:CAPS"></a><h3>VIPS_IMAGE_ADDR()</h3>
<pre class="programlisting">#define             VIPS_IMAGE_ADDR( I, X, Y )</pre>
<p>This macro returns a pointer to a pixel in an image, cast to a <a class="link" href="libvips-basic.html#VipsPel" title="VipsPel"><span class="type">VipsPel</span></a> *. 
It only works for
images which are fully available in memory, so memory buffers and small
mapped images only.</p>
<p>If VIPS_DEBUG is defined, you get a version that checks bounds for you.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()"><code class="function">vips_image_wio_input()</code></a>, <a class="link" href="VipsImage.html#vips-image-inplace" title="vips_image_inplace ()"><code class="function">vips_image_inplace()</code></a>, <a class="link" href="VipsRegion.html#VIPS-REGION-ADDR:CAPS" title="VIPS_REGION_ADDR()"><code class="function">VIPS_REGION_ADDR()</code></a>.</p>
<div class="refsect3">
<a name="VIPS-IMAGE-ADDR.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>X</p></td>
<td class="parameter_description"><p>x coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Y</p></td>
<td class="parameter_description"><p>y coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-IMAGE-ADDR.returns"></a><h4>Returns</h4>
<p> The address of pixel (<em class="parameter"><code>X</code></em>
,<em class="parameter"><code>Y</code></em>
) in <em class="parameter"><code>I</code></em>
. </p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-MATRIX:CAPS"></a><h3>VIPS_MATRIX()</h3>
<pre class="programlisting">#define             VIPS_MATRIX( I, X, Y )</pre>
<p>This macro returns a pointer to a pixel in an image, cast to a double*. The
image must have a single band, be <a class="link" href="VipsImage.html#VIPS-FORMAT-DOUBLE:CAPS"><span class="type">VIPS_FORMAT_DOUBLE</span></a> and be 
fully available in memory, so memory buffers and small
mapped images only.</p>
<p>If VIPS_DEBUG is defined, you get a version that checks bounds and image
type for you.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()"><code class="function">vips_image_wio_input()</code></a>, <a class="link" href="VipsImage.html#vips-image-inplace" title="vips_image_inplace ()"><code class="function">vips_image_inplace()</code></a>, <a class="link" href="libvips-error.html#vips-check-matrix" title="vips_check_matrix ()"><code class="function">vips_check_matrix()</code></a>.</p>
<div class="refsect3">
<a name="VIPS-MATRIX.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>I</p></td>
<td class="parameter_description"><p>a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>X</p></td>
<td class="parameter_description"><p>x coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Y</p></td>
<td class="parameter_description"><p>y coordinate</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="VIPS-MATRIX.returns"></a><h4>Returns</h4>
<p> The address of pixel (<em class="parameter"><code>X</code></em>
,<em class="parameter"><code>Y</code></em>
) in <em class="parameter"><code>I</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-progress-set"></a><h3>vips_progress_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
vips_progress_set (<em class="parameter"><code><span class="type">gboolean</span> progress</code></em>);</pre>
<p>If set, vips will print messages about the progress of computation to
stdout. This can also be enabled with the --vips-progress option, or by
setting the environment variable VIPS_PROGRESS.</p>
<div class="refsect3">
<a name="vips-progress-set.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>progress</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to enable progress messages</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-invalidate-all"></a><h3>vips_image_invalidate_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
vips_image_invalidate_all (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Invalidate all pixel caches on <em class="parameter"><code>image</code></em>
 and any downstream images, that
is, images which depend on this image. Additionally, all operations which
depend upon this image are dropped from the VIPS operation cache. </p>
<p>You should call this function after
destructively modifying an image with something like <a class="link" href="libvips-draw.html#vips-draw-circle" title="vips_draw_circle ()"><code class="function">vips_draw_circle()</code></a>.</p>
<p>The <a class="link" href="VipsImage.html#VipsImage-invalidate" title="The “invalidate” signal"><span class="type">“invalidate”</span></a> signal is emitted for all invalidated images.</p>
<p>See also: <a class="link" href="VipsRegion.html#vips-region-invalidate" title="vips_region_invalidate ()"><code class="function">vips_region_invalidate()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-invalidate-all.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>image</p></td>
<td class="parameter_description"><p><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> to invalidate</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-minimise-all"></a><h3>vips_image_minimise_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
vips_image_minimise_all (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Minimise memory use on this image and any upstream images, that is, images
which this image depends upon. This function is called automatically at the
end of a computation, but it might be useful to call at other times. </p>
<p>The <a class="link" href="VipsImage.html#VipsImage-minimise" title="The “minimise” signal"><span class="type">“minimise”</span></a> signal is emitted for all minimised images.</p>
<div class="refsect3">
<a name="vips-image-minimise-all.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>image</p></td>
<td class="parameter_description"><p><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> to minimise</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-set-progress"></a><h3>vips_image_set_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
vips_image_set_progress (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>,
                         <em class="parameter"><code><span class="type">gboolean</span> progress</code></em>);</pre>
<p>vips signals evaluation progress via the <a class="link" href="VipsImage.html#VipsImage-preeval" title="The “preeval” signal"><span class="type">“preeval”</span></a>, 
<a class="link" href="VipsImage.html#VipsImage-eval" title="The “eval” signal"><span class="type">“eval”</span></a> and <a class="link" href="VipsImage.html#VipsImage-posteval" title="The “posteval” signal"><span class="type">“posteval”</span></a>
signals. Progress is signalled on the most-downstream image for which
<a class="link" href="VipsImage.html#vips-image-set-progress" title="vips_image_set_progress ()"><code class="function">vips_image_set_progress()</code></a> was called.</p>
<div class="refsect3">
<a name="vips-image-set-progress.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>image</p></td>
<td class="parameter_description"><p>image to signal progress on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>turn progress reporting on or off</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-filename-get-filename"></a><h3>vips_filename_get_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
vips_filename_get_filename (<em class="parameter"><code>const <span class="type">char</span> *vips_filename</code></em>);</pre>
<p>Given a vips filename like "fred.jpg[Q=90]", return a new string of
just the filename part, "fred.jpg" in this case. </p>
<p>Useful for language bindings. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-filename-get-options" title="vips_filename_get_options ()"><code class="function">vips_filename_get_options()</code></a>.</p>
<div class="refsect3">
<a name="vips-filename-get-filename.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>vips_filename</p></td>
<td class="parameter_description"><p>a filename including a set of options</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-filename-get-filename.returns"></a><h4>Returns</h4>
<p> transfer full: just the filename component.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-filename-get-options"></a><h3>vips_filename_get_options ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
vips_filename_get_options (<em class="parameter"><code>const <span class="type">char</span> *vips_filename</code></em>);</pre>
<p>Given a vips filename like "fred.jpg[Q=90]", return a new string of
just the options part, "[Q=90]" in this case. </p>
<p>Useful for language bindings. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-filename-get-filename" title="vips_filename_get_filename ()"><code class="function">vips_filename_get_filename()</code></a>.</p>
<div class="refsect3">
<a name="vips-filename-get-options.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>vips_filename</p></td>
<td class="parameter_description"><p>a filename including a set of options</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-filename-get-options.returns"></a><h4>Returns</h4>
<p> transfer full: just the options component.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new"></a><h3>vips_image_new ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>vips_image_new() creates a new, empty <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>. 
If you write to one of these images, vips will just attach some callbacks,
no pixels will be generated. </p>
<p>Write pixels to an image with <a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a> or 
<a class="link" href="VipsImage.html#vips-image-write-line" title="vips_image_write_line ()"><code class="function">vips_image_write_line()</code></a>. Write a whole image to another image with
<a class="link" href="VipsImage.html#vips-image-write" title="vips_image_write ()"><code class="function">vips_image_write()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-memory"></a><h3>vips_image_new_memory ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_memory (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>vips_image_new_memory() creates a new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> which, when written to, will
create a memory image. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new" title="vips_image_new ()"><code class="function">vips_image_new()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new-memory.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-memory"></a><h3>vips_image_memory ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_memory (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>A renamed <a class="link" href="VipsImage.html#vips-image-new-memory" title="vips_image_new_memory ()"><code class="function">vips_image_new_memory()</code></a> ... Some gobject binding systems do not 
like more than one <code class="function">_new()</code> method.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-memory" title="vips_image_new_memory ()"><code class="function">vips_image_new_memory()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-memory.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-from-file"></a><h3>vips_image_new_from_file ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_from_file (<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>access</code></em>
: hint <a class="link" href="VipsImage.html#VipsAccess" title="enum VipsAccess"><span class="type">VipsAccess</span></a> mode to loader</p></li>
<li class="listitem"><p><em class="parameter"><code>disc</code></em>
: load via a temporary disc file</p></li>
</ul></div>
<p>vips_image_new_from_file() opens <em class="parameter"><code>name</code></em>
 for reading. It can load files
in many image formats, including VIPS, TIFF, PNG, JPEG, FITS, Matlab,
OpenEXR, CSV, WebP, Radiance, RAW, PPM and others. </p>
<p>Load options may be appended to <em class="parameter"><code>filename</code></em>
 as "[name=value,...]" or given as
a NULL-terminated list of name-value pairs at the end of the arguments.
Options given in the function call override options given in the filename. 
Many loaders add extra options, see <a class="link" href="VipsForeignSave.html#vips-jpegload" title="vips_jpegload ()"><code class="function">vips_jpegload()</code></a>, for example. </p>
<p>vips_image_new_from_file() always returns immediately with the header
fields filled in. No pixels are actually read until you first access them. </p>
<p><em class="parameter"><code>access</code></em>
 lets you set a <a class="link" href="VipsImage.html#VipsAccess" title="enum VipsAccess"><span class="type">VipsAccess</span></a> hint giving the expected access pattern 
for this file.
<a class="link" href="VipsImage.html#VIPS-ACCESS-RANDOM:CAPS"><span class="type">VIPS_ACCESS_RANDOM</span></a> means you can fetch pixels randomly from the image.
This is the default mode. <a class="link" href="VipsImage.html#VIPS-ACCESS-SEQUENTIAL:CAPS"><span class="type">VIPS_ACCESS_SEQUENTIAL</span></a> means you will read the
whole image exactly once, top-to-bottom. In this mode, vips can avoid
converting the whole image in one go, for a large memory saving. You are
allowed to make small non-local references, so area operations like 
convolution will work. <a class="link" href="VipsImage.html#VIPS-ACCESS-SEQUENTIAL-UNBUFFERED:CAPS"><span class="type">VIPS_ACCESS_SEQUENTIAL_UNBUFFERED</span></a> does not allow
non-local references, so will only work for very strict top-to-bottom
operations, but does have very low memory needs. </p>
<p>In <a class="link" href="VipsImage.html#VIPS-ACCESS-RANDOM:CAPS"><span class="type">VIPS_ACCESS_RANDOM</span></a> mode, small images are decompressed to memory and
then processed from there. Large images are decompressed to temporary
random-access files on disc and then processed from there. Set <em class="parameter"><code>disc</code></em>
 to
<code class="literal">TRUE</code> to force loading via disc. See <a class="link" href="VipsImage.html#vips-image-new-temp-file" title="vips_image_new_temp_file ()"><code class="function">vips_image_new_temp_file()</code></a> for an 
explanation of how VIPS selects a location for the temporary file.</p>
<p>The disc threshold can be set with the "--vips-disc-threshold"
command-line argument, or the VIPS_DISC_THRESHOLD environment variable.
The value is a simple integer, but can take a unit postfix of "k", 
"m" or "g" to indicate kilobytes, megabytes or gigabytes.
The default threshold is 100 MB.</p>
<p>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">VipsImage <span class="gtkdoc opt">*</span>image <span class="gtkdoc opt">=</span> <span class="function"><a href="VipsImage.html#vips-image-new-from-file">vips_image_new_from_file</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;fred.tif&quot;</span><span class="gtkdoc opt">,</span>
	<span class="string">&quot;page&quot;</span><span class="gtkdoc opt">,</span> <span class="number">12</span><span class="gtkdoc opt">,</span>
	NULL<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>Will open "fred.tif", reading page 12. </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</pre></td>
        <td class="listing_code"><pre class="programlisting">VipsImage <span class="gtkdoc opt">*</span>image <span class="gtkdoc opt">=</span> <span class="function"><a href="VipsImage.html#vips-image-new-from-file">vips_image_new_from_file</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;fred.jpg[shrink=2]&quot;</span><span class="gtkdoc opt">,</span>
	NULL<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>Will open "fred.jpg", downsampling by a factor of two. </p>
<p>Use <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 <a class="link" href="VipsForeignSave.html#vips-foreign-is-a" title="vips_foreign_is_a ()"><code class="function">vips_foreign_is_a()</code></a> to see what format a 
file is in and therefore what options are available. If you need more 
control over the loading process, you can call loaders directly, see 
<a class="link" href="VipsForeignSave.html#vips-jpegload" title="vips_jpegload ()"><code class="function">vips_jpegload()</code></a>, for example. </p>
<p>See also: <a class="link" href="VipsForeignSave.html#vips-foreign-find-load" title="vips_foreign_find_load ()"><code class="function">vips_foreign_find_load()</code></a>, <a class="link" href="VipsForeignSave.html#vips-foreign-is-a" title="vips_foreign_is_a ()"><code class="function">vips_foreign_is_a()</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-image-new-from-file.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>name</p></td>
<td class="parameter_description"><p>file to open</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-image-new-from-file.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-from-file-RW"></a><h3>vips_image_new_from_file_RW ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_from_file_RW (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>Opens the named file for simultaneous reading and writing. This will only 
work for VIPS files in a format native to your machine. It is only for 
paintbox-type applications.</p>
<p>See also: <a class="link" href="libvips-draw.html#vips-draw-circle" title="vips_draw_circle ()"><code class="function">vips_draw_circle()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new-from-file-RW.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>filename to open</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-from-file-RW.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-from-file-raw"></a><h3>vips_image_new_from_file_raw ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_from_file_raw (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
                              <em class="parameter"><code><span class="type">int</span> xsize</code></em>,
                              <em class="parameter"><code><span class="type">int</span> ysize</code></em>,
                              <em class="parameter"><code><span class="type">int</span> bands</code></em>,
                              <em class="parameter"><code><span class="type">guint64</span> offset</code></em>);</pre>
<p>This function maps the named file and returns a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> you can use to
read it.</p>
<p>It returns an 8-bit image with <em class="parameter"><code>bands</code></em>
 bands. If the image is not 8-bit, use 
<a class="link" href="libvips-conversion.html#vips-copy" title="vips_copy ()"><code class="function">vips_copy()</code></a> to transform the descriptor after loading it.</p>
<p>See also: <a class="link" href="libvips-conversion.html#vips-copy" title="vips_copy ()"><code class="function">vips_copy()</code></a>, <a class="link" href="VipsForeignSave.html#vips-rawload" title="vips_rawload ()"><code class="function">vips_rawload()</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-image-new-from-file-raw.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>filename to open</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xsize</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ysize</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bands</p></td>
<td class="parameter_description"><p>image bands (or bytes per pixel)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>bytes to skip at start of file</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-from-file-raw.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-from-memory"></a><h3>vips_image_new_from_memory ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_from_memory (<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>,
                            <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><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>This function wraps a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> around a memory area. The memory area
must be a simple array, for example RGBRGBRGB, left-to-right,
top-to-bottom. Use <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> to load an area of memory
containing an image in a format.</p>
<p>VIPS does not take
responsibility for the area of memory, it's up to you to make sure it's
freed when the image is closed. See for example <a class="link" href="VipsObject.html#VipsObject-close" title="The “close” signal"><span class="type">“close”</span></a>.</p>
<p>Because VIPS is "borrowing" <em class="parameter"><code>data</code></em>
 from the caller, this function is
extremely dangerous. Unless you are very careful, you will get crashes or
memory corruption. Use <a class="link" href="VipsImage.html#vips-image-new-from-memory-copy" title="vips_image_new_from_memory_copy ()"><code class="function">vips_image_new_from_memory_copy()</code></a> instead if you are
at all unsure. </p>
<p>Use <a class="link" href="libvips-conversion.html#vips-copy" title="vips_copy ()"><code class="function">vips_copy()</code></a> to set other image properties. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new" title="vips_image_new ()"><code class="function">vips_image_new()</code></a>, <a class="link" href="VipsImage.html#vips-image-write-to-memory" title="vips_image_write_to_memory ()"><code class="function">vips_image_write_to_memory()</code></a>,
<a class="link" href="VipsImage.html#vips-image-new-from-memory-copy" title="vips_image_new_from_memory_copy ()"><code class="function">vips_image_new_from_memory_copy()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new-from-memory.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 area. </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>length of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bands</p></td>
<td class="parameter_description"><p>image bands (or bytes per pixel)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>image format</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-from-memory.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-from-memory-copy"></a><h3>vips_image_new_from_memory_copy ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_from_memory_copy (<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>,
                                 <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><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>Like <a class="link" href="VipsImage.html#vips-image-new-from-memory" title="vips_image_new_from_memory ()"><code class="function">vips_image_new_from_memory()</code></a>, but VIPS will make a copy of the memory 
area. This
means more memory use and an extra copy operation, but is much simpler and
safer. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-from-memory" title="vips_image_new_from_memory ()"><code class="function">vips_image_new_from_memory()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new-from-memory-copy.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 area. </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>length of memory area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bands</p></td>
<td class="parameter_description"><p>image bands (or bytes per pixel)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>image format</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-from-memory-copy.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-from-buffer"></a><h3>vips_image_new_from_buffer ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_from_buffer (<em class="parameter"><code>const <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>const <span class="type">char</span> *option_string</code></em>,
                            <em class="parameter"><code>...</code></em>);</pre>
<p>Loads an image from the formatted area of memory <em class="parameter"><code>buf</code></em>
, <em class="parameter"><code>len</code></em>
 using the 
loader recommended by <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>. 
To load an unformatted area of memory, use
<a class="link" href="VipsImage.html#vips-image-new-from-memory" title="vips_image_new_from_memory ()"><code class="function">vips_image_new_from_memory()</code></a>. </p>
<p>VIPS does not take
responsibility for the area of memory, it's up to you to make sure it's
freed when the image is closed. See for example <a class="link" href="VipsObject.html#VipsObject-close" title="The “close” signal"><span class="type">“close”</span></a>.</p>
<p>Load options may be given in <em class="parameter"><code>option_string</code></em>
 as "[name=value,...]" or given as
a NULL-terminated list of name-value pairs at the end of the arguments.
Options given in the function call override options given in the filename. </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-image-new-from-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> image data. </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=len][<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>len</p></td>
<td class="parameter_description"><p>length of memory buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>option_string</p></td>
<td class="parameter_description"><p>set of extra options as a string</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-image-new-from-buffer.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-matrix"></a><h3>vips_image_new_matrix ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_matrix (<em class="parameter"><code><span class="type">int</span> width</code></em>,
                       <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
<p>This convenience function makes an image which is a matrix: a one-band
<a class="link" href="VipsImage.html#VIPS-FORMAT-DOUBLE:CAPS"><span class="type">VIPS_FORMAT_DOUBLE</span></a> image held in memory.</p>
<p>Use <a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()"><code class="function">VIPS_IMAGE_ADDR()</code></a>, or <a class="link" href="VipsImage.html#VIPS-MATRIX:CAPS" title="VIPS_MATRIX()"><code class="function">VIPS_MATRIX()</code></a> to address pixels in the image.</p>
<p>Use <a class="link" href="libvips-header.html#vips-image-set-double" title="vips_image_set_double ()"><code class="function">vips_image_set_double()</code></a> to set "scale" and "offset", if required. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-matrixv" title="vips_image_new_matrixv ()"><code class="function">vips_image_new_matrixv()</code></a></p>
<div class="refsect3">
<a name="vips-image-new-matrix.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>width</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-matrix.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-matrixv"></a><h3>vips_image_new_matrixv ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_matrixv (<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>...</code></em>);</pre>
<p>As <a class="link" href="VipsImage.html#vips-image-new-matrix" title="vips_image_new_matrix ()"><code class="function">vips_image_new_matrix()</code></a>, but initialise the matrix from the argument
list. After <em class="parameter"><code>height</code></em>
 should be <em class="parameter"><code>width</code></em>
 * <em class="parameter"><code>height</code></em>
 double constants which are
used to set the matrix elements. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-matrix" title="vips_image_new_matrix ()"><code class="function">vips_image_new_matrix()</code></a></p>
<div class="refsect3">
<a name="vips-image-new-matrixv.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>width</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>matrix coefficients</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-matrixv.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-matrix-from-array"></a><h3>vips_image_new_matrix_from_array ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_matrix_from_array (<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>const <span class="type">double</span> *array</code></em>,
                                  <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
<p>A binding-friendly version of <a class="link" href="VipsImage.html#vips-image-new-matrixv" title="vips_image_new_matrixv ()"><code class="function">vips_image_new_matrixv()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new-matrix-from-array.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>width</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>array</p></td>
<td class="parameter_description"><p> array of elements. </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="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 elements</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-matrix-from-array.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-matrix-from-array"></a><h3>vips_image_matrix_from_array ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_matrix_from_array (<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>const <span class="type">double</span> *array</code></em>,
                              <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
<p>A renamed <a class="link" href="VipsImage.html#vips-image-new-matrix-from-array" title="vips_image_new_matrix_from_array ()"><code class="function">vips_image_new_matrix_from_array()</code></a>. Some gobject bindings do not
like more than one _new method.</p>
<div class="refsect3">
<a name="vips-image-matrix-from-array.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>width</p></td>
<td class="parameter_description"><p>image width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>image height</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>array</p></td>
<td class="parameter_description"><p> array of elements. </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="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 elements</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-matrix-from-array.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-set-delete-on-close"></a><h3>vips_image_set_delete_on_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
vips_image_set_delete_on_close (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> delete_on_close</code></em>);</pre>
<p>Sets the delete_on_close flag for the image. If this flag is set, when
<em class="parameter"><code>image</code></em>
 is finalized, the filename held in <em class="parameter"><code>image-&gt;filename</code></em>
 at the time of
this call is deleted.</p>
<p>This function is clearly extremely dangerous, use with great caution.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new-temp-file" title="vips_image_new_temp_file ()"><code class="function">vips_image_new_temp_file()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-set-delete-on-close.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>image</p></td>
<td class="parameter_description"><p>image to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>delete_on_close</p></td>
<td class="parameter_description"><p>format of file</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-get-disc-threshold"></a><h3>vips_get_disc_threshold ()</h3>
<pre class="programlisting"><span class="returnvalue">guint64</span>
vips_get_disc_threshold (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Return the number of bytes at which we flip between open via memory and
open via disc. This defaults to 100mb, but can be changed with the
VIPS_DISC_THRESHOLD environment variable or the --vips-disc-threshold
command-line flag. See <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-get-disc-threshold.returns"></a><h4>Returns</h4>
<p> disc threshold in bytes.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-new-temp-file"></a><h3>vips_image_new_temp_file ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_new_temp_file (<em class="parameter"><code>const <span class="type">char</span> *format</code></em>);</pre>
<p>Make a <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> which, when written to, will create a temporary file on
disc. The file will be automatically deleted when the image is destroyed. 
<em class="parameter"><code>format</code></em>
 is something like "%s.v" for a vips file.</p>
<p>The file is created in the temporary directory. This is set with the
environment variable TMPDIR. If this is not set, then on Unix systems, vips
will default to /tmp. On Windows, vips uses <code class="function">GetTempPath()</code> to find the
temporary directory. </p>
<p>vips uses <code class="function">g_mkstemp()</code> to make the temporary filename. They generally look
something like "vips-12-EJKJFGH.v".</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new" title="vips_image_new ()"><code class="function">vips_image_new()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-new-temp-file.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>format</p></td>
<td class="parameter_description"><p>format of file</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-new-temp-file.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-write"></a><h3>vips_image_write ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_write (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>,
                  <em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *out</code></em>);</pre>
<p>Write <em class="parameter"><code>image</code></em>
 to <em class="parameter"><code>out</code></em>
. Use <a class="link" href="VipsImage.html#vips-image-new" title="vips_image_new ()"><code class="function">vips_image_new()</code></a> and friends to create the
<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> you want to write to.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-new" title="vips_image_new ()"><code class="function">vips_image_new()</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="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-image-write.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>image</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>write to this image</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-write.returns"></a><h4>Returns</h4>
<p> 0 on success, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-write-to-file"></a><h3>vips_image_write_to_file ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_write_to_file (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>,
                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                          <em class="parameter"><code>...</code></em>);</pre>
<p>Writes <em class="parameter"><code>in</code></em>
 to <em class="parameter"><code>name</code></em>
 using the saver recommended by
<a class="link" href="VipsForeignSave.html#vips-foreign-find-save" title="vips_foreign_find_save ()"><code class="function">vips_foreign_find_save()</code></a>. </p>
<p>Save options may be appended to <em class="parameter"><code>filename</code></em>
 as "[name=value,...]" or given as
a NULL-terminated list of name-value pairs at the end of the arguments.
Options given in the function call override options given in the filename. </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-image-write-to-file.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>image</p></td>
<td class="parameter_description"><p>image to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>write to this file</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-image-write-to-file.returns"></a><h4>Returns</h4>
<p> 0 on success, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-write-to-buffer"></a><h3>vips_image_write_to_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_write_to_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>const <span class="type">char</span> *suffix</code></em>,
                            <em class="parameter"><code><span class="type">void</span> **buf</code></em>,
                            <em class="parameter"><code><span class="type">size_t</span> *size</code></em>,
                            <em class="parameter"><code>...</code></em>);</pre>
<p>Writes <em class="parameter"><code>in</code></em>
 to a memory buffer in a format specified by <em class="parameter"><code>suffix</code></em>
. </p>
<p>Save options may be appended to <em class="parameter"><code>suffix</code></em>
 as "[name=value,...]" or given as
a NULL-terminated list of name-value pairs at the end of the arguments.
Options given in the function call override options given in the filename. </p>
<p>Currently only TIFF, JPEG and PNG formats are supported.</p>
<p>You can call the various save operations directly if you wish, see
<a class="link" href="VipsForeignSave.html#vips-jpegsave-buffer" title="vips_jpegsave_buffer ()"><code class="function">vips_jpegsave_buffer()</code></a>, for example. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-write-to-memory" title="vips_image_write_to_memory ()"><code class="function">vips_image_write_to_memory()</code></a>, <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-image-write-to-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 write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>suffix</p></td>
<td class="parameter_description"><p>format to write </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p> return buffer start here. </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="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>return buffer 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-image-write-to-buffer.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-write-to-memory"></a><h3>vips_image_write_to_memory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
vips_image_write_to_memory (<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">size_t</span> *size</code></em>);</pre>
<p>Writes <em class="parameter"><code>in</code></em>
 to memory as a simple, unformatted C-style array. </p>
<p>The caller is responsible for freeing this memory. </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-image-write-to-memory.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 write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>return buffer length here</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-write-to-memory.returns"></a><h4>Returns</h4>
<p> return buffer start here. </p>
<p><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="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-decode-predict"></a><h3>vips_image_decode_predict ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_decode_predict (<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> *bands</code></em>,
                           <em class="parameter"><code><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> *format</code></em>);</pre>
<p>We often need to know what an image will decode to without actually
decoding it, for example, in arg checking.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-decode" title="vips_image_decode ()"><code class="function">vips_image_decode()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-decode-predict.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 decode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bands</p></td>
<td class="parameter_description"><p>predict bands here</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>predict format here</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-decode"></a><h3>vips_image_decode ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_decode (<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><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>);</pre>
<p>A convenience function to unpack to a format that we can compute with. 
<em class="parameter"><code>out.coding</code></em>
 is always <a class="link" href="VipsImage.html#VIPS-CODING-NONE:CAPS"><span class="type">VIPS_CODING_NONE</span></a>. </p>
<p>This unpacks LABQ to plain LAB. Use <a class="link" href="libvips-colour.html#vips-LabQ2LabS" title="vips_LabQ2LabS ()"><code class="function">vips_LabQ2LabS()</code></a> for a bit more speed
if you need it. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-encode" title="vips_image_encode ()"><code class="function">vips_image_encode()</code></a>, <a class="link" href="libvips-colour.html#vips-LabQ2Lab" title="vips_LabQ2Lab ()"><code class="function">vips_LabQ2Lab()</code></a>, <a class="link" href="libvips-colour.html#vips-rad2float" title="vips_rad2float ()"><code class="function">vips_rad2float()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-decode.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 decode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>write to this image</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-decode.returns"></a><h4>Returns</h4>
<p> 0 on success, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-encode"></a><h3>vips_image_encode ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_encode (<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><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **out</code></em>,
                   <em class="parameter"><code><a class="link" href="VipsImage.html#VipsCoding" title="enum VipsCoding"><span class="type">VipsCoding</span></a> coding</code></em>);</pre>
<p>A convenience function to pack to a coding. The inverse of
<a class="link" href="VipsImage.html#vips-image-decode" title="vips_image_decode ()"><code class="function">vips_image_decode()</code></a>.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-decode" title="vips_image_decode ()"><code class="function">vips_image_decode()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-encode.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 encode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>write to this image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coding</p></td>
<td class="parameter_description"><p>coding to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-encode.returns"></a><h4>Returns</h4>
<p> 0 on success, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-isMSBfirst"></a><h3>vips_image_isMSBfirst ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_image_isMSBfirst (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>image</code></em>
 is in most-significant-
byte first form. This is the byte order used on the SPARC
architecture and others.</p>
<div class="refsect3">
<a name="vips-image-isMSBfirst.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>image</p></td>
<td class="parameter_description"><p>image to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-isfile"></a><h3>vips_image_isfile ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_image_isfile (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>image</code></em>
 represents a file on disc in some way.</p>
<div class="refsect3">
<a name="vips-image-isfile.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>image</p></td>
<td class="parameter_description"><p>image to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-ispartial"></a><h3>vips_image_ispartial ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_image_ispartial (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>im</code></em>
 represents a partial image (a delayed calculation).</p>
<div class="refsect3">
<a name="vips-image-ispartial.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>image</p></td>
<td class="parameter_description"><p>image to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-copy-memory"></a><h3>vips_image_copy_memory ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> *
vips_image_copy_memory (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Allocate a memory buffer and copy <em class="parameter"><code>image</code></em>
 to it. This is a thread-safe
equivalent of <a class="link" href="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()"><code class="function">vips_image_wio_input()</code></a>, useful if <em class="parameter"><code>image</code></em>
 is small and from an
unknown source.</p>
<p>If <em class="parameter"><code>image</code></em>
 is already in memory (perhaps a mmaped file on disc),
<a class="link" href="VipsImage.html#vips-image-copy-memory" title="vips_image_copy_memory ()"><code class="function">vips_image_copy_memory()</code></a> will just ref <em class="parameter"><code>image</code></em>
 and return that.</p>
<p>If you are sure that <em class="parameter"><code>image</code></em>
 is not shared with another thread (perhaps you
have made it yourself), use <a class="link" href="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()"><code class="function">vips_image_wio_input()</code></a> instead.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()"><code class="function">vips_image_wio_input()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-copy-memory.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>image</p></td>
<td class="parameter_description"><p>image to copy to a memory buffer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-copy-memory.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-wio-input"></a><h3>vips_image_wio_input ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_wio_input (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Check that an image is readable via the <a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()"><code class="function">VIPS_IMAGE_ADDR()</code></a> macro, that is,
that the entire image is in memory and all pixels can be read with 
<a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()"><code class="function">VIPS_IMAGE_ADDR()</code></a>.  If it 
isn't, try to transform it so that <a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()"><code class="function">VIPS_IMAGE_ADDR()</code></a> can work. </p>
<p>Since this function modifies <em class="parameter"><code>image</code></em>
, it is not thread-safe. Only call it on
images which you are sure have not been shared with another thread. If the
image might have been shared, use the less efficient
<a class="link" href="VipsImage.html#vips-image-copy-memory" title="vips_image_copy_memory ()"><code class="function">vips_image_copy_memory()</code></a> instead.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-copy-memory" title="vips_image_copy_memory ()"><code class="function">vips_image_copy_memory()</code></a>, <a class="link" href="VipsImage.html#vips-image-pio-input" title="vips_image_pio_input ()"><code class="function">vips_image_pio_input()</code></a>, <a class="link" href="VipsImage.html#vips-image-inplace" title="vips_image_inplace ()"><code class="function">vips_image_inplace()</code></a>, <a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()"><code class="function">VIPS_IMAGE_ADDR()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-wio-input.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>image</p></td>
<td class="parameter_description"><p>image to transform</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-wio-input.returns"></a><h4>Returns</h4>
<p> 0 on succeess, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-pio-input"></a><h3>vips_image_pio_input ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_pio_input (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Check that an image is readable with <a class="link" href="VipsRegion.html#vips-region-prepare" title="vips_region_prepare ()"><code class="function">vips_region_prepare()</code></a> and friends. 
If it isn't, try to transform the image so that <a class="link" href="VipsRegion.html#vips-region-prepare" title="vips_region_prepare ()"><code class="function">vips_region_prepare()</code></a> can 
work.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-pio-output" title="vips_image_pio_output ()"><code class="function">vips_image_pio_output()</code></a>, <a class="link" href="VipsRegion.html#vips-region-prepare" title="vips_region_prepare ()"><code class="function">vips_region_prepare()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-pio-input.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>image</p></td>
<td class="parameter_description"><p>image to check</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-pio-input.returns"></a><h4>Returns</h4>
<p> 0 on succeess, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-pio-output"></a><h3>vips_image_pio_output ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_pio_output (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Check that an image is writeable with <a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a>. If it isn't,
try to transform the image so that <a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a> can work.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-image-pio-input" title="vips_image_pio_input ()"><code class="function">vips_image_pio_input()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-pio-output.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>image</p></td>
<td class="parameter_description"><p>image to check</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-pio-output.returns"></a><h4>Returns</h4>
<p> 0 on succeess, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-inplace"></a><h3>vips_image_inplace ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_inplace (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Gets <em class="parameter"><code>image</code></em>
 ready for an in-place operation, such as <a class="link" href="libvips-draw.html#vips-draw-circle" title="vips_draw_circle ()"><code class="function">vips_draw_circle()</code></a>.
After calling this function you can both read and write the image with 
<a class="link" href="VipsImage.html#VIPS-IMAGE-ADDR:CAPS" title="VIPS_IMAGE_ADDR()"><code class="function">VIPS_IMAGE_ADDR()</code></a>.</p>
<p>Since this function modifies <em class="parameter"><code>image</code></em>
, it is not thread-safe. Only call it on
images which you are sure have not been shared with another thread. 
All in-place operations are inherently not thread-safe, so you need to take
great care in any case.</p>
<p>See also: <a class="link" href="libvips-draw.html#vips-draw-circle" title="vips_draw_circle ()"><code class="function">vips_draw_circle()</code></a>, <a class="link" href="VipsImage.html#vips-image-wio-input" title="vips_image_wio_input ()"><code class="function">vips_image_wio_input()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-inplace.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>image</p></td>
<td class="parameter_description"><p>image to make read-write</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-inplace.returns"></a><h4>Returns</h4>
<p> 0 on succeess, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-write-prepare"></a><h3>vips_image_write_prepare ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_write_prepare (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Call this after setting header fields (width, height, and so on) to
allocate resources ready for writing. </p>
<p>Normally this function is called for you by <a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a> or
<a class="link" href="VipsImage.html#vips-image-write-line" title="vips_image_write_line ()"><code class="function">vips_image_write_line()</code></a>. You will need to call it yourself if you plan to
write directly to the -&gt;data member of a memory image.</p>
<div class="refsect3">
<a name="vips-image-write-prepare.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>image</p></td>
<td class="parameter_description"><p>image to prepare</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-write-prepare.returns"></a><h4>Returns</h4>
<p> 0 on success, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-image-write-line"></a><h3>vips_image_write_line ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_image_write_line (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>,
                       <em class="parameter"><code><span class="type">int</span> ypos</code></em>,
                       <em class="parameter"><code><a class="link" href="libvips-basic.html#VipsPel" title="VipsPel"><span class="type">VipsPel</span></a> *linebuffer</code></em>);</pre>
<p>Write a line of pixels to an image. This function must be called repeatedly
with <em class="parameter"><code>ypos</code></em>
 increasing from 0 to <span class="type">“height”</span> .
<em class="parameter"><code>linebuffer</code></em>
 must be <a class="link" href="VipsImage.html#VIPS-IMAGE-SIZEOF-LINE:CAPS" title="VIPS_IMAGE_SIZEOF_LINE()"><code class="function">VIPS_IMAGE_SIZEOF_LINE()</code></a> bytes long.</p>
<p>See also: <a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a>.</p>
<div class="refsect3">
<a name="vips-image-write-line.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>image</p></td>
<td class="parameter_description"><p>image to write to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ypos</p></td>
<td class="parameter_description"><p>vertical position of scan-line to write</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>linebuffer</p></td>
<td class="parameter_description"><p>scanline of pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-image-write-line.returns"></a><h4>Returns</h4>
<p> 0 on success, or -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-band-format-isint"></a><h3>vips_band_format_isint ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_band_format_isint (<em class="parameter"><code><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>format</code></em>
 is one of the integer types.</p>
<div class="refsect3">
<a name="vips-band-format-isint.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>format</p></td>
<td class="parameter_description"><p>format to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-band-format-isuint"></a><h3>vips_band_format_isuint ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_band_format_isuint (<em class="parameter"><code><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>format</code></em>
 is one of the unsigned integer types.</p>
<div class="refsect3">
<a name="vips-band-format-isuint.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>format</p></td>
<td class="parameter_description"><p>format to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-band-format-is8bit"></a><h3>vips_band_format_is8bit ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_band_format_is8bit (<em class="parameter"><code><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>format</code></em>
 is uchar or schar.</p>
<div class="refsect3">
<a name="vips-band-format-is8bit.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>format</p></td>
<td class="parameter_description"><p>format to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-band-format-isfloat"></a><h3>vips_band_format_isfloat ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_band_format_isfloat (<em class="parameter"><code><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>format</code></em>
 is one of the float types.</p>
<div class="refsect3">
<a name="vips-band-format-isfloat.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>format</p></td>
<td class="parameter_description"><p>format to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-band-format-iscomplex"></a><h3>vips_band_format_iscomplex ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
vips_band_format_iscomplex (<em class="parameter"><code><a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a> format</code></em>);</pre>
<p>Return <code class="literal">TRUE</code> if <em class="parameter"><code>fmt</code></em>
 is one of the complex types.</p>
<div class="refsect3">
<a name="vips-band-format-iscomplex.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>format</p></td>
<td class="parameter_description"><p>format to test</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-system"></a><h3>vips_system ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
vips_system (<em class="parameter"><code>const <span class="type">char</span> *cmd_format</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>in</code></em>
: array of input images</p></li>
<li class="listitem"><p><em class="parameter"><code>out</code></em>
: output image</p></li>
<li class="listitem"><p><em class="parameter"><code>in_format</code></em>
: write input files like this</p></li>
<li class="listitem"><p><em class="parameter"><code>out_format</code></em>
: write output filename like this</p></li>
<li class="listitem"><p><em class="parameter"><code>log</code></em>
: stdout of command is returned here</p></li>
</ul></div>
<p>vips_system() runs a command, optionally passing a set of images in and 
optionally getting an image back. The command's stdout is returned in <em class="parameter"><code>log</code></em>
. </p>
<p>First, if <em class="parameter"><code>in</code></em>
 is set, the array of images are written to files. See
<a class="link" href="VipsImage.html#vips-image-new-temp-file" title="vips_image_new_temp_file ()"><code class="function">vips_image_new_temp_file()</code></a> to see how temporary files are created. 
If <em class="parameter"><code>in_format</code></em>
 is
something like %s.png, the file will be written in PNG format. By
default, <em class="parameter"><code>in_format</code></em>
 is %s.tif. </p>
<p>If <em class="parameter"><code>out_format</code></em>
 is set, an output filename is formed in the same way. Any
trailing [options] are stripped from <em class="parameter"><code>out_format</code></em>
. </p>
<p>The command string to run is made by substituting the first set of %s 
in <em class="parameter"><code>cmd_format</code></em>
 for the names of the input files, if <em class="parameter"><code>in</code></em>
 is set, and then 
the next %s for the output filename, if <em class="parameter"><code>out_format</code></em>
 is set. 
You can put a number between the % and the s to change the order 
in which the substitution occurs.</p>
<p>The command is executed with <code class="function">popen()</code> and the output captured in <em class="parameter"><code>log</code></em>
. </p>
<p>After the command finishes, if <em class="parameter"><code>out_format</code></em>
 is set, the output image is
opened and returned in <em class="parameter"><code>out</code></em>
. You can append [options] to <em class="parameter"><code>out_format</code></em>
 to
control how this open happens. 
Closing <em class="parameter"><code>out</code></em>
 image will automatically delete the output file.</p>
<p>Finally the input images are deleted. </p>
<p>For example, this call will run the ImageMagick convert program on an
image, using JPEG files to pass images into and out of the convert command.</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</pre></td>
        <td class="listing_code"><pre class="programlisting">VipsArrayImage <span class="gtkdoc opt">*</span>in<span class="gtkdoc opt">;</span>
VipsImage <span class="gtkdoc opt">*</span>out<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">char</span> <span class="gtkdoc opt">*</span>log<span class="gtkdoc opt">;</span>

<span class="keyword">if</span> <span class="gtkdoc opt">(</span><span class="function"><a href="VipsImage.html#vips-system">vips_system</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;convert %s -swirl 45 %s&quot;</span><span class="gtkdoc opt">,</span>
	<span class="string">&quot;in&quot;</span><span class="gtkdoc opt">,</span> in<span class="gtkdoc opt">,</span> 
	<span class="string">&quot;out&quot;</span><span class="gtkdoc opt">, &amp;</span>out<span class="gtkdoc opt">,</span> 
  	<span class="string">&quot;in_format&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;%s.jpg&quot;</span><span class="gtkdoc opt">,</span> 
  	<span class="string">&quot;out_format&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;%s.jpg&quot;</span><span class="gtkdoc opt">,</span> 
  	<span class="string">&quot;log&quot;</span><span class="gtkdoc opt">, &amp;</span>log<span class="gtkdoc opt">,</span>
  	NULL<span class="gtkdoc opt">))</span>
  	error <span class="gtkdoc opt">...</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<div class="refsect3">
<a name="vips-system.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>cmd_format</p></td>
<td class="parameter_description"><p>command to run</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-system.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on failure. </p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-array-image-new"></a><h3>vips_array_image_new ()</h3>
<pre class="programlisting"><a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
vips_array_image_new (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> **array</code></em>,
                      <em class="parameter"><code><span class="type">int</span> n</code></em>);</pre>
<p>Allocate a new array of images and copy <em class="parameter"><code>array</code></em>
 into it. Free with
<a class="link" href="libvips-type.html#vips-area-unref" title="vips_area_unref ()"><code class="function">vips_area_unref()</code></a>. </p>
<p>The images will all be reffed by this function. They 
will be automatically unreffed for you by
<a class="link" href="libvips-type.html#vips-area-unref" title="vips_area_unref ()"><code class="function">vips_area_unref()</code></a>.</p>
<p>Add an extra NULL element at the end, handy for eg.
<a class="link" href="libvips-generate.html#vips-image-pipeline-array" title="vips_image_pipeline_array ()"><code class="function">vips_image_pipeline_array()</code></a> etc. </p>
<p>See also: <a class="link" href="libvips-type.html#VipsArea"><span class="type">VipsArea</span></a>.</p>
<div class="refsect3">
<a name="vips-array-image-new.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>array</p></td>
<td class="parameter_description"><p> array of <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>. </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=n]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>number of images</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-array-image-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-array-image-newv"></a><h3>vips_array_image_newv ()</h3>
<pre class="programlisting"><a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
vips_array_image_newv (<em class="parameter"><code><span class="type">int</span> n</code></em>,
                       <em class="parameter"><code>...</code></em>);</pre>
<p>Allocate a new array of <em class="parameter"><code>n</code></em>
 <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> and copy @... into it. Free with
<a class="link" href="libvips-type.html#vips-area-unref" title="vips_area_unref ()"><code class="function">vips_area_unref()</code></a>. </p>
<p>The images will all be reffed by this function. They 
will be automatically unreffed for you by
<a class="link" href="libvips-type.html#vips-area-unref" title="vips_area_unref ()"><code class="function">vips_area_unref()</code></a>.</p>
<p>Add an extra NULL element at the end, handy for eg.
<a class="link" href="libvips-generate.html#vips-image-pipeline-array" title="vips_image_pipeline_array ()"><code class="function">vips_image_pipeline_array()</code></a> etc. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-array-image-new" title="vips_array_image_new ()"><code class="function">vips_array_image_new()</code></a></p>
<div class="refsect3">
<a name="vips-array-image-newv.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>n</p></td>
<td class="parameter_description"><p>number of images</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>list of <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-array-image-newv.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-array-image-new-from-string"></a><h3>vips_array_image_new_from_string ()</h3>
<pre class="programlisting"><a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
vips_array_image_new_from_string (<em class="parameter"><code>const <span class="type">char</span> *string</code></em>,
                                  <em class="parameter"><code><a class="link" href="VipsImage.html#VipsAccess" title="enum VipsAccess"><span class="type">VipsAccess</span></a> flags</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="vips-array-image-empty"></a><h3>vips_array_image_empty ()</h3>
<pre class="programlisting"><a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
vips_array_image_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Make an empty image array. 
Handy with <code class="function">vips_array_image_add()</code> for bindings
which can't handle object array arguments.</p>
<p>See also: <code class="function">vips_array_image_add()</code>.</p>
<div class="refsect3">
<a name="vips-array-image-empty.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-array-image-append"></a><h3>vips_array_image_append ()</h3>
<pre class="programlisting"><a class="link" href="libvips-type.html#VipsArrayImage"><span class="returnvalue">VipsArrayImage</span></a> *
vips_array_image_append (<em class="parameter"><code><a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a> *array</code></em>,
                         <em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image</code></em>);</pre>
<p>Make a new <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a>, one larger than <em class="parameter"><code>array</code></em>
, with <em class="parameter"><code>image</code></em>
 appended 
to the end.
Handy with <a class="link" href="VipsImage.html#vips-array-image-empty" title="vips_array_image_empty ()"><code class="function">vips_array_image_empty()</code></a> for bindings
which can't handle object array arguments.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-array-image-empty" title="vips_array_image_empty ()"><code class="function">vips_array_image_empty()</code></a>.</p>
<div class="refsect3">
<a name="vips-array-image-append.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>array</p></td>
<td class="parameter_description"><p> append to this. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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>image</p></td>
<td class="parameter_description"><p>add this</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-array-image-append.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="vips-array-image-get"></a><h3>vips_array_image_get ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> **
vips_array_image_get (<em class="parameter"><code><a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a> *array</code></em>,
                      <em class="parameter"><code><span class="type">int</span> *n</code></em>);</pre>
<p>Fetch an image array from a <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a>. Useful for language bindings.</p>
<div class="refsect3">
<a name="vips-array-image-get.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>array</p></td>
<td class="parameter_description"><p>the <a class="link" href="libvips-type.html#VipsArrayImage"><span class="type">VipsArrayImage</span></a> to fetch from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>length of array</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-array-image-get.returns"></a><h4>Returns</h4>
<p> array of <a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a>. </p>
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n][<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-value-get-array-image"></a><h3>vips_value_get_array_image ()</h3>
<pre class="programlisting"><a class="link" href="VipsImage.html" title="VipsImage"><span class="returnvalue">VipsImage</span></a> **
vips_value_get_array_image (<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
                            <em class="parameter"><code><span class="type">int</span> *n</code></em>);</pre>
<p>Return the start of the array of images held by <em class="parameter"><code>value</code></em>
.
optionally return the number of elements in <em class="parameter"><code>n</code></em>
.</p>
<p>See also: <a class="link" href="VipsImage.html#vips-value-set-array-image" title="vips_value_set_array_image ()"><code class="function">vips_value_set_array_image()</code></a>.</p>
<div class="refsect3">
<a name="vips-value-get-array-image.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>value</p></td>
<td class="parameter_description"><p><code class="literal">GValue</code> to get from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p> return the number of elements here, optionally. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="vips-value-get-array-image.returns"></a><h4>Returns</h4>
<p> The array address. </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-value-set-array-image"></a><h3>vips_value_set_array_image ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
vips_value_set_array_image (<em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
                            <em class="parameter"><code><span class="type">int</span> n</code></em>);</pre>
<p>Set <em class="parameter"><code>value</code></em>
 to hold an array of images. Pass in the array length in <em class="parameter"><code>n</code></em>
. </p>
<p>See also: <a class="link" href="VipsImage.html#vips-array-image-get" title="vips_array_image_get ()"><code class="function">vips_array_image_get()</code></a>.</p>
<div class="refsect3">
<a name="vips-value-set-array-image.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>value</p></td>
<td class="parameter_description"><p> <code class="literal">GValue</code> to get from. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>the number of elements </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="VipsImage.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="VIPS-MAGIC-INTEL:CAPS"></a><h3>VIPS_MAGIC_INTEL</h3>
<pre class="programlisting">#define VIPS_MAGIC_INTEL (0xb6a6f208U)
</pre>
<p>The first four bytes of a VIPS file in Intel byte ordering.</p>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-MAGIC-SPARC:CAPS"></a><h3>VIPS_MAGIC_SPARC</h3>
<pre class="programlisting">#define VIPS_MAGIC_SPARC (0x08f2a6b6U)
</pre>
<p>The first four bytes of a VIPS file in SPARC byte ordering.</p>
</div>
<hr>
<div class="refsect2">
<a name="VIPS-MAX-COORD:CAPS"></a><h3>VIPS_MAX_COORD</h3>
<pre class="programlisting">#define VIPS_MAX_COORD (10000000)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="VipsDemandStyle"></a><h3>enum VipsDemandStyle</h3>
<p>See <a class="link" href="libvips-generate.html#vips-image-pipelinev" title="vips_image_pipelinev ()"><code class="function">vips_image_pipelinev()</code></a>. Operations can hint to the VIPS image IO 
system about the kind of demand geometry they prefer. </p>
<p>These demand styles are given below in order of increasing
restrictiveness.  When demanding output from a pipeline, 
<a class="link" href="libvips-generate.html#vips-image-generate" title="vips_image_generate ()"><code class="function">vips_image_generate()</code></a>
will use the most restrictive of the styles requested by the operations 
in the pipeline.</p>
<p><a class="link" href="VipsImage.html#VIPS-DEMAND-STYLE-THINSTRIP:CAPS"><span class="type">VIPS_DEMAND_STYLE_THINSTRIP</span></a> --- This operation would like to output strips 
the width of the image and a few pels high. This is option suitable for 
point-to-point operations, such as those in the arithmetic package.</p>
<p>This option is only efficient for cases where each output pel depends 
upon the pel in the corresponding position in the input image.</p>
<p><a class="link" href="VipsImage.html#VIPS-DEMAND-STYLE-FATSTRIP:CAPS"><span class="type">VIPS_DEMAND_STYLE_FATSTRIP</span></a> --- This operation would like to output strips 
the width of the image and as high as possible. This option is suitable 
for area operations which do not violently transform coordinates, such 
as <a class="link" href="libvips-convolution.html#vips-conv" title="vips_conv ()"><code class="function">vips_conv()</code></a>. </p>
<p><a class="link" href="VipsImage.html#VIPS-DEMAND-STYLE-SMALLTILE:CAPS"><span class="type">VIPS_DEMAND_STYLE_SMALLTILE</span></a> --- This is the most general demand format.
Output is demanded in small (around 100x100 pel) sections. This style works 
reasonably efficiently, even for bizzare operations like 45 degree rotate.</p>
<p><a class="link" href="VipsImage.html#VIPS-DEMAND-STYLE-ANY:CAPS"><span class="type">VIPS_DEMAND_STYLE_ANY</span></a> --- This image is not being demand-read from a disc 
file (even indirectly) so any demand style is OK. It's used for things like
<a class="link" href="libvips-create.html#vips-black" title="vips_black ()"><code class="function">vips_black()</code></a> where the pixels are calculated.</p>
<p>See also: <a class="link" href="libvips-generate.html#vips-image-pipelinev" title="vips_image_pipelinev ()"><code class="function">vips_image_pipelinev()</code></a>.</p>
<div class="refsect3">
<a name="VipsDemandStyle.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-DEMAND-STYLE-ERROR:CAPS"></a>VIPS_DEMAND_STYLE_ERROR</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-DEMAND-STYLE-SMALLTILE:CAPS"></a>VIPS_DEMAND_STYLE_SMALLTILE</p></td>
<td class="enum_member_description">
<p>demand in small (typically 64x64 pixel) tiles</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-DEMAND-STYLE-FATSTRIP:CAPS"></a>VIPS_DEMAND_STYLE_FATSTRIP</p></td>
<td class="enum_member_description">
<p>demand in fat (typically 10 pixel high) strips</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-DEMAND-STYLE-THINSTRIP:CAPS"></a>VIPS_DEMAND_STYLE_THINSTRIP</p></td>
<td class="enum_member_description">
<p>demand in thin (typically 1 pixel high) strips</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-DEMAND-STYLE-ANY:CAPS"></a>VIPS_DEMAND_STYLE_ANY</p></td>
<td class="enum_member_description">
<p>demand geometry does not matter</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsImageType"></a><h3>enum VipsImageType</h3>
<div class="refsect3">
<a name="VipsImageType.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-IMAGE-ERROR:CAPS"></a>VIPS_IMAGE_ERROR</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-NONE:CAPS"></a>VIPS_IMAGE_NONE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-SETBUF:CAPS"></a>VIPS_IMAGE_SETBUF</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-SETBUF-FOREIGN:CAPS"></a>VIPS_IMAGE_SETBUF_FOREIGN</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-OPENIN:CAPS"></a>VIPS_IMAGE_OPENIN</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-MMAPIN:CAPS"></a>VIPS_IMAGE_MMAPIN</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-MMAPINRW:CAPS"></a>VIPS_IMAGE_MMAPINRW</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-OPENOUT:CAPS"></a>VIPS_IMAGE_OPENOUT</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-IMAGE-PARTIAL:CAPS"></a>VIPS_IMAGE_PARTIAL</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsInterpretation"></a><h3>enum VipsInterpretation</h3>
<p>How the values in an image should be interpreted. For example, a
three-band float image of type <a class="link" href="VipsImage.html#VIPS-INTERPRETATION-LAB:CAPS"><span class="type">VIPS_INTERPRETATION_LAB</span></a> should have its 
pixels interpreted as coordinates in CIE Lab space.</p>
<p>These values are set by operations as hints to user-interfaces built on top 
of VIPS to help them show images to the user in a meaningful way. 
Operations do not use these values to decide their action.</p>
<p>The gaps in numbering are historical and must be maintained. Allocate 
new numbers from the end.</p>
<div class="refsect3">
<a name="VipsInterpretation.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-INTERPRETATION-ERROR:CAPS"></a>VIPS_INTERPRETATION_ERROR</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-MULTIBAND:CAPS"></a>VIPS_INTERPRETATION_MULTIBAND</p></td>
<td class="enum_member_description">
<p>generic many-band image</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-B-W:CAPS"></a>VIPS_INTERPRETATION_B_W</p></td>
<td class="enum_member_description">
<p>some kind of single-band image</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-HISTOGRAM:CAPS"></a>VIPS_INTERPRETATION_HISTOGRAM</p></td>
<td class="enum_member_description">
<p>a 1D image, eg. histogram or lookup table</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-XYZ:CAPS"></a>VIPS_INTERPRETATION_XYZ</p></td>
<td class="enum_member_description">
<p>the first three bands are CIE XYZ </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-LAB:CAPS"></a>VIPS_INTERPRETATION_LAB</p></td>
<td class="enum_member_description">
<p>pixels are in CIE Lab space</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-CMYK:CAPS"></a>VIPS_INTERPRETATION_CMYK</p></td>
<td class="enum_member_description">
<p>the first four bands are in CMYK space</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-LABQ:CAPS"></a>VIPS_INTERPRETATION_LABQ</p></td>
<td class="enum_member_description">
<p>implies <a class="link" href="VipsImage.html#VIPS-CODING-LABQ:CAPS"><span class="type">VIPS_CODING_LABQ</span></a></p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-RGB:CAPS"></a>VIPS_INTERPRETATION_RGB</p></td>
<td class="enum_member_description">
<p>generic RGB space</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-CMC:CAPS"></a>VIPS_INTERPRETATION_CMC</p></td>
<td class="enum_member_description">
<p>a uniform colourspace based on CMC(1:1)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-LCH:CAPS"></a>VIPS_INTERPRETATION_LCH</p></td>
<td class="enum_member_description">
<p>pixels are in CIE LCh space</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-LABS:CAPS"></a>VIPS_INTERPRETATION_LABS</p></td>
<td class="enum_member_description">
<p>CIE LAB coded as three signed 16-bit values</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-sRGB"></a>VIPS_INTERPRETATION_sRGB</p></td>
<td class="enum_member_description">
<p>pixels are sRGB</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-YXY:CAPS"></a>VIPS_INTERPRETATION_YXY</p></td>
<td class="enum_member_description">
<p>pixels are CIE Yxy</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-FOURIER:CAPS"></a>VIPS_INTERPRETATION_FOURIER</p></td>
<td class="enum_member_description">
<p>image is in fourier space</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-RGB16:CAPS"></a>VIPS_INTERPRETATION_RGB16</p></td>
<td class="enum_member_description">
<p>generic 16-bit RGB</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-GREY16:CAPS"></a>VIPS_INTERPRETATION_GREY16</p></td>
<td class="enum_member_description">
<p>generic 16-bit mono</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-MATRIX:CAPS"></a>VIPS_INTERPRETATION_MATRIX</p></td>
<td class="enum_member_description">
<p>a matrix</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-scRGB"></a>VIPS_INTERPRETATION_scRGB</p></td>
<td class="enum_member_description">
<p>pixels are scRGB</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-HSV:CAPS"></a>VIPS_INTERPRETATION_HSV</p></td>
<td class="enum_member_description">
<p>pixels are HSV</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-INTERPRETATION-LAST:CAPS"></a>VIPS_INTERPRETATION_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsBandFormat"></a><h3>enum VipsBandFormat</h3>
<p>The format used for each band element. </p>
<p>Each corresponds to a native C type for the current machine. For example,
<a class="link" href="VipsImage.html#VIPS-FORMAT-USHORT:CAPS"><span class="type">VIPS_FORMAT_USHORT</span></a> is <span class="type">unsigned short</span>.</p>
<div class="refsect3">
<a name="VipsBandFormat.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-FORMAT-NOTSET:CAPS"></a>VIPS_FORMAT_NOTSET</p></td>
<td class="enum_member_description">
<p>invalid setting</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-UCHAR:CAPS"></a>VIPS_FORMAT_UCHAR</p></td>
<td class="enum_member_description">
<p>unsigned char format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-CHAR:CAPS"></a>VIPS_FORMAT_CHAR</p></td>
<td class="enum_member_description">
<p>char format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-USHORT:CAPS"></a>VIPS_FORMAT_USHORT</p></td>
<td class="enum_member_description">
<p>unsigned short format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-SHORT:CAPS"></a>VIPS_FORMAT_SHORT</p></td>
<td class="enum_member_description">
<p>short format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-UINT:CAPS"></a>VIPS_FORMAT_UINT</p></td>
<td class="enum_member_description">
<p>unsigned int format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-INT:CAPS"></a>VIPS_FORMAT_INT</p></td>
<td class="enum_member_description">
<p>int format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-FLOAT:CAPS"></a>VIPS_FORMAT_FLOAT</p></td>
<td class="enum_member_description">
<p>float format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-COMPLEX:CAPS"></a>VIPS_FORMAT_COMPLEX</p></td>
<td class="enum_member_description">
<p>complex (two floats) format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-DOUBLE:CAPS"></a>VIPS_FORMAT_DOUBLE</p></td>
<td class="enum_member_description">
<p>double float format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-DPCOMPLEX:CAPS"></a>VIPS_FORMAT_DPCOMPLEX</p></td>
<td class="enum_member_description">
<p>double complex (two double) format</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-FORMAT-LAST:CAPS"></a>VIPS_FORMAT_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsCoding"></a><h3>enum VipsCoding</h3>
<p>How pixels are coded. </p>
<p>Normally, pixels are uncoded and can be manipulated as you would expect.
However some file formats code pixels for compression, and sometimes it's
useful to be able to manipulate images in the coded format.</p>
<p>The gaps in the numbering are historical and must be maintained. Allocate 
new numbers from the end.</p>
<div class="refsect3">
<a name="VipsCoding.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-CODING-ERROR:CAPS"></a>VIPS_CODING_ERROR</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-CODING-NONE:CAPS"></a>VIPS_CODING_NONE</p></td>
<td class="enum_member_description">
<p>pixels are not coded</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-CODING-LABQ:CAPS"></a>VIPS_CODING_LABQ</p></td>
<td class="enum_member_description">
<p>pixels encode 3 float CIELAB values as 4 uchar</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-CODING-RAD:CAPS"></a>VIPS_CODING_RAD</p></td>
<td class="enum_member_description">
<p>pixels encode 3 float RGB as 4 uchar (Radiance coding)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-CODING-LAST:CAPS"></a>VIPS_CODING_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsAccess"></a><h3>enum VipsAccess</h3>
<p>The type of access an operation has to supply. See <a class="link" href="libvips-conversion.html#vips-tilecache" title="vips_tilecache ()"><code class="function">vips_tilecache()</code></a>
and <a class="link" href="VipsForeignSave.html#VipsForeign"><span class="type">VipsForeign</span></a>. </p>
<p><em class="parameter"><code>VIPS_ACCESS_RANDOM</code></em>
 means requests can come in any order. </p>
<p><em class="parameter"><code>VIPS_ACCESS_SEQUENTIAL</code></em>
 means requests will be top-to-bottom, but with some
amount of buffering behind the read point for small non-local accesses. </p>
<p><em class="parameter"><code>VIPS_ACCESS_SEQUENTIAL_UNBUFFERED</code></em>
 means requests will be strictly
top-to-bottom with no read-behind. This can save some memory.</p>
<div class="refsect3">
<a name="VipsAccess.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-ACCESS-RANDOM:CAPS"></a>VIPS_ACCESS_RANDOM</p></td>
<td class="enum_member_description">
<p>can read anywhere</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-ACCESS-SEQUENTIAL:CAPS"></a>VIPS_ACCESS_SEQUENTIAL</p></td>
<td class="enum_member_description">
<p>top-to-bottom reading only, but with a small buffer</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-ACCESS-SEQUENTIAL-UNBUFFERED:CAPS"></a>VIPS_ACCESS_SEQUENTIAL_UNBUFFERED</p></td>
<td class="enum_member_description">
<p>top-to-bottom reading only</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="VIPS-ACCESS-LAST:CAPS"></a>VIPS_ACCESS_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="VipsProgress"></a><h3>VipsProgress</h3>
<pre class="programlisting">typedef struct {
	int run;		/* Time we have been running */
	int eta;		/* Estimated seconds of computation left */
	gint64 tpels;		/* Number of pels we expect to calculate */
	gint64 npels;		/* Number of pels calculated so far */
	int percent;		/* Percent complete */
	GTimer *start;		/* Start time */
} VipsProgress;
</pre>
<p>A structure available to eval callbacks giving information on evaluation
progress. See <a class="link" href="VipsImage.html#VipsImage-eval" title="The “eval” signal"><span class="type">“eval”</span></a>.</p>
<div class="refsect3">
<a name="VipsProgress.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="VipsProgress.run"></a>run</code></em>;</p></td>
<td class="struct_member_description"><p>Time we have been running </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="VipsProgress.eta"></a>eta</code></em>;</p></td>
<td class="struct_member_description"><p>Estimated seconds of computation left </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint64</span> <em class="structfield"><code><a name="VipsProgress.tpels"></a>tpels</code></em>;</p></td>
<td class="struct_member_description"><p>Number of pels we expect to calculate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint64</span> <em class="structfield"><code><a name="VipsProgress.npels"></a>npels</code></em>;</p></td>
<td class="struct_member_description"><p>Number of pels calculated so far</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="VipsProgress.percent"></a>percent</code></em>;</p></td>
<td class="struct_member_description"><p>Percent complete</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GTimer</span> *<em class="structfield"><code><a name="VipsProgress.start"></a>start</code></em>;</p></td>
<td class="struct_member_description"><p>Start time </p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="VipsImage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="VipsImage--bands"></a><h3>The <code class="literal">“bands”</code> property</h3>
<pre class="programlisting">  “bands”                    <span class="type">gint</span></pre>
<p>Number of bands in image.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [1,10000000]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--coding"></a><h3>The <code class="literal">“coding”</code> property</h3>
<pre class="programlisting">  “coding”                   <a class="link" href="VipsImage.html#VipsCoding" title="enum VipsCoding"><span class="type">VipsCoding</span></a></pre>
<p>Pixel coding.</p>
<p>Flags: Read / Write</p>
<p>Default value: VIPS_CODING_NONE</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--demand"></a><h3>The <code class="literal">“demand”</code> property</h3>
<pre class="programlisting">  “demand”                   <a class="link" href="VipsImage.html#VipsDemandStyle" title="enum VipsDemandStyle"><span class="type">VipsDemandStyle</span></a></pre>
<p>Preferred demand style for this image.</p>
<p>Flags: Read / Write</p>
<p>Default value: VIPS_DEMAND_STYLE_SMALLTILE</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting">  “filename”                 <span class="type">gchar</span> *</pre>
<p>Image filename.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--foreign-buffer"></a><h3>The <code class="literal">“foreign-buffer”</code> property</h3>
<pre class="programlisting">  “foreign-buffer”           <span class="type">gpointer</span></pre>
<p>Pointer to foreign pixels.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--format"></a><h3>The <code class="literal">“format”</code> property</h3>
<pre class="programlisting">  “format”                   <a class="link" href="VipsImage.html#VipsBandFormat" title="enum VipsBandFormat"><span class="type">VipsBandFormat</span></a></pre>
<p>Pixel format in image.</p>
<p>Flags: Read / Write</p>
<p>Default value: VIPS_FORMAT_UCHAR</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--height"></a><h3>The <code class="literal">“height”</code> property</h3>
<pre class="programlisting">  “height”                   <span class="type">gint</span></pre>
<p>Image height in pixels.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [1,10000000]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--interpretation"></a><h3>The <code class="literal">“interpretation”</code> property</h3>
<pre class="programlisting">  “interpretation”           <a class="link" href="VipsImage.html#VipsInterpretation" title="enum VipsInterpretation"><span class="type">VipsInterpretation</span></a></pre>
<p>Pixel interpretation.</p>
<p>Flags: Read / Write</p>
<p>Default value: VIPS_INTERPRETATION_MULTIBAND</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--kill"></a><h3>The <code class="literal">“kill”</code> property</h3>
<pre class="programlisting">  “kill”                     <span class="type">gboolean</span></pre>
<p>Block evaluation on this image.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting">  “mode”                     <span class="type">gchar</span> *</pre>
<p>Open mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: "p"</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--sizeof-header"></a><h3>The <code class="literal">“sizeof-header”</code> property</h3>
<pre class="programlisting">  “sizeof-header”            <span class="type">guint64</span></pre>
<p>Offset in bytes from start of file.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &lt;= 1000000000</p>
<p>Default value: 64</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--width"></a><h3>The <code class="literal">“width”</code> property</h3>
<pre class="programlisting">  “width”                    <span class="type">gint</span></pre>
<p>Image width in pixels.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [1,10000000]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--xoffset"></a><h3>The <code class="literal">“xoffset”</code> property</h3>
<pre class="programlisting">  “xoffset”                  <span class="type">gint</span></pre>
<p>Horizontal offset of origin.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-10000000,10000000]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--xres"></a><h3>The <code class="literal">“xres”</code> property</h3>
<pre class="programlisting">  “xres”                     <span class="type">gdouble</span></pre>
<p>Horizontal resolution in pixels/mm.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-0,1e+06]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--yoffset"></a><h3>The <code class="literal">“yoffset”</code> property</h3>
<pre class="programlisting">  “yoffset”                  <span class="type">gint</span></pre>
<p>Vertical offset of origin.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-10000000,10000000]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage--yres"></a><h3>The <code class="literal">“yres”</code> property</h3>
<pre class="programlisting">  “yres”                     <span class="type">gdouble</span></pre>
<p>Vertical resolution in pixels/mm.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-0,1e+06]</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="VipsImage.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="VipsImage-eval"></a><h3>The <code class="literal">“eval”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image,
               <span class="type">gpointer</span>   progress,
               <span class="type">gpointer</span>   user_data)</pre>
<p>The ::eval signal is emitted once per work unit (typically a 128 x
128 area of pixels) during image computation. </p>
<p>You can use this signal to update user-interfaces with progress
feedback. Beware of updating too frequently: you will usually
need some throttling mechanism.</p>
<p>Use <a class="link" href="VipsImage.html#vips-image-set-progress" title="vips_image_set_progress ()"><code class="function">vips_image_set_progress()</code></a> to turn on progress reporting for an
image.</p>
<div class="refsect3">
<a name="VipsImage-eval.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>image</p></td>
<td class="parameter_description"><p>the image being calculated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p><a class="link" href="VipsImage.html#VipsProgress" title="VipsProgress"><span class="type">VipsProgress</span></a> for this image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage-invalidate"></a><h3>The <code class="literal">“invalidate”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image,
               <span class="type">gpointer</span>   user_data)</pre>
<p>The ::invalidate signal is emitted when an image or one of it's
upstream data sources has been destructively modified. See
<a class="link" href="VipsImage.html#vips-image-invalidate-all" title="vips_image_invalidate_all ()"><code class="function">vips_image_invalidate_all()</code></a>.</p>
<div class="refsect3">
<a name="VipsImage-invalidate.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>image</p></td>
<td class="parameter_description"><p>the image that has changed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Action</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage-minimise"></a><h3>The <code class="literal">“minimise”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image,
               <span class="type">gpointer</span>   user_data)</pre>
<p>The ::minimise signal is emitted when an image has been asked to
minimise memory usage. All non-essential caches are dropped.

See
<a class="link" href="VipsImage.html#vips-image-minimise-all" title="vips_image_minimise_all ()"><code class="function">vips_image_minimise_all()</code></a>.</p>
<div class="refsect3">
<a name="VipsImage-minimise.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>image</p></td>
<td class="parameter_description"><p>the image that is being minimised</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Action</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage-posteval"></a><h3>The <code class="literal">“posteval”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image,
               <span class="type">gpointer</span>   progress,
               <span class="type">gpointer</span>   user_data)</pre>
<p>The ::posteval signal is emitted once at the end of the computation

of <em class="parameter"><code>image</code></em>
. It's a good place to shut down evaluation feedback.</p>
<p>Use <a class="link" href="VipsImage.html#vips-image-set-progress" title="vips_image_set_progress ()"><code class="function">vips_image_set_progress()</code></a> to turn on progress reporting for an
image.</p>
<div class="refsect3">
<a name="VipsImage-posteval.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>image</p></td>
<td class="parameter_description"><p>the image that was calculated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p><a class="link" href="VipsImage.html#VipsProgress" title="VipsProgress"><span class="type">VipsProgress</span></a> for this image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage-preeval"></a><h3>The <code class="literal">“preeval”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image,
               <span class="type">gpointer</span>   progress,
               <span class="type">gpointer</span>   user_data)</pre>
<p>The ::preeval signal is emitted once before computation of <em class="parameter"><code>image</code></em>

starts. It's a good place to set up evaluation feedback.</p>
<p>Use <a class="link" href="VipsImage.html#vips-image-set-progress" title="vips_image_set_progress ()"><code class="function">vips_image_set_progress()</code></a> to turn on progress reporting for an
image.</p>
<div class="refsect3">
<a name="VipsImage-preeval.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>image</p></td>
<td class="parameter_description"><p>the image to be calculated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p><a class="link" href="VipsImage.html#VipsProgress" title="VipsProgress"><span class="type">VipsProgress</span></a> for this image</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="VipsImage-written"></a><h3>The <code class="literal">“written”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *image,
               <span class="type">gpointer</span>   result,
               <span class="type">gpointer</span>   user_data)</pre>
<p>The ::written signal is emitted just after an image has been

written to. It is
used by vips to implement things like write to foreign file
formats.</p>
<div class="refsect3">
<a name="VipsImage-written.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>image</p></td>
<td class="parameter_description"><p>the image that was calculated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>set to non-zero to indicate error</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Action</p>
</div>
</div>
<div class="refsect1">
<a name="VipsImage.see-also"></a><h2>See Also</h2>
<a class="link" href="libvips-header.html" title="header">header</a><a class="link" href="VipsRegion.html" title="VipsRegion">VipsRegion</a><a class="link" href="libvips-generate.html" title="generate">generate</a><a class="link" href="VipsOperation.html" title="VipsOperation">VipsOperation</a>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>