1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163
|
<?xml version="1.0"?>
<!DOCTYPE doc SYSTEM "DevilDoc.dtd"><!-- Matrixes are expressed like a matrix, the scale and offset -->
<doc>
<set name="IL">
<entity type="function">
<name>ilActiveImage</name>
<return>ILboolean</return>
<param description="Animation numer to select as current." name="Number" type="ILuint" />ma
<description>ilActiveImage sets the current image to be an image in an animation chain</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INTERNAL_ERROR" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilActiveMipmap" />
<a from="IL" name="ilActiveLayer" />
<a from="IL" name="ilGenImages" />
</link>
</entity>
<entity type="function">
<name>ilActiveMipmap</name>
<return>ILboolean</return>
<param description="Mipmap level to select as current." name="Number" type="ILuint" />
<description>ilActiveMipmap sets a mipmap of the image as the current mipmap. Currently, the only way to generate mipmaps is by calling iluBuildMipmaps. If neither function has been called for the current image, no mipmaps exist for it. If Number is 0, then the current base image is set.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INTERNAL_ERROR" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilActiveImage" />
<a from="ILU" name="iluBuildMipmaps" />
<a from="IL" name="ilActiveLayer" />
</link>
</entity>
<entity type="function">
<name>ilBindImage</name>
<return>ILvoid</return>
<param description="The name of an image." name="Image" type="ILuint" />
<description>The ilBindImage function creates a named image. Image names are ILuint's, with zero being reserved as the default image. The default image is generated by ilCreateDefaultTex. The only reason the default image would be NULL is if OpenIL could not create the default image, due to memory constraints of the system, so always heed the IL_OUT_OF_MEMORY error. Any dimension image may be bound with ilBindImage. When ilBindImage is called, the bound image remains bound until ilBindImage is called again with a different value in Image.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
<a from="IL" name="ilCreateDefaultTex" />
<a from="IL" name="ilGetError" />
</link>
</entity>
<entity type="function">
<name>ilClearImage</name>
<return>ILboolean</return>
<description>ilClearImage simply clears the image to the colours specified in ilClearColour. If the current image is of format IL_COLOR_INDEX, the image is cleared to all zeros, and the palette is changed to one entry of all zeros. If the current image is of format IL_LUMINANCE, the image is cleared to all zeros.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilClearColour" />
</link>
</entity>
<entity type="function">
<name>ilConvertImage</name>
<return>ILboolean</return>
<param description="The format the current image should be converted to." name="DestFormat" type="ILenum" />
<param description="The type the current image should be converted to." name="DestType" type="ILenum" />
<description>ilConvertImage converts the current bound image from its format/type to DestFormat and DestType. Almost all conversions are allowable.</description>
<link name="Formats" verbose="true">
<a name="IL_RGB" description="" />
<a name="IL_RGBA" description="" />
<a name="IL_BGR" description="" />
<a name="IL_BGRA" description="" />
<a name="IL_LUMINANCE" description="" />
<a name="IL_LUMINANCE_ALPHA" description="" />
<a name="IL_COLOUR_INDEX" description="" />
</link>
<link name="Types" verbose="true">
<a name="IL_BYTE" description="" />
<a name="IL_UNSIGNED_BYTE" description="" />
<a name="IL_SHORT" description="" />
<a name="IL_UNSIGNED_SHORT" description="" />
<a name="IL_INT" description="" />
<a name="IL_UNSIGNED_INT" description="" />
<a name="IL_FLOAT" description="" />
<a name="IL_DOUBLE" description="" />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INVALID_CONVERSION" description="DestFormat and/or DestType was an invalid identifier." />
<a from="IL" name="IL_OUT_OF_MEMORY" description="Could not allocate memory for the converted image data." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="IL" name="ilConvertPal" />
</link>
</entity>
<entity type="function">
<name>ilCopyImage</name>
<return>ILboolean</return>
<param description="Name of an image to copy to the current image." name="Src" type="ILuint" />
<description>ilCopyImage copies the attributes and data from the image named in Src. The same image bound before calling ilCopyImage remains bound afterward.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_OUT_OF_MEMORY" description="Could not allocate memory for the converted image data." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilCopyPixels</name>
<return>ILvoid</return>
<param description="Where to begin copying pixels from in the x direction." name="XOff" type="ILuint" />
<param description="Where to begin copying pixels from in the y direction." name="YOff" type="ILuint" />
<param description="Where to begin copying pixels from in the z direction." name="ZOff" type="ILuint" />
<param description="How many pixels to copy in the x direction." name="Width" type="ILuint" />
<param description="How many pixels to copy in the y direction." name="Height" type="ILuint" />
<param description="How many pixels to copy in the z direction." name="Depth" type="ILuint" />
<param description="The desired format the output should be." name="Format" type="ILenum" />
<param description="The desired type the output should be." name="Type" type="ILenum" />
<param description="User-defined buffer to copy the image data to." name="Data" type="ILvoid *" />
<description>ilCopyPixels has very simple behaviour. It simply copies a block of pixels from the current image to the Data buffer. XOff, YOff and ZOff can be used to skip a certain number of pixels in each respective direction. If XOff + Width, YOff + Height and/or ZOff + Depth is greater than the current image's width, height or depth, only the current image's width, height or depth number of pixels will be copied to Data.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" description="Format did not match the current image's format. Use ilGetInteger to obtain the current image's format." name="IL_INVALID_CONVERSION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetInteger" />
</link>
</entity>
<entity type="function">
<name>ilDefaultImage</name>
<return>ILboolean</return>
<description>ilDefaultImage creates an ugly 64x64 image of 8x8 black and yellow squares to form a checkerboard pattern. In future versions of OpenIL, there may be an option that will load this image if an image-loading function failed (unless memory could not be allocated). This way, the user can easily tell if an image was not loaded. Plus, the calling program can continue normally, even though it will have an ugly image. ;-)</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilDeleteImages</name>
<return>ILvoid</return>
<param description="Number of image names to delete." name="Num" type="ILsizei" />
<param description="Pointer to image names to delete." name="Images" type="const ILuint *" />
<description>ilDeleteImages deletes Num image names specified in Images. After a texture is deleted, its characteristics and dimensions are undefined, and the name may be reused byilGenImages. ilDeleteImages ignores zeros and out-of-bounds image names. If the current image is deleted, the binding reverts to the default image (image name of 0).</description>
<link name="Errors" verbose="true">
<a from="IL" description="Num was less than one." name="IL_INVALID_VALUE" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilEnable</name>
<return>ILboolean</return>
<param description="Mode to enable." name="Mode" type="ILenum" />
<description>ilEnable enables a mode specified by Mode. This function is identical to it's OpenGL counterpart glEnable.</description>
<link name="Modes" verbose="true">
<a from="IL" description="When enabled, the origin is specified at an absolute position, and all images loaded or saved adhere to this set origin. For more information, check out ilOriginFunc." name="IL_ORIGIN_SET" />
<a from="IL" description="If enabled while saving, OpenIL will overwrite existing files, else IL_FILE_ALREADY_EXISTS is set, and the image is not saved." name="IL_FILE_OVERWRITE" />
<a description="When enabled, OpenIL automatically converts palette'd images to their base types, e.g. converting to a bgra image." from="IL" name="IL_CONV_PAL" />
</link>
<link name="Errors" verbose="true">
<a from="IL" description="Invalid Mode value." name="IL_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilDisable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="IL" name="ilOriginFunc" />
</link>
</entity>
<entity type="function">
<name>ilDisable</name>
<return>ILboolean</return>
<param description="Mode to disable." name="Mode" type="ILenum" />
<description>ilDisable disables a mode specified by Mode. This function is identical to it's OpenGL counterpart glDisable.</description>
<link name="Modes" verbose="true">
<a from="IL" description="When enabled, the origin is specified at an absolute position, and all images loaded or saved adhere to this set origin. For more information, check out ilOriginFunc." name="IL_ORIGIN_SET" />
<a from="IL" description="If enabled while saving, OpenIL will overwrite existing files, else IL_FILE_ALREADY_EXISTS is set, and the image is not saved." name="IL_FILE_OVERWRITE" />
<a from="IL" description="When enabled, OpenIL automatically converts palette'd images to their base types, e.g. converting to a bgra image." name="IL_CONV_PAL" />
</link>
<link name="Errors" verbose="true">
<a from="IL" description="Invalid Mode value." name="IL_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="IL" name="ilOriginFunc" />
</link>
</entity>
<entity type="function">
<name>ilGenImages</name>
<return>ILvoid</return>
<param description="Number of image names to generate." name="Num" type="ILsizei" />
<param description="Pointer in which the generated image names are stored." name="Images" type="ILuint *" />
<description>ilGenImages stores Num image names in Images. The names stored are not necessarily contiguous, and names can have been deleted via ilDeleteImages beforehand. The image names stored in Images can be used with ilBindImage after calling ilGenImages. After calling ilGenImages, all image dimensions and features are undefined.</description>
<link name="Errors" verbose="true">
<a from="IL" description="Num was less than 1 or Images was NULL." name="IL_INVALID_VALUE" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilDeleteImages" />
</link>
</entity>
<entity type="function">
<name>ilDeleteImage</name>
<return>ILvoid</return>
<param name="Id" type="ILuint" description="The image name to delete" />
<description>ilDeleteImage is a convenience function to delete a single image instead of calling ilDeleteImages</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_INVALID_VALUE" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
<a from="IL" name="ilGenImage" />
</link>
</entity>
<entity type="function">
<name>ilGenImage</name>
<return>ILvoid</return>
<param name="Id" type="ILuint" description="The image name to delete" />
<description>ilGenImage is a convenience function to delete a single image instead of calling ilGenImages</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
<a from="IL" name="ilDeleteImage" />
</link>
</entity>
<entity type="function">
<name>ilGetBoolean</name>
<return>ILboolean</return>
<param description="The mode value to be returned." name="Mode" type="ILenum" />
<description>ilGetBoolean returns the value of a selected mode.</description>
<link name="Modes" verbose="true">
<a from="IL" description="Returns whether file overwriting when saving is enabled." name="IL_FILE_MODE" />
<a from="IL" description="Returns whether palette'd images are converted to their base palettes types on load - e.g. converted to a bgra image." name="IL_CONV_PAL" />
<a from="IL" description="Returns whether all images loaded and saved adhere to a specific origin." name="IL_ORIGIN_SET" />
<a from="IL" description="Returns the current origin position." name="IL_ORIGIN_MODE" />
<a from="IL" description="Returns whether all images loaded are converted to a specific format." name="IL_FORMAT_SET" />
<a from="IL" description="Returns the format images are converted to upon loading." name="IL_FORMAT_MODE" />
<a from="IL" description="Returns whether all images loaded are converted to a specific type." name="IL_TYPE_SET" />
<a from="IL" description="Returns the type images are converted to upon loading." name="IL_TYPE_MODE" />
<a from="IL" description="Returns the version number of the shared library. This can be checked against the IL_VERSION #define." name="IL_VERSION_NUM" />
<a from="IL" description="Returns the current image's width." name="IL_IMAGE_WIDTH" />
<a from="IL" description="Returns the current image's height." name="IL_IMAGE_HEIGHT" />
<a from="IL" description="Returns the bytes per pixel of the current image's data." name="IL_IMAGE_BYTES_PER_PIXEL" />
<a from="IL" description="Returns the bits per pixel of the current image's data." name="IL_IMAGE_BITS_PER_PIXEL" />
<a from="IL" description="Returns the current image's format." name="IL_IMAGE_FORMAT" />
<a from="IL" description="Returns the current image's type." name="IL_IMAGE_TYPE" />
<a from="IL" description="Returns the number of images in the current image animation chain." name="IL_NUM_IMAGES" />
<a from="IL" description="Returns the number of mipmaps of the current image." name="IL_NUM_MIPMAPS" />
<a from="IL" description="Returns the palette type of the current image." name="IL_PALETTE_TYPE" />
<a from="IL" description="Returns the bytes per pixel of the current image's palette." name="IL_PALETTE_BPP" />
<a from="IL" description="Returns the number of colours of the current image's palette." name="IL_PALETTE_NUM_COLS" />
<a from="IL" description="Returns the current image number." name="IL_ACTIVE_IMAGE" />
<a from="IL" description="Returns the current layer number." name="IL_ACTIVE_LAYER" />
<a from="IL" description="Returns the current mipmap number." name="IL_ACTIVE_MIPMAP" />
<a from="IL" description="Returns the current bound image name." name="IL_CUR_IMAGE" />
<a from="IL" description="Returns whether OpenIL uses a key colour (not used yet)." name="IL_USE_KEY_COLOUR" />
</link>
<link name="Errors" verbose="true">
<a description="Mode was an invalid enum." name="IL_INVALID_ENUM" />
<a description="Param was NULL." name="IL_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="IL" name="ilOriginFunc" />
<a from="IL" name="ilSetInteger" />
</link>
</entity>
<entity type="function">
<name>ilGetBooleanv</name>
<return>ILvoid</return>
<param description="The mode value to be returned." name="Mode" type="ILenum" />
<param description="Array where the values are stored" name="Param" type="ILboolean *" />
<description>ilGetBooleanv function returns the mode value in the Param parameter.</description>
<link name="Modes" verbose="true">
<a from="IL" description="Returns whether file overwriting when saving is enabled." name="IL_FILE_MODE" />
<a from="IL" description="Returns whether palette'd images are converted to their base palettes types on load - e.g. converted to a bgra image." name="IL_CONV_PAL" />
<a from="IL" description="Returns whether all images loaded and saved adhere to a specific origin." name="IL_ORIGIN_SET" />
<a from="IL" description="Returns the current origin position." name="IL_ORIGIN_MODE" />
<a from="IL" description="Returns whether all images loaded are converted to a specific format." name="IL_FORMAT_SET" />
<a from="IL" description="Returns the format images are converted to upon loading." name="IL_FORMAT_MODE" />
<a from="IL" description="Returns whether all images loaded are converted to a specific type." name="IL_TYPE_SET" />
<a from="IL" description="Returns the type images are converted to upon loading." name="IL_TYPE_MODE" />
<a from="IL" description="Returns the version number of the shared library. This can be checked against the IL_VERSION #define." name="IL_VERSION_NUM" />
<a from="IL" description="Returns the current image's width." name="IL_IMAGE_WIDTH" />
<a from="IL" description="Returns the current image's height." name="IL_IMAGE_HEIGHT" />
<a from="IL" description="Returns the bytes per pixel of the current image's data." name="IL_IMAGE_BYTES_PER_PIXEL" />
<a from="IL" description="Returns the bits per pixel of the current image's data." name="IL_IMAGE_BITS_PER_PIXEL" />
<a from="IL" description="Returns the current image's format." name="IL_IMAGE_FORMAT" />
<a from="IL" description="Returns the current image's type." name="IL_IMAGE_TYPE" />
<a from="IL" description="Returns the number of images in the current image animation chain." name="IL_NUM_IMAGES" />
<a from="IL" description="Returns the number of mipmaps of the current image." name="IL_NUM_MIPMAPS" />
<a from="IL" description="Returns the palette type of the current image." name="IL_PALETTE_TYPE" />
<a from="IL" description="Returns the bytes per pixel of the current image's palette." name="IL_PALETTE_BPP" />
<a from="IL" description="Returns the number of colours of the current image's palette." name="IL_PALETTE_NUM_COLS" />
<a from="IL" description="Returns the current image number." name="IL_ACTIVE_IMAGE" />
<a from="IL" description="Returns the current layer number." name="IL_ACTIVE_LAYER" />
<a from="IL" description="Returns the current mipmap number." name="IL_ACTIVE_MIPMAP" />
<a from="IL" description="Returns the current bound image name." name="IL_CUR_IMAGE" />
<a from="IL" description="Returns whether OpenIL uses a key colour (not used yet)." name="IL_USE_KEY_COLOUR" />
</link>
<link name="Errors" verbose="true">
<a from="IL" description="Mode was an invalid enum." name="IL_INVALID_ENUM" />
<a from="IL" description="Param was NULL." name="IL_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="IL" name="ilOriginFunc" />
<a from="IL" name="ilSetInteger" />
</link>
</entity>
<entity type="function">
<name>ilGetIntegerv</name>
<return>ILvoid</return>
<param description="The mode value to be returned." name="Mode" type="ILenum" />
<param description="Array where the values are stored" name="Param" type="ILboolean *" />
<description>ilGetIntegerv function returns the mode value in the Param parameter.</description>
<link name="" verbose="true">
<a description="Returns whether file overwriting when saving is enabled." name="IL_FILE_MODE" />
<a description="Returns whether palette'd images are converted to their base palettes types on load - e.g. converted to a bgra image." name="IL_CONV_PAL" />
<a description="Returns whether all images loaded and saved adhere to a specific origin." name="IL_ORIGIN_SET" />
<a description="Returns the current origin position." name="IL_ORIGIN_MODE" />
<a description="Returns whether all images loaded are converted to a specific format." name="IL_FORMAT_SET" />
<a description="Returns the format images are converted to upon loading." name="IL_FORMAT_MODE" />
<a description="Returns whether all images loaded are converted to a specific type." name="IL_TYPE_SET" />
<a description="Returns the type images are converted to upon loading." name="IL_TYPE_MODE" />
<a description="Returns the version number of the shared library. This can be checked against the IL_VERSION #define." name="IL_VERSION_NUM" />
<a description="Returns the current image's width." name="IL_IMAGE_WIDTH" />
<a description="Returns the current image's height." name="IL_IMAGE_HEIGHT" />
<a description="Returns the bytes per pixel of the current image's data." name="IL_IMAGE_BYTES_PER_PIXEL" />
<a description="Returns the bits per pixel of the current image's data." name="IL_IMAGE_BITS_PER_PIXEL" />
<a description="Returns the current image's format." name="IL_IMAGE_FORMAT" />
<a description="Returns the current image's type." name="IL_IMAGE_TYPE" />
<a description="Returns the number of images in the current image animation chain." name="IL_NUM_IMAGES" />
<a description="Returns the number of mipmaps of the current image." name="IL_NUM_MIPMAPS" />
<a description="Returns the palette type of the current image." name="IL_PALETTE_TYPE" />
<a description="Returns the bytes per pixel of the current image's palette." name="IL_PALETTE_BPP" />
<a description="Returns the number of colours of the current image's palette." name="IL_PALETTE_NUM_COLS" />
<a description="Returns the current image number." name="IL_ACTIVE_IMAGE" />
<a description="Returns the current layer number." name="IL_ACTIVE_LAYER" />
<a description="Returns the current mipmap number." name="IL_ACTIVE_MIPMAP" />
<a description="Returns the current bound image name." name="IL_CUR_IMAGE" />
<a description="Returns whether OpenIL uses a key colour (not used yet)." name="IL_USE_KEY_COLOUR" />
</link>
<link name="Errors" verbose="true">
<a description="Mode was an invalid enum." name="IL_INVALID_ENUM" />
<a description="Param was NULL." name="IL_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilSetInteger" />
<a from="IL" name="ilOriginFunc" />
</link>
</entity>
<entity type="function">
<name>ilGetInteger</name>
<return>ILint</return>
<param description="The mode value to be returned." name="Mode" type="ILenum" />
<description>ilGetInteger returns the value of a selected mode.</description>
<link name="Modes" verbose="true">
<a description="Returns whether file overwriting when saving is enabled." name="IL_FILE_MODE" />
<a description="Returns whether palette'd images are converted to their base palettes types on load - e.g. converted to a bgra image." name="IL_CONV_PAL" />
<a description="Returns whether all images loaded and saved adhere to a specific origin." name="IL_ORIGIN_SET" />
<a description="Returns the current origin position." name="IL_ORIGIN_MODE" />
<a description="Returns whether all images loaded are converted to a specific format." name="IL_FORMAT_SET" />
<a description="Returns the format images are converted to upon loading." name="IL_FORMAT_MODE" />
<a description="Returns whether all images loaded are converted to a specific type." name="IL_TYPE_SET" />
<a description="Returns the type images are converted to upon loading." name="IL_TYPE_MODE" />
<a description="Returns the version number of the shared library. This can be checked against the IL_VERSION #define." name="IL_VERSION_NUM" />
<a description="Returns the current image's width." name="IL_IMAGE_WIDTH" />
<a description="Returns the current image's height." name="IL_IMAGE_HEIGHT" />
<a description="Returns the bytes per pixel of the current image's data." name="IL_IMAGE_BYTES_PER_PIXEL" />
<a description="Returns the bits per pixel of the current image's data." name="IL_IMAGE_BITS_PER_PIXEL" />
<a description="Returns the current image's format." name="IL_IMAGE_FORMAT" />
<a description="Returns the current image's type." name="IL_IMAGE_TYPE" />
<a description="Returns the number of images in the current image animation chain." name="IL_NUM_IMAGES" />
<a description="Returns the number of mipmaps of the current image." name="IL_NUM_MIPMAPS" />
<a description="Returns the palette type of the current image." name="IL_PALETTE_TYPE" />
<a description="Returns the bytes per pixel of the current image's palette." name="IL_PALETTE_BPP" />
<a description="Returns the number of colours of the current image's palette." name="IL_PALETTE_NUM_COLS" />
<a description="Returns the current image number." name="IL_ACTIVE_IMAGE" />
<a description="Returns the current layer number." name="IL_ACTIVE_LAYER" />
<a description="Returns the current mipmap number." name="IL_ACTIVE_MIPMAP" />
<a description="Returns the current bound image name." name="IL_CUR_IMAGE" />
<a description="Returns whether OpenIL uses a key colour (not used yet)." name="IL_USE_KEY_COLOUR" />
</link>
<link name="Errors" verbose="true">
<a description="Mode was an invalid enum." name="IL_INVALID_ENUM" />
<a description="Param was NULL." name="IL_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetIntegerv" />
<a from="IL" name="ilOriginFunc" />
<a from="IL" name="ilSetInteger" />
</link>
</entity>
<entity type="function">
<name>ilGetError</name>
<return>ILenum</return>
<param description="The mode value to be returned." name="Mode" type="ILenum" />
<description>ilGetError returns the value of the last error on the error stack. If no error has occurred, IL_NO_ERROR is returned. Initially, the error stack is set to IL_NO_ERROR. When ilGetError is called, the last error on the error stack is "popped off". Errors that occur in ILU and ILUT are also reported through ilGetError. ilGetError only returns something other than IL_NO_ERROR if detectable errors have occurred.</description>
<link name="Returned Errors" verbose="true">
<a description="No detectable error has occured." name="IL_NO_ERROR" />
<a description="An unacceptable enumerated value was passed to a function." name="IL_INVALID_ENUM" />
<a description="An unacceptable enumerated value was passed to a function." name="ILU_INVALID_ENUM" />
<a description="An unacceptable enumerated value was passed to a function." name="ILUT_INVALID_ENUM" />
<a description="Could not allocate enough memory in an operation." name="IL_OUT_OF_MEMORY" />
<a description="Could not allocate enough memory in an operation." name="ILU_OUT_OF_MEMORY" />
<a description="Could not allocate enough memory in an operation." name="ILUT_OUT_OF_MEMORY" />
<a description="The format a function tried to use was not able to be used by that function." name="IL_FORMAT_NOT_SUPPORTED" />
<a description="A serious error has occurred. Please e-mail an admin with the conditions leading up to this error being reported." name="IL_INTERNAL_ERROR" />
<a description="A serious error has occurred. Please e-mail an admin with the conditions leading up to this error being reported." name="ILU_INTERNAL_ERROR" />
<a description="An invalid value was passed to a function or was in a file." name="IL_INVALID_VALUE" />
<a description="An invalid value was passed to a function or was in a file." name="ILU_INVALID_VALUE" />
<a description="An invalid value was passed to a function or was in a file." name="ILUT_INVALID_VALUE" />
<a description="The operation attempted is not allowable in the current state. The function returns with no ill side effects." name="IL_ILLEGAL_OPERATION" />
<a description="The operation attempted is not allowable in the current state. The function returns with no ill side effects." name="ILU_ILLEGAL_OPERATION" />
<a description="The operation attempted is not allowable in the current state. The function returns with no ill side effects." name="ILUT_ILLEGAL_OPERATION" />
<a description="An illegal value was found in a file trying to be loaded." name="IL_ILLEGAL_FILE_VALUE" />
<a description="A file's header was incorrect." name="IL_INVALID_FILE_HEADER" />
<a description="An invalid parameter was passed to a function, such as a NULL pointer." name="IL_INVALID_PARAM" />
<a description="An invalid parameter was passed to a function, such as a NULL pointer." name="ILU_INVALID_PARAM" />
<a description="An invalid parameter was passed to a function, such as a NULL pointer." name="ILUT_INVALID_PARAM" />
<a description="Could not open the file specified. The file may already be open by another app or may not exist." name="IL_COULD_NOT_OPEN_FILE" />
<a description="Could not open the file specified. The file may already be open by another app or may not exist." name="ILUT_COULD_NOT_OPEN_FILE" />
<a description="The extension of the specified filename was not correct for the type of image-loading function." name="IL_INVALID_EXTENSION" />
<a description="The filename specified already belongs to another file. To overwrite files by default read more at ilEnable function." name="IL_FILE_ALREADY_EXISTS" />
<a description="Tried to convert an image from its format to the same format." name="IL_OUT_FORMAT_SAME" />
<a description="One of the internal stacks was already filled, and the user tried to add on to the full stack." name="IL_STACK_OVERFLOW" />
<a description="One of the internal stacks was already filled, and the user tried to add on to the full stack." name="ILUT_STACK_OVERFLOW" />
<a description="One of the internal stacks was empty, and the user tried to empty the already empty stack." name="IL_STACK_UNDERFLOW" />
<a description="One of the internal stacks was empty, and the user tried to empty the already empty stack." name="ILUT_STACK_UNDERFLOW" />
<a description="An invalid conversion attempt was tried." name="IL_INVALID_CONVERSION" />
<a description="An error occurred in the libjpeg library." name="IL_LIB_JPEG_ERROR" />
<a description="An error occurred in the libpng library." name="IL_LIB_PNG_ERROR" />
<a description="No function sets this yet, but it is possible (not probable) it may be used in the future." name="IL_UNKNOWN_ERROR" />
<a description="A type is valid but not supported in the current build." name="ILUT_NOT_SUPPORTED" />
</link>
</entity>
<entity type="function">
<name>ilGetString</name>
<return>const char *</return>
<description>ilGetString returns a constant human-readable string describing the current OpenIL implementation.</description>
<param description="Describes the string to be retrieved." name="StringName" type="ILenum" />
<link name="Strings" verbose="true">
<a description="Describes the OpenIL vendor (currently Abysmal Software)." name="IL_VENDOR" />
<a description="String describing the current OpenIL version. Use ilGetInteger with IL_VERSION_NUM to actually check for version differences." name="IL_VERSION" />
</link>
<link name="Errors" verbose="true">
<a description="StringName was an invalid value." name="IL_INVALID_ENUM" />
</link>
</entity>
<entity type="function">
<name>ilIsEnabled</name>
<return>ILboolean</return>
<description>ilIsEnabled returns whether the mode indicated by Mode is enabled.</description>
<param description="Indicates an OpenIL mode" name="Mode" type="ILenum" />
<link name="Modes" verbose="true">
<a description="Whether the origin is set." name="IL_ORIGIN_SET" />
<a description="Whether OpenIL is allowed to overwrite existing files when saving." name="IL_FILE_OVERWRITE" />
<a description="Whether OpenIL should automatically convert palette'd images to truecolour images." name="IL_CONV_PAL" />
</link>
<link name="Errors" verbose="true">
<a description="Mode was of an invalid value." name="IL_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilDisable" />
<a from="IL" name="ilIsDisabled" />
<a from="IL" name="ilOriginFunc" />
<a from="ILUT" name="ilutIsEnabled" />
<a from="ILUT" name="ilutIsDisabled" />
</link>
</entity>
<entity type="function">
<name>ilIsDisabled</name>
<return>ILboolean</return>
<description>ilIsDisabled returns whether the mode indicated by Mode is disabled.</description>
<param description="Indicates an OpenIL mode" name="Mode" type="ILenum" />
<link name="Modes" verbose="true">
<a description="Whether the origin is set." name="IL_ORIGIN_SET" />
<a description="Whether OpenIL is allowed to overwrite existing files when saving." name="IL_FILE_OVERWRITE" />
<a description="Whether OpenIL should automatically convert palette'd images to truecolour images." name="IL_CONV_PAL" />
</link>
<link name="Errors" verbose="true">
<a description="Mode was of an invalid value." name="IL_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilDisable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilOriginFunc" />
<a from="ILUT" name="ilutIsEnabled" />
<a from="ILUT" name="ilutIsDisabled" />
</link>
</entity>
<entity type="function">
<name>ilOriginFunc</name>
<return>ILboolean</return>
<description>ilOriginFunc sets the origin to be used when loading all images, so that any image with a different origin will be flipped to have the set origin. This behaviour is actually disabled by default but can be enabled using ilEnable with the IL_ORIGIN_SET parameter.</description>
<param description="Specifies the origin to be used" name="Mode" type="ILenum" />
<link name="Modes" verbose="true">
<a description="The origin is in the lower left of the image." name="IL_ORIGIN_LOWER_LEFT" />
<a description="The origin is in the upper left of the image." name="IL_ORIGIN_UPPER_LEFT" />
</link>
<link name="Errors" verbose="true">
<a description="Mode was of an invalid value." name="IL_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoad" />
<a from="IL" name="ilLoadF" />
<a from="IL" name="ilLoadL" />
<a from="IL" name="ilLoadImage" />
</link>
</entity>
<entity type="function">
<name>ilLoadImage</name>
<return>ILboolean</return>
<description>The ilLoadImage function allows a general interface to the specific internal file-loading routines. The approach ilLoadImage takes toward determining image types is three-pronged. First, it finds the extension and checks to see if any user-registered functions (registered through ilRegisterLoad) match the extension. If nothing matches, it takes the extension and determines which function to call based on it. Lastly, it attempts to identify the image based on various image header verification functions, such as ilIsValidPngF. If all this checking fails, IL_FALSE is returned with no modification to the current bound image.</description>
<param description="Specifies which file to load an image from." name="FileName" type="char *" />
<link name="Errors" verbose="true">
<a from="IL" description="The file pointed to by FileName could not be opened. Either the file does not exist or may be in use by another process." name="IL_COULD_NOT_OPEN_FILE" />
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" description="The file could not be loaded based on extension or header." name="IL_INVALID_EXTENSION" />
<a from="IL" description="FileName was not valid. It was most likely NULL." name="IL_INVALID_PARAM" />
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="IL" name="ilLoad" />
<a from="IL" name="ilLoadF" />
<a from="IL" name="ilLoadL" />
<a from="IL" name="ilLoadPal" />
</link>
</entity>
<entity type="function">
<name>ilPopAttrib</name>
<return>ILvoid</return>
<description>ilPopAttrib pops the last pushed stack entry off the stack and copies the bits specified when pushed by ilPushAttrib to the previous set of states.</description>
<link name="Errors" verbose="true">
<a description="The stack was popped without being pushed by ilPushAttrib." name="IL_STACK_UNDERFLOW" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilPushAttrib" />
</link>
</entity>
<entity type="function">
<name>ilPushAttrib</name>
<return>ILvoid</return>
<description>ilPushAttrib pushes a new set of modes and attributes onto the state stack, allowing for "a fresh start".</description>
<param description="Attribute bits to push." name="Bits" type="ILuint" />
<link name="Bits" verbose="true">
<a description="Preserves the origin state set by ilOriginFunc." name="IL_ORIGIN_BIT" />
<a description="Preserves whether OpenIL is allowed to overwrite files when saving (set by ilEnable, ilDisable)." name="IL_FILE_BIT" />
<a description="Preserves whether OpenIL is supposed to convert palette'd to truecolour images (set by ilEnable, ilDisable)." name="IL_PAL_BIT" />
<a description="Preserves all OpenIL states and attributes." name="IL_ALL_ATTRIB_BITS" />
</link>
<link name="Errors" verbose="true">
<a description="The stack was pushed more times than the current OpenIL implementation allows. Use ilPopAttrib to clear the stack. OpenIL implementations must support a stack depth of at least 32." name="IL_STACK_OVERFLOW" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilPushAttrib" />
</link>
</entity>
<entity type="function">
<name>ilSaveImage</name>
<return>ILboolean</return>
<description>The ilSaveImage function allows a general interface to the specific internal file saving routines. Based on the extension, OpenIL will save that type of file (e.g. Targa file saved when the extension is "tga").</description>
<param description="Specifies which file to save an image to" name="FileName" type="char *" />
<link name="Errors" verbose="true">
<a description="Preserves the origin state set by ilOriginFunc." name="IL_COULD_NOT_OPEN_FILE" />
<a description="Preserves whether OpenIL is allowed to overwrite files when saving (set by ilEnable, ilDisable)." name="IL_ILLEGAL_OPERATION" />
<a description="Preserves whether OpenIL is supposed to convert palette'd to truecolour images (set by ilEnable, ilDisable)." name="IL_INVALID_EXTENSION" />
<a description="Preserves all OpenIL states and attributes." name="IL_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilLoad" />
<a from="IL" name="ilLoadF" />
<a from="IL" name="ilLoadL" />
</link>
</entity>
<entity type="function">
<name>ilSetRead</name>
<return>ILvoid</return>
<description>ilSetRead was primarily designed to allow languages other than C/C++ access to DevIL's file-reading functions, since other languages do not use stdio.h's FILE* struct. This function can also double usefully in instances where filetypes other than FILE* are used, such as Windows file handles and C++ istreams. Simply provide an alternative to each of the functions needed by DevIL. The "special" datatype ILHANDLE is passed to these functions when used, so any internal datatype used by the differing language (or file handle) can be used.</description>
<param description="Pointer to a function to open a file." name="Open" type="fOpenRProc" />
<param description="Pointer to a function to close a file." name="Close" type="fCloseRProc" />
<param description="Pointer to a function that returns IL_TRUE if the end of file is reached." name="Eof" type="fEofProc" />
<param description="Pointer to a function to return one byte from a file." name="Getc" type="fGetcProc" />
<param description="Pointer to a function to read multiple bytes from a file." name="Read" type="fReadProc" />
<param description="Pointer to a function to change position in a file." name="Seek" type="fSeekRProc" />
<param description="Pointer to a function to report the position in a file." name="Tell" type="fTellRProc" />
<link name="See Also" verbose="false">
<a from="IL" name="ilSetWrite" />
<a from="IL" name="ilResetRead" />
<a from="IL" name="ilResetWrite" />
</link>
</entity>
<entity type="function">
<name>ilInit</name>
<return>ILvoid</return>
<description>ilInit starts DevIL and must be called prior to using DevIL, or else DevIL will probably crash when you attempt to use it.</description>
<link name="See Also" verbose="false">
<a from="ILU" name="iluInit" />
<a from="ILUT" name="ilutInit" />
<a from="IL" name="ilShutDown" />
</link>
</entity>
<entity type="function">
<name>ilTexImage</name>
<return>ILboolean</return>
<param description="Specifies the new image width. This cannot be 0." name="Width" type="ILuint" />
<param description="Specifies the new image height. This cannot be 0." name="Height" type="ILuint" />
<param description="Specifies the new image depth. Anything greater than 1 will make the image 3d. This cannot be 0." name="Depth" type="ILuint" />
<param description="Specifies the new channels. Common values are 3 and 4." name="numberOfChannels" type="ILubyte" />
<param description="Specifies the data format this image has. For a list of values this can be, see the See Also section." name="Format" type="ILenum" />
<param description="Specifies the data format this image has. For a list of values this can be, see the See Also section." name="Type" type="ILenum" />
<param description="Specifies data that should be copied to the new image. If this parameter is NULL, no data is copied, and the new image data consists of undefined values." name="Data" type="ILvoid *" />
<description>Any current image data is destroyed by ilTexImage and replaced by a new image with the attributes specified. The new image data has undefined values. To set the new image data to a certain value, use ilClearImage or ilClearImageTo.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a description="One of the parameters provided was invalid. Width, Height, Depth or Bpp was an incorrect 0." name="IL_INVALID_PARAM" />
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="ILU" name="ilGenImages" />
<a from="ILUT" name="ilBindImage" />
<a from="Constants" name="Data Formats" />
<a from="Constants" name="Data Types" />
</link>
</entity>
<entity type="function">
<name>ilSetData</name>
<return>ILboolean</return>
<param description="Specifies the new image data to update the image with." name="Data" type="ILvoid *" />
<description>ilSetData just updates the current bound image data (bound by ilBindImage) with new data of the same size. This way new memory does not have to be allocated, so transfers are much faster.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a description="Data was NULL." name="IL_INVALID_PARAM" />
</link>
</entity>
<entity type="function">
<name>ilClearColour</name>
<return>ILvoid</return>
<param description="Amount of red to clear to." name="Red" type="ILclampf" />
<param description="Amount of green to clear to." name="Green" type="ILclampf" />
<param description="Amount of blue to clear to." name="Blue" type="ILclampf" />
<param description="Amount of alpha to clear to." name="Alpha" type="ILclampf" />
<description>ilClearColour sets the current clearing colour to be used by future calls to ilClearImage. iluRotate and iluEnlargeCanvas both use these values to clear blank space in images, too.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilClearImage" />
<a from="ILU" name="iluRotate" />
<a from="ILU" name="iluEnlargeCanvas" />
</link>
</entity>
<entity type="function">
<name>ilGetData</name>
<return>ILubyte *</return>
<description>ilGetData returns an unsigned byte pointer to the current bound image's data to allow direct access and modification to the contents of the image.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetPalette" />
<a from="IL" name="ilCopyPixels" />
</link>
</entity>
<entity type="function">
<name>ilHint</name>
<return>ILvoid</return>
<param description="An enum indicating what behaviour of the library is to be controlled." name="Target" type="ILenum" />
<param description="The desired behaviour." name="Mode" type="ILenum" />
<description>ilHint lets the user control aspects of OpenIL's behaviour, in order to optimize either speed, memory, compression or quality, depending wholly on what the user desires.</description>
<link name="Targets" verbose="true">
<a from="IL" description="Controls the memory used vs. speed tradeoff." name="IL_MEM_SPEED_HINT" />
<a from="IL" description="Controls whether compression is used when saving images." name="IL_COMPRESSION_HINT" />
</link>
<link name="Modes" verbose="true">
<a from="IL" description="Makes the target use a faster but more memory-intensive algorithm." name="IL_FASTEST" />
<a from="IL" description="Makes the target use less memory but a potentially slower algorithm." name="IL_LESS_MEM" />
<a from="IL" description="Specifies that OpenIL should use compression when saving, if possible." name="IL_USE_COMPRESSION" />
<a from="IL" description="Specifies that OpenIL should never use compression when saving." name="IL_NO_COMPRESSION" />
<a from="IL" description="The client does not have a preference." name="IL_DONT_CARE" />
</link>
<link name="Errors" verbose="true">
<a from="IL" description="Either Target or Mode was an invalid enum." name="IL_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetPalette" />
<a from="IL" name="ilCopyPixels" />
</link>
</entity>
<entity type="function">
<name>ilIsImage</name>
<return>ILboolean</return>
<param description="An image name." name="Image" type="ILuint" />
<description>ilIsImage returns whether the image name in Image is a valid image in use. If the image name in Image is in use, ilIsImage returns IL_TRUE. If Image is 0, ilIsImage returns IL_FALSE, because the default image is a special image and is never returned by ilGenImages. If the image name has been deleted by ilDeleteImages or never generated byilGenImages, IL_FALSE is returned.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilCreateDefaultTex" />
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
</link>
</entity>
<entity type="function">
<name>ilConvertPal</name>
<return>ILboolean</return>
<param description="The format the current image palette should be converted to. Accepted Values are: <dl><dd>IL_PAL_RGB24</dd><dd>IL_PAL_RGB32</dd><dd>IL_PAL_RGBA32</dd><dd>IL_PAL_BGR24</dd><dd>IL_PAL_BGR32</dd><dd>IL_PAL_BGRA32</dd></dl>" name="DestFormat" type="ILenum" />
<description>ilIsImage returns whether the image name in Image is a valid image in use. If the image name in Image is in use, ilIsImage returns IL_TRUE. If Image is 0, ilIsImage returns IL_FALSE, because the default image is a special image and is never returned by ilGenImages. If the image name has been deleted by ilDeleteImages or never generated byilGenImages, IL_FALSE is returned.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. " />
<a from="IL" name="IL_OUT_OF_MEMORY" description="Could not allocate memory for the new image palette." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilCreateDefaultTex" />
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
</link>
</entity>
<entity type="function">
<name>ilLoad</name>
<return>ILboolean</return>
<param name="Type" type="ILenum" description="Format Specification" />
<param name="FileName" type="char *" description="File to load the image" />
<description>ilLoad can be used much in the same way ilLoadImage is used, except with ilLoad, it is possible to force OpenIL to load a file as a specific image format, no matter what the extension.</description>
<link name="Types" verbose="true">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Load the image as a Microsoft bitmap (.bmp)." />
<a name="IL_CUT" description="Load the image as a .cut image." />
<a name="IL_DDS" description="Load a DirectDraw Surface (.dds) image." />
<a name="IL_DOOM" description="Load the image as a Doom texture." />
<a name="IL_DOOM_FLAT" description="Load the image as a Doom flat (floor)." />
<a name="IL_GIF" description="Load a Graphics Interchange Format (.gif) file." />
<a name="IL_ICO" description="Load the image as a Microsoft icon (.ico)." />
<a name="IL_JPG" description="Load the image as a Jpeg (.jpg)." />
<a name="IL_MDL" description="Load an Half-Life model file (.mdl)." />
<a name="IL_MNG" description="Load a Multiple Network Graphics (.mng)." />
<a name="IL_LIF" description="Load an Homeworld image." />
<a name="IL_PCD" description="Load the image as a .pcd image." />
<a name="IL_PCX" description="Load the image as a PCX." />
<a name="IL_PIC" description="Load the image as a .pic image." />
<a name="IL_PIX" description="Load an Alias | Wavefront .pix file." />
<a name="IL_PNG" description="Load a Portable Network Graphics (.png) image." />
<a name="IL_PNM" description="Load a Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="Load a PhotoShop (.psd) file." />
<a name="IL_PSP" description="Load a Paint Shop Pro file." />
<a name="IL_PXR" description="Load a Pxrar (.pxr) file." />
<a name="IL_SGI" description="Load an SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="Load a TrueVision Targa." />
<a name="IL_TIF" description="Load a TIFF (.tif or .tiff) image." />
<a name="IL_RAW" description="Load the image as raw data with a 13-byte header." />
<a name="IL_WAL" description="Load a Quake .wal texture." />
<a name="IL_XPM" description="Load an .xpm file." />
<a name="IL_JASC_PAL" description="Load the file into the current image's palette as a Paint Shop Pro (Jasc) palette." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. " />
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="The file pointed to by FileName could not be opened. Either the file does not exist or is in use by another process." />
<a from="IL" name="IL_INVALID_ENUM" description="Type was of an invalid value." />
<a from="IL" name="IL_INVALID_PARAM" description="FileName or Type was NULL." />
<a from="IL" name="IL_INVALID_FILE_HEADER" description="The file had an invalid header and could not be loaded." />
<a from="IL" name="IL_ILLEGAL_FILE_VALUE" description="The file could not be loaded due to an invalid value present." />
<a from="IL" name="IL_OUT_OF_MEMORY" />
<a from="IL" name="IL_LIB_JPEG_ERROR" description="Error occurred when trying to load a jpeg." />
<a from="IL" name="IL_LIB_PNG_ERROR" description="Error occurred when trying to load a png." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="function">
<name>ilLoadF</name>
<return>ILboolean</return>
<param name="Type" type="ILenum" description="Image format" />
<param name="File" type="ILHANDLE" description="Pointer to a previous opened file" />
<description>ilLoadF loads an image from a previously opened file</description>
<link name="Types" verbose="true">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Load the image as a Microsoft bitmap (.bmp)." />
<a name="IL_CUT" description="Load the image as a .cut image." />
<a name="IL_DDS" description="Load a DirectDraw Surface (.dds) image." />
<a name="IL_DOOM" description="Load the image as a Doom texture." />
<a name="IL_DOOM_FLAT" description="Load the image as a Doom flat (floor)." />
<a name="IL_GIF" description="Load a Graphics Interchange Format (.gif) file." />
<a name="IL_ICO" description="Load the image as a Microsoft icon (.ico)." />
<a name="IL_JPG" description="Load the image as a Jpeg (.jpg)." />
<a name="IL_MDL" description="Load an Half-Life model file (.mdl)." />
<a name="IL_MNG" description="Load a Multiple Network Graphics (.mng)." />
<a name="IL_LIF" description="Load an Homeworld image." />
<a name="IL_PCD" description="Load the image as a .pcd image." />
<a name="IL_PCX" description="Load the image as a PCX." />
<a name="IL_PIC" description="Load the image as a .pic image." />
<a name="IL_PIX" description="Load an Alias | Wavefront .pix file." />
<a name="IL_PNG" description="Load a Portable Network Graphics (.png) image." />
<a name="IL_PNM" description="Load a Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="Load a PhotoShop (.psd) file." />
<a name="IL_PSP" description="Load a Paint Shop Pro file." />
<a name="IL_PXR" description="Load a Pxrar (.pxr) file." />
<a name="IL_SGI" description="Load an SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="Load a TrueVision Targa." />
<a name="IL_TIF" description="Load a TIFF (.tif or .tiff) image." />
<a name="IL_RAW" description="Load the image as raw data with a 13-byte header." />
<a name="IL_WAL" description="Load a Quake .wal texture." />
<a name="IL_XPM" description="Load an .xpm file." />
<a name="IL_JASC_PAL" description="Load the file into the current image's palette as a Paint Shop Pro (Jasc) palette." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. " />
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="The file pointed to by FileName could not be opened. Either the file does not exist or is in use by another process." />
<a from="IL" name="IL_INVALID_ENUM" description="Type was of an invalid value." />
<a from="IL" name="IL_INVALID_PARAM" description="FileName or Type was NULL." />
<a from="IL" name="IL_INVALID_FILE_HEADER" description="The file had an invalid header and could not be loaded." />
<a from="IL" name="IL_ILLEGAL_FILE_VALUE" description="The file could not be loaded due to an invalid value present." />
<a from="IL" name="IL_OUT_OF_MEMORY" />
<a from="IL" name="IL_LIB_JPEG_ERROR" description="Error occurred when trying to load a jpeg." />
<a from="IL" name="IL_LIB_PNG_ERROR" description="Error occurred when trying to load a png." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="function">
<name>ilLoadL</name>
<return>ILboolean</return>
<param name="Type" type="ILenum" description="Image format" />
<param name="Lump" type="ILvoid *" description="Lump Address" />
<param name="Size" type="ILuint" description="Lump size" />
<description>ilLoadL loads an image from a memory lump</description>
<link name="Types" verbose="true">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Load the image as a Microsoft bitmap (.bmp)." />
<a name="IL_CUT" description="Load the image as a .cut image." />
<a name="IL_DDS" description="Load a DirectDraw Surface (.dds) image." />
<a name="IL_DOOM" description="Load the image as a Doom texture." />
<a name="IL_DOOM_FLAT" description="Load the image as a Doom flat (floor)." />
<a name="IL_GIF" description="Load a Graphics Interchange Format (.gif) file." />
<a name="IL_ICO" description="Load the image as a Microsoft icon (.ico)." />
<a name="IL_JPG" description="Load the image as a Jpeg (.jpg)." />
<a name="IL_MDL" description="Load an Half-Life model file (.mdl)." />
<a name="IL_MNG" description="Load a Multiple Network Graphics (.mng)." />
<a name="IL_LIF" description="Load an Homeworld image." />
<a name="IL_PCD" description="Load the image as a .pcd image." />
<a name="IL_PCX" description="Load the image as a PCX." />
<a name="IL_PIC" description="Load the image as a .pic image." />
<a name="IL_PIX" description="Load an Alias | Wavefront .pix file." />
<a name="IL_PNG" description="Load a Portable Network Graphics (.png) image." />
<a name="IL_PNM" description="Load a Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="Load a PhotoShop (.psd) file." />
<a name="IL_PXR" description="Load a Pxrar (.pxr) file." />
<a name="IL_SGI" description="Load an SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="Load a TrueVision Targa." />
<a name="IL_TIF" description="Load a TIFF (.tif or .tiff) image." />
<a name="IL_RAW" description="Load the image as raw data with a 13-byte header." />
<a name="IL_WAL" description="Load a Quake .wal texture." />
<a name="IL_XPM" description="Load an .xpm file." />
<a name="IL_JASC_PAL" description="Load the file into the current image's palette as a Paint Shop Pro (Jasc) palette." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. " />
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="The file pointed to by FileName could not be opened. Either the file does not exist or is in use by another process." />
<a from="IL" name="IL_INVALID_ENUM" description="Type was of an invalid value." />
<a from="IL" name="IL_INVALID_PARAM" description="Lump or Size were NULL." />
<a from="IL" name="IL_INVALID_FILE_HEADER" description="The file had an invalid header and could not be loaded." />
<a from="IL" name="IL_ILLEGAL_FILE_VALUE" description="The file could not be loaded due to an invalid value present." />
<a from="IL" name="IL_OUT_OF_MEMORY" />
<a from="IL" name="IL_LIB_JPEG_ERROR" description="Error occurred when trying to load a jpeg." />
<a from="IL" name="IL_LIB_PNG_ERROR" description="Error occurred when trying to load a png." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="function">
<name>ilRegisterLoad</name>
<return>ILboolean</return>
<param name="Ext" type="char *" description="Extension of the image type to load" />
<param name="IL_LOADPROC" type="Load" description="Pointer to a loading function" />
<description>ilRegisterLoad allows the user to register functions for use by OpenIL, when loading unknown image types. The user can also override the default internal loading functions by passing their extension in Ext when using ilLoadImage. ilRegisterLoad allows the user to use their own loading functions while using OpenIL's capabilities, or to extend OpenIL when it does not support a specific image format</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterSave" />
<a from="IL" name="ilRemoveLoad" />
<a from="IL" name="ilRemoveSave" />
</link>
</entity>
<entity type="function">
<name>ilRegisterFormat</name>
<return>ILvoid</return>
<param name="Format" type="ILenum" description="The format that the registered image is in." />
<description>ilRegisterFormat tells OpenIL what format the current registered image is in. This function is to be used from within functions that have been registered via ilRegisterLoad</description>
<link name="Formats" verbose="true">
<a name="IL_RGB" description="" />
<a name="IL_RGBA" description="" />
<a name="IL_BGR" description="" />
<a name="IL_BGRA" description="" />
<a name="IL_LUMINANCE" description="" />
<a name="IL_LUMINANCE_ALPHA" description="" />
<a name="IL_COLOR_INDEX" description="" />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterLoad" />
<a from="IL" name="ilRegisterType" />
<a from="IL" name="ilRegisterOrigin" />
<a from="IL" name="ilRegisterPal" />
</link>
</entity>
<entity type="function">
<name>ilRegisterOrigin</name>
<return>ILvoid</return>
<param name="Origin" type="ILenum" description="The new Origin of the image" />
<description>ilRegisterFormat tells OpenIL what format the current registered image is in. This function is to be used from within functions that have been registered via ilRegisterLoad</description>
<param description="Specifies the origin to be used" name="Mode" type="ILenum" />
<link name="Origin" verbose="true">
<a description="The origin is in the lower left of the image." name="IL_ORIGIN_LOWER_LEFT" />
<a description="The origin is in the upper left of the image." name="IL_ORIGIN_UPPER_LEFT" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterLoad" />
<a from="IL" name="ilRegisterType" />
<a from="IL" name="ilRegisterOrigin" />
<a from="IL" name="ilRegisterPal" />
</link>
</entity>
<entity type="function">
<name>ilRegisterPal</name>
<return>ILvoid</return>
<param name="Pal" type="ILvoid" description="Pointer to palette to be copied to the current image" />
<param name="Size" type="ILuint" description="Size of Pal in bytes" />
<param name="Type" type="ILenum" description="Type of the palette." />
<description>The ilRegisterPal function registers the current image's palette.</description>
<link name="Types" verbose="true">
<a name="IL_PAL_RGB24" description="" />
<a name="IL_PAL_RGB32" description="" />
<a name="IL_PAL_RGBA32" description="" />
<a name="IL_PAL_RGB16_TGA" description="" />
<a name="IL_PAL_BGR24" description="" />
<a name="IL_PAL_BGR32" description="" />
<a name="IL_PAL_BGRA32" description="" />
<a name="IL_PAL_BGR16_TGA" description="" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterLoad" />
<a from="IL" name="ilRegisterFormat" />
<a from="IL" name="ilRegisterOrigin" />
<a from="IL" name="ilRegisterPal" />
</link>
</entity>
<entity type="function">
<name>ilRegisterType</name>
<return>ILvoid</return>
<param description="The type the current image should be converted to. Values accepted are: <dl><dd>IL_BYTE</dd><dd>IL_UNSIGNED_BYTE</dd><dd>IL_SHORT</dd><dd>IL_UNSIGNED_SHORT</dd><dd>IL_INT</dd><dd>IL_UNSIGNED_INT</dd><dd>IL_FLOAT</dd></dl>" name="Type" type="ILenum" />
<description>ilRegisterType tells OpenIL what datatype the current registered image uses. This function is to be used from within functions that have been registered via ilRegisterLoad.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterLoad" />
<a from="IL" name="ilRegisterFormat" />
<a from="IL" name="ilRegisterOrigin" />
<a from="IL" name="ilRegisterPal" />
</link>
</entity>
<entity type="function">
<name>ilRegisterSave</name>
<return>ILboolean</return>
<param name="Ext" type="char *" description="Extension of the image type to save" />
<param name="Save" type="IL_SAVEPROC" description="Pointer to a saving function" />
<description>ilRegisterType tells OpenIL what datatype the current registered image uses. This function is to be used from within functions that have been registered via ilRegisterLoad.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterLoad" />
<a from="IL" name="ilRemoveSave" />
<a from="IL" name="ilRemoveLoad" />
</link>
</entity>
<entity type="function">
<name>ilRemoveLoad</name>
<return>ILboolean</return>
<param name="Ext" type="char *" description="Extension to remove (e.g. tga)." />
<description>ilRemoveLoad removes a registered extension handler from the registered load functions list. Use this function when a new handler for an extension needs to be registered.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterLoad" />
<a from="IL" name="ilRemoveSave" />
<a from="IL" name="ilRegisterSave" />
</link>
</entity>
<entity type="function">
<name>ilRemoveSave</name>
<return>ILboolean</return>
<param name="Ext" type="char *" description="Extension to remove (e.g. tga)." />
<description>ilRemoveSave removes a registered extension handler from the registered save functions list. Use this function when a new handler for an extension needs to be registered.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilRegisterSave" />
<a from="IL" name="ilRemoveSave" />
<a from="IL" name="ilRegisterSave" />
</link>
</entity>
<entity type="function">
<name>ilSavePal</name>
<return>ILboolean</return>
<param name="FileName" type="char *" description="Filename to save the palette data to." />
<description>If the current bound image has a palette, ilSavePal saves the current image's palette to the file specified by FileName. Currently, OpenIL only supports saving to Paint Shop Pro .pal files.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INVALID_PARAM" description="FileName or Type was NULL." />
<a from="IL" name="IL_INVALID_EXTENSION" description="No extension set matched FileName's extension." />
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="Could not open FileName for writing." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilGetPalette</name>
<return>ILubyte *</return>
<description>ilGetPalette returns an unsigned byte pointer to the current bound image's palette (if one exists) to allow direct access and modification to the contents of the palette.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetData" />
</link>
</entity>
<entity type="function">
<name>ilLoadPal</name>
<return>ILboolean</return>
<param name="FileName" type="char *" description="Filename to load the palette data from." />
<description>ilLoadPal simply loads a palette from the file specified by FileName into the current bound image's palette. If the current bound image is not of type IL_COLOR_INDEX, the palette is not used, but it is loaded nonetheless. ilLoadPal can load .col, Halo and Jasc PSP palette files.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INVALID_PARAM" description="FileName or Type was NULL." />
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="Could not open FileName for writing." />
<a from="IL" name="IL_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
</link>
</entity>
<entity type="function">
<name>ilSetPixels</name>
<return>ILvoid</return>
<param name="XOff" type="ILuint" description="Where to begin copying pixels to in the x direction." />
<param name="YOff" type="ILuint" description="Where to begin copying pixels to in the y direction." />
<param name="ZOff" type="ILuint" description="Where to begin copying pixels to in the z direction." />
<param name="Width" type="ILuint" description="How many pixels to copy in the x direction." />
<param name="Height" type="ILuint" description="How many pixels to copy in the y direction." />
<param name="Depth" type="ILuint" description="How many pixels to copy in the z direction." />
<param name="Format" type="ILenum" description="The format the input is." />
<param name="Type" type="ILenum" description="The type the input is." />
<param name="Data" type="ILvoid *" description="User-defined buffer to copy the image data to." />
<description>ilCopyPixels has very simple behaviour. It simply copies a block of pixels from the Data buffer to the current image's data. XOff, YOff and ZOff can be used to skip a certain number of pixels in each respective direction. If XOff + Width, YOff + Height and/or ZOff + Depth is greater than the current image's width, height or depth, only the current image's width, height or depth number of pixels will be copied to the current image's data buffer.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INVALID_CONVERSION" description="Format did not match the current image's format. Use ilGetInteger to obtain the current image's format." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetInteger" />
</link>
</entity>
<entity type="function">
<name>ilRegisterMipNum</name>
<return>ILboolean</return>
<param name="Num" type="ILuint" description="Number of mipmaps to create." />
<description>ilRegisterMipNum tells OpenIL the number of mipmaps the current image has. The mipmaps can then be chosen and modified via ilActiveMipmap. This function is to be used from within functions that have been registered via ilRegisterLoad.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilActiveMipmap" />
<a from="IL" name="ilRegisterNumImages" />
<a from="IL" name="ilRegisterLoad" />
</link>
</entity>
<entity type="function">
<name>ilRegisterNumImages</name>
<return>ILboolean</return>
<param name="Num" type="ILuint" description="Number of images in the animation chain to create." />
<description>ilRegisterNumImages tells OpenIL the number of images in the current image's animation chain. The "next" images can then be chosen and modified via ilActiveImage. This function is to be used from within functions that have been registered via ilRegisterLoad.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilActiveMipmap" />
<a from="IL" name="ilRegisterNumImages" />
<a from="IL" name="ilRegisterLoad" />
</link>
</entity>
<entity type="function">
<name>ilActiveLayer</name>
<return>ILboolean</return>
<param name="Number" type="ILuint" description="Layer number to select as current." />
<description>ilActiveLayer is not yet used.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_INTERNAL_ERROR" description="*Big* problem with OpenIL. E-mail an admin with the conditions leading up to the error and pray. =]" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilActiveImage" />
<a from="IL" name="ilActiveMipmap" />
</link>
</entity>
<entity type="function">
<name>ilOverlayImage</name>
<return>ILboolean</return>
<param name="Src" type="ILuint" description="The image to copy." />
<param name="XCoord" type="ILuint" description="The starting x position of the current image to copy Src to." />
<param name="YCoord" type="ILuint" description="The starting y position of the current image to copy Src to." />
<param name="ZCoord" type="ILuint" description="The starting z position of the current image to copy Src to." />
<description>The ilOverlayImage function copies the image named by Src onto the current bound image. XCoord, YCoord and ZCoord are allowed to be any number, even negative numbers, for if you want to start copying Src in the middle of it to the current image's left side. If the image named by Src has alpha components, then blending will occur, instead of just a simple overlay.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilCloneCurImage</name>
<return>ILuint</return>
<description>ilCloneCurImage creates a copy of the current image and returns the id of the new image. If a subimage of the current image is currently selected via ilActiveImage, ilActiveLayer or ilActiveMipmap, the subimage is copied, not the base image.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilCopyImage" />
<a from="IL" name="ilActiveImage" />
<a from="IL" name="ilActiveLayer" />
<a from="IL" name="ilActiveMipmap" />
</link>
</entity>
<entity type="function">
<name>ilSetMemory</name>
<return>ILvoid</return>
<param name="AllocFunc" type="mAlloc" description="Specifies a function to override DevIL's allocation function." />
<param name="FreeFunc" type="mFree" description="Specifies a function to override DevIL's deallocation function." />
<description>ilSetMemory was created to let DevIL users override the default memory allocation and deallocation functions present in DevIL. This support can be useful if you are using your own optimized memory handler or anything similar.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_INVALID_PARAM" description="Either AllocFunc or FreeFunc is NULL." />
</link>
</entity>
<entity type="function">
<name>ilSetWrite</name>
<return>ILvoid</return>
<param type="fOpenWProc" name="Open" description="Pointer to a function to open a file." />
<param type="fCloseWProc" name="Close" description="Pointer to a function to close a file." />
<param type="fPutcProc" name="Putc" description="Pointer to a function to write one byte to a file." />
<param type="fSeekWProc" name="Seek" description="Pointer to a function to change position in a file." />
<param type="fTellRProc" name="Tell" description="Pointer to a function to report the position in a file." />
<param type="fWriteProc" name="Write" description="Pointer to a function to write multiple bytes to a file." />
<description>ilSetWrite allows you to override the default DevIL saving functions with your own. You are virtually unlimited in how your functions work, as long as they have the same behaviour as DevIL's default saving functions. All the functions work on the ILHANDLE type, which is a just a void pointer.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilSetRead" />
<a from="IL" name="ilResetRead" />
<a from="IL" name="ilResetWrite" />
</link>
</entity>
<entity type="function">
<name>ilResetRead</name>
<return>ILvoid</return>
<description>ilResetRead resets the reading functions set by ilSetRead.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilSetRead" />
<a from="IL" name="ilSetRead" />
<a from="IL" name="ilResetWrite" />
</link>
</entity>
<entity type="function">
<name>ilResetWrite</name>
<return>ILvoid</return>
<description>ilResetWrite resets the writing functions set by ilSetWrite.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilSetRead" />
<a from="IL" name="ilSetRead" />
<a from="IL" name="ilResetRead" />
</link>
</entity>
<entity type="function">
<name>ilSetDuration</name>
<return>ILboolean</return>
<param name="Duration" type="ILuint" description="Number of milliseconds to play the currently bound image." />
<description>ilSetDuration allows you to set how long to show the currently bound image. This function can also change the durations of individual images in animation chains.</description>
</entity>
<entity type="function">
<name>ilApplyProfile</name>
<return>ILboolean</return>
<param name="InProfile" type="const ILstring" description="Profile file describing the colour space the image is in." />
<param name="OutProfile" type="const ILstring" description="Profile file describing the colour space to convert the image to." />
<description>iluApplyProfile applies a colour profile (files with extension .icm) to the currently bound image. InProfile describes the current image's colour space, and OutProfile describes the colour space to convert the currently bound image to. If InProfile is NULL, DevIL attempts to use the colour profile present in the image, if one is present, else it returns IL_FALSE.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" />
<a from="IL" name="IL_OUT_OF_MEMORY" />
<a from="IL" name="IL_INVALID_PARAM" description="InProfile and/or OutProfile was NULL." />
</link>
</entity>
<entity type="function">
<name>ilSetString</name>
<return>ILvoid</return>
<param name="String" type="char *" description="String to use for setting a string field of a specified image format." />
<param name="Mode" type="ILenum" description="Specifies the string to be set." />
<link name="Modes" verbose="false">
<a name="IL_TGA_ID_STRING" from="IL" description="Specifies a string for the identification field of a .tga file. The maximum length is 254 characters." />
<a name="IL_TGA_AUTHNAME_STRING" from="IL" description="Specifies the author's name for a .tga file, to be put in the extensions field. The maximum length is 40 characters." />
<a name="IL_TGA_AUTHCOMMENT_STRING" from="IL" description="Specifies any author's comments for a .tga file, to be put in the extensions field. The maximum length is 80 characters." />
<a name="IL_PNG_AUTHNAME_STRING" from="IL" description="Specifies the author's name for a .png file. The maximum length is 255 characters." />
<a name="IL_PNG_TITLE_STRING" from="IL" description="Specifies the title of the image for a .png file. The maximum length is 255 characters." />
<a name="IL_PNG_DESCRIPTION_STRING" from="IL" description="Specifies a short description of the image for a .png file. The maximum length is 255 characters." />
<a name="IL_TIF_DESCRIPTION_STRING" from="IL" description="Specifies a short description of the image for a .tif file. The maximum length is 255 characters." />
<a name="IL_TIF_HOSTCOMPUTER_STRING" from="IL" description="Specifies the host computer's name for a .tif file. The maximum length is 255 characters." />
<a name="IL_TIF_DOCUMENTNAME_STRING" from="IL" description="Specifies the name of the image for a .tif file. The maximum length is 255 characters." />
<a name="IL_TIF_AUTHNAME_STRING" from="IL" description="Specifies the author's name for a .tif file. The maximum length is 255 characters." />
</link>
<description>ilSetString gives DevIL users the option to set strings in certain file formats that have fields for strings, making DevIL highly customizable. Choose one of the acceptable parameters for Mode and specify any string you want. If the string is too long, it will be truncated when writing to the file.</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_INVALID_ENUM" description="Mode was an invalid enum." />
<a from="IL" name="IL_INVALID_PARAM" description="String was NULL." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="function">
<name>ilSaveF</name>
<return>ILboolean</return>
<param name="Type" type="ILenum" description="Image format" />
<param name="File" type="ILHANDLE" description="Pointer to a previous opened file" />
<description>ilSaveF saves an image to a previously opened file</description>
<link name="Types" verbose="true">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Save the image as a Microsoft bitmap (.bmp)." />
<a name="IL_JPG" description="Save the image as a Jpeg (.jpg)." />
<a name="IL_PNM" description="Save a Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="Save a PhotoShop (.psd) file." />
<a name="IL_SGI" description="Save an SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="Save a TrueVision Targa." />
<a name="IL_CHEAD" description="Save a C Header style image." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. " />
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="The file pointed to by FileName could not be opened. Either the file does not exist or is in use by another process." />
<a from="IL" name="IL_INVALID_ENUM" description="Type was of an invalid value." />
<a from="IL" name="IL_INVALID_PARAM" description="FileName or Type was NULL." />
<a from="IL" name="IL_LIB_JPEG_ERROR" description="Error occurred when trying to save a jpeg." />
<a from="IL" name="IL_LIB_PNG_ERROR" description="Error occurred when trying to save a png." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="function">
<name>ilSaveL</name>
<return>ILboolean</return>
<param name="Type" type="ILenum" description="Image format" />
<param name="Lump" type="ILvoid *" description="Lump Address" />
<param name="Size" type="ILuint" description="Lump size" />
<description>ilSaveL saves an image to a memory lump</description>
<link name="Types" verbose="true">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Save the image as a Microsoft bitmap (.bmp)." />
<a name="IL_JPG" description="Save the image as a Jpeg (.jpg)." />
<a name="IL_PNM" description="Save a Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="Save a PhotoShop (.psd) file." />
<a name="IL_SGI" description="Save an SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="Save a TrueVision Targa." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. " />
<a from="IL" name="IL_INVALID_ENUM" description="Type was of an invalid value." />
<a from="IL" name="IL_OUT_OF_MEMORY" description="Could not allocate memory for the new image palette." />
<a from="IL" name="IL_LIB_JPEG_ERROR" description="Error occurred when trying to load a jpeg." />
<a from="IL" name="IL_LIB_PNG_ERROR" description="Error occurred when trying to load a png." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="function">
<name>ilSave</name>
<return>ILboolean</return>
<param name="Type" type="ILenum" description="Image format." />
<param name="File" type="char *" description="The filename of the file to save to." />
<description>ilSave can be used much in the same way ilSaveImage is used, except with ilSave, it is possible to force OpenIL to save a file as a specific image format, no matter what the extension.</description>
<link name="Types" verbose="false">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Save the image as a Microsoft bitmap (.bmp)." />
<a name="IL_JPG" description="Save the image as a Jpeg (.jpg)." />
<a name="IL_PNM" description="Save a Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="Save a PhotoShop (.psd) file." />
<a name="IL_PSD" description="Save a PhotoShop (.psd) file." />
<a name="IL_SGI" description="Save an SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="Save a TrueVision Targa." />
<a name="IL_CHEAD" description="Save a C Header style image." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_COULD_NOT_OPEN_FILE" description="The file pointed to by FileName could not be opened. Either the file does not exist or is in use by another process." />
<a from="IL" name="IL_INVALID_ENUM" description="Type was of an invalid value." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="function">
<name>ilSetInteger</name>
<return>ILvoid</return>
<param name="Mode" type="ILenum" description="The mode value to be modified." />
<param name="Param" type="ILint" description="The value to set the mode with." />
<description>The ilSetInteger function sets the value of a selected mode. it's the ilGetInteger's counterpart</description>
<link name="Mode" verbose="true">
<a name="IL_TGA_CREATE_STAMP" description="Sets whether .tga files are saved with a 'postage stamp' in their extension fields (IL_TRUE or IL_FALSE accepted)." />
<a name="IL_JPG_QUALITY" description="Sets the quality .jpg files are saved at. Valid values are in the 0-99 range, with 99 being the best quality." />
<a name="IL_PNG_INTERLACE" description="Tells DevIL to save .png files interlaced." />
<a name="IL_TGA_RLE" description="Tells DevIL to save .tga files with RLE-compressed data." />
<a name="IL_BMP_RLE" description="Tells DevIL to save .bmp files with RLE-compressed data." />
<a name="IL_SGI_RLE" description="Tells DevIL to save .sgi files with RLE-compressed data." />
</link>
<link name="Errors" verbose="true">
<a from="IL" name="IL_INVALID_PARAM" description="Param was not in range." />
<a from="IL" name="IL_INVALID_ENUM" description="Mode was of an invalid value." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilSave" />
<a from="IL" name="ilSaveImage" />
<a from="IL" name="ilSetFileCallbacks" />
</link>
</entity>
<entity type="value">
<name>IL_VENDOR</name>
<description>Describes the OpenIL vendor and should be used only with ilGetString</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetString" />
</link>
</entity>
<entity type="value">
<name>IL_VERSION</name>
<description>Used to retrive a string describing the current OpenIL version.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetString" />
<a from="IL" name="ilGetInteger" />
</link>
</entity>
<entity type="value">
<name>IL_ORIGIN_SET</name>
<description>IL Mode Value. When enabled, the origin is specified at an absolute position, and all images loaded or saved adhere to this set origin. For more information, check out ilOriginFunc.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilDisable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_FILE_OVERWRITE</name>
<description>IL Mode Value. If enabled while saving, OpenIL will overwrite existing files, else IL_FILE_ALREADY_EXISTS is set, and the image is not saved.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilDisable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
</link>
</entity>
<entity type="value">
<name>IL_CONV_PAL</name>
<description>IL Mode Value. When enabled, OpenIL automatically converts palette'd images to their base types, e.g. converting to a bgra image.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilEnable" />
<a from="IL" name="ilDisable" />
<a from="IL" name="ilIsEnabled" />
<a from="IL" name="ilIsDisabled" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_ORIGIN_MODE</name>
<description>IL Mode Value. Returns the current origin position.</description>
<link name="Values" verbose="false">
<a description="Origin is in the lower left corner" name="IL_ORIGIN_LOWER_LEFT" />
<a description="Origin is in the upper left corner" name="IL_ORIGIN_UPPER_LEFT" />
</link>
<link name="Usage" verbose="false">
<a from="IL" name="ilOriginFunc" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_FILE_MODE</name>
<description>IL Mode Value. Returns whether file overwriting when saving is enabled.</description>
<link name="Usage" verbose="false">
<a from="IL" name="IL_FILE_OVERWRITE" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_FORMAT_SET</name>
<description>IL Mode Value. Returns whether all images loaded are converted to a specific format.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_FORMAT_MODE</name>
<description>IL Mode Value. Returns the format images are converted to upon loading.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_TYPE_SET</name>
<description>IL Mode Value. Returns whether all images loaded are converted to a specific type.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_TYPE_MODE</name>
<description>IL Mode Value. Returns the type images are converted to upon loading.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_VERSION_NUM</name>
<description>IL Mode Value. Returns the version number of the shared library. This can be checked against the IL_VERSION #define.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_IMAGE_WIDTH</name>
<description>IL Mode Value. Returns the current image's width.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_IMAGE_HEIGHT</name>
<description>IL Mode Value. Returns the current image's height.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_IMAGE_BYTES_PER_PIXEL</name>
<description>IL Mode Value. Returns the bytes per pixel of the current image's data.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_IMAGE_BITS_PER_PIXEL</name>
<description>IL Mode Value. Returns the bits per pixel of the current image's data.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_IMAGE_FORMAT</name>
<description>IL Mode Value. Returns the current image format.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_IMAGE_TYPE</name>
<description>IL Mode Value. Returns the current images type.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_NUM_IMAGES</name>
<description>IL Mode Value. Returns the number of images in the current image animation chain.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_NUM_MIPMAPS</name>
<description>IL Mode Value. Returns the number of mipmaps of the current image.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_PALETTE_TYPE</name>
<description>IL Mode Value. Returns the palette type of the current image.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_PALETTE_BPP</name>
<description>IL Mode Value. Returns the bytes per pixel of the current images palette.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_PALETTE_NUM_COLS</name>
<description>IL Mode Value. Returns the number of colours of the current images palette.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_ACTIVE_IMAGE</name>
<description>IL Mode Value. Returns the current image number.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_ACTIVE_LAYER</name>
<description>IL Mode Value. Returns the current layer number.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_CUR_IMAGE</name>
<description>IL Mode Value. Returns the current bound image name.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_ACTIVE_MIPMAP</name>
<description>IL Mode Value. Returns the current mipmap number.</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_USE_KEY_COLOUR</name>
<description>IL Mode Value. Returns whether OpenIL uses a key colour (not used yet).</description>
<link name="Usage" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>IL_ILLEGAL_OPERATION</name>
<description>The operation attempted is not allowable in the current state. The function returns with no ill side effects. Generally there is currently no image bound or it has been deleted via ilDeleteImages. You should use ilGenImages and ilBindImage before calling the function.</description>
</entity>
<entity type="value">
<name>IL_OUT_OF_MEMORY</name>
<description>Could not allocate enough memory for the image data.</description>
</entity>
<entity type="value">
<name>IL_INVALID_CONVERSION</name>
<description>During a conversion destination format and/or dest type was an invalid identifier. In the function documentation there should be a more specific descriptionanation.</description>
</entity>
<entity type="value">
<name>IL_INVALID_ENUM</name>
<description>An invalid value have been used, which was not part of the set of values that can be used. In the function documentation there should be a more specific descriptionanation.</description>
</entity>
<entity type="value">
<name>IL_INVALID_PARAM</name>
<description>An invalid value have been used, which was not part of the set of values that can be used. In the function documentation there should be a more specific descriptionanation.</description>
</entity>
<entity type="value">
<name>IL_NO_ERROR</name>
<description>No detectable error has occured.</description>
</entity>
<entity type="value">
<name>IL_FORMAT_NOT_SUPPORTED</name>
<description>The format a function tried to use was not able to be used by that function.</description>
</entity>
<entity type="value">
<name>IL_INTERNAL_ERROR</name>
<description>A serious error has occurred. Please e-mail an admin with the conditions leading up to this error being reported.</description>
</entity>
<entity type="value">
<name>IL_INVALID_VALUE</name>
<description>An invalid value was passed to a function or was in a file.</description>
</entity>
<entity type="value">
<name>IL_ILLEGAL_FILE_VALUE</name>
<description>An illegal value was found in a file trying to be loaded.</description>
</entity>
<entity type="value">
<name>IL_INVALID_FILE_HEADER</name>
<description>A file's header was incorrect.</description>
</entity>
<entity type="value">
<name>IL_COULD_NOT_OPEN_FILE</name>
<description>Could not open the file specified. The file may already be open by another app or may not exist.</description>
</entity>
<entity type="value">
<name>IL_INVALID_EXTENSION</name>
<description>The extension of the specified filename was not correct for the type of image-loading function.</description>
</entity>
<entity type="value">
<name>IL_FILE_ALREADY_EXISTS</name>
<description>The filename specified already belongs to another file. To overwrite files by default read more at ilEnable function.</description>
</entity>
<entity type="value">
<name>IL_OUT_FORMAT_SAME</name>
<description>Tried to convert an image from its format to the same format.</description>
</entity>
<entity type="value">
<name>IL_STACK_OVERFLOW</name>
<description>One of the internal stacks was already filled, and the user tried to add on to the full stack.</description>
</entity>
<entity type="value">
<name>IL_STACK_UNDERFLOW</name>
<description>One of the internal stacks was empty, and the user tried to empty the already empty stack.</description>
</entity>
<entity type="value">
<name>IL_LIB_JPEG_ERROR</name>
<description>An error occurred in the libjpeg library.</description>
</entity>
<entity type="value">
<name>IL_LIB_PNG_ERROR</name>
<description>An error occurred in the libpng library.</description>
</entity>
<entity type="value">
<name>IL_UNKNOWN_ERROR</name>
<description>No function sets this yet, but it is possible (not probable) it may be used in the future.</description>
</entity>
<entity type="value">
<name>IL_ORIGIN_BIT</name>
<description>Preserves the origin state set by ilOriginFunc.</description>
</entity>
<entity type="value">
<name>IL_FILE_BIT</name>
<description>Preserves whether OpenIL is allowed to overwrite files when saving (set by ilEnable, ilDisable).</description>
</entity>
<entity type="value">
<name>IL_PAL_BIT</name>
<description>Preserves whether OpenIL is supposed to convert palette'd to truecolour images (set by ilEnable, ilDisable).</description>
</entity>
<entity type="value">
<name>IL_ALL_ATTRIB_BITS</name>
<description>Preserves all OpenIL states and attributes.</description>
</entity>
</set>
<set name="ILU">
<entity type="function">
<name>iluFlipImage</name>
<return>ILboolean</return>
<description>iluFlipImage inverts an image over the x axis. The image will be upside-down after calling this function. If this function is called twice in succession, the image is restored to its original state. A version of this function in OpenIL is used throughout internally when loading images to correct images that would otherwise be upside-down. Using ilOriginFunc will essentially tell the library which way is up.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_OUT_OF_MEMORY" />
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilOriginFunc" />
</link>
</entity>
<entity type="function">
<name>iluMirror</name>
<return>ILboolean</return>
<description>iluMirror mirrors an image across its y axis, making it appear backwards.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>iluNegative</name>
<return>ILboolean</return>
<description>iluNegative creates a negative version of an image, like it was viewed as a picture negative instead of the actual picture. The effect is caused by inverting the image's colours, such as a green pixel would become purple (red-blue).</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>iluSwapColours</name>
<return>ILboolean</return>
<description>iluSwapColours "swaps" the colour order of the current image. If the current image is in bgr(a) format, iluSwapColours will change the image to use rgb(a) format, or vice-versa. This can be helpful when you want to manipulate the image data yourself but only want to use a certain colour order. To determine the current colour order, call ilGetInteger with the IL_IMAGE_FORMAT parameter.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="function">
<name>iluBuildMipmaps</name>
<return>ILboolean</return>
<description>iluBuildMipmaps generates power-of-2 mipmaps for an image. If the image does not have power-of-2 dimensions, then the image is resized via iluScale. Mipmaps are then generated for the image, down to a 1x1 image. To use the mipmaps, see ilActiveMipmap.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILU" name="iluScale" />
<a from="IL" name="ilActiveMipmap" />
</link>
</entity>
<entity type="function">
<name>iluInvertAlpha</name>
<return>ILboolean</return>
<description>iluInvertAlpha inverts the alpha of the currently bound image.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilGetAlpha" />
</link>
</entity>
<entity type="function">
<name>iluGetString</name>
<return>const char*</return>
<param name="StringName" type="ILenum" description="Enum that describes the string to be retrieved." />
<description>iluGetString returns a constant human-readable string describing the current OpenILU implementation.</description>
<link name="Values" verbose="true">
<a name="ILU_VENDOR" description="Describes the OpenILU vendor." />
<a name="ILU_VERSION_NUM" description="Use iluGetInteger with ILU_VERSION_NUM to check for version differences instead." />
</link>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_INVALID_ENUM" description="StringName was an invalid enum type." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetString" />
<a from="ILUT" name="ilutGetString" />
</link>
</entity>
<entity type="function">
<name>iluErrorString</name>
<return>const ILbyte*</return>
<param name="StringName" type="ILenum" description="Enum that describes the string to be retrieved." />
<description>iluErrorString returns a human-readable string of the error in Error. This can be useful for displaying the human-readable error in your program to let the user know wtf just happened.</description>
<link name="Values" verbose="true">
<a name="ILU_VENDOR" description="Describes the OpenILU vendor." />
<a name="ILU_VERSION_NUM" description="Use iluGetInteger with ILU_VERSION_NUM to check for version differences instead." />
</link>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetError" />
</link>
</entity>
<entity type="function">
<name>iluRotate</name>
<return>ILboolean</return>
<param name="Angle" type="ILfloat" description="Angle in degrees to rotate the image." />
<description>iluRotate simply rotates an image about the center by Angle degrees. The background where there is space left by the rotation will be set to the clear colour.</description>
<link name="Values" verbose="true">
<a name="ILU_VENDOR" description="Describes the OpenILU vendor." />
<a name="ILU_VERSION_NUM" description="Use iluGetInteger with ILU_VERSION_NUM to check for version differences instead." />
</link>
<link name="See Also" verbose="false">
<a from="ILU" name="iluRotate3D" />
<a from="IL" name="ilClearColour" />
</link>
</entity>
<entity type="function">
<name>iluAlienify</name>
<return>ILboolean</return>
<description>The story behind this function is actually sorta funny. I had been using a picture of me (contact me if you want it! =) as a test image, and I started working on some colour matrix filters. Well, my first attempt screwed-up, because I had changed the equations to accomodate my bgr image, but I transposed the equations entirely wrong. I got a really neat output, though, where I looked like an alien. =) I decided to keep the screw-up and placed it in iluAlienify. I can't say I've ever run across a filter like this before.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluScale</name>
<return>ILboolean</return>
<param name="Width" type="ILuint" description="New width of the image." />
<param name="Height" type="ILuint" description="New height of the image." />
<param name="Depth" type="ILuint" description="New depth of the image." />
<description>The iluScale function scales the image to the new dimensions specified, shrinking or enlarging the image, depending on the image's original dimensions. There are different filters that can be used to scale an image, and which filter to use can be specified via iluImageParameter.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluImageParameter" />
</link>
</entity>
<entity type="function">
<name>iluBlurAvg</name>
<return>ILboolean</return>
<param name="Iter" type="ILuint" description="Number of iterations of blurring to perform." />
<description>iluBlurAvg blurs an image using an averaging convolution filter. The filter is applied up to Iter number of times, giving more of a blurring effect the higher Iter is. The 3x3 convolution filter used to do the average blur is: %center% %img:../images/matrix_avg.gif% %center/%</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluImageParameter" />
</link>
</entity> <!-- @TODO Matrix is (1,2,1)
(2,4,2)
(1,2,1) with scale 9 and offset 1 -->
<entity type="function">
<name>iluBlurGaussian</name>
<return>ILboolean</return>
<param name="Iter" type="ILuint" description="Number of iterations of blurring to perform." />
<description>iluBlurGaussian blurs an image using a Gaussian convolution filter, which usually gives better results than the filter used by iluBlurAvg. The filter is applied up to Iter number of times, giving more of a blurring effect the higher Iter is.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluBlurAvg" />
<a from="ILUA" name="iluSharpen" />
</link> <!-- @TODO Matrix is (1,2,1)
(2,4,2)
(1,2,1) with scale 16 and offset 1 -->
</entity>
<entity type="function">
<name>iluContrast</name>
<return>ILboolean</return>
<param name="Contrast" type="ILfloat" description="The factor to contrast by" />
<description>iluContrast changes the contrast of an image by using interpolation and extrapolation. Common values for Contrast are in the range -0.5 to 1.7. Anything below 0.0 generates a negative of the image with varying contrast. 1.0 outputs the original image. 0.0 - 1.0 lowers the contrast of the image. 1.0 - 1.7 increases the contrast of the image. This effect is caused by interpolating (or extrapolating) the source image with a totally grey image.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluCrop</name>
<return>ILboolean</return>
<param name="XOff" type="ILuint" description="Number of pixels to skip in the x direction." />
<param name="YOff" type="ILuint" description="Number of pixels to skip in the y direction." />
<param name="ZOff" type="ILuint" description="Number of pixels to skip in the z direction." />
<param name="Width" type="ILuint" description="Number of pixels to preserve in the x direction." />
<param name="Height" type="ILuint" description="Number of pixels to preserve in the y direction." />
<param name="Depth" type="ILuint" description="Number of pixels to preserve in the z direction." />
<description>iluCrop "crops" the current image to new dimensions. The new image appears the same as the original, but portions of the image are clipped-off, depending on the values of the parameters of these functions. If XOff + Width, YOff + Height or ZOff + Depth is larger than the current image's dimensions, ILU_ILLEGAL_OPERATION is set. If ZOff is minus or equal to one the crop will be done only on 2 dimensions</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" description="There is currently no image bound. Use ilGenImages and ilBindImage before calling this function. XOff + Width, YOff + Height, or ZOff + Depth is greater than the current image's dimensions. " />
<a from="ILU" name="ILU_OUT_OF_MEMORY" description="Could not allocate memory for the new image data." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluEdgeDetectP</name>
<return>ILboolean</return>
<description>iluEdgeDetectP detects the edges in the current image by combining two convolution filters. The filters used are Prewitt filters.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" description="Could not allocate memory for the new image data." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluEdgeDetectS" />
</link>
</entity><!-- @TODO Matrixes:
(-1,0,1)
(-1,0,1)
(-1,0,1) scale 1 offset 0
(1,1,1)
(0,0,0)
(-1,-1,-1) scale 1 offset 0 -->
<entity type="function">
<name>iluEdgeDetectS</name>
<return>ILboolean</return>
<description>iluEdgeDetectS detects the edges in the current image by combining two convolution filters. The filters used are Sobel filters.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" description="Could not allocate memory for the new image data." />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluEdgeDetectP" />
</link>
</entity><!-- @TODO Matrixes:
(1,2,1)
(0,0,0)
(-1,-2,-1) scale 1 offset 0
(1,0,-1)
(2,0,-2)
(1,0,-1) scale 1 offset 0 -->
<entity type="function">
<name>iluEnlargeCanvas</name>
<return>ILboolean</return>
<param name="Width" type="ILuint" description="New image width - must be larger than the current image's width." />
<param name="Height" type="ILuint" description="New image height - must be larger than the current image's width." />
<param name="Depth" type="ILuint" description="New image depth - must be larger than the current image's width." />
<description>iluEnlargeCanvas enlarges the canvas of the current image, clearing the background to the colour specified in ilClearColour. To control the placement of the image, use iluImageParameter</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="IL" name="ilClearColour" />
<a from="ILU" name="iluImageParameter" />
</link>
</entity>
<entity type="function">
<name>iluGammaCorrectInter</name>
<return>ILboolean</return>
<param name="Gamma" type="ILfloat" description="Gamma correction." />
<description>iluGammaCorrectInter adjust the gamma of the current image. If Gamma is less than 1.0, the image is darkened. If Gamma is greater than 1.0, the image is brightened. It uses interpolation so it's slower then iluGammaCorrectScale</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluGammaCorrectScale" />
</link>
</entity>
<entity type="function">
<name>iluGammaCorrectScale</name>
<return>ILboolean</return>
<param name="Gamma" type="ILfloat" description="Gamma correction." />
<description>These two functions adjust the gamma of the current image. If Gamma is less than 1.0, the image is darkened. If Gamma is greater than 1.0, the image is brightened. iluGammaCorrectInter is a slower function and uses interpolation to achieve this effect. iluGammaCorrectScale achieves this effect by scaling the colours via iluScaleColours.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluGammaCorrectScale" />
</link>
</entity>
<entity type="function">
<name>iluPixelize</name>
<return>ILboolean</return>
<param name="PixSize" type="ILuint" description="New pixel size" />
<description>iluPixelize performs the effect that can be seen on television, where people want their identity to remain anonymous, so the editors cover the person's face with a very blocky pixelized version. PixSize specifies how blocky the image should be, with 1 being the lowest blockiness (doesn't change the image).</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluSaturate1f</name>
<return>ILboolean</return>
<param name="Saturation" type="ILfloat" description="Amount of saturation to apply to the current bound image. the value must go from -1.0 to 1.0" />
<description>iluSaturate1f applies a saturation consistent with the IL_LUMINANCE conversion values to red, green and blue.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluSaturate4f" />
</link>
</entity>
<entity type="function">
<name>iluSaturate4f</name>
<return>ILboolean</return>
<param name="r" type="ILfloat" description="Amount of saturation to apply at the red channel." />
<param name="g" type="ILfloat" description="Amount of saturation to apply at the green channel." />
<param name="b" type="ILfloat" description="Amount of saturation to apply at the blue channel." />
<description>iluSaturate1f applies a saturation consistent with the IL_LUMINANCE conversion values to red, green and blue.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluSaturate1f" />
</link>
</entity>
<entity type="function">
<name>iluSharpen</name>
<return>ILboolean</return>
<param name="Factor" type="ILfloat" description="Factor to sharpen by." />
<param name="Iter" type="ILuint" description="Number of iterations to perform on the image." />
<description>iluSharpen can actually either sharpen or blur an image, depending on the value of Factor. iluBlurAvg and iluBlurGaussian are much faster for blurring, though. When Factor is 1.0, the image goes unchanged. When Factor is in the range 0.0 - 1.0, the current image is blurred. When Factor is in the range 1.0 - 2.5, the current image is sharpened. To achieve a more pronounced sharpening/blurring effect, simply increase the number of iterations by increasing the value passed in Iter.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluBlurAvg" />
<a from="ILU" name="iluBlurGaussian" />
</link>
</entity>
<entity type="function">
<name>iluCompareImage</name>
<return>ILboolean</return>
<param name="Comp" type="ILuint" description="The image to compare with." />
<description>iluCompareImage compares the current image to the image having the name in Comp. If both images are identical, IL_TRUE is returned. IL_FALSE is returned if the images are not identical. The bound image before calling this function remains the bound image after calling ilCompareImage.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluGetInteger</name>
<return>ILint</return>
<param name="Mode" type="ILenum" description="The mode value to be returned." />
<description>The iluGetInteger function returns the value of a selected mode</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluGetIntegerv" />
<a from="IL" name="ilGetBoolan" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="ILUT" name="ilGetBoolan" />
<a from="ILUT" name="ilGetBooleanv" />
<a from="ILUT" name="ilGetInteger" />
<a from="ILUT" name="ilGetIntegerv" />
</link>
</entity>
<entity type="function">
<name>iluGetIntegerv</name>
<return>ILvoid</return>
<param name="Mode" type="ILenum" description="The mode value to be returned." />
<param name="Param" type="ILint*" description="When used, the value is stored here instead of returned.." />
<description>The iluGetIntegerv function returns the mode value in the Param parameter.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluGetInteger" />
<a from="IL" name="ilGetBoolan" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="ILUT" name="ilGetBoolan" />
<a from="ILUT" name="ilGetBooleanv" />
<a from="ILUT" name="ilGetInteger" />
<a from="ILUT" name="ilGetIntegerv" />
</link>
</entity>
<entity type="function">
<name>iluSaturate4f</name>
<return>ILboolean</return>
<param name="r" type="ILfloat" description="Amount of red to use from the original image" />
<param name="g" type="ILfloat" description="Amount of green to use from the original image" />
<param name="b" type="ILfloat" description="Amount of blue to use from the original image" />
<description>iluScaleColours scales the individual colour components of the current bound image. Using 1.0f as any of the parameters yields that colour component's original plane in the new image.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
<a from="ILU" name="iluGammaCorrectScale" />
</link>
</entity>
<entity type="function">
<name>iluColoursUsed</name>
<return>ILboolean</return>
<description>iluColoursUsed creates a copy of the image data, quicksorts it and counts the number of unique colours in the image. This value is returned without affecting the original image.</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluImageParameter</name>
<return>ILvoid</return>
<param name="PName" type="ILenum" description="Parameter name" />
<param name="Param" type="ILenum" description="Behaviour to use" />
<description>iluImageParameter modifies the behaviour of some ilu functions. Right now, it controls the behaviour of iluEnlargeCanvas and iluScale. For ILU_FILTER, values for Param other than ILU_NEAREST, ILU_LINEAR and ILU_BILINEAR are higher-quality scaling filters and take longer to perform.</description>
<link name="Properties" verbose="true">
<a name="ILU_FILTER" description="Which filter iluScale uses, default is ILU_NEAREST" />
<a name="ILU_PLACEMENT" description="Where to place the image when using iluEnlargeCanvas. The default is ILU_CENTER" />
</link>
<link name="Scale Filters" verbose="true">
<a name="ILU_NEAREST" description="Uses a nearest filter to scale the image (looks worst)" />
<a name="ILU_LINEAR" description="Uses a linear interpolation filter to scale the image (looks better)" />
<a name="ILU_BILINEAR" description="Uses a bilinear (or trilinear for 3d images) interpolation filter to scale the image (looks best)" />
<a name="ILU_SCALE_BOX" description="Uses a box filter to scale the image" />
<a name="ILU_SCALE_TRIANGLE" description="Uses a triangle filter to scale the image" />
<a name="ILU_SCALE_BELL" description="Uses a bell filter to scale the image" />
<a name="ILU_SCALE_BSPLINE" description="Uses a b-spline filter to scale the image" />
<a name="ILU_SCALE_LANCZOS3" description="Uses a lanczos filter to scale the image" />
<a name="ILU_SCALE_MITCHELL" description="Uses a mitchell filter to scale the image" />
</link>
<link name="Placements" verbose="true">
<a name="ILU_LOWER_LEFT" description="Places the image in the lower left of the enlarged canvas" />
<a name="ILU_LOWER_RIGHT" description="Places the image in the lower right of the enlarged canvas" />
<a name="ILU_UPPER_LEFT" description="Places the image in the upper left of the enlarged canvas" />
<a name="ILU_UPPER_RIGHT" description="Places the image in the upper right of the enlarged canvas" />
<a name="ILU_CENTER" description="Places the image in the center of the enlarged canvas" />
</link>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_INVALID_ENUM" description="StringName was an invalid enum type."/>
</link>
<link name="See Also" verbose="false">
<a from="ILU" name="iluEnlargeCanvas" />
<a from="ILU" name="iluScale" />
</link>
</entity>
<entity type="function">
<name>iluInit</name>
<return>ILvoid</return>
<description>iluInit starts ILU and must be called prior to using ILU</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilInit" />
<a from="ILUT" name="ilutInit" />
</link>
</entity>
<entity type="function">
<name>iluEmboss</name>
<return>ILboolean</return>
<description>iluEmboss embosses an image, causing it to have a "relief" feel to it using a convolution filter:</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<!-- @TODO static const ILint filter_emboss_scale = 1;
static const ILint filter_emboss_bias = 128;
static const ILint filter_emboss[] =
{ -1, 0, 1,
-1, 0, 1,
-1, 0, 1 };-->
<entity type="function">
<name>iluNoisify</name>
<return>ILboolean</return>
<param name="Factor" type="ILclampf" description="Specifies the amount of noise to add. Higher values mean more noise" />
<description>iluNoisify adds Factor amount of random noise to an image. Factor can range from 0.0f to 1.0f, with 1.0 being extreme noise and 0.0 being no noise</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluNoisify</name>
<return>ILboolean</return>
<param name="XDim" type="ILfloat" description="Width multiplier" />
<param name="YDim" type="ILfloat" description="Height multiplier" />
<param name="ZDim" type="ILfloat" description="Depth multiplier" />
<description>iluEnlargeImage enlarges an image's dimensions by multipliers, via iluScale. This function could be useful if you wanted to double the size of all images or something similar</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluNoisify</name>
<return>ILboolean</return>
<param name="XDim" type="ILfloat" description="Width multiplier" />
<param name="YDim" type="ILfloat" description="Height multiplier" />
<param name="ZDim" type="ILfloat" description="Depth multiplier" />
<description>iluEnlargeImage enlarges an image's dimensions by multipliers, via iluScale. This function could be useful if you wanted to double the size of all images or something similar</description>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
<a from="ILU" name="ILU_INVALID_PARAM" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImages" />
</link>
</entity>
<entity type="function">
<name>iluDeleteImage</name>
<return>ILvoid</return>
<param name="Id" type="ILuint" description="The image name to delete" />
<description>iluDeleteImage is a convenience function to delete a single image instead of calling ilDeleteImages. Deprecated! use ilDeleteImage instead</description>
<link name="Errors" verbose="true">
<a from="IL" name="IL_INVALID_VALUE" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
<a from="ILU" name="iluGenImage" />
<a from="IL" name="ilGenImage" />
<a from="IL" name="ilDeleteImage" />
</link>
</entity>
<entity type="function">
<name>iluGenImage</name>
<return>ILvoid</return>
<param name="Id" type="ILuint" description="The image name to delete" />
<description>iluGenImage is a convenience function to delete a single image instead of calling ilGenImages. Deprecated! use ilGenImage instead</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilDeleteImages" />
<a from="ILU" name="iluDeleteImage" />
<a from="IL" name="ilGenImage" />
<a from="IL" name="ilDeleteImage" />
</link>
</entity>
<entity type="function">
<name>iluGetImageInfo</name>
<return>ILvoid</return>
<description>The iluGetImageInfo function retrieves information about the current image in an ILinfo struct. This is useful when you are repeatedly calling ilGetInteger and is more efficient in this case.</description>
<param name="Info" type="ILinfo*" description="ILinfo struct to receive the image information." />
<link name="ILInfo structure" verbose="true">
<a name="Width" description="ILuint which contains the image width" />
<a name="Height" description="ILuint which contains the image height" />
<a name="Depth" description="ILuint which contains the image depth" />
<a name="Bpp" description="ILubyte which contains the image Bytes per pixel (not bits)" />
<a name=" SizeOfData" description="ILuint which contains the image size of data in bytes" />
<a name="Format" description="ILuint which contains the image format" />
<a name="Type" description="ILenum which contains the image type" />
<a name="Origin" description="ILenum which contains the image origin" />
<a name="PalType" description="ILenum which contains the image palette type" />
<a name="PalSize" description="ILenum which contains the image palette size" />
<a name="NumNext" description="ILenum which contains the number of image following the current" />
<a name="NumMips" description="ILenum which contains the number of image mipmaps" />
<a name="NumLayers" description="ILenum which contains the image number of layer" />
</link>
<link name="Errors" verbose="true">
<a from="ILU" name="ILU_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
</link>
</entity>
<entity type="value">
<name>ILU_INVALID_PARAM</name>
<description>A Parameter was invalid or out of range</description>
</entity>
<entity type="value">
<name>ILU_INVALID_ENUM</name>
<description>A Parameter was invalid or out of range</description>
</entity>
<entity type="value">
<name>ILU_OUT_OF_MEMORY</name>
<description>Could not allocate enough memory in an operation</description>
</entity>
<entity type="value">
<name>ILU_INTERNAL_ERROR</name>
<description>A serious error has occurred. Please e-mail an admin with the conditions leading up to this error being reported.</description>
</entity>
<entity type="value">
<name>ILU_INVALID_VALUE</name>
<description>An invalid value was passed to a function or was in a file</description>
</entity>
<entity type="value">
<name>ILU_ILLEGAL_OPERATION</name>
<description>The operation attempted is not allowable in the current state. The function returns with no ill side effects. Generally there is currently no image bound or it has been deleted via ilDeleteImages. You should use ilGenImages and ilBindImage before calling the function.</description>
</entity>
</set>
<set name="ILUT">
<entity type="function">
<name>ilutIsEnabled</name>
<return>ILboolean</return>
<description>ilutIsEnabled returns whether the mode indicated by Mode is enabled.</description>
<param description="Indicates an OpenIL mode" name="Mode" type="ILenum" />
<link name="Modes" verbose="true">
<a from="ILUT" description="Not used right now." name="ILUT_PALETTE_MODE" />
<a from="ILUT" description="Whether ilut is allowed to use GL_RGB8 and GL_RGBA8 instead of GL_RGB8 or GL_RGBA8 (useful with nVidia cards)." name="ILUT_OPENGL_CONV" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" description="Mode was of an invalid value." name="ILUT_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="ILUT" name="ilutIsDisabled" />
</link>
</entity>
<entity type="function">
<name>ilutIsDisabled</name>
<return>ILboolean</return>
<description>ilutIsDisabled returns whether the mode indicated by Mode is disabled.</description>
<param description="Indicates an OpenIL mode" name="Mode" type="ILenum" />
<link name="Modes" verbose="true">
<a from="ILUT" description="Not used right now." name="ILUT_PALETTE_MODE" />
<a from="ILUT" description="Whether ilut is allowed to use GL_RGB8 and GL_RGBA8 instead of GL_RGB8 or GL_RGBA8 (useful with nVidia cards)." name="ILUT_OPENGL_CONV" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" description="Mode was of an invalid value." name="ILUT_INVALID_ENUM" />
</link>
<link name="See Also" verbose="false">
<a from="ILUT" name="ilutEnable" />
<a from="ILUT" name="ilutDisable" />
<a from="ILUT" name="ilutIsDisabled" />
</link>
</entity>
<entity type="function">
<name>ilutGetHPal</name>
<return>HPALETTE</return>
<description>The ilutGetHPal function returns a Windows-friendly palette. If the current bound image has a palette, ilutGetHPal returns a Windows-compatible copy of the current image's palette in HPAL format.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
<a from="ILUT" description="Could not allocate enough memory for the palette. " name="ILUT_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutConvertToHBitmap" />
</link>
</entity>
<entity type="function">
<name>ilutInit</name>
<return>ILvoid</return>
<description>The ilutInit function initializes ILUT.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilInit" />
<a from="ILU" name="ilutInit" />
</link>
</entity>
<entity type="function">
<name>ilutGLBindTexImage</name>
<return>GLuint</return>
<description>The ilutGLBindTexImage function binds an image to a generated OpenGL texture.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutGLBuildMipmaps" />
<a from="ILUT" name="ilutGLScreen" />
<a from="ILUT" name="ilutGLTexImage" />
</link>
</entity>
<entity type="function">
<name>ilutGLTexImage</name>
<return>ILboolean</return>
<description>The ilutGLTexImage function binds an image to an OpenGL texture, simply calls glTexImage2D with the current bound image's data and attributes.</description>
<param description="Texture level to place the image at. 0 is the base image level, and anything lower is a mipmap. Use ilActiveMipmap to access OpenIL's mipmaps." name="Level" type="GLuint" />
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilActiveMipmap" />
<a from="ILUT" name="ilutOglBuildMipmaps" />
<a from="ILUT" name="ilutGLScreen" />
<a from="ILUT" name="ilutGLBindTexImage" />
<a from="ILUT" name="ilutGLScreenie" />
</link>
</entity>
<entity type="function">
<name>ilutGLBindMipmaps</name>
<return>GLuint</return>
<description>The ilutGLBindMipmaps function binds an image to an OpenGL texture and creates mipmaps, generates a texture via glGenTextures, binds the current OpenIL image to it, generates mipmaps via gluBuild2DMipmaps and returns the texture name. This function is a more general purpose version of ilutOglBindTexImage.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilActiveMipmap" />
<a from="ILUT" name="ilutGLBuildMipmaps" />
<a from="ILUT" name="ilutGLBindTexImage" />
</link>
</entity>
<entity type="function">
<name>ilutGLScreen</name>
<return>ILboolean</return>
<description>ilutGLScreen copies the current OpenGL window contents to the current bound image, effectively taking a screenshot. The new image attributes are that of the current OpenGL window's.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
<a from="ILUT" description="Could not allocate enough memory for the palette. " name="ILUT_OUT_OF_MEMORY" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutGLScreenie" />
</link>
</entity>
<entity type="function">
<name>ilutGLScreenie</name>
<return>ILboolean</return>
<description>ilutGLScreen copies the current OpenGL window contents to a temporary image, effectively taking a screenshot. The screenshot image is then saved to disk as screen0.tga - screen127.tga (the lowest name it can find). This is just a convenience function that uses ilutGLScreen.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
<a from="ILUT" description="Could not allocate enough memory for the palette. " name="ILUT_OUT_OF_MEMORY" />
<a from="ILUT" description="All possible files already exist." name="ILUT_COULD_NOT_OPEN_FILE" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutGLScreen" />
</link>
</entity>
<entity type="function">
<name>ilutGetWinClipboard</name>
<return>ILboolean</return>
<description>ilutGetWinClipboard copies the contents of the Windows clipboard to the current bound image, resizing as necessary.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutSetWinClipboard" />
</link>
</entity>
<entity type="function">
<name>ilutSetWinClipboard</name>
<return>ILboolean</return>
<description>ilutSetWinClipboard copies the current bound image to the Windows clipboard.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutGetWinClipboard" />
</link>
</entity>
<entity type="function">
<name>ilutPopAttrib</name>
<return>ILvoid</return>
<description>ilutPopAttrib pops the last pushed stack entry off the stack and copies the bits specified when pushed by ilutPushAttrib to the previous set of states.</description>
<link name="Errors" verbose="true">
<a from="ILUT" description="The stack was popped without being pushed by ilutPushAttrib." name="ILUT_STACK_UNDERFLOW" />
</link>
<link name="See Also" verbose="false">
<a from="ILUT" name="ilutPushAttrib" />
</link>
</entity>
<entity type="function">
<name>ilutGetBmpInfo</name>
<return>ILvoid</return>
<param description="BITMAPINFO struct pointer to be filled." name="Mode" type="Info" />
<description>ilutGetBmpInfo fills a BITMAPINFO struct with the current image's information. The BITMAPINFO struct is used commonly used in Windows applications.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilutGetPaddedData</name>
<return>ILvoid</return>
<description>ilutGetPaddedData gets a copy of the current image's data, but pads it to be DWORD-aligned, just how Windows likes it. Almost all Windows functions that use images expect the images to be DWORD-aligned. The caller is responsible for freeing the memory returned by ilutGetPaddedData.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilutSetHPal</name>
<return>ILboolean</return>
<param description="A Windows palette to set the palette from" name="Pal" type="HPALETTE" />
<description>ilutSetHPal sets the current iamge's palette from a logical Windows palette handle specified in Pal. If the current image is not colour-indexed, the palette is still loaded, though it will never be used.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
</link>
</entity>
<entity type="function">
<name>ilutLoadResource</name>
<return>ILboolean</return>
<param description="The application-s HINSTANCE" name="hInst" type="HINSTANCE" />
<param description="The resource identifier of the resource to be loaded" name="ID" type="ILINT" />
<param description="The type of user-defined resource (name used when creating)" name="ResourceType" type="char *" />
<param description="The type of image to be loaded. Use IL_TYPE_UNKNOWN to let OpenIL determine the type" name="Type" type="ILenum" />
<description>ilutLoadResource is a Windows-specific function that loads a resource as the current bound image. This feature allows you to have images directly in your .exe and not worry whether a particular file is present on the user's harddrive. An alternative, more portable solution is to use ilSave with IL_CHEAD as the Type parameter.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="IL" name="ilSave" />
<a from="ILUT" name="ilutGetWinClipboard" />
</link>
</entity>
<entity type="function">
<name>ilutGLLoadImage</name>
<return>GLuint</return>
<param description="Name of the image to load" name="filename" type="char *" />
<description>ilutGLLoadImage loads an image directly to an OpenGL texture, skipping the use of OpenIL image names.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoadImage" />
<a from="ILUT" name="ilutWinLoadImage" />
</link>
</entity> <!-- sure of absence of errors ?? -->
<entity type="function">
<name>ilutWinLoadImage</name>
<return>HBITMAP</return>
<param description="Name of the image to load" name="filename" type="char *" />
<param description="Device context the bitmap should reside in" name="hDC" type="HDC" />
<description>ilutWinLoadImage loads an image directly to a Win32 HBITMAP, skipping the use of OpenIL image names.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoadImage" />
<a from="ILUT" name="ilutWinSaveImage" />
<a from="ILUT" name="ilutGLLoadImage" />
</link>
</entity> <!-- sure of absence of errors ?? -->
<entity type="function">
<name>ilutSetHBitmap</name>
<return>HBITMAP</return>
<param description="Bitmap to copy to the current bound image." name="Bitmap" type="HBITMAP" />
<description>ilutSetHBitmap copies Bitmap to the current bound image in a format OpenIL can understand. The image can then be used just as if you had loaded an image via ilLoadImage. This function is the opposite of ilutConvertToHBitmap.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoadImage" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutConvertToHBitmap" />
</link>
</entity>
<entity type="function">
<name>ilutWinSaveImage</name>
<return>Ilboolean</return>
<param description="Name of the image file to save to" name="filename" type="char *" />
<param description="Win32 HBITMAP to save from" name="bitmap" type="HBITMAP" />
<description>ilutWinSaveImage saves Bitmap to FileName. This function is the complement of ilutWinLoadImage.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilSaveImage" />
<a from="ILUT" name="ilutWinLoadImage" />
</link>
</entity>
<entity type="function">
<name>ilutGetBoolean</name>
<return>ILboolean</return>
<param name="mode" type="ILenum" description="The ilutGetBoolean returns the value of a selected mode." />
<param name="Param" type="ILboolean *" description="Used to store the return values." />
<description>The ilutGetBooleanv return the value of a selected mode.</description>
<link name="Modes" verbose="true">
<a from="ILUT" name="ILUT_PALETTE_MODE" />
<a from="ILUT" name="ILUT_OPENGL_CONV" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="ILU" name="iluGetBoolean" />
<a from="ILU" name="iluGetBooleanv" />
<a from="ILU" name="iluGetInteger" />
<a from="ILU" name="iluGetIntegerv" />
<a from="ILUT" name="ilutGetBooleanv" />
<a from="ILUT" name="ilutGetInteger" />
<a from="ILUT" name="ilutGetIntegerv" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_INVALID_ENUM" />
<a from="ILUT" name="ILUT_INVALID_PARAM" />
</link>
</entity>
<entity type="function">
<name>ilutGetInteger</name>
<return>ILint</return>
<param name="mode" type="ILenum" description="The ilutGetBoolean returns the value of a selected mode." />
<param name="Param" type="ILint *" description="Used to store the return values." />
<description>The ilutGetIntegerv return the value of a selected mode.</description>
<link name="Modes" verbose="true">
<a from="ILUT" name="ILUT_VERSION_NUM" />
<a from="ILUT" name="ILUT_PALETTE_MODE" />
<a from="ILUT" name="ILUT_OPENGL_CONV" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="ILU" name="iluGetBoolean" />
<a from="ILU" name="iluGetBooleanv" />
<a from="ILU" name="iluGetInteger" />
<a from="ILU" name="iluGetIntegerv" />
<a from="ILUT" name="ilutGetBooleanv" />
<a from="ILUT" name="ilutGetInteger" />
<a from="ILUT" name="ilutGetIntegerv" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_INVALID_ENUM" />
<a from="ILUT" name="ILUT_INVALID_PARAM" />
</link>
</entity>
<entity type="function">
<name>ilutGetBooleanv</name>
<return>ILvoid</return>
<param name="mode" type="ILenum" description="The ilutGetBoolean returns the value of a selected mode." />
<description>The ilutGetBoolean return the value of a selected mode.</description>
<link name="Modes" verbose="true">
<a from="ILUT" name="ILUT_PALETTE_MODE" />
<a from="ILUT" name="ILUT_OPENGL_CONV" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="ILU" name="iluGetBoolean" />
<a from="ILU" name="iluGetBooleanv" />
<a from="ILU" name="iluGetInteger" />
<a from="ILU" name="iluGetIntegerv" />
<a from="ILUT" name="ilutGetBooleanv" />
<a from="ILUT" name="ilutGetInteger" />
<a from="ILUT" name="ilutGetIntegerv" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_INVALID_ENUM" />
<a from="ILUT" name="ILUT_INVALID_PARAM" />
</link>
</entity>
<entity type="function">
<name>ilutGetInteger</name>
<return>ILint</return>
<param name="mode" type="ILenum" description="The ilutGetBoolean returns the value of a selected mode." />
<description>The ilutGetInteger return the value of a selected mode.</description>
<link name="Modes" verbose="true">
<a from="ILUT" name="ILUT_VERSION_NUM" />
<a from="ILUT" name="ILUT_PALETTE_MODE" />
<a from="ILUT" name="ILUT_OPENGL_CONV" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilGetBoolean" />
<a from="IL" name="ilGetBooleanv" />
<a from="IL" name="ilGetInteger" />
<a from="IL" name="ilGetIntegerv" />
<a from="ILU" name="iluGetBoolean" />
<a from="ILU" name="iluGetBooleanv" />
<a from="ILU" name="iluGetInteger" />
<a from="ILU" name="iluGetIntegerv" />
<a from="ILUT" name="ilutGetBooleanv" />
<a from="ILUT" name="ilutGetInteger" />
<a from="ILUT" name="ilutGetIntegerv" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_INVALID_ENUM" />
<a from="ILUT" name="ILUT_INVALID_PARAM" />
</link>
</entity>
<entity type="function">
<name>ilutConvertToHBitmap</name>
<return>HBITMAP</return>
<param name="hDC" type="HDC" description="The ilutGetBoolean returns the value of a selected mode." />
<description>ilutConvertToHBitmap creates a Windows bitmap handle (HBITMAP) copy of the current image, for direct use in Windows.</description>
<link name="See Also" verbose="false">
<a from="ILUT" name="ilGenImages" />
<a from="ILUT" name="ilBindImage" />
<a from="ILUT" name="ilutGetHPal" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_INVALID_ENUM" />
<a from="ILUT" name="ILUT_INVALID_PARAM" />
</link>
</entity>
<entity type="function">
<name>ilutGLBuildMipmaps</name>
<return>ILboolean</return>
<description>ilutGLBuildMipmaps generates mipmaps via gluBuild2DMipmaps from an image. This function is similar to ilutGLTexImage but creates mipmaps.</description>
<link name="See Also" verbose="false">
<a from="IL" name="ilGenImages" />
<a from="IL" name="ilBindImage" />
<a from="ILUT" name="ilutGLBindMipmaps" />
</link>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
</entity>
<entity type="function">
<name>ilutD3D8MipFunc</name>
<return>ILvoid</return>
<param description="Number of miplevels to use with all D3D8 texture-generation functions. The default is 0." name="NumLevels" type="ILuint" />
<description>ilutD3D8MipFunc changes the number of miplevels specified whenever creating a Direct3D 8 texture. The default value is 0, which means that all mipmap levels are created.</description>
</entity>
<entity type="function">
<name>ilutD3D8VolTexFromFile</name>
<return>IDirect3DTexture8 *</return>
<param description="Pointer to an IDirect3DDevice8 interface, representing the device to be associated with the texture." name="Device" type="IDirect3DDevice8 *" />
<param description="File to create the texture from." name="FileName" type="char *" />
<param description="Address of a pointer to an IDirect3DVolumeTexture8 interface, representing the created texture object." name="Texture" type="IDirect3DVolumeTexture8 **" />
<description>ilutD3D8VolTexFromFile loads the file named by FileName and converts it to a Direct3D 8 volume texture (IDirect3DVolumeTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFile but for a volume texture.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
<a from="ILUT" name="ILUT_COULD_NOT_OPEN_FILE" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoad" />
</link>
</entity>
<entity type="function">
<name>ilutD3D8VolumeTexture</name>
<return>IDirect3DTexture8 *</return>
<param description="Pointer to an IDirect3DDevice8 interface, representing the device to be associated with the texture." name="Device" type="IDirect3DDevice8 *" />
<description>The ilutD3D8VolumeTexture function creates a Direct3D 8 texture (IDirect3DVolumeTexture8) from the current bound image.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoad" />
</link>
</entity>
<entity type="function">
<name>ilutD3D8TexFromFileInMemory</name>
<return>ILboolean</return>
<param description="Pointer to an IDirect3DDevice8 interface, representing the device to be associated with the texture." name="Device" type="IDirect3DDevice8 *" />
<param name="Lump" type="ILvoid *" description="Location of memory file." />
<param name="Size" type="ILuint" description="Size of Lump in bytes" />
<param name="Texture" type="IDirect3DTexture8 **" description="Address of a pointer to an IDirect3DTexture8 interface, representing the created texture object." />
<description>ilutD3D8TexFromFileInMemory loads the file present in Lump and converts it to a Direct3D 8 texture (IDirect3DTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFileInMemory.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoadL" />
</link>
</entity>
<entity type="function">
<name>ilutD3D8VolTexFromFileInMemory</name>
<return>ILboolean</return>
<param description="Pointer to an IDirect3DDevice8 interface, representing the device to be associated with the texture." name="Device" type="IDirect3DDevice8 *" />
<param name="Lump" type="ILvoid *" description="Location of memory file." />
<param name="Size" type="ILuint" description="Size of Lump in bytes" />
<param name="Texture" type="IDirect3DTexture8 **" description="Address of a pointer to an IDirect3DTexture8 interface, representing the created texture object." />
<description>ilutD3D8VolTexFromFileInMemory loads the file present in Lump and converts it to a Direct3D 8 volume texture (IDirect3DVolumeTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFileInMemory but for a volume texture.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilLoadL" />
</link>
</entity>
<entity type="function">
<name>ilutD3D8TexFromFileHandle</name>
<return>ILboolean</return>
<param description="Pointer to an IDirect3DDevice8 interface, representing the device to be associated with the texture." name="Device" type="IDirect3DDevice8 *" />
<param name="File" type="ILHANDLE" description="File handle containing the image file" />
<param name="Texture" type="IDirect3DTexture8 **" description="Address of a pointer to an IDirect3DTexture8 interface, representing the created texture object." />
<description>ilutD3D8TexFromFileInMemory loads the file present in Lump and converts it to a Direct3D 8 texture (IDirect3DTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFile but with a file handle.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
</entity>
<entity type="function">
<name>ilutD3D8VolTexFromFileHandle</name>
<return>ILboolean</return>
<param description="Pointer to an IDirect3DDevice8 interface, representing the device to be associated with the texture." name="Device" type="IDirect3DDevice8 *" />
<param name="File" type="ILHANDLE" description="File handle containing the image file" />
<param name="Texture" type="IDirect3DTexture8 **" description="Address of a pointer to an IDirect3DTexture8 interface, representing the created texture object." />
<description>ilutD3D8VolTexFromFileHandle loads the file present in File and converts it to a Direct3D 8 volume texture (IDirect3DVolumeTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFile but with a file handle and a volume texture.</description>
<link name="Errors" verbose="true">
<a from="ILUT" name="ILUT_ILLEGAL_OPERATION" />
</link>
</entity>
<entity type="value">
<name>ILUT_PALETTE_MODE</name>
<description>An ILUT mode not used right now</description>
<link name="Usage" verbose="false">
<a from="ILUT" name="ilutIsDisabled" />
<a from="ILUT" name="ilutIsEnabled" />
<a from="ILUT" name="ilutDisable" />
<a from="ILUT" name="ilutIsEnable" />
</link>
</entity>
<entity type="value">
<name>ILUT_OPENGL_CONV</name>
<description>An ILUT mode used to track if OpenIL is allowed to use GL_RGB8 and GL_RGBA8 instead of GL_RGB8 or GL_RGBA8 (useful with nVidia cards)</description>
<link name="Usage" verbose="false">
<a from="ILUT" name="ilutIsDisabled" />
<a from="ILUT" name="ilutIsEnabled" />
<a from="ILUT" name="ilutDisable" />
<a from="ILUT" name="ilutIsEnable" />
</link>
</entity>
<entity type="value">
<name>ILUT_VERSION_NUM</name>
<description>Returns the version number of the shared library. This can be checked against the ILUT_VERSION #define</description>
</entity>
<entity type="value">
<name>ILUT_PALETTE_MODE</name>
<description>Whether ilut uses palettes or converts the image to truecolour before sending it to the renderer.</description>
</entity>
<entity type="value">
<name>ILUT_OPENGL_CONV</name>
<description>Whether to use GL_RGB8 or GL_RGB, etc. when passing data to OpenGL only.</description>
</entity>
<entity type="value">
<name>ILUT_INVALID_ENUM</name>
<description>An invalid parameter was passed to a function, probably a wrong constant or an out of range value.</description>
</entity>
<entity type="value">
<name>ILUT_ILLEGAL_OPERATION</name>
<description>The operation attempted is not allowable in the current state. The function returns with no ill side effects.</description>
</entity>
<entity type="value">
<name>ILUT_INVALID_PARAM</name>
<description>An invalid parameter was passed to a function, such as a NULL pointer.</description>
</entity>
<entity type="value">
<name>ILUT_INVALID_ENUM</name>
<description>An unacceptable enumerated value was passed to a function.</description>
</entity>
<entity type="value">
<name>ILUT_OUT_OF_MEMORY</name>
<description>Could not allocate enough memory in an operation.</description>
</entity>
<entity type="value">
<name>ILUT_INVALID_VALUE</name>
<description>An invalid value was passed to a function or was in a file.</description>
</entity>
<entity type="value">
<name>ILUT_NOT_SUPPORTED</name>
<description>A type is valid but not supported in the current build.</description>
</entity>
<entity type="value">
<name>ILUT_COULD_NOT_OPEN_FILE</name>
<description>Could not open the file specified. The file may already be open by another app or may not exist.</description>
</entity>
<entity type="value">
<name>ILUT_STACK_UNDERFLOW</name>
<description>One of the internal stacks was empty, and the user tried to empty the already empty stack.</description>
</entity>
<entity type="value">
<name>ILUT_STACK_OVERFLOW</name>
<description>One of the internal stacks was already filled, and the user tried to add on to the full stack.</description>
</entity>
</set>
<set name="Constants">
<entity type="value">
<name>Data Formats</name>
<description>This is a list of all the constants that indicates a particular image format</description>
<link name="Formats" verbose="false">
<a name="IL_COLOUR_INDEX" />
<a name="IL_RGB" />
<a name="IL_RGBA" />
<a name="IL_BGR" />
<a name="IL_BGRA" />
<a name="IL_LUMINANCE" />
<a name="IL_LUMINANCE_ALPHA" />
</link>
</entity>
<entity type="value">
<name>Data Types</name>
<description>This is a list of all the constants that indicates a particular image data type</description>
<link name="Formats" verbose="false">
<a name="IL_BYTE" />
<a name="IL_UNSIGNED_BYTE" />
<a name="IL_SHORT" />
<a name="IL_UNSIGNED_SHORT" />
<a name="IL_INT" />
<a name="IL_UNSIGNED INT" />
<a name="IL_FLOAT" />
<a name="IL_DOUBLE" />
</link>
</entity>
<entity type="value">
<name>Palette Types</name>
<description>This is a list of all the constants that indicates a particular palette color data type</description>
<link name="Formats" verbose="false">
<a name="IL_PAL_RGB24" />
<a name="IL_PAL_RGB32" />
<a name="IL_PAL_RGBA32" />
<a name="IL_PAL_BGR24" />
<a name="IL_PAL_BGR32" />
<a name="IL_PAL_BGRA32" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilConvertPal" />
</link>
</entity>
<entity type="value">
<name>Hint Targets</name>
<description>An enum indicating what behaviour of the library is to be controlled.</description>
<link name="Targets" verbose="true">
<a description="Controls the memory used vs. speed tradeoff." name="IL_MEM_SPEED_HINT" />
<a description="Controls whether compression is used when saving images." name="IL_COMPRESSION_HINT" />
</link>
<link name="See Also" verbose="false">
<a from="IL" name="ilHint" />
</link>
</entity>
<entity type="value">
<name>Hint Modes</name>
<description>The desired behaviour of some specific situation</description>
<link name="Modes" verbose="true">
<a description="Makes the target use a faster but more memory-intensive algorithm." name="IL_FASTEST" />
<a description="Makes the target use less memory but a potentially slower algorithm." name="IL_LESS_MEM" />
<a description="Specifies that OpenIL should use compression when saving, if possible." name="IL_USE_COMPRESSION" />
<a description="Specifies that OpenIL should never use compression when saving." name="IL_NO_COMPRESSION" />
<a description="The client does not have a preference." name="IL_DONT_CARE" />
</link>
</entity>
<entity type="value">
<name>Image Formats</name>
<description>A List of all the image formats</description>
<link name="Modes" verbose="true">
<a name="IL_TYPE_UNKNOWN" description="Tells OpenIL to try to determine the type of image present in FileName, File or Lump." />
<a name="IL_BMP" description="Microsoft bitmap ." />
<a name="IL_CHEAD" description="C Header." />
<a name="IL_CUT" description="Dr. Halo .cut image." />
<a name="IL_DCX" description=".dcx image." />
<a name="IL_DDS" description="DirectDraw Surface image." />
<a name="IL_DOOM" description="Doom texture." />
<a name="IL_DOOM_FLAT" description="Doom flat (floor)." />
<a name="IL_GIF" description="Graphics Interchange Format file." />
<a name="IL_HDR" description="RADIANCE High Dynamic Range Image." />
<a name="IL_ICO" description="Microsoft icon (.ico)." />
<a name="IL_JPG" description="Jpeg." />
<a name="IL_LIF" description="Homeworld image." />
<a name="IL_MDL" description="Half-Life model file (.mdl)." />
<a name="IL_MNG" description="Load a Multiple Network Graphics (.mng)." />
<a name="IL_PCD" description="Kodak PhotoCD image." />
<a name="IL_PCX" description=" .pcx Image." />
<a name="IL_PIC" description="Softimage Pic image." />
<a name="IL_PIX" description="Alias | Wavefront .pix file." />
<a name="IL_PNG" description="Portable Network Graphics (.png) image." />
<a name="IL_PNM" description="Portable AnyMap (.pbm, .pgm or .ppm)." />
<a name="IL_PSD" description="PhotoShop (.psd) file." />
<a name="IL_PSP" description="Paint Shop Pro file." />
<a name="IL_PXR" description="Pxrar (.pxr) file." />
<a name="IL_SGI" description="SGI (.bw, .rgb, .rgba or .sgi)." />
<a name="IL_TGA" description="TrueVision Targa." />
<a name="IL_TIF" description="TIFF (.tif or .tiff) image." />
<a name="IL_RAW" description="Raw data with a 13-byte header." />
<a name="IL_WAL" description="Quake .wal texture." />
<a name="IL_XPM" description=".xpm file." />
<a name="IL_JASC_PAL" description="Load the file into the current image's palette as a Paint Shop Pro (Jasc) palette." />
</link>
</entity>
</set>
</doc>
|