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
|
// ==========================================================
// FreeImage 3 .NET wrapper
// Original FreeImage 3 functions and .NET compatible derived functions
//
// Design and implementation by
// - Jean-Philippe Goerke (jpgoerke@users.sourceforge.net)
// - Carsten Klein (cklein05@users.sourceforge.net)
//
// Contributors:
// - David Boland (davidboland@vodafone.ie)
//
// Main reference : MSDN Knowlede Base
//
// This file is part of FreeImage 3
//
// COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTY
// OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
// THAT THE COVERED CODE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE
// OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED
// CODE IS WITH YOU. SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT
// THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
// SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL
// PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER
// THIS DISCLAIMER.
//
// Use at your own risk!
// ==========================================================
// ==========================================================
// CVS
// $Revision: 1.9 $
// $Date: 2009/09/15 11:41:37 $
// $Id: FreeImageStaticImports.cs,v 1.9 2009/09/15 11:41:37 cklein05 Exp $
// ==========================================================
using System;
using System.Runtime.InteropServices;
using FreeImageAPI.Plugins;
using FreeImageAPI.IO;
namespace FreeImageAPI
{
public static partial class FreeImage
{
#region Constants
/// <summary>
/// Filename of the FreeImage library.
/// </summary>
private const string FreeImageLibrary = "FreeImage";
/// <summary>
/// Number of bytes to shift left within a 4 byte block.
/// </summary>
public const int FI_RGBA_RED = 2;
/// <summary>
/// Number of bytes to shift left within a 4 byte block.
/// </summary>
public const int FI_RGBA_GREEN = 1;
/// <summary>
/// Number of bytes to shift left within a 4 byte block.
/// </summary>
public const int FI_RGBA_BLUE = 0;
/// <summary>
/// Number of bytes to shift left within a 4 byte block.
/// </summary>
public const int FI_RGBA_ALPHA = 3;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const uint FI_RGBA_RED_MASK = 0x00FF0000;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const uint FI_RGBA_GREEN_MASK = 0x0000FF00;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const uint FI_RGBA_BLUE_MASK = 0x000000FF;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const uint FI_RGBA_ALPHA_MASK = 0xFF000000;
/// <summary>
/// Number of bits to shift left within a 32 bit block.
/// </summary>
public const int FI_RGBA_RED_SHIFT = 16;
/// <summary>
/// Number of bits to shift left within a 32 bit block.
/// </summary>
public const int FI_RGBA_GREEN_SHIFT = 8;
/// <summary>
/// Number of bits to shift left within a 32 bit block.
/// </summary>
public const int FI_RGBA_BLUE_SHIFT = 0;
/// <summary>
/// Number of bits to shift left within a 32 bit block.
/// </summary>
public const int FI_RGBA_ALPHA_SHIFT = 24;
/// <summary>
/// Mask indicating the position of color components of a 32 bit color.
/// </summary>
public const uint FI_RGBA_RGB_MASK = (FI_RGBA_RED_MASK | FI_RGBA_GREEN_MASK | FI_RGBA_BLUE_MASK);
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const int FI16_555_RED_MASK = 0x7C00;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const int FI16_555_GREEN_MASK = 0x03E0;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const int FI16_555_BLUE_MASK = 0x001F;
/// <summary>
/// Number of bits to shift left within a 16 bit block.
/// </summary>
public const int FI16_555_RED_SHIFT = 10;
/// <summary>
/// Number of bits to shift left within a 16 bit block.
/// </summary>
public const int FI16_555_GREEN_SHIFT = 5;
/// <summary>
/// Number of bits to shift left within a 16 bit block.
/// </summary>
public const int FI16_555_BLUE_SHIFT = 0;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const int FI16_565_RED_MASK = 0xF800;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const int FI16_565_GREEN_MASK = 0x07E0;
/// <summary>
/// Mask indicating the position of the given color.
/// </summary>
public const int FI16_565_BLUE_MASK = 0x001F;
/// <summary>
/// Number of bits to shift left within a 16 bit block.
/// </summary>
public const int FI16_565_RED_SHIFT = 11;
/// <summary>
/// Number of bits to shift left within a 16 bit block.
/// </summary>
public const int FI16_565_GREEN_SHIFT = 5;
/// <summary>
/// Number of bits to shift left within a 16 bit block.
/// </summary>
public const int FI16_565_BLUE_SHIFT = 0;
#endregion
#region General functions
/// <summary>
/// Initialises the library.
/// </summary>
/// <param name="load_local_plugins_only">
/// When the <paramref name="load_local_plugins_only"/> is true, FreeImage won't make use of external plugins.
/// </param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Initialise")]
private static extern void Initialise(bool load_local_plugins_only);
/// <summary>
/// Deinitialises the library.
/// </summary>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_DeInitialise")]
private static extern void DeInitialise();
/// <summary>
/// Returns a string containing the current version of the library.
/// </summary>
/// <returns>The current version of the library.</returns>
public static unsafe string GetVersion() { return PtrToStr(GetVersion_()); }
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetVersion")]
private static unsafe extern byte* GetVersion_();
/// <summary>
/// Returns a string containing a standard copyright message.
/// </summary>
/// <returns>A standard copyright message.</returns>
public static unsafe string GetCopyrightMessage() { return PtrToStr(GetCopyrightMessage_()); }
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetCopyrightMessage")]
private static unsafe extern byte* GetCopyrightMessage_();
/// <summary>
/// Calls the set error message function in FreeImage.
/// </summary>
/// <param name="fif">Format of the bitmaps.</param>
/// <param name="message">The error message.</param>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_OutputMessageProc")]
public static extern void OutputMessageProc(FREE_IMAGE_FORMAT fif, string message);
/// <summary>
/// You use the function FreeImage_SetOutputMessage to capture the log string
/// so that you can show it to the user of the program.
/// The callback is implemented in the <see cref="FreeImageEngine.Message"/> event of this class.
/// </summary>
/// <remarks>The function is private because FreeImage can only have a single
/// callback function. To use the callback use the <see cref="FreeImageEngine.Message"/>
/// event of this class.</remarks>
/// <param name="omf">Handler to the callback function.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetOutputMessage")]
internal static extern void SetOutputMessage(OutputMessageFunction omf);
#endregion
#region Bitmap management functions
/// <summary>
/// Creates a new bitmap in memory.
/// </summary>
/// <param name="width">Width of the new bitmap.</param>
/// <param name="height">Height of the new bitmap.</param>
/// <param name="bpp">Bit depth of the new Bitmap.
/// Supported pixel depth: 1-, 4-, 8-, 16-, 24-, 32-bit per pixel for standard bitmap</param>
/// <param name="red_mask">Red part of the color layout.
/// eg: 0xFF0000</param>
/// <param name="green_mask">Green part of the color layout.
/// eg: 0x00FF00</param>
/// <param name="blue_mask">Blue part of the color layout.
/// eg: 0x0000FF</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Allocate")]
public static extern FIBITMAP Allocate(int width, int height, int bpp,
uint red_mask, uint green_mask, uint blue_mask);
/// <summary>
/// Creates a new bitmap in memory.
/// </summary>
/// <param name="type">Type of the image.</param>
/// <param name="width">Width of the new bitmap.</param>
/// <param name="height">Height of the new bitmap.</param>
/// <param name="bpp">Bit depth of the new Bitmap.
/// Supported pixel depth: 1-, 4-, 8-, 16-, 24-, 32-bit per pixel for standard bitmap</param>
/// <param name="red_mask">Red part of the color layout.
/// eg: 0xFF0000</param>
/// <param name="green_mask">Green part of the color layout.
/// eg: 0x00FF00</param>
/// <param name="blue_mask">Blue part of the color layout.
/// eg: 0x0000FF</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AllocateT")]
public static extern FIBITMAP AllocateT(FREE_IMAGE_TYPE type, int width, int height, int bpp,
uint red_mask, uint green_mask, uint blue_mask);
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AllocateEx")]
internal static extern FIBITMAP AllocateEx(int width, int height, int bpp,
IntPtr color, FREE_IMAGE_COLOR_OPTIONS options, RGBQUAD[] palette,
uint red_mask, uint green_mask, uint blue_mask);
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AllocateExT")]
internal static extern FIBITMAP AllocateExT(FREE_IMAGE_TYPE type, int width, int height, int bpp,
IntPtr color, FREE_IMAGE_COLOR_OPTIONS options, RGBQUAD[] palette,
uint red_mask, uint green_mask, uint blue_mask);
/// <summary>
/// Makes an exact reproduction of an existing bitmap, including metadata and attached profile if any.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Clone")]
public static extern FIBITMAP Clone(FIBITMAP dib);
/// <summary>
/// Deletes a previously loaded FIBITMAP from memory.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Unload")]
public static extern void Unload(FIBITMAP dib);
/// <summary>
/// Decodes a bitmap, allocates memory for it and returns it as a FIBITMAP.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="filename">Name of the file to decode.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_LoadU")]
public static extern FIBITMAP Load(FREE_IMAGE_FORMAT fif, string filename, FREE_IMAGE_LOAD_FLAGS flags);
/// <summary>
/// Decodes a bitmap, allocates memory for it and returns it as a FIBITMAP.
/// The filename supports UNICODE.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="filename">Name of the file to decode.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_LoadU")]
private static extern FIBITMAP LoadU(FREE_IMAGE_FORMAT fif, string filename, FREE_IMAGE_LOAD_FLAGS flags);
/// <summary>
/// Loads a bitmap from an arbitrary source.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="io">A FreeImageIO structure with functionpointers to handle the source.</param>
/// <param name="handle">A handle to the source.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_LoadFromHandle")]
public static extern FIBITMAP LoadFromHandle(FREE_IMAGE_FORMAT fif, ref FreeImageIO io, fi_handle handle, FREE_IMAGE_LOAD_FLAGS flags);
/// <summary>
/// Saves a previosly loaded FIBITMAP to a file.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="filename">Name of the file to save to.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_SaveU")]
public static extern bool Save(FREE_IMAGE_FORMAT fif, FIBITMAP dib, string filename, FREE_IMAGE_SAVE_FLAGS flags);
/// <summary>
/// Saves a previosly loaded FIBITMAP to a file.
/// The filename supports UNICODE.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="filename">Name of the file to save to.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_SaveU")]
private static extern bool SaveU(FREE_IMAGE_FORMAT fif, FIBITMAP dib, string filename, FREE_IMAGE_SAVE_FLAGS flags);
/// <summary>
/// Saves a bitmap to an arbitrary source.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="io">A FreeImageIO structure with functionpointers to handle the source.</param>
/// <param name="handle">A handle to the source.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SaveToHandle")]
public static extern bool SaveToHandle(FREE_IMAGE_FORMAT fif, FIBITMAP dib, ref FreeImageIO io, fi_handle handle,
FREE_IMAGE_SAVE_FLAGS flags);
#endregion
#region Memory I/O streams
/// <summary>
/// Open a memory stream.
/// </summary>
/// <param name="data">Pointer to the data in memory.</param>
/// <param name="size_in_bytes">Length of the data in byte.</param>
/// <returns>Handle to a memory stream.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_OpenMemory")]
public static extern FIMEMORY OpenMemory(IntPtr data, uint size_in_bytes);
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_OpenMemory")]
internal static extern FIMEMORY OpenMemoryEx(byte[] data, uint size_in_bytes);
/// <summary>
/// Close and free a memory stream.
/// </summary>
/// <param name="stream">Handle to a memory stream.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_CloseMemory")]
public static extern void CloseMemory(FIMEMORY stream);
/// <summary>
/// Decodes a bitmap from a stream, allocates memory for it and returns it as a FIBITMAP.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="stream">Handle to a memory stream.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_LoadFromMemory")]
public static extern FIBITMAP LoadFromMemory(FREE_IMAGE_FORMAT fif, FIMEMORY stream, FREE_IMAGE_LOAD_FLAGS flags);
/// <summary>
/// Saves a previosly loaded FIBITMAP to a stream.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="stream">Handle to a memory stream.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SaveToMemory")]
public static extern bool SaveToMemory(FREE_IMAGE_FORMAT fif, FIBITMAP dib, FIMEMORY stream, FREE_IMAGE_SAVE_FLAGS flags);
/// <summary>
/// Gets the current position of a memory handle.
/// </summary>
/// <param name="stream">Handle to a memory stream.</param>
/// <returns>The current file position if successful, -1 otherwise.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_TellMemory")]
public static extern int TellMemory(FIMEMORY stream);
/// <summary>
/// Moves the memory handle to a specified location.
/// </summary>
/// <param name="stream">Handle to a memory stream.</param>
/// <param name="offset">Number of bytes from origin.</param>
/// <param name="origin">Initial position.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SeekMemory")]
public static extern bool SeekMemory(FIMEMORY stream, int offset, System.IO.SeekOrigin origin);
/// <summary>
/// Provides a direct buffer access to a memory stream.
/// </summary>
/// <param name="stream">The target memory stream.</param>
/// <param name="data">Pointer to the data in memory.</param>
/// <param name="size_in_bytes">Size of the data in bytes.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AcquireMemory")]
public static extern bool AcquireMemory(FIMEMORY stream, ref IntPtr data, ref uint size_in_bytes);
/// <summary>
/// Reads data from a memory stream.
/// </summary>
/// <param name="buffer">The buffer to store the data in.</param>
/// <param name="size">Size in bytes of the items.</param>
/// <param name="count">Number of items to read.</param>
/// <param name="stream">The stream to read from.
/// The memory pointer associated with stream is increased by the number of bytes actually read.</param>
/// <returns>The number of full items actually read.
/// May be less than count on error or stream-end.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ReadMemory")]
public static extern uint ReadMemory(byte[] buffer, uint size, uint count, FIMEMORY stream);
/// <summary>
/// Writes data to a memory stream.
/// </summary>
/// <param name="buffer">The buffer to read the data from.</param>
/// <param name="size">Size in bytes of the items.</param>
/// <param name="count">Number of items to write.</param>
/// <param name="stream">The stream to write to.
/// The memory pointer associated with stream is increased by the number of bytes actually written.</param>
/// <returns>The number of full items actually written.
/// May be less than count on error or stream-end.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_WriteMemory")]
public static extern uint WriteMemory(byte[] buffer, uint size, uint count, FIMEMORY stream);
/// <summary>
/// Open a multi-page bitmap from a memory stream.
/// </summary>
/// <param name="fif">Type of the bitmap.</param>
/// <param name="stream">The stream to decode.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage multi-paged bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_LoadMultiBitmapFromMemory")]
public static extern FIMULTIBITMAP LoadMultiBitmapFromMemory(FREE_IMAGE_FORMAT fif, FIMEMORY stream, FREE_IMAGE_LOAD_FLAGS flags);
#endregion
#region Plugin functions
/// <summary>
/// Registers a new plugin to be used in FreeImage.
/// </summary>
/// <param name="proc_address">Pointer to the function that initialises the plugin.</param>
/// <param name="format">A string describing the format of the plugin.</param>
/// <param name="description">A string describing the plugin.</param>
/// <param name="extension">A string witha comma sperated list of extensions. f.e: "pl,pl2,pl4"</param>
/// <param name="regexpr">A regular expression used to identify the bitmap.</param>
/// <returns>The format idientifier assigned by FreeImage.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_RegisterLocalPlugin")]
public static extern FREE_IMAGE_FORMAT RegisterLocalPlugin(InitProc proc_address,
string format, string description, string extension, string regexpr);
/// <summary>
/// Registers a new plugin to be used in FreeImage. The plugin is residing in a DLL.
/// The Init function must be called Init and must use the stdcall calling convention.
/// </summary>
/// <param name="path">Complete path to the dll file hosting the plugin.</param>
/// <param name="format">A string describing the format of the plugin.</param>
/// <param name="description">A string describing the plugin.</param>
/// <param name="extension">A string witha comma sperated list of extensions. f.e: "pl,pl2,pl4"</param>
/// <param name="regexpr">A regular expression used to identify the bitmap.</param>
/// <returns>The format idientifier assigned by FreeImage.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_RegisterExternalPlugin")]
public static extern FREE_IMAGE_FORMAT RegisterExternalPlugin(string path,
string format, string description, string extension, string regexpr);
/// <summary>
/// Retrieves the number of FREE_IMAGE_FORMAT identifiers being currently registered.
/// </summary>
/// <returns>The number of registered formats.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFIFCount")]
public static extern int GetFIFCount();
/// <summary>
/// Enables or disables a plugin.
/// </summary>
/// <param name="fif">The plugin to enable or disable.</param>
/// <param name="enable">True: enable the plugin. false: disable the plugin.</param>
/// <returns>The previous state of the plugin.
/// 1 - enabled. 0 - disables. -1 plugin does not exist.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetPluginEnabled")]
public static extern int SetPluginEnabled(FREE_IMAGE_FORMAT fif, bool enable);
/// <summary>
/// Retrieves the state of a plugin.
/// </summary>
/// <param name="fif">The plugin to check.</param>
/// <returns>1 - enabled. 0 - disables. -1 plugin does not exist.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_IsPluginEnabled")]
public static extern int IsPluginEnabled(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Returns a <see cref="FREE_IMAGE_FORMAT"/> identifier from the format string that was used to register the FIF.
/// </summary>
/// <param name="format">The string that was used to register the plugin.</param>
/// <returns>A <see cref="FREE_IMAGE_FORMAT"/> identifier from the format.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetFIFFromFormat")]
public static extern FREE_IMAGE_FORMAT GetFIFFromFormat(string format);
/// <summary>
/// Returns a <see cref="FREE_IMAGE_FORMAT"/> identifier from a MIME content type string
/// (MIME stands for Multipurpose Internet Mail Extension).
/// </summary>
/// <param name="mime">A MIME content type.</param>
/// <returns>A <see cref="FREE_IMAGE_FORMAT"/> identifier from the MIME.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetFIFFromMime")]
public static extern FREE_IMAGE_FORMAT GetFIFFromMime(string mime);
/// <summary>
/// Returns the string that was used to register a plugin from the system assigned <see cref="FREE_IMAGE_FORMAT"/>.
/// </summary>
/// <param name="fif">The assigned <see cref="FREE_IMAGE_FORMAT"/>.</param>
/// <returns>The string that was used to register the plugin.</returns>
public static unsafe string GetFormatFromFIF(FREE_IMAGE_FORMAT fif) { return PtrToStr(GetFormatFromFIF_(fif)); }
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFormatFromFIF")]
private static unsafe extern byte* GetFormatFromFIF_(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Returns a comma-delimited file extension list describing the bitmap formats the given plugin can read and/or write.
/// </summary>
/// <param name="fif">The desired <see cref="FREE_IMAGE_FORMAT"/>.</param>
/// <returns>A comma-delimited file extension list.</returns>
public static unsafe string GetFIFExtensionList(FREE_IMAGE_FORMAT fif) { return PtrToStr(GetFIFExtensionList_(fif)); }
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFIFExtensionList")]
private static unsafe extern byte* GetFIFExtensionList_(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Returns a descriptive string that describes the bitmap formats the given plugin can read and/or write.
/// </summary>
/// <param name="fif">The desired <see cref="FREE_IMAGE_FORMAT"/>.</param>
/// <returns>A descriptive string that describes the bitmap formats.</returns>
public static unsafe string GetFIFDescription(FREE_IMAGE_FORMAT fif) { return PtrToStr(GetFIFDescription_(fif)); }
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFIFDescription")]
private static unsafe extern byte* GetFIFDescription_(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Returns a regular expression string that can be used by a regular expression engine to identify the bitmap.
/// FreeImageQt makes use of this function.
/// </summary>
/// <param name="fif">The desired <see cref="FREE_IMAGE_FORMAT"/>.</param>
/// <returns>A regular expression string.</returns>
public static unsafe string GetFIFRegExpr(FREE_IMAGE_FORMAT fif) { return PtrToStr(GetFIFRegExpr_(fif)); }
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFIFRegExpr")]
private static unsafe extern byte* GetFIFRegExpr_(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Given a <see cref="FREE_IMAGE_FORMAT"/> identifier, returns a MIME content type string (MIME stands for Multipurpose Internet Mail Extension).
/// </summary>
/// <param name="fif">The desired <see cref="FREE_IMAGE_FORMAT"/>.</param>
/// <returns>A MIME content type string.</returns>
public static unsafe string GetFIFMimeType(FREE_IMAGE_FORMAT fif) { return PtrToStr(GetFIFMimeType_(fif)); }
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFIFMimeType")]
private static unsafe extern byte* GetFIFMimeType_(FREE_IMAGE_FORMAT fif);
/// <summary>
/// This function takes a filename or a file-extension and returns the plugin that can
/// read/write files with that extension in the form of a <see cref="FREE_IMAGE_FORMAT"/> identifier.
/// </summary>
/// <param name="filename">The filename or -extension.</param>
/// <returns>The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_GetFIFFromFilenameU")]
public static extern FREE_IMAGE_FORMAT GetFIFFromFilename(string filename);
/// <summary>
/// This function takes a filename or a file-extension and returns the plugin that can
/// read/write files with that extension in the form of a <see cref="FREE_IMAGE_FORMAT"/> identifier.
/// Supports UNICODE filenames.
/// </summary>
/// <param name="filename">The filename or -extension.</param>
/// <returns>The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_GetFIFFromFilenameU")]
private static extern FREE_IMAGE_FORMAT GetFIFFromFilenameU(string filename);
/// <summary>
/// Checks if a plugin can load bitmaps.
/// </summary>
/// <param name="fif">The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</param>
/// <returns>True if the plugin can load bitmaps, else false.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FIFSupportsReading")]
public static extern bool FIFSupportsReading(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Checks if a plugin can save bitmaps.
/// </summary>
/// <param name="fif">The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</param>
/// <returns>True if the plugin can save bitmaps, else false.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FIFSupportsWriting")]
public static extern bool FIFSupportsWriting(FREE_IMAGE_FORMAT fif);
/// <summary>
/// Checks if a plugin can save bitmaps in the desired bit depth.
/// </summary>
/// <param name="fif">The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</param>
/// <param name="bpp">The desired bit depth.</param>
/// <returns>True if the plugin can save bitmaps in the desired bit depth, else false.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FIFSupportsExportBPP")]
public static extern bool FIFSupportsExportBPP(FREE_IMAGE_FORMAT fif, int bpp);
/// <summary>
/// Checks if a plugin can save a bitmap in the desired data type.
/// </summary>
/// <param name="fif">The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</param>
/// <param name="type">The desired image type.</param>
/// <returns>True if the plugin can save bitmaps as the desired type, else false.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FIFSupportsExportType")]
public static extern bool FIFSupportsExportType(FREE_IMAGE_FORMAT fif, FREE_IMAGE_TYPE type);
/// <summary>
/// Checks if a plugin can load or save an ICC profile.
/// </summary>
/// <param name="fif">The <see cref="FREE_IMAGE_FORMAT"/> of the plugin.</param>
/// <returns>True if the plugin can load or save an ICC profile, else false.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FIFSupportsICCProfiles")]
public static extern bool FIFSupportsICCProfiles(FREE_IMAGE_FORMAT fif);
#endregion
#region Multipage functions
/// <summary>
/// Loads a FreeImage multi-paged bitmap.
/// Load flags can be provided by the flags parameter.
/// </summary>
/// <param name="fif">Format of the image.</param>
/// <param name="filename">The complete name of the file to load.</param>
/// <param name="create_new">When true a new bitmap is created.</param>
/// <param name="read_only">When true the bitmap will be loaded read only.</param>
/// <param name="keep_cache_in_memory">When true performance is increased at the cost of memory.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage multi-paged bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_OpenMultiBitmap")]
public static extern FIMULTIBITMAP OpenMultiBitmap(FREE_IMAGE_FORMAT fif, string filename, bool create_new,
bool read_only, bool keep_cache_in_memory, FREE_IMAGE_LOAD_FLAGS flags);
/// <summary>
/// Loads a FreeImage multi-pages bitmap from the specified handle
/// using the specified functions.
/// Load flags can be provided by the flags parameter.
/// </summary>
/// <param name="fif">Format of the image.</param>
/// <param name="io">IO functions used to read from the specified handle.</param>
/// <param name="handle">The handle to load the bitmap from.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Handle to a FreeImage multi-paged bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_OpenMultiBitmapFromHandle")]
public static extern FIMULTIBITMAP OpenMultiBitmapFromHandle(FREE_IMAGE_FORMAT fif, ref FreeImageIO io,
fi_handle handle, FREE_IMAGE_LOAD_FLAGS flags);
/// <summary>
/// Closes a previously opened multi-page bitmap and, when the bitmap was not opened read-only, applies any changes made to it.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="flags">Flags to enable or disable plugin-features.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_CloseMultiBitmap")]
private static extern bool CloseMultiBitmap_(FIMULTIBITMAP bitmap, FREE_IMAGE_SAVE_FLAGS flags);
/// <summary>
/// Returns the number of pages currently available in the multi-paged bitmap.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <returns>Number of pages.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetPageCount")]
public static extern int GetPageCount(FIMULTIBITMAP bitmap);
/// <summary>
/// Appends a new page to the end of the bitmap.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="data">Handle to a FreeImage bitmap.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AppendPage")]
public static extern void AppendPage(FIMULTIBITMAP bitmap, FIBITMAP data);
/// <summary>
/// Inserts a new page before the given position in the bitmap.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="page">Page has to be a number smaller than the current number of pages available in the bitmap.</param>
/// <param name="data">Handle to a FreeImage bitmap.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_InsertPage")]
public static extern void InsertPage(FIMULTIBITMAP bitmap, int page, FIBITMAP data);
/// <summary>
/// Deletes the page on the given position.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="page">Number of the page to delete.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_DeletePage")]
public static extern void DeletePage(FIMULTIBITMAP bitmap, int page);
/// <summary>
/// Locks a page in memory for editing.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="page">Number of the page to lock.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_LockPage")]
public static extern FIBITMAP LockPage(FIMULTIBITMAP bitmap, int page);
/// <summary>
/// Unlocks a previously locked page and gives it back to the multi-page engine.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="data">Handle to a FreeImage bitmap.</param>
/// <param name="changed">If true, the page is applied to the multi-page bitmap.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_UnlockPage")]
public static extern void UnlockPage(FIMULTIBITMAP bitmap, FIBITMAP data, bool changed);
/// <summary>
/// Moves the source page to the position of the target page.
/// </summary>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="target">New position of the page.</param>
/// <param name="source">Old position of the page.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_MovePage")]
public static extern bool MovePage(FIMULTIBITMAP bitmap, int target, int source);
/// <summary>
/// Returns an array of page-numbers that are currently locked in memory.
/// When the pages parameter is null, the size of the array is returned in the count variable.
/// </summary>
/// <example>
/// <code>
/// int[] lockedPages = null;
/// int count = 0;
/// GetLockedPageNumbers(dib, lockedPages, ref count);
/// lockedPages = new int[count];
/// GetLockedPageNumbers(dib, lockedPages, ref count);
/// </code>
/// </example>
/// <param name="bitmap">Handle to a FreeImage multi-paged bitmap.</param>
/// <param name="pages">The list of locked pages in the multi-pages bitmap.
/// If set to null, count will contain the number of pages.</param>
/// <param name="count">If <paramref name="pages"/> is set to null count will contain the number of locked pages.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetLockedPageNumbers")]
public static extern bool GetLockedPageNumbers(FIMULTIBITMAP bitmap, int[] pages, ref int count);
#endregion
#region Filetype functions
/// <summary>
/// Orders FreeImage to analyze the bitmap signature.
/// </summary>
/// <param name="filename">Name of the file to analyze.</param>
/// <param name="size">Reserved parameter - use 0.</param>
/// <returns>Type of the bitmap.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_GetFileTypeU")]
public static extern FREE_IMAGE_FORMAT GetFileType(string filename, int size);
/// <summary>
/// Orders FreeImage to analyze the bitmap signature.
/// Supports UNICODE filenames.
/// </summary>
/// <param name="filename">Name of the file to analyze.</param>
/// <param name="size">Reserved parameter - use 0.</param>
/// <returns>Type of the bitmap.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_GetFileTypeU")]
private static extern FREE_IMAGE_FORMAT GetFileTypeU(string filename, int size);
/// <summary>
/// Uses the <see cref="FreeImageIO"/> structure as described in the topic bitmap management functions
/// to identify a bitmap type.
/// </summary>
/// <param name="io">A <see cref="FreeImageIO"/> structure with functionpointers to handle the source.</param>
/// <param name="handle">A handle to the source.</param>
/// <param name="size">Size in bytes of the source.</param>
/// <returns>Type of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFileTypeFromHandle")]
public static extern FREE_IMAGE_FORMAT GetFileTypeFromHandle(ref FreeImageIO io, fi_handle handle, int size);
/// <summary>
/// Uses a memory handle to identify a bitmap type.
/// </summary>
/// <param name="stream">Pointer to the stream.</param>
/// <param name="size">Size in bytes of the source.</param>
/// <returns>Type of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetFileTypeFromMemory")]
public static extern FREE_IMAGE_FORMAT GetFileTypeFromMemory(FIMEMORY stream, int size);
#endregion
#region Helper functions
/// <summary>
/// Returns whether the platform is using Little Endian.
/// </summary>
/// <returns>Returns true if the platform is using Litte Endian, else false.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_IsLittleEndian")]
public static extern bool IsLittleEndian();
/// <summary>
/// Converts a X11 color name into a corresponding RGB value.
/// </summary>
/// <param name="szColor">Name of the color to convert.</param>
/// <param name="nRed">Red component.</param>
/// <param name="nGreen">Green component.</param>
/// <param name="nBlue">Blue component.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_LookupX11Color")]
public static extern bool LookupX11Color(string szColor, out byte nRed, out byte nGreen, out byte nBlue);
/// <summary>
/// Converts a SVG color name into a corresponding RGB value.
/// </summary>
/// <param name="szColor">Name of the color to convert.</param>
/// <param name="nRed">Red component.</param>
/// <param name="nGreen">Green component.</param>
/// <param name="nBlue">Blue component.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_LookupSVGColor")]
public static extern bool LookupSVGColor(string szColor, out byte nRed, out byte nGreen, out byte nBlue);
#endregion
#region Pixel access functions
/// <summary>
/// Returns a pointer to the data-bits of the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Pointer to the data-bits.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetBits")]
public static extern IntPtr GetBits(FIBITMAP dib);
/// <summary>
/// Returns a pointer to the start of the given scanline in the bitmap's data-bits.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="scanline">Number of the scanline.</param>
/// <returns>Pointer to the scanline.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetScanLine")]
public static extern IntPtr GetScanLine(FIBITMAP dib, int scanline);
/// <summary>
/// Get the pixel index of a palettized image at position (x, y), including range check (slow access).
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="x">Pixel position in horizontal direction.</param>
/// <param name="y">Pixel position in vertical direction.</param>
/// <param name="value">The pixel index.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetPixelIndex")]
public static extern bool GetPixelIndex(FIBITMAP dib, uint x, uint y, out byte value);
/// <summary>
/// Get the pixel color of a 16-, 24- or 32-bit image at position (x, y), including range check (slow access).
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="x">Pixel position in horizontal direction.</param>
/// <param name="y">Pixel position in vertical direction.</param>
/// <param name="value">The pixel color.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetPixelColor")]
public static extern bool GetPixelColor(FIBITMAP dib, uint x, uint y, out RGBQUAD value);
/// <summary>
/// Set the pixel index of a palettized image at position (x, y), including range check (slow access).
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="x">Pixel position in horizontal direction.</param>
/// <param name="y">Pixel position in vertical direction.</param>
/// <param name="value">The new pixel index.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetPixelIndex")]
public static extern bool SetPixelIndex(FIBITMAP dib, uint x, uint y, ref byte value);
/// <summary>
/// Set the pixel color of a 16-, 24- or 32-bit image at position (x, y), including range check (slow access).
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="x">Pixel position in horizontal direction.</param>
/// <param name="y">Pixel position in vertical direction.</param>
/// <param name="value">The new pixel color.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetPixelColor")]
public static extern bool SetPixelColor(FIBITMAP dib, uint x, uint y, ref RGBQUAD value);
#endregion
#region Bitmap information functions
/// <summary>
/// Retrieves the type of the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Type of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetImageType")]
public static extern FREE_IMAGE_TYPE GetImageType(FIBITMAP dib);
/// <summary>
/// Returns the number of colors used in a bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Palette-size for palletised bitmaps, and 0 for high-colour bitmaps.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetColorsUsed")]
public static extern uint GetColorsUsed(FIBITMAP dib);
/// <summary>
/// Returns the size of one pixel in the bitmap in bits.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Size of one pixel in the bitmap in bits.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetBPP")]
public static extern uint GetBPP(FIBITMAP dib);
/// <summary>
/// Returns the width of the bitmap in pixel units.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>With of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetWidth")]
public static extern uint GetWidth(FIBITMAP dib);
/// <summary>
/// Returns the height of the bitmap in pixel units.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Height of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetHeight")]
public static extern uint GetHeight(FIBITMAP dib);
/// <summary>
/// Returns the width of the bitmap in bytes.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>With of the bitmap in bytes.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetLine")]
public static extern uint GetLine(FIBITMAP dib);
/// <summary>
/// Returns the width of the bitmap in bytes, rounded to the next 32-bit boundary,
/// also known as pitch or stride or scan width.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>With of the bitmap in bytes.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetPitch")]
public static extern uint GetPitch(FIBITMAP dib);
/// <summary>
/// Returns the size of the DIB-element of a FIBITMAP in memory.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Size of the DIB-element</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetDIBSize")]
public static extern uint GetDIBSize(FIBITMAP dib);
/// <summary>
/// Returns a pointer to the bitmap's palette.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Pointer to the bitmap's palette.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetPalette")]
public static extern IntPtr GetPalette(FIBITMAP dib);
/// <summary>
/// Returns the horizontal resolution, in pixels-per-meter, of the target device for the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The horizontal resolution, in pixels-per-meter.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetDotsPerMeterX")]
public static extern uint GetDotsPerMeterX(FIBITMAP dib);
/// <summary>
/// Returns the vertical resolution, in pixels-per-meter, of the target device for the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The vertical resolution, in pixels-per-meter.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetDotsPerMeterY")]
public static extern uint GetDotsPerMeterY(FIBITMAP dib);
/// <summary>
/// Set the horizontal resolution, in pixels-per-meter, of the target device for the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="res">The new horizontal resolution.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetDotsPerMeterX")]
public static extern void SetDotsPerMeterX(FIBITMAP dib, uint res);
/// <summary>
/// Set the vertical resolution, in pixels-per-meter, of the target device for the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="res">The new vertical resolution.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetDotsPerMeterY")]
public static extern void SetDotsPerMeterY(FIBITMAP dib, uint res);
/// <summary>
/// Returns a pointer to the <see cref="BITMAPINFOHEADER"/> of the DIB-element in a FIBITMAP.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Poiter to the header of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetInfoHeader")]
public static extern IntPtr GetInfoHeader(FIBITMAP dib);
/// <summary>
/// Alias for FreeImage_GetInfoHeader that returns a pointer to a <see cref="BITMAPINFO"/>
/// rather than to a <see cref="BITMAPINFOHEADER"/>.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Pointer to the <see cref="BITMAPINFO"/> structure for the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetInfo")]
public static extern IntPtr GetInfo(FIBITMAP dib);
/// <summary>
/// Investigates the color type of the bitmap by reading the bitmap's pixel bits and analysing them.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The color type of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetColorType")]
public static extern FREE_IMAGE_COLOR_TYPE GetColorType(FIBITMAP dib);
/// <summary>
/// Returns a bit pattern describing the red color component of a pixel in a FreeImage bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The bit pattern for RED.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetRedMask")]
public static extern uint GetRedMask(FIBITMAP dib);
/// <summary>
/// Returns a bit pattern describing the green color component of a pixel in a FreeImage bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The bit pattern for green.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetGreenMask")]
public static extern uint GetGreenMask(FIBITMAP dib);
/// <summary>
/// Returns a bit pattern describing the blue color component of a pixel in a FreeImage bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The bit pattern for blue.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetBlueMask")]
public static extern uint GetBlueMask(FIBITMAP dib);
/// <summary>
/// Returns the number of transparent colors in a palletised bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The number of transparent colors in a palletised bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTransparencyCount")]
public static extern uint GetTransparencyCount(FIBITMAP dib);
/// <summary>
/// Returns a pointer to the bitmap's transparency table.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Pointer to the bitmap's transparency table.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTransparencyTable")]
public static extern IntPtr GetTransparencyTable(FIBITMAP dib);
/// <summary>
/// Tells FreeImage if it should make use of the transparency table
/// or the alpha channel that may accompany a bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="enabled">True to enable the transparency, false to disable.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTransparent")]
public static extern void SetTransparent(FIBITMAP dib, bool enabled);
/// <summary>
/// Set the bitmap's transparency table. Only affects palletised bitmaps.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="table">Pointer to the bitmap's new transparency table.</param>
/// <param name="count">The number of transparent colors in the new transparency table.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTransparencyTable")]
internal static extern void SetTransparencyTable(FIBITMAP dib, byte[] table, int count);
/// <summary>
/// Returns whether the transparency table is enabled.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Returns true when the transparency table is enabled (1-, 4- or 8-bit images)
/// or when the input dib contains alpha values (32-bit images). Returns false otherwise.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_IsTransparent")]
public static extern bool IsTransparent(FIBITMAP dib);
/// <summary>
/// Returns whether the bitmap has a file background color.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Returns true when the image has a file background color, false otherwise.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_HasBackgroundColor")]
public static extern bool HasBackgroundColor(FIBITMAP dib);
/// <summary>
/// Returns the file background color of an image.
/// For 8-bit images, the color index in the palette is returned in the
/// rgbReserved member of the bkcolor parameter.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="bkcolor">The background color.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetBackgroundColor")]
public static extern bool GetBackgroundColor(FIBITMAP dib, out RGBQUAD bkcolor);
/// <summary>
/// Set the file background color of an image.
/// When saving an image to PNG, this background color is transparently saved to the PNG file.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="bkcolor">The new background color.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetBackgroundColor")]
public static unsafe extern bool SetBackgroundColor(FIBITMAP dib, ref RGBQUAD bkcolor);
/// <summary>
/// Set the file background color of an image.
/// When saving an image to PNG, this background color is transparently saved to the PNG file.
/// When the bkcolor parameter is null, the background color is removed from the image.
/// <para>
/// This overloaded version of the function with an array parameter is provided to allow
/// passing <c>null</c> in the <paramref name="bkcolor"/> parameter. This is similar to the
/// original C/C++ function. Passing <c>null</c> as <paramref name="bkcolor"/> parameter will
/// unset the dib's previously set background color.
/// </para>
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="bkcolor">The new background color.
/// The first entry in the array is used.</param>
/// <returns>Returns true on success, false on failure.</returns>
/// <example>
/// <code>
/// // create a RGBQUAD color
/// RGBQUAD color = new RGBQUAD(Color.Green);
///
/// // set the dib's background color (using the other version of the function)
/// FreeImage.SetBackgroundColor(dib, ref color);
///
/// // remove it again (this only works due to the array parameter RGBQUAD[])
/// FreeImage.SetBackgroundColor(dib, null);
/// </code>
/// </example>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetBackgroundColor")]
public static unsafe extern bool SetBackgroundColor(FIBITMAP dib, RGBQUAD[] bkcolor);
/// <summary>
/// Sets the index of the palette entry to be used as transparent color
/// for the image specified. Does nothing on high color images.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="index">The index of the palette entry to be set as transparent color.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTransparentIndex")]
public static extern void SetTransparentIndex(FIBITMAP dib, int index);
/// <summary>
/// Returns the palette entry used as transparent color for the image specified.
/// Works for palletised images only and returns -1 for high color
/// images or if the image has no color set to be transparent.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>the index of the palette entry used as transparent color for
/// the image specified or -1 if there is no transparent color found
/// (e.g. the image is a high color image).</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTransparentIndex")]
public static extern int GetTransparentIndex(FIBITMAP dib);
#endregion
#region ICC profile functions
/// <summary>
/// Retrieves the <see cref="FIICCPROFILE"/> data of the bitmap.
/// This function can also be called safely, when the original format does not support profiles.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>The <see cref="FIICCPROFILE"/> data of the bitmap.</returns>
public static FIICCPROFILE GetICCProfileEx(FIBITMAP dib) { unsafe { return *(FIICCPROFILE*)FreeImage.GetICCProfile(dib); } }
/// <summary>
/// Retrieves a pointer to the <see cref="FIICCPROFILE"/> data of the bitmap.
/// This function can also be called safely, when the original format does not support profiles.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Pointer to the <see cref="FIICCPROFILE"/> data of the bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetICCProfile")]
public static extern IntPtr GetICCProfile(FIBITMAP dib);
/// <summary>
/// Creates a new <see cref="FIICCPROFILE"/> block from ICC profile data previously read from a file
/// or built by a color management system. The profile data is attached to the bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="data">Pointer to the new <see cref="FIICCPROFILE"/> data.</param>
/// <param name="size">Size of the <see cref="FIICCPROFILE"/> data.</param>
/// <returns>Pointer to the created <see cref="FIICCPROFILE"/> structure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_CreateICCProfile")]
public static extern IntPtr CreateICCProfile(FIBITMAP dib, byte[] data, int size);
/// <summary>
/// This function destroys an <see cref="FIICCPROFILE"/> previously created by <see cref="CreateICCProfile(FIBITMAP,byte[],int)"/>.
/// After this call the bitmap will contain no profile information.
/// This function should be called to ensure that a stored bitmap will not contain any profile information.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_DestroyICCProfile")]
public static extern void DestroyICCProfile(FIBITMAP dib);
#endregion
#region Conversion functions
/// <summary>
/// Converts a bitmap to 4 bits.
/// If the bitmap was a high-color bitmap (16, 24 or 32-bit) or if it was a
/// monochrome or greyscale bitmap (1 or 8-bit), the end result will be a
/// greyscale bitmap, otherwise (1-bit palletised bitmaps) it will be a palletised bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertTo4Bits")]
public static extern FIBITMAP ConvertTo4Bits(FIBITMAP dib);
/// <summary>
/// Converts a bitmap to 8 bits. If the bitmap was a high-color bitmap (16, 24 or 32-bit)
/// or if it was a monochrome or greyscale bitmap (1 or 4-bit), the end result will be a
/// greyscale bitmap, otherwise (1 or 4-bit palletised bitmaps) it will be a palletised bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertTo8Bits")]
public static extern FIBITMAP ConvertTo8Bits(FIBITMAP dib);
/// <summary>
/// Converts a bitmap to a 8-bit greyscale image with a linear ramp.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertToGreyscale")]
public static extern FIBITMAP ConvertToGreyscale(FIBITMAP dib);
/// <summary>
/// Converts a bitmap to 16 bits, where each pixel has a color pattern of
/// 5 bits red, 5 bits green and 5 bits blue. One bit in each pixel is unused.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertTo16Bits555")]
public static extern FIBITMAP ConvertTo16Bits555(FIBITMAP dib);
/// <summary>
/// Converts a bitmap to 16 bits, where each pixel has a color pattern of
/// 5 bits red, 6 bits green and 5 bits blue.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertTo16Bits565")]
public static extern FIBITMAP ConvertTo16Bits565(FIBITMAP dib);
/// <summary>
/// Converts a bitmap to 24 bits. A clone of the input bitmap is returned for 24-bit bitmaps.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertTo24Bits")]
public static extern FIBITMAP ConvertTo24Bits(FIBITMAP dib);
/// <summary>
/// Converts a bitmap to 32 bits. A clone of the input bitmap is returned for 32-bit bitmaps.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertTo32Bits")]
public static extern FIBITMAP ConvertTo32Bits(FIBITMAP dib);
/// <summary>
/// Quantizes a high-color 24-bit bitmap to an 8-bit palette color bitmap.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="quantize">Specifies the color reduction algorithm to be used.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ColorQuantize")]
public static extern FIBITMAP ColorQuantize(FIBITMAP dib, FREE_IMAGE_QUANTIZE quantize);
/// <summary>
/// ColorQuantizeEx is an extension to the <see cref="ColorQuantize(FIBITMAP, FREE_IMAGE_QUANTIZE)"/> method that
/// provides additional options used to quantize a 24-bit image to any
/// number of colors (up to 256), as well as quantize a 24-bit image using a
/// partial or full provided palette.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="quantize">Specifies the color reduction algorithm to be used.</param>
/// <param name="PaletteSize">Size of the desired output palette.</param>
/// <param name="ReserveSize">Size of the provided palette of ReservePalette.</param>
/// <param name="ReservePalette">The provided palette.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ColorQuantizeEx")]
public static extern FIBITMAP ColorQuantizeEx(FIBITMAP dib, FREE_IMAGE_QUANTIZE quantize, int PaletteSize, int ReserveSize, RGBQUAD[] ReservePalette);
/// <summary>
/// Converts a bitmap to 1-bit monochrome bitmap using a threshold T between [0..255].
/// The function first converts the bitmap to a 8-bit greyscale bitmap.
/// Then, any brightness level that is less than T is set to zero, otherwise to 1.
/// For 1-bit input bitmaps, the function clones the input bitmap and builds a monochrome palette.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="t">The threshold.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Threshold")]
public static extern FIBITMAP Threshold(FIBITMAP dib, byte t);
/// <summary>
/// Converts a bitmap to 1-bit monochrome bitmap using a dithering algorithm.
/// For 1-bit input bitmaps, the function clones the input bitmap and builds a monochrome palette.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="algorithm">The dithering algorithm to use.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Dither")]
public static extern FIBITMAP Dither(FIBITMAP dib, FREE_IMAGE_DITHER algorithm);
/// <summary>
/// Converts a raw bitmap to a FreeImage bitmap.
/// </summary>
/// <param name="bits">Pointer to the memory block containing the raw bitmap.</param>
/// <param name="width">The width in pixels of the raw bitmap.</param>
/// <param name="height">The height in pixels of the raw bitmap.</param>
/// <param name="pitch">Defines the total width of a scanline in the raw bitmap,
/// including padding bytes.</param>
/// <param name="bpp">The bit depth (bits per pixel) of the raw bitmap.</param>
/// <param name="red_mask">The bit mask describing the bits used to store a single
/// pixel's red component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="green_mask">The bit mask describing the bits used to store a single
/// pixel's green component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="blue_mask">The bit mask describing the bits used to store a single
/// pixel's blue component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="topdown">If true, the raw bitmap is stored in top-down order (top-left pixel first)
/// and in bottom-up order (bottom-left pixel first) otherwise.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertFromRawBits")]
public static extern FIBITMAP ConvertFromRawBits(IntPtr bits, int width, int height, int pitch,
uint bpp, uint red_mask, uint green_mask, uint blue_mask, bool topdown);
/// <summary>
/// Converts a raw bitmap to a FreeImage bitmap.
/// </summary>
/// <param name="bits">Array of bytes containing the raw bitmap.</param>
/// <param name="width">The width in pixels of the raw bitmap.</param>
/// <param name="height">The height in pixels of the raw bitmap.</param>
/// <param name="pitch">Defines the total width of a scanline in the raw bitmap,
/// including padding bytes.</param>
/// <param name="bpp">The bit depth (bits per pixel) of the raw bitmap.</param>
/// <param name="red_mask">The bit mask describing the bits used to store a single
/// pixel's red component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="green_mask">The bit mask describing the bits used to store a single
/// pixel's green component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="blue_mask">The bit mask describing the bits used to store a single
/// pixel's blue component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="topdown">If true, the raw bitmap is stored in top-down order (top-left pixel first)
/// and in bottom-up order (bottom-left pixel first) otherwise.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertFromRawBits")]
public static extern FIBITMAP ConvertFromRawBits(byte[] bits, int width, int height, int pitch,
uint bpp, uint red_mask, uint green_mask, uint blue_mask, bool topdown);
/// <summary>
/// Converts a FreeImage bitmap to a raw bitmap, that is a raw piece of memory.
/// </summary>
/// <param name="bits">Pointer to the memory block receiving the raw bitmap.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="pitch">The desired total width in bytes of a scanline in the raw bitmap,
/// including any padding bytes.</param>
/// <param name="bpp">The desired bit depth (bits per pixel) of the raw bitmap.</param>
/// <param name="red_mask">The desired bit mask describing the bits used to store a single
/// pixel's red component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="green_mask">The desired bit mask describing the bits used to store a single
/// pixel's green component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="blue_mask">The desired bit mask describing the bits used to store a single
/// pixel's blue component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="topdown">If true, the raw bitmap will be stored in top-down order (top-left pixel first)
/// and in bottom-up order (bottom-left pixel first) otherwise.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertToRawBits")]
public static extern void ConvertToRawBits(IntPtr bits, FIBITMAP dib, int pitch, uint bpp,
uint red_mask, uint green_mask, uint blue_mask, bool topdown);
/// <summary>
/// Converts a FreeImage bitmap to a raw bitmap, that is a raw piece of memory.
/// </summary>
/// <param name="bits">Array of bytes receiving the raw bitmap.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="pitch">The desired total width in bytes of a scanline in the raw bitmap,
/// including any padding bytes.</param>
/// <param name="bpp">The desired bit depth (bits per pixel) of the raw bitmap.</param>
/// <param name="red_mask">The desired bit mask describing the bits used to store a single
/// pixel's red component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="green_mask">The desired bit mask describing the bits used to store a single
/// pixel's green component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="blue_mask">The desired bit mask describing the bits used to store a single
/// pixel's blue component in the raw bitmap. This is only applied to 16-bpp raw bitmaps.</param>
/// <param name="topdown">If true, the raw bitmap will be stored in top-down order (top-left pixel first)
/// and in bottom-up order (bottom-left pixel first) otherwise.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertToRawBits")]
public static extern void ConvertToRawBits(byte[] bits, FIBITMAP dib, int pitch, uint bpp,
uint red_mask, uint green_mask, uint blue_mask, bool topdown);
/// <summary>
/// Converts a 24- or 32-bit RGB(A) standard image or a 48-bit RGB image to a FIT_RGBF type image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertToRGBF")]
public static extern FIBITMAP ConvertToRGBF(FIBITMAP dib);
/// <summary>
/// Converts a non standard image whose color type is FIC_MINISBLACK
/// to a standard 8-bit greyscale image.
/// </summary>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="scale_linear">When true the conversion is done by scaling linearly
/// each pixel value from [min, max] to an integer value between [0..255],
/// where min and max are the minimum and maximum pixel values in the image.
/// When false the conversion is done by rounding each pixel value to an integer between [0..255].
///
/// Rounding is done using the following formula:
///
/// dst_pixel = (BYTE) MIN(255, MAX(0, q)) where int q = int(src_pixel + 0.5);</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertToStandardType")]
public static extern FIBITMAP ConvertToStandardType(FIBITMAP src, bool scale_linear);
/// <summary>
/// Converts an image of any type to type dst_type.
/// </summary>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="dst_type">Destination type.</param>
/// <param name="scale_linear">True to scale linear, else false.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ConvertToType")]
public static extern FIBITMAP ConvertToType(FIBITMAP src, FREE_IMAGE_TYPE dst_type, bool scale_linear);
#endregion
#region Tone mapping operators
/// <summary>
/// Converts a High Dynamic Range image (48-bit RGB or 96-bit RGBF) to a 24-bit RGB image, suitable for display.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="tmo">The tone mapping operator to be used.</param>
/// <param name="first_param">Parmeter depending on the used algorithm</param>
/// <param name="second_param">Parmeter depending on the used algorithm</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ToneMapping")]
public static extern FIBITMAP ToneMapping(FIBITMAP dib, FREE_IMAGE_TMO tmo, double first_param, double second_param);
/// <summary>
/// Converts a High Dynamic Range image to a 24-bit RGB image using a global
/// operator based on logarithmic compression of luminance values, imitating the human response to light.
/// </summary>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="gamma">A gamma correction that is applied after the tone mapping.
/// A value of 1 means no correction.</param>
/// <param name="exposure">Scale factor allowing to adjust the brightness of the output image.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_TmoDrago03")]
public static extern FIBITMAP TmoDrago03(FIBITMAP src, double gamma, double exposure);
/// <summary>
/// Converts a High Dynamic Range image to a 24-bit RGB image using a global operator inspired
/// by photoreceptor physiology of the human visual system.
/// </summary>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="intensity">Controls the overall image intensity in the range [-8, 8].</param>
/// <param name="contrast">Controls the overall image contrast in the range [0.3, 1.0[.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_TmoReinhard05")]
public static extern FIBITMAP TmoReinhard05(FIBITMAP src, double intensity, double contrast);
/// <summary>
/// Apply the Gradient Domain High Dynamic Range Compression to a RGBF image and convert to 24-bit RGB.
/// </summary>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="color_saturation">Color saturation (s parameter in the paper) in [0.4..0.6]</param>
/// <param name="attenuation">Atenuation factor (beta parameter in the paper) in [0.8..0.9]</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_TmoFattal02")]
public static extern FIBITMAP TmoFattal02(FIBITMAP src, double color_saturation, double attenuation);
#endregion
#region Compression functions
/// <summary>
/// Compresses a source buffer into a target buffer, using the ZLib library.
/// </summary>
/// <param name="target">Pointer to the target buffer.</param>
/// <param name="target_size">Size of the target buffer.
/// Must be at least 0.1% larger than source_size plus 12 bytes.</param>
/// <param name="source">Pointer to the source buffer.</param>
/// <param name="source_size">Size of the source buffer.</param>
/// <returns>The actual size of the compressed buffer, or 0 if an error occurred.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ZLibCompress")]
public static extern uint ZLibCompress(byte[] target, uint target_size, byte[] source, uint source_size);
/// <summary>
/// Decompresses a source buffer into a target buffer, using the ZLib library.
/// </summary>
/// <param name="target">Pointer to the target buffer.</param>
/// <param name="target_size">Size of the target buffer.
/// Must have been saved outlide of zlib.</param>
/// <param name="source">Pointer to the source buffer.</param>
/// <param name="source_size">Size of the source buffer.</param>
/// <returns>The actual size of the uncompressed buffer, or 0 if an error occurred.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ZLibUncompress")]
public static extern uint ZLibUncompress(byte[] target, uint target_size, byte[] source, uint source_size);
/// <summary>
/// Compresses a source buffer into a target buffer, using the ZLib library.
/// </summary>
/// <param name="target">Pointer to the target buffer.</param>
/// <param name="target_size">Size of the target buffer.
/// Must be at least 0.1% larger than source_size plus 24 bytes.</param>
/// <param name="source">Pointer to the source buffer.</param>
/// <param name="source_size">Size of the source buffer.</param>
/// <returns>The actual size of the compressed buffer, or 0 if an error occurred.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ZLibGZip")]
public static extern uint ZLibGZip(byte[] target, uint target_size, byte[] source, uint source_size);
/// <summary>
/// Decompresses a source buffer into a target buffer, using the ZLib library.
/// </summary>
/// <param name="target">Pointer to the target buffer.</param>
/// <param name="target_size">Size of the target buffer.
/// Must have been saved outlide of zlib.</param>
/// <param name="source">Pointer to the source buffer.</param>
/// <param name="source_size">Size of the source buffer.</param>
/// <returns>The actual size of the uncompressed buffer, or 0 if an error occurred.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ZLibGUnzip")]
public static extern uint ZLibGUnzip(byte[] target, uint target_size, byte[] source, uint source_size);
/// <summary>
/// Generates a CRC32 checksum.
/// </summary>
/// <param name="crc">The CRC32 checksum to begin with.</param>
/// <param name="source">Pointer to the source buffer.
/// If the value is 0, the function returns the required initial value for the crc.</param>
/// <param name="source_size">Size of the source buffer.</param>
/// <returns></returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ZLibCRC32")]
public static extern uint ZLibCRC32(uint crc, byte[] source, uint source_size);
#endregion
#region Tag creation and destruction
/// <summary>
/// Allocates a new <see cref="FITAG"/> object.
/// This object must be destroyed with a call to
/// <see cref="FreeImageAPI.FreeImage.DeleteTag(FITAG)"/> when no longer in use.
/// </summary>
/// <returns>The new <see cref="FITAG"/>.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_CreateTag")]
public static extern FITAG CreateTag();
/// <summary>
/// Delete a previously allocated <see cref="FITAG"/> object.
/// </summary>
/// <param name="tag">The <see cref="FITAG"/> to destroy.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_DeleteTag")]
public static extern void DeleteTag(FITAG tag);
/// <summary>
/// Creates and returns a copy of a <see cref="FITAG"/> object.
/// </summary>
/// <param name="tag">The <see cref="FITAG"/> to clone.</param>
/// <returns>The new <see cref="FITAG"/>.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_CloneTag")]
public static extern FITAG CloneTag(FITAG tag);
#endregion
#region Tag accessors
/// <summary>
/// Returns the tag field name (unique inside a metadata model).
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>The field name.</returns>
public static unsafe string GetTagKey(FITAG tag) { return PtrToStr(GetTagKey_(tag)); }
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetTagKey")]
private static unsafe extern byte* GetTagKey_(FITAG tag);
/// <summary>
/// Returns the tag description.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>The description or NULL if unavailable.</returns>
public static unsafe string GetTagDescription(FITAG tag) { return PtrToStr(GetTagDescription_(tag)); }
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetTagDescription")]
private static unsafe extern byte* GetTagDescription_(FITAG tag);
/// <summary>
/// Returns the tag ID.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>The ID or 0 if unavailable.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTagID")]
public static extern ushort GetTagID(FITAG tag);
/// <summary>
/// Returns the tag data type.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>The tag type.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTagType")]
public static extern FREE_IMAGE_MDTYPE GetTagType(FITAG tag);
/// <summary>
/// Returns the number of components in the tag (in tag type units).
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>The number of components.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTagCount")]
public static extern uint GetTagCount(FITAG tag);
/// <summary>
/// Returns the length of the tag value in bytes.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>The length of the tag value.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTagLength")]
public static extern uint GetTagLength(FITAG tag);
/// <summary>
/// Returns the tag value.
/// It is up to the programmer to interpret the returned pointer correctly,
/// according to the results of GetTagType and GetTagCount.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <returns>Pointer to the value.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetTagValue")]
public static extern IntPtr GetTagValue(FITAG tag);
/// <summary>
/// Sets the tag field name.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="key">The new name.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_SetTagKey")]
public static extern bool SetTagKey(FITAG tag, string key);
/// <summary>
/// Sets the tag description.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="description">The new description.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_SetTagDescription")]
public static extern bool SetTagDescription(FITAG tag, string description);
/// <summary>
/// Sets the tag ID.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="id">The new ID.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTagID")]
public static extern bool SetTagID(FITAG tag, ushort id);
/// <summary>
/// Sets the tag data type.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="type">The new type.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTagType")]
public static extern bool SetTagType(FITAG tag, FREE_IMAGE_MDTYPE type);
/// <summary>
/// Sets the number of data in the tag.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="count">New number of data.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTagCount")]
public static extern bool SetTagCount(FITAG tag, uint count);
/// <summary>
/// Sets the length of the tag value in bytes.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="length">The new length.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTagLength")]
public static extern bool SetTagLength(FITAG tag, uint length);
/// <summary>
/// Sets the tag value.
/// </summary>
/// <param name="tag">The tag field.</param>
/// <param name="value">Pointer to the new value.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetTagValue")]
public static extern bool SetTagValue(FITAG tag, byte[] value);
#endregion
#region Metadata iterator
/// <summary>
/// Provides information about the first instance of a tag that matches the metadata model.
/// </summary>
/// <param name="model">The model to match.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="tag">Tag that matches the metadata model.</param>
/// <returns>Unique search handle that can be used to call FindNextMetadata or FindCloseMetadata.
/// Null if the metadata model does not exist.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FindFirstMetadata")]
public static extern FIMETADATA FindFirstMetadata(FREE_IMAGE_MDMODEL model, FIBITMAP dib, out FITAG tag);
/// <summary>
/// Find the next tag, if any, that matches the metadata model argument in a previous call
/// to FindFirstMetadata, and then alters the tag object contents accordingly.
/// </summary>
/// <param name="mdhandle">Unique search handle provided by FindFirstMetadata.</param>
/// <param name="tag">Tag that matches the metadata model.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FindNextMetadata")]
public static extern bool FindNextMetadata(FIMETADATA mdhandle, out FITAG tag);
/// <summary>
/// Closes the specified metadata search handle and releases associated resources.
/// </summary>
/// <param name="mdhandle">The handle to close.</param>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FindCloseMetadata")]
private static extern void FindCloseMetadata_(FIMETADATA mdhandle);
#endregion
#region Metadata setter and getter
/// <summary>
/// Retrieve a metadata attached to a dib.
/// </summary>
/// <param name="model">The metadata model to look for.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="key">The metadata field name.</param>
/// <param name="tag">A FITAG structure returned by the function.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_GetMetadata")]
public static extern bool GetMetadata(FREE_IMAGE_MDMODEL model, FIBITMAP dib, string key, out FITAG tag);
/// <summary>
/// Attach a new FreeImage tag to a dib.
/// </summary>
/// <param name="model">The metadata model used to store the tag.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="key">The tag field name.</param>
/// <param name="tag">The FreeImage tag to be attached.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_SetMetadata")]
public static extern bool SetMetadata(FREE_IMAGE_MDMODEL model, FIBITMAP dib, string key, FITAG tag);
#endregion
#region Metadata helper functions
/// <summary>
/// Returns the number of tags contained in the model metadata model attached to the input dib.
/// </summary>
/// <param name="model">The metadata model.</param>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Number of tags contained in the metadata model.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetMetadataCount")]
public static extern uint GetMetadataCount(FREE_IMAGE_MDMODEL model, FIBITMAP dib);
/// <summary>
/// Copies the metadata of FreeImage bitmap to another.
/// </summary>
/// <param name="dst">The FreeImage bitmap to copy the metadata to.</param>
/// <param name="src">The FreeImage bitmap to copy the metadata from.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_CloneMetadata")]
public static extern bool CloneMetadata(FIBITMAP dst, FIBITMAP src);
/// <summary>
/// Converts a FreeImage tag structure to a string that represents the interpreted tag value.
/// The function is not thread safe.
/// </summary>
/// <param name="model">The metadata model.</param>
/// <param name="tag">The interpreted tag value.</param>
/// <param name="Make">Reserved.</param>
/// <returns>The representing string.</returns>
public static unsafe string TagToString(FREE_IMAGE_MDMODEL model, FITAG tag, uint Make) { return PtrToStr(TagToString_(model, tag, Make)); }
[DllImport(FreeImageLibrary, CharSet = CharSet.Ansi, EntryPoint = "FreeImage_TagToString")]
private static unsafe extern byte* TagToString_(FREE_IMAGE_MDMODEL model, FITAG tag, uint Make);
#endregion
#region Rotation and flipping
/// <summary>
/// This function rotates a 1-, 8-bit greyscale or a 24-, 32-bit color image by means of 3 shears.
/// 1-bit images rotation is limited to integer multiple of 90.
/// <c>null</c> is returned for other values.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="angle">The angle of rotation.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_RotateClassic")]
[Obsolete("RotateClassic is deprecated (use Rotate instead).")]
public static extern FIBITMAP RotateClassic(FIBITMAP dib, double angle);
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Rotate")]
internal static extern FIBITMAP Rotate(FIBITMAP dib, double angle, IntPtr backgroundColor);
/// <summary>
/// This function performs a rotation and / or translation of an 8-bit greyscale,
/// 24- or 32-bit image, using a 3rd order (cubic) B-Spline.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="angle">The angle of rotation.</param>
/// <param name="x_shift">Horizontal image translation.</param>
/// <param name="y_shift">Vertical image translation.</param>
/// <param name="x_origin">Rotation center x-coordinate.</param>
/// <param name="y_origin">Rotation center y-coordinate.</param>
/// <param name="use_mask">When true the irrelevant part of the image is set to a black color,
/// otherwise, a mirroring technique is used to fill irrelevant pixels.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_RotateEx")]
public static extern FIBITMAP RotateEx(FIBITMAP dib, double angle,
double x_shift, double y_shift, double x_origin, double y_origin, bool use_mask);
/// <summary>
/// Flip the input dib horizontally along the vertical axis.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FlipHorizontal")]
public static extern bool FlipHorizontal(FIBITMAP dib);
/// <summary>
/// Flip the input dib vertically along the horizontal axis.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FlipVertical")]
public static extern bool FlipVertical(FIBITMAP dib);
/// <summary>
/// Performs a lossless rotation or flipping on a JPEG file.
/// </summary>
/// <param name="src_file">Source file.</param>
/// <param name="dst_file">Destination file; can be the source file; will be overwritten.</param>
/// <param name="operation">The operation to apply.</param>
/// <param name="perfect">To avoid lossy transformation, you can set the perfect parameter to true.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_JPEGTransformU")]
public static extern bool JPEGTransform(string src_file, string dst_file,
FREE_IMAGE_JPEG_OPERATION operation, bool perfect);
#endregion
#region Upsampling / downsampling
/// <summary>
/// Performs resampling (or scaling, zooming) of a greyscale or RGB(A) image
/// to the desired destination width and height.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="dst_width">Destination width.</param>
/// <param name="dst_height">Destination height.</param>
/// <param name="filter">The filter to apply.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Rescale")]
public static extern FIBITMAP Rescale(FIBITMAP dib, int dst_width, int dst_height, FREE_IMAGE_FILTER filter);
/// <summary>
/// Creates a thumbnail from a greyscale or RGB(A) image, keeping aspect ratio.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="max_pixel_size">Thumbnail square size.</param>
/// <param name="convert">When true HDR images are transperantly converted to standard images.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_MakeThumbnail")]
public static extern FIBITMAP MakeThumbnail(FIBITMAP dib, int max_pixel_size, bool convert);
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_EnlargeCanvas")]
internal static extern FIBITMAP EnlargeCanvas(FIBITMAP dib,
int left, int top, int right, int bottom, IntPtr color, FREE_IMAGE_COLOR_OPTIONS options);
#endregion
#region Color manipulation
/// <summary>
/// Perfoms an histogram transformation on a 8-, 24- or 32-bit image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="lookUpTable">The lookup table.
/// It's size is assumed to be 256 in length.</param>
/// <param name="channel">The color channel to be transformed.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AdjustCurve")]
public static extern bool AdjustCurve(FIBITMAP dib, byte[] lookUpTable, FREE_IMAGE_COLOR_CHANNEL channel);
/// <summary>
/// Performs gamma correction on a 8-, 24- or 32-bit image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="gamma">The parameter represents the gamma value to use (gamma > 0).
/// A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AdjustGamma")]
public static extern bool AdjustGamma(FIBITMAP dib, double gamma);
/// <summary>
/// Adjusts the brightness of a 8-, 24- or 32-bit image by a certain amount.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="percentage">A value 0 means no change,
/// less than 0 will make the image darker and greater than 0 will make the image brighter.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AdjustBrightness")]
public static extern bool AdjustBrightness(FIBITMAP dib, double percentage);
/// <summary>
/// Adjusts the contrast of a 8-, 24- or 32-bit image by a certain amount.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="percentage">A value 0 means no change,
/// less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AdjustContrast")]
public static extern bool AdjustContrast(FIBITMAP dib, double percentage);
/// <summary>
/// Inverts each pixel data.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Invert")]
public static extern bool Invert(FIBITMAP dib);
/// <summary>
/// Computes the image histogram.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="histo">Array of integers with a size of 256.</param>
/// <param name="channel">Channel to compute from.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetHistogram")]
public static extern bool GetHistogram(FIBITMAP dib, int[] histo, FREE_IMAGE_COLOR_CHANNEL channel);
#endregion
#region Channel processing
/// <summary>
/// Retrieves the red, green, blue or alpha channel of a 24- or 32-bit image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="channel">The color channel to extract.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetChannel")]
public static extern FIBITMAP GetChannel(FIBITMAP dib, FREE_IMAGE_COLOR_CHANNEL channel);
/// <summary>
/// Insert a 8-bit dib into a 24- or 32-bit image.
/// Both images must have to same width and height.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="dib8">Handle to the bitmap to insert.</param>
/// <param name="channel">The color channel to replace.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetChannel")]
public static extern bool SetChannel(FIBITMAP dib, FIBITMAP dib8, FREE_IMAGE_COLOR_CHANNEL channel);
/// <summary>
/// Retrieves the real part, imaginary part, magnitude or phase of a complex image.
/// </summary>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="channel">The color channel to extract.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetComplexChannel")]
public static extern FIBITMAP GetComplexChannel(FIBITMAP src, FREE_IMAGE_COLOR_CHANNEL channel);
/// <summary>
/// Set the real or imaginary part of a complex image.
/// Both images must have to same width and height.
/// </summary>
/// <param name="dst">Handle to a FreeImage bitmap.</param>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="channel">The color channel to replace.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SetComplexChannel")]
public static extern bool SetComplexChannel(FIBITMAP dst, FIBITMAP src, FREE_IMAGE_COLOR_CHANNEL channel);
#endregion
#region Copy / Paste / Composite routines
/// <summary>
/// Copy a sub part of the current dib image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="left">Specifies the left position of the cropped rectangle.</param>
/// <param name="top">Specifies the top position of the cropped rectangle.</param>
/// <param name="right">Specifies the right position of the cropped rectangle.</param>
/// <param name="bottom">Specifies the bottom position of the cropped rectangle.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Copy")]
public static extern FIBITMAP Copy(FIBITMAP dib, int left, int top, int right, int bottom);
/// <summary>
/// Alpha blend or combine a sub part image with the current dib image.
/// The bit depth of the dst bitmap must be greater than or equal to the bit depth of the src.
/// </summary>
/// <param name="dst">Handle to a FreeImage bitmap.</param>
/// <param name="src">Handle to a FreeImage bitmap.</param>
/// <param name="left">Specifies the left position of the sub image.</param>
/// <param name="top">Specifies the top position of the sub image.</param>
/// <param name="alpha">alpha blend factor.
/// The source and destination images are alpha blended if alpha=0..255.
/// If alpha > 255, then the source image is combined to the destination image.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Paste")]
public static extern bool Paste(FIBITMAP dst, FIBITMAP src, int left, int top, int alpha);
/// <summary>
/// This function composite a transparent foreground image against a single background color or
/// against a background image.
/// </summary>
/// <param name="fg">Handle to a FreeImage bitmap.</param>
/// <param name="useFileBkg">When true the background of fg is used if it contains one.</param>
/// <param name="appBkColor">The application background is used if useFileBkg is false.</param>
/// <param name="bg">Image used as background when useFileBkg is false or fg has no background
/// and appBkColor is null.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Composite")]
public static extern FIBITMAP Composite(FIBITMAP fg, bool useFileBkg, ref RGBQUAD appBkColor, FIBITMAP bg);
/// <summary>
/// This function composite a transparent foreground image against a single background color or
/// against a background image.
/// </summary>
/// <param name="fg">Handle to a FreeImage bitmap.</param>
/// <param name="useFileBkg">When true the background of fg is used if it contains one.</param>
/// <param name="appBkColor">The application background is used if useFileBkg is false
/// and 'appBkColor' is not null.</param>
/// <param name="bg">Image used as background when useFileBkg is false or fg has no background
/// and appBkColor is null.</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_Composite")]
public static extern FIBITMAP Composite(FIBITMAP fg, bool useFileBkg, RGBQUAD[] appBkColor, FIBITMAP bg);
/// <summary>
/// Performs a lossless crop on a JPEG file.
/// </summary>
/// <param name="src_file">Source filename.</param>
/// <param name="dst_file">Destination filename.</param>
/// <param name="left">Specifies the left position of the cropped rectangle.</param>
/// <param name="top">Specifies the top position of the cropped rectangle.</param>
/// <param name="right">Specifies the right position of the cropped rectangle.</param>
/// <param name="bottom">Specifies the bottom position of the cropped rectangle.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, CharSet = CharSet.Unicode, EntryPoint = "FreeImage_JPEGCropU")]
public static extern bool JPEGCrop(string src_file, string dst_file, int left, int top, int right, int bottom);
/// <summary>
/// Applies the alpha value of each pixel to its color components.
/// The aplha value stays unchanged.
/// Only works with 32-bits color depth.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <returns>Returns true on success, false on failure.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_PreMultiplyWithAlpha")]
public static extern bool PreMultiplyWithAlpha(FIBITMAP dib);
#endregion
#region Miscellaneous algorithms
/// <summary>
/// Solves a Poisson equation, remap result pixels to [0..1] and returns the solution.
/// </summary>
/// <param name="Laplacian">Handle to a FreeImage bitmap.</param>
/// <param name="ncycle">Number of cycles in the multigrid algorithm (usually 2 or 3)</param>
/// <returns>Handle to a FreeImage bitmap.</returns>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_MultigridPoissonSolver")]
public static extern FIBITMAP MultigridPoissonSolver(FIBITMAP Laplacian, int ncycle);
#endregion
#region Colors
/// <summary>
/// Creates a lookup table to be used with <see cref="AdjustCurve"/> which may adjusts brightness and
/// contrast, correct gamma and invert the image with a single call to <see cref="AdjustCurve"/>.
/// </summary>
/// <param name="lookUpTable">Output lookup table to be used with <see cref="AdjustCurve"/>.
/// The size of 'lookUpTable' is assumed to be 256.</param>
/// <param name="brightness">Percentage brightness value where -100 <= brightness <= 100.
/// <para>A value of 0 means no change, less than 0 will make the image darker and greater
/// than 0 will make the image brighter.</para></param>
/// <param name="contrast">Percentage contrast value where -100 <= contrast <= 100.
/// <para>A value of 0 means no change, less than 0 will decrease the contrast
/// and greater than 0 will increase the contrast of the image.</para></param>
/// <param name="gamma">Gamma value to be used for gamma correction.
/// <para>A value of 1.0 leaves the image alone, less than one darkens it,
/// and greater than one lightens it.</para></param>
/// <param name="invert">If set to true, the image will be inverted.</param>
/// <returns>The number of adjustments applied to the resulting lookup table
/// compared to a blind lookup table.</returns>
/// <remarks>
/// This function creates a lookup table to be used with <see cref="AdjustCurve"/> which may adjust
/// brightness and contrast, correct gamma and invert the image with a single call to
/// <see cref="AdjustCurve"/>. If more than one of these image display properties need to be adjusted,
/// using a combined lookup table should be preferred over calling each adjustment function
/// separately. That's particularly true for huge images or if performance is an issue. Then,
/// the expensive process of iterating over all pixels of an image is performed only once and
/// not up to four times.
/// <para/>
/// Furthermore, the lookup table created does not depend on the order, in which each single
/// adjustment operation is performed. Due to rounding and byte casting issues, it actually
/// matters in which order individual adjustment operations are performed. Both of the following
/// snippets most likely produce different results:
/// <para/>
/// <code>
/// // snippet 1: contrast, brightness
/// AdjustContrast(dib, 15.0);
/// AdjustBrightness(dib, 50.0);
/// </code>
/// <para/>
/// <code>
/// // snippet 2: brightness, contrast
/// AdjustBrightness(dib, 50.0);
/// AdjustContrast(dib, 15.0);
/// </code>
/// <para/>
/// Better and even faster would be snippet 3:
/// <para/>
/// <code>
/// // snippet 3:
/// byte[] lut = new byte[256];
/// GetAdjustColorsLookupTable(lut, 50.0, 15.0, 1.0, false);
/// AdjustCurve(dib, lut, FREE_IMAGE_COLOR_CHANNEL.FICC_RGB);
/// </code>
/// <para/>
/// This function is also used internally by <see cref="AdjustColors"/>, which does not return the
/// lookup table, but uses it to call <see cref="AdjustCurve"/> on the passed image.
/// </remarks>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_GetAdjustColorsLookupTable")]
public static extern int GetAdjustColorsLookupTable(byte[] lookUpTable, double brightness, double contrast, double gamma, bool invert);
/// <summary>
/// Adjusts an image's brightness, contrast and gamma as well as it may
/// optionally invert the image within a single operation.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="brightness">Percentage brightness value where -100 <= brightness <= 100.
/// <para>A value of 0 means no change, less than 0 will make the image darker and greater
/// than 0 will make the image brighter.</para></param>
/// <param name="contrast">Percentage contrast value where -100 <= contrast <= 100.
/// <para>A value of 0 means no change, less than 0 will decrease the contrast
/// and greater than 0 will increase the contrast of the image.</para></param>
/// <param name="gamma">Gamma value to be used for gamma correction.
/// <para>A value of 1.0 leaves the image alone, less than one darkens it,
/// and greater than one lightens it.</para>
/// This parameter must not be zero or smaller than zero.
/// If so, it will be ignored and no gamma correction will be performed on the image.</param>
/// <param name="invert">If set to true, the image will be inverted.</param>
/// <returns>Returns true on success, false on failure.</returns>
/// <remarks>
/// This function adjusts an image's brightness, contrast and gamma as well as it
/// may optionally invert the image within a single operation. If more than one of
/// these image display properties need to be adjusted, using this function should
/// be preferred over calling each adjustment function separately. That's particularly
/// true for huge images or if performance is an issue.
/// <para/>
/// This function relies on <see cref="GetAdjustColorsLookupTable"/>,
/// which creates a single lookup table, that combines all adjustment operations requested.
/// <para/>
/// Furthermore, the lookup table created by <see cref="GetAdjustColorsLookupTable"/> does
/// not depend on the order, in which each single adjustment operation is performed.
/// Due to rounding and byte casting issues, it actually matters in which order individual
/// adjustment operations are performed. Both of the following snippets most likely produce
/// different results:
/// <para/>
/// <code>
/// // snippet 1: contrast, brightness
/// AdjustContrast(dib, 15.0);
/// AdjustBrightness(dib, 50.0);
/// </code>
/// <para/>
/// <code>
/// // snippet 2: brightness, contrast
/// AdjustBrightness(dib, 50.0);
/// AdjustContrast(dib, 15.0);
/// </code>
/// <para/>
/// Better and even faster would be snippet 3:
/// <para/>
/// <code>
/// // snippet 3:
/// AdjustColors(dib, 50.0, 15.0, 1.0, false);
/// </code>
/// </remarks>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_AdjustColors")]
public static extern bool AdjustColors(FIBITMAP dib, double brightness, double contrast, double gamma, bool invert);
/// <summary>
/// Applies color mapping for one or several colors on a 1-, 4- or 8-bit
/// palletized or a 16-, 24- or 32-bit high color image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="srccolors">Array of colors to be used as the mapping source.</param>
/// <param name="dstcolors">Array of colors to be used as the mapping destination.</param>
/// <param name="count">The number of colors to be mapped. This is the size of both
/// srccolors and dstcolors.</param>
/// <param name="ignore_alpha">If true, 32-bit images and colors are treated as 24-bit.</param>
/// <param name="swap">If true, source and destination colors are swapped, that is,
/// each destination color is also mapped to the corresponding source color.</param>
/// <returns>The total number of pixels changed.</returns>
/// <remarks>
/// This function maps up to <paramref name="count"/> colors specified in
/// <paramref name="srccolors"/> to these specified in <paramref name="dstcolors"/>.
/// Thereby, color <i>srccolors[N]</i>, if found in the image, will be replaced by color
/// <i>dstcolors[N]</i>. If <paramref name="swap"/> is <b>true</b>, additionally all colors
/// specified in <paramref name="dstcolors"/> are also mapped to these specified
/// in <paramref name="srccolors"/>. For high color images, the actual image data will be
/// modified whereas, for palletized images only the palette will be changed.
/// <para/>
/// The function returns the number of pixels changed or zero, if no pixels were changed.
/// <para/>
/// Both arrays <paramref name="srccolors"/> and <paramref name="dstcolors"/> are assumed
/// not to hold less than <paramref name="count"/> colors.
/// <para/>
/// For 16-bit images, all colors specified are transparently converted to their
/// proper 16-bit representation (either in RGB555 or RGB565 format, which is determined
/// by the image's red- green- and blue-mask).
/// <para/>
/// <b>Note, that this behaviour is different from what <see cref="ApplyPaletteIndexMapping"/> does,
/// which modifies the actual image data on palletized images.</b>
/// </remarks>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ApplyColorMapping")]
public static extern uint ApplyColorMapping(FIBITMAP dib, RGBQUAD[] srccolors, RGBQUAD[] dstcolors, uint count, bool ignore_alpha, bool swap);
/// <summary>
/// Swaps two specified colors on a 1-, 4- or 8-bit palletized
/// or a 16-, 24- or 32-bit high color image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="color_a">One of the two colors to be swapped.</param>
/// <param name="color_b">The other of the two colors to be swapped.</param>
/// <param name="ignore_alpha">If true, 32-bit images and colors are treated as 24-bit.</param>
/// <returns>The total number of pixels changed.</returns>
/// <remarks>
/// This function swaps the two specified colors <paramref name="color_a"/> and
/// <paramref name="color_b"/> on a palletized or high color image.
/// For high color images, the actual image data will be modified whereas, for palletized
/// images only the palette will be changed.
/// <para/>
/// <b>Note, that this behaviour is different from what <see cref="SwapPaletteIndices"/> does,
/// which modifies the actual image data on palletized images.</b>
/// <para/>
/// This is just a thin wrapper for <see cref="ApplyColorMapping"/> and resolves to:
/// <para/>
/// <code>
/// return ApplyColorMapping(dib, color_a, color_b, 1, ignore_alpha, true);
/// </code>
/// </remarks>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SwapColors")]
public static extern uint SwapColors(FIBITMAP dib, ref RGBQUAD color_a, ref RGBQUAD color_b, bool ignore_alpha);
/// <summary>
/// Applies palette index mapping for one or several indices
/// on a 1-, 4- or 8-bit palletized image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="srcindices">Array of palette indices to be used as the mapping source.</param>
/// <param name="dstindices">Array of palette indices to be used as the mapping destination.</param>
/// <param name="count">The number of palette indices to be mapped. This is the size of both
/// srcindices and dstindices</param>
/// <param name="swap">If true, source and destination palette indices are swapped, that is,
/// each destination index is also mapped to the corresponding source index.</param>
/// <returns>The total number of pixels changed.</returns>
/// <remarks>
/// This function maps up to <paramref name="count"/> palette indices specified in
/// <paramref name="srcindices"/> to these specified in <paramref name="dstindices"/>.
/// Thereby, index <i>srcindices[N]</i>, if present in the image, will be replaced by index
/// <i>dstindices[N]</i>. If <paramref name="swap"/> is <b>true</b>, additionally all indices
/// specified in <paramref name="dstindices"/> are also mapped to these specified in
/// <paramref name="srcindices"/>.
/// <para/>
/// The function returns the number of pixels changed or zero, if no pixels were changed.
/// Both arrays <paramref name="srcindices"/> and <paramref name="dstindices"/> are assumed not to
/// hold less than <paramref name="count"/> indices.
/// <para/>
/// <b>Note, that this behaviour is different from what <see cref="ApplyColorMapping"/> does, which
/// modifies the actual image data on palletized images.</b>
/// </remarks>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_ApplyPaletteIndexMapping")]
public static extern uint ApplyPaletteIndexMapping(FIBITMAP dib, byte[] srcindices, byte[] dstindices, uint count, bool swap);
/// <summary>
/// Swaps two specified palette indices on a 1-, 4- or 8-bit palletized image.
/// </summary>
/// <param name="dib">Handle to a FreeImage bitmap.</param>
/// <param name="index_a">One of the two palette indices to be swapped.</param>
/// <param name="index_b">The other of the two palette indices to be swapped.</param>
/// <returns>The total number of pixels changed.</returns>
/// <remarks>
/// This function swaps the two specified palette indices <i>index_a</i> and
/// <i>index_b</i> on a palletized image. Therefore, not the palette, but the
/// actual image data will be modified.
/// <para/>
/// <b>Note, that this behaviour is different from what <see cref="SwapColors"/> does on palletized images,
/// which only swaps the colors in the palette.</b>
/// <para/>
/// This is just a thin wrapper for <see cref="ApplyColorMapping"/> and resolves to:
/// <para/>
/// <code>
/// return ApplyPaletteIndexMapping(dib, index_a, index_b, 1, true);
/// </code>
/// </remarks>
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_SwapPaletteIndices")]
public static extern uint SwapPaletteIndices(FIBITMAP dib, ref byte index_a, ref byte index_b);
[DllImport(FreeImageLibrary, EntryPoint = "FreeImage_FillBackground")]
internal static extern bool FillBackground(FIBITMAP dib, IntPtr color, FREE_IMAGE_COLOR_OPTIONS options);
#endregion
}
}
|