/usr/lib/python2.7/dist-packages/pyglet/image/__init__.py is in python-pyglet 1.1.4.dfsg-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 | # ----------------------------------------------------------------------------
# pyglet
# Copyright (c) 2006-2008 Alex Holkner
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# * Neither the name of pyglet nor the names of its
# contributors may be used to endorse or promote products
# derived from this software without specific prior written
# permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# ----------------------------------------------------------------------------
'''Image load, capture and high-level texture functions.
Only basic functionality is described here; for full reference see the
accompanying documentation.
To load an image::
from pyglet import image
pic = image.load('picture.png')
The supported image file types include PNG, BMP, GIF, JPG, and many more,
somewhat depending on the operating system. To load an image from a file-like
object instead of a filename::
pic = image.load('hint.jpg', file=fileobj)
The hint helps the module locate an appropriate decoder to use based on the
file extension. It is optional.
Once loaded, images can be used directly by most other modules of pyglet. All
images have a width and height you can access::
width, height = pic.width, pic.height
You can extract a region of an image (this keeps the original image intact;
the memory is shared efficiently)::
subimage = pic.get_region(x, y, width, height)
Remember that y-coordinates are always increasing upwards.
Drawing images
--------------
To draw an image at some point on the screen::
pic.blit(x, y, z)
This assumes an appropriate view transform and projection have been applied.
Some images have an intrinsic "anchor point": this is the point which will be
aligned to the ``x`` and ``y`` coordinates when the image is drawn. By
default the anchor point is the lower-left corner of the image. You can use
the anchor point to center an image at a given point, for example::
pic.anchor_x = pic.width // 2
pic.anchor_y = pic.height // 2
pic.blit(x, y, z)
Texture access
--------------
If you are using OpenGL directly, you can access the image as a texture::
texture = pic.get_texture()
(This is the most efficient way to obtain a texture; some images are
immediately loaded as textures, whereas others go through an intermediate
form). To use a texture with pyglet.gl::
from pyglet.gl import *
glEnable(texture.target) # typically target is GL_TEXTURE_2D
glBindTexture(texture.target, texture.id)
# ... draw with the texture
Pixel access
------------
To access raw pixel data of an image::
rawimage = pic.get_image_data()
(If the image has just been loaded this will be a very quick operation;
however if the image is a texture a relatively expensive readback operation
will occur). The pixels can be accessed as a string::
format = 'RGBA'
pitch = rawimage.width * len(format)
pixels = rawimage.get_data(format, pitch)
"format" strings consist of characters that give the byte order of each color
component. For example, if rawimage.format is 'RGBA', there are four color
components: red, green, blue and alpha, in that order. Other common format
strings are 'RGB', 'LA' (luminance, alpha) and 'I' (intensity).
The "pitch" of an image is the number of bytes in a row (this may validly be
more than the number required to make up the width of the image, it is common
to see this for word alignment). If "pitch" is negative the rows of the image
are ordered from top to bottom, otherwise they are ordered from bottom to top.
Retrieving data with the format and pitch given in `ImageData.format` and
`ImageData.pitch` avoids the need for data conversion (assuming you can make
use of the data in this arbitrary format).
'''
__docformat__ = 'restructuredtext'
__version__ = '$Id: __init__.py 2541 2009-12-31 04:31:11Z benjamin.coder.smith@gmail.com $'
import sys
import re
import warnings
import weakref
from ctypes import *
from math import ceil
from StringIO import StringIO
from pyglet import gl
from pyglet.gl import *
from pyglet.gl import gl_info
from pyglet import graphics
from pyglet.window import *
from pyglet.image import atlas
class ImageException(Exception):
pass
def load(filename, file=None, decoder=None):
'''Load an image from a file.
:note: You can make no assumptions about the return type; usually it will
be ImageData or CompressedImageData, but decoders are free to return
any subclass of AbstractImage.
:Parameters:
`filename` : str
Used to guess the image format, and to load the file if `file` is
unspecified.
`file` : file-like object or None
Source of image data in any supported format.
`decoder` : ImageDecoder or None
If unspecified, all decoders that are registered for the filename
extension are tried. If none succeed, the exception from the
first decoder is raised.
:rtype: AbstractImage
'''
if not file:
file = open(filename, 'rb')
if not hasattr(file, 'seek'):
file = StringIO(file.read())
if decoder:
return decoder.decode(file, filename)
else:
first_exception = None
for decoder in codecs.get_decoders(filename):
try:
image = decoder.decode(file, filename)
return image
except codecs.ImageDecodeException, e:
first_exception = first_exception or e
file.seek(0)
if not first_exception:
raise codecs.ImageDecodeException('No image decoders are available')
raise first_exception
def create(width, height, pattern=None):
'''Create an image optionally filled with the given pattern.
:note: You can make no assumptions about the return type; usually it will
be ImageData or CompressedImageData, but patterns are free to return
any subclass of AbstractImage.
:Parameters:
`width` : int
Width of image to create
`height` : int
Height of image to create
`pattern` : ImagePattern or None
Pattern to fill image with. If unspecified, the image will
initially be transparent.
:rtype: AbstractImage
'''
if not pattern:
pattern = SolidColorImagePattern()
return pattern.create_image(width, height)
class ImagePattern(object):
'''Abstract image creation class.'''
def create_image(self, width, height):
'''Create an image of the given size.
:Parameters:
`width` : int
Width of image to create
`height` : int
Height of image to create
:rtype: AbstractImage
'''
raise NotImplementedError('abstract')
class SolidColorImagePattern(ImagePattern):
'''Creates an image filled with a solid color.'''
def __init__(self, color=(0, 0, 0, 0)):
'''Create a solid image pattern with the given color.
:Parameters:
`color` : (int, int, int, int)
4-tuple of ints in range [0,255] giving RGBA components of
color to fill with.
'''
self.color = '%c%c%c%c' % color
def create_image(self, width, height):
data = self.color * width * height
return ImageData(width, height, 'RGBA', data)
class CheckerImagePattern(ImagePattern):
'''Create an image with a tileable checker image.
'''
def __init__(self, color1=(150,150,150,255), color2=(200,200,200,255)):
'''Initialise with the given colors.
:Parameters:
`color1` : (int, int, int, int)
4-tuple of ints in range [0,255] giving RGBA components of
color to fill with. This color appears in the top-left and
bottom-right corners of the image.
`color2` : (int, int, int, int)
4-tuple of ints in range [0,255] giving RGBA components of
color to fill with. This color appears in the top-right and
bottom-left corners of the image.
'''
self.color1 = '%c%c%c%c' % color1
self.color2 = '%c%c%c%c' % color2
def create_image(self, width, height):
hw = width/2
hh = height/2
row1 = self.color1 * hw + self.color2 * hw
row2 = self.color2 * hw + self.color1 * hw
data = row1 * hh + row2 * hh
return ImageData(width, height, 'RGBA', data)
class AbstractImage(object):
'''Abstract class representing an image.
:Ivariables:
`width` : int
Width of image
`height` : int
Height of image
`anchor_x` : int
X coordinate of anchor, relative to left edge of image data
`anchor_y` : int
Y coordinate of anchor, relative to bottom edge of image data
'''
anchor_x = 0
anchor_y = 0
_is_rectangle = False
def __init__(self, width, height):
self.width = width
self.height = height
def __repr__(self):
return '<%s %dx%d>' % (self.__class__.__name__, self.width, self.height)
def get_image_data(self):
'''Get an ImageData view of this image.
Changes to the returned instance may or may not be reflected in this
image.
:rtype: `ImageData`
:since: pyglet 1.1
'''
raise ImageException('Cannot retrieve image data for %r' % self)
image_data = property(lambda self: self.get_image_data(),
doc='''An `ImageData` view of this image.
Changes to the returned instance may or may not be reflected in this
image. Read-only.
:deprecated: Use `get_image_data`.
:type: `ImageData`
''')
def get_texture(self, rectangle=False, force_rectangle=False):
'''A `Texture` view of this image.
By default, textures are created with dimensions that are powers of
two. Smaller images will return a `TextureRegion` that covers just
the image portion of the larger texture. This restriction is required
on older video cards, and for compressed textures, or where texture
repeat modes will be used, or where mipmapping is desired.
If the `rectangle` parameter is ``True``, this restriction is ignored
and a texture the size of the image may be created if the driver
supports the ``GL_ARB_texture_rectangle`` or
``GL_NV_texture_rectangle`` extensions. If the extensions are not
present, the image already is a texture, or the image has power 2
dimensions, the `rectangle` parameter is ignored.
Examine `Texture.target` to determine if the returned texture is a
rectangle (``GL_TEXTURE_RECTANGLE_ARB`` or
``GL_TEXTURE_RECTANGLE_NV``) or not (``GL_TEXTURE_2D``).
If the `force_rectangle` parameter is ``True``, one of these
extensions must be present, and the returned texture always
has target ``GL_TEXTURE_RECTANGLE_ARB`` or ``GL_TEXTURE_RECTANGLE_NV``.
Changes to the returned instance may or may not be reflected in this
image.
:Parameters:
`rectangle` : bool
True if the texture can be created as a rectangle.
`force_rectangle` : bool
True if the texture must be created as a rectangle.
**Since:** pyglet 1.1.4.
:rtype: `Texture`
:since: pyglet 1.1
'''
raise ImageException('Cannot retrieve texture for %r' % self)
texture = property(lambda self: self.get_texture(),
doc='''Get a `Texture` view of this image.
Changes to the returned instance may or may not be reflected in this
image.
:deprecated: Use `get_texture`.
:type: `Texture`
''')
def get_mipmapped_texture(self):
'''Retrieve a `Texture` instance with all mipmap levels filled in.
Requires that image dimensions be powers of 2.
:rtype: `Texture`
:since: pyglet 1.1
'''
raise ImageException('Cannot retrieve mipmapped texture for %r' % self)
mipmapped_texture = property(lambda self: self.get_mipmapped_texture(),
doc='''A Texture view of this image.
The returned Texture will have mipmaps filled in for all levels.
Requires that image dimensions be powers of 2. Read-only.
:deprecated: Use `get_mipmapped_texture`.
:type: `Texture`
''')
def get_region(self, x, y, width, height):
'''Retrieve a rectangular region of this image.
:Parameters:
`x` : int
Left edge of region.
`y` : int
Bottom edge of region.
`width` : int
Width of region.
`height` : int
Height of region.
:rtype: AbstractImage
'''
raise ImageException('Cannot get region for %r' % self)
def save(self, filename=None, file=None, encoder=None):
'''Save this image to a file.
:Parameters:
`filename` : str
Used to set the image file format, and to open the output file
if `file` is unspecified.
`file` : file-like object or None
File to write image data to.
`encoder` : ImageEncoder or None
If unspecified, all encoders matching the filename extension
are tried. If all fail, the exception from the first one
attempted is raised.
'''
if not file:
file = open(filename, 'wb')
if encoder:
encoder.encode(self, file, filename)
else:
first_exception = None
for encoder in codecs.get_encoders(filename):
try:
encoder.encode(self, file, filename)
return
except codecs.ImageDecodeException, e:
first_exception = first_exception or e
file.seek(0)
if not first_exception:
raise codecs.ImageEncodeException(
'No image encoders are available')
raise first_exception
def blit(self, x, y, z=0):
'''Draw this image to the active framebuffers.
The image will be drawn with the lower-left corner at
(``x -`` `anchor_x`, ``y -`` `anchor_y`, ``z``).
'''
raise ImageException('Cannot blit %r.' % self)
def blit_into(self, source, x, y, z):
'''Draw `source` on this image.
`source` will be copied into this image such that its anchor point
is aligned with the `x` and `y` parameters. If this image is a 3D
texture, the `z` coordinate gives the image slice to copy into.
Note that if `source` is larger than this image (or the positioning
would cause the copy to go out of bounds) then you must pass a
region of `source` to this method, typically using get_region().
'''
raise ImageException('Cannot blit images onto %r.' % self)
def blit_to_texture(self, target, level, x, y, z=0):
'''Draw this image on the currently bound texture at `target`.
This image is copied into the texture such that this image's anchor
point is aligned with the given `x` and `y` coordinates of the
destination texture. If the currently bound texture is a 3D texture,
the `z` coordinate gives the image slice to blit into.
'''
raise ImageException('Cannot blit %r to a texture.' % self)
class AbstractImageSequence(object):
'''Abstract sequence of images.
The sequence is useful for storing image animations or slices of a volume.
For efficient access, use the `texture_sequence` member. The class
also implements the sequence interface (`__len__`, `__getitem__`,
`__setitem__`).
'''
def get_texture_sequence(self):
'''Get a TextureSequence.
:rtype: `TextureSequence`
:since: pyglet 1.1
'''
raise NotImplementedError('abstract')
texture_sequence = property(lambda self: self.get_texture_sequence(),
doc='''Access this image sequence as a texture sequence.
:deprecated: Use `get_texture_sequence`
:type: `TextureSequence`
''')
def get_animation(self, period, loop=True):
'''Create an animation over this image sequence for the given constant
framerate.
:Parameters
`period` : float
Number of seconds to display each frame.
`loop` : bool
If True, the animation will loop continuously.
:rtype: `Animation`
:since: pyglet 1.1
'''
return Animation.from_image_sequence(self, period, loop)
def __getitem__(self, slice):
'''Retrieve a (list of) image.
:rtype: AbstractImage
'''
raise NotImplementedError('abstract')
def __setitem__(self, slice, image):
'''Replace one or more images in the sequence.
:Parameters:
`image` : `AbstractImage`
The replacement image. The actual instance may not be used,
depending on this implementation.
'''
raise NotImplementedError('abstract')
def __len__(self):
raise NotImplementedError('abstract')
def __iter__(self):
'''Iterate over the images in sequence.
:rtype: Iterator
:since: pyglet 1.1
'''
raise NotImplementedError('abstract')
class TextureSequence(AbstractImageSequence):
'''Interface for a sequence of textures.
Typical implementations store multiple `TextureRegion` s within one
`Texture` so as to minimise state changes.
'''
def get_texture_sequence(self):
return self
class UniformTextureSequence(TextureSequence):
'''Interface for a sequence of textures, each with the same dimensions.
:Ivariables:
`item_width` : int
Width of each texture in the sequence.
`item_height` : int
Height of each texture in the sequence.
'''
def _get_item_width(self):
raise NotImplementedError('abstract')
item_width = property(_get_item_width)
def _get_item_height(self):
raise NotImplementedError('abstract')
item_height = property(_get_item_height)
class ImageData(AbstractImage):
'''An image represented as a string of unsigned bytes.
:Ivariables:
`data` : str
Pixel data, encoded according to `format` and `pitch`.
`format` : str
The format string to use when reading or writing `data`.
`pitch` : int
Number of bytes per row. Negative values indicate a top-to-bottom
arrangement.
Setting the `format` and `pitch` instance variables and reading `data` is
deprecated; use `get_data` and `set_data` in new applications. (Reading
`format` and `pitch` to obtain the current encoding is not deprecated).
'''
_swap1_pattern = re.compile('(.)', re.DOTALL)
_swap2_pattern = re.compile('(.)(.)', re.DOTALL)
_swap3_pattern = re.compile('(.)(.)(.)', re.DOTALL)
_swap4_pattern = re.compile('(.)(.)(.)(.)', re.DOTALL)
_current_texture = None
_current_mipmap_texture = None
def __init__(self, width, height, format, data, pitch=None):
'''Initialise image data.
:Parameters:
`width` : int
Width of image data
`height` : int
Height of image data
`format` : str
A valid format string, such as 'RGB', 'RGBA', 'ARGB', etc.
`data` : sequence
String or array/list of bytes giving the decoded data.
`pitch` : int or None
If specified, the number of bytes per row. Negative values
indicate a top-to-bottom arrangement. Defaults to
``width * len(format)``.
'''
super(ImageData, self).__init__(width, height)
self._current_format = self._desired_format = format.upper()
self._current_data = data
if not pitch:
pitch = width * len(format)
self._current_pitch = self.pitch = pitch
self.mipmap_images = []
def __getstate__(self):
return {
'width': self.width,
'height': self.height,
'_current_data':
self.get_data(self._current_format, self._current_pitch),
'_current_format': self._current_format,
'_desired_format': self._desired_format,
'_current_pitch': self._current_pitch,
'pitch': self.pitch,
'mipmap_images': self.mipmap_images
}
def get_image_data(self):
return self
def _set_format(self, format):
self._desired_format = format.upper()
self._current_texture = None
format = property(lambda self: self._desired_format, _set_format,
doc='''Format string of the data. Read-write.
:type: str
''')
def _get_data(self):
if self._current_pitch != self.pitch or \
self._current_format != self.format:
self._current_data = self._convert(self.format, self.pitch)
self._current_format = self.format
self._current_pitch = self.pitch
self._ensure_string_data()
return self._current_data
def _set_data(self, data):
self._current_data = data
self._current_format = self.format
self._current_pitch = self.pitch
self._current_texture = None
self._current_mipmapped_texture = None
data = property(_get_data, _set_data,
doc='''The byte data of the image. Read-write.
:deprecated: Use `get_data` and `set_data`.
:type: sequence of bytes, or str
''')
def get_data(self, format, pitch):
'''Get the byte data of the image.
:Parameters:
`format` : str
Format string of the return data.
`pitch` : int
Number of bytes per row. Negative values indicate a
top-to-bottom arrangement.
:since: pyglet 1.1
:rtype: sequence of bytes, or str
'''
if format == self._current_format and pitch == self._current_pitch:
return self._current_data
return self._convert(format, pitch)
def set_data(self, format, pitch, data):
'''Set the byte data of the image.
:Parameters:
`format` : str
Format string of the return data.
`pitch` : int
Number of bytes per row. Negative values indicate a
top-to-bottom arrangement.
`data` : str or sequence of bytes
Image data.
:since: pyglet 1.1
'''
self._current_format = format
self._current_pitch = pitch
self._current_data = data
self._current_texture = None
self._current_mipmapped_texture = None
def set_mipmap_image(self, level, image):
'''Set a mipmap image for a particular level.
The mipmap image will be applied to textures obtained via
`get_mipmapped_texture`.
:Parameters:
`level` : int
Mipmap level to set image at, must be >= 1.
`image` : AbstractImage
Image to set. Must have correct dimensions for that mipmap
level (i.e., width >> level, height >> level)
'''
if level == 0:
raise ImageException(
'Cannot set mipmap image at level 0 (it is this image)')
if not _is_pow2(self.width) or not _is_pow2(self.height):
raise ImageException(
'Image dimensions must be powers of 2 to use mipmaps.')
# Check dimensions of mipmap
width, height = self.width, self.height
for i in range(level):
width >>= 1
height >>= 1
if width != image.width or height != image.height:
raise ImageException(
'Mipmap image has wrong dimensions for level %d' % level)
# Extend mipmap_images list to required level
self.mipmap_images += [None] * (level - len(self.mipmap_images))
self.mipmap_images[level - 1] = image
def create_texture(self, cls, rectangle=False, force_rectangle=False):
'''Create a texture containing this image.
If the image's dimensions are not powers of 2, a TextureRegion of
a larger Texture will be returned that matches the dimensions of this
image.
:Parameters:
`cls` : class (subclass of Texture)
Class to construct.
`rectangle` : bool
``True`` if a rectangle can be created; see
`AbstractImage.get_texture`.
**Since:** pyglet 1.1
`force_rectangle` : bool
``True`` if a rectangle must be created; see
`AbstractImage.get_texture`.
**Since:** pyglet 1.1.4
:rtype: cls or cls.region_class
'''
internalformat = self._get_internalformat(self.format)
texture = cls.create(self.width, self.height, internalformat,
rectangle, force_rectangle)
if self.anchor_x or self.anchor_y:
texture.anchor_x = self.anchor_x
texture.anchor_y = self.anchor_y
self.blit_to_texture(texture.target, texture.level,
self.anchor_x, self.anchor_y, 0, None)
return texture
def get_texture(self, rectangle=False, force_rectangle=False):
if (not self._current_texture or
(not self._current_texture._is_rectangle and force_rectangle)):
self._current_texture = self.create_texture(Texture,
rectangle,
force_rectangle)
return self._current_texture
def get_mipmapped_texture(self):
'''Return a Texture with mipmaps.
If `set_mipmap_image` has been called with at least one image, the set
of images defined will be used. Otherwise, mipmaps will be
automatically generated.
The texture dimensions must be powers of 2 to use mipmaps.
:rtype: `Texture`
:since: pyglet 1.1
'''
if self._current_mipmap_texture:
return self._current_mipmap_texture
if not _is_pow2(self.width) or not _is_pow2(self.height):
raise ImageException(
'Image dimensions must be powers of 2 to use mipmaps.')
texture = Texture.create_for_size(
GL_TEXTURE_2D, self.width, self.height)
if self.anchor_x or self.anchor_y:
texture.anchor_x = self.anchor_x
texture.anchor_y = self.anchor_y
internalformat = self._get_internalformat(self.format)
glBindTexture(texture.target, texture.id)
glTexParameteri(texture.target, GL_TEXTURE_MIN_FILTER,
GL_LINEAR_MIPMAP_LINEAR)
if self.mipmap_images:
self.blit_to_texture(texture.target, texture.level,
self.anchor_x, self.anchor_y, 0, internalformat)
level = 0
for image in self.mipmap_images:
level += 1
if image:
image.blit_to_texture(texture.target, level,
self.anchor_x, self.anchor_y, 0, internalformat)
# TODO: should set base and max mipmap level if some mipmaps
# are missing.
elif gl_info.have_version(1, 4):
glTexParameteri(texture.target, GL_GENERATE_MIPMAP, GL_TRUE)
self.blit_to_texture(texture.target, texture.level,
self.anchor_x, self.anchor_y, 0, internalformat)
else:
raise NotImplementedError('TODO: gluBuild2DMipmaps')
self._current_mipmap_texture = texture
return texture
def get_region(self, x, y, width, height):
'''Retrieve a rectangular region of this image data.
:Parameters:
`x` : int
Left edge of region.
`y` : int
Bottom edge of region.
`width` : int
Width of region.
`height` : int
Height of region.
:rtype: ImageDataRegion
'''
return ImageDataRegion(x, y, width, height, self)
def blit(self, x, y, z=0, width=None, height=None):
self.get_texture().blit(x, y, z, width, height)
def blit_to_texture(self, target, level, x, y, z, internalformat=None):
'''Draw this image to to the currently bound texture at `target`.
This image's anchor point will be aligned to the given `x` and `y`
coordinates. If the currently bound texture is a 3D texture, the `z`
parameter gives the image slice to blit into.
If `internalformat` is specified, glTexImage is used to initialise
the texture; otherwise, glTexSubImage is used to update a region.
'''
x -= self.anchor_x
y -= self.anchor_y
data_format = self.format
data_pitch = abs(self._current_pitch)
# Determine pixel format from format string
matrix = None
format, type = self._get_gl_format_and_type(data_format)
if format is None:
if (len(data_format) in (3, 4) and
gl_info.have_extension('GL_ARB_imaging')):
# Construct a color matrix to convert to GL_RGBA
def component_column(component):
try:
pos = 'RGBA'.index(component)
return [0] * pos + [1] + [0] * (3 - pos)
except ValueError:
return [0, 0, 0, 0]
# pad to avoid index exceptions
lookup_format = data_format + 'XXX'
matrix = (component_column(lookup_format[0]) +
component_column(lookup_format[1]) +
component_column(lookup_format[2]) +
component_column(lookup_format[3]))
format = {
3: GL_RGB,
4: GL_RGBA}.get(len(data_format))
type = GL_UNSIGNED_BYTE
glMatrixMode(GL_COLOR)
glPushMatrix()
glLoadMatrixf((GLfloat * 16)(*matrix))
else:
# Need to convert data to a standard form
data_format = {
1: 'L',
2: 'LA',
3: 'RGB',
4: 'RGBA'}.get(len(data_format))
format, type = self._get_gl_format_and_type(data_format)
# Workaround: don't use GL_UNPACK_ROW_LENGTH
if gl.current_context._workaround_unpack_row_length:
data_pitch = self.width * len(data_format)
# Get data in required format (hopefully will be the same format it's
# already in, unless that's an obscure format, upside-down or the
# driver is old).
data = self._convert(data_format, data_pitch)
if data_pitch & 0x1:
alignment = 1
elif data_pitch & 0x2:
alignment = 2
else:
alignment = 4
row_length = data_pitch / len(data_format)
glPushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT)
glPixelStorei(GL_UNPACK_ALIGNMENT, alignment)
glPixelStorei(GL_UNPACK_ROW_LENGTH, row_length)
self._apply_region_unpack()
if target == GL_TEXTURE_3D:
assert not internalformat
glTexSubImage3D(target, level,
x, y, z,
self.width, self.height, 1,
format, type,
data)
elif internalformat:
glTexImage2D(target, level,
internalformat,
self.width, self.height,
0,
format, type,
data)
else:
glTexSubImage2D(target, level,
x, y,
self.width, self.height,
format, type,
data)
glPopClientAttrib()
if matrix:
glPopMatrix()
glMatrixMode(GL_MODELVIEW)
# Flush image upload before data get GC'd.
glFlush()
def _apply_region_unpack(self):
pass
def _convert(self, format, pitch):
'''Return data in the desired format; does not alter this instance's
current format or pitch.
'''
if format == self._current_format and pitch == self._current_pitch:
return self._current_data
self._ensure_string_data()
data = self._current_data
current_pitch = self._current_pitch
current_format = self._current_format
sign_pitch = current_pitch / abs(current_pitch)
if format != self._current_format:
# Create replacement string, e.g. r'\4\1\2\3' to convert RGBA to
# ARGB
repl = ''
for c in format:
try:
idx = current_format.index(c) + 1
except ValueError:
idx = 1
repl += r'\%d' % idx
if len(current_format) == 1:
swap_pattern = self._swap1_pattern
elif len(current_format) == 2:
swap_pattern = self._swap2_pattern
elif len(current_format) == 3:
swap_pattern = self._swap3_pattern
elif len(current_format) == 4:
swap_pattern = self._swap4_pattern
else:
raise ImageException(
'Current image format is wider than 32 bits.')
packed_pitch = self.width * len(current_format)
if abs(self._current_pitch) != packed_pitch:
# Pitch is wider than pixel data, need to go row-by-row.
rows = re.findall(
'.' * abs(self._current_pitch), data, re.DOTALL)
rows = [swap_pattern.sub(repl, r[:packed_pitch]) for r in rows]
data = ''.join(rows)
else:
# Rows are tightly packed, apply regex over whole image.
data = swap_pattern.sub(repl, data)
# After conversion, rows will always be tightly packed
current_pitch = sign_pitch * (len(format) * self.width)
if pitch != current_pitch:
diff = abs(current_pitch) - abs(pitch)
if diff > 0:
# New pitch is shorter than old pitch, chop bytes off each row
pattern = re.compile(
'(%s)%s' % ('.' * abs(pitch), '.' * diff), re.DOTALL)
data = pattern.sub(r'\1', data)
elif diff < 0:
# New pitch is longer than old pitch, add '0' bytes to each row
pattern = re.compile(
'(%s)' % ('.' * abs(current_pitch)), re.DOTALL)
pad = '.' * -diff
data = pattern.sub(r'\1%s' % pad, data)
if current_pitch * pitch < 0:
# Pitch differs in sign, swap row order
rows = re.findall('.' * abs(pitch), data, re.DOTALL)
rows.reverse()
data = ''.join(rows)
return data
def _ensure_string_data(self):
if type(self._current_data) is not str:
buf = create_string_buffer(len(self._current_data))
memmove(buf, self._current_data, len(self._current_data))
self._current_data = buf.raw
def _get_gl_format_and_type(self, format):
if format == 'I':
return GL_LUMINANCE, GL_UNSIGNED_BYTE
elif format == 'L':
return GL_LUMINANCE, GL_UNSIGNED_BYTE
elif format == 'LA':
return GL_LUMINANCE_ALPHA, GL_UNSIGNED_BYTE
elif format == 'R':
return GL_RED, GL_UNSIGNED_BYTE
elif format == 'G':
return GL_GREEN, GL_UNSIGNED_BYTE
elif format == 'B':
return GL_BLUE, GL_UNSIGNED_BYTE
elif format == 'A':
return GL_ALPHA, GL_UNSIGNED_BYTE
elif format == 'RGB':
return GL_RGB, GL_UNSIGNED_BYTE
elif format == 'RGBA':
return GL_RGBA, GL_UNSIGNED_BYTE
elif (format == 'ARGB' and
gl_info.have_extension('GL_EXT_bgra') and
gl_info.have_extension('GL_APPLE_packed_pixels')):
return GL_BGRA, GL_UNSIGNED_INT_8_8_8_8_REV
elif (format == 'ABGR' and
gl_info.have_extension('GL_EXT_abgr')):
return GL_ABGR_EXT, GL_UNSIGNED_BYTE
elif (format == 'BGR' and
gl_info.have_extension('GL_EXT_bgra')):
return GL_BGR, GL_UNSIGNED_BYTE
elif (format == 'BGRA' and
gl_info.have_extension('GL_EXT_bgra')):
return GL_BGRA, GL_UNSIGNED_BYTE
return None, None
def _get_internalformat(self, format):
if len(format) == 4:
return GL_RGBA
elif len(format) == 3:
return GL_RGB
elif len(format) == 2:
return GL_LUMINANCE_ALPHA
elif format == 'A':
return GL_ALPHA
elif format == 'L':
return GL_LUMINANCE
elif format == 'I':
return GL_INTENSITY
return GL_RGBA
class ImageDataRegion(ImageData):
def __init__(self, x, y, width, height, image_data):
super(ImageDataRegion, self).__init__(width, height,
image_data._current_format, image_data._current_data,
image_data._current_pitch)
self.x = x
self.y = y
def __getstate__(self):
return {
'width': self.width,
'height': self.height,
'_current_data':
self.get_data(self._current_format, self._current_pitch),
'_current_format': self._current_format,
'_desired_format': self._desired_format,
'_current_pitch': self._current_pitch,
'pitch': self.pitch,
'mipmap_images': self.mipmap_images,
'x': self.x,
'y': self.y
}
def _get_data(self):
# Crop the data first
x1 = len(self._current_format) * self.x
x2 = len(self._current_format) * (self.x + self.width)
self._ensure_string_data()
data = self._convert(self._current_format, abs(self._current_pitch))
rows = re.findall('.' * abs(self._current_pitch), data, re.DOTALL)
rows = [row[x1:x2] for row in rows[self.y:self.y+self.height]]
self._current_data = ''.join(rows)
self._current_pitch = self.width * len(self._current_format)
self._current_texture = None
self.x = 0
self.y = 0
return super(ImageDataRegion, self)._get_data()
def _set_data(self, data):
self.x = 0
self.y = 0
super(ImageDataRegion, self)._set_data(data)
data = property(_get_data, _set_data)
def get_data(self, format, pitch):
x1 = len(self._current_format) * self.x
x2 = len(self._current_format) * (self.x + self.width)
self._ensure_string_data()
data = self._convert(self._current_format, abs(self._current_pitch))
rows = re.findall('.' * abs(self._current_pitch), data, re.DOTALL)
rows = [row[x1:x2] for row in rows[self.y:self.y+self.height]]
self._current_data = ''.join(rows)
self._current_pitch = self.width * len(self._current_format)
self._current_texture = None
self.x = 0
self.y = 0
return super(ImageDataRegion, self).get_data(format, pitch)
def _apply_region_unpack(self):
glPixelStorei(GL_UNPACK_SKIP_PIXELS, self.x)
glPixelStorei(GL_UNPACK_SKIP_ROWS, self.y)
def _ensure_string_data(self):
super(ImageDataRegion, self)._ensure_string_data()
def get_region(self, x, y, width, height):
x += self.x
y += self.y
return super(ImageDataRegion, self).get_region(x, y, width, height)
class CompressedImageData(AbstractImage):
'''Image representing some compressed data suitable for direct uploading
to driver.
'''
_current_texture = None
_current_mipmapped_texture = None
def __init__(self, width, height, gl_format, data,
extension=None, decoder=None):
'''Construct a CompressedImageData with the given compressed data.
:Parameters:
`width` : int
Width of image
`height` : int
Height of image
`gl_format` : int
GL constant giving format of compressed data; for example,
``GL_COMPRESSED_RGBA_S3TC_DXT5_EXT``.
`data` : sequence
String or array/list of bytes giving compressed image data.
`extension` : str or None
If specified, gives the name of a GL extension to check for
before creating a texture.
`decoder` : function(data, width, height) -> AbstractImage
A function to decode the compressed data, to be used if the
required extension is not present.
'''
if not _is_pow2(width) or not _is_pow2(height):
raise ImageException('Dimensions of %r must be powers of 2' % self)
super(CompressedImageData, self).__init__(width, height)
self.data = data
self.gl_format = gl_format
self.extension = extension
self.decoder = decoder
self.mipmap_data = []
def set_mipmap_data(self, level, data):
'''Set data for a mipmap level.
Supplied data gives a compressed image for the given mipmap level.
The image must be of the correct dimensions for the level
(i.e., width >> level, height >> level); but this is not checked. If
any mipmap levels are specified, they are used; otherwise, mipmaps for
`mipmapped_texture` are generated automatically.
:Parameters:
`level` : int
Level of mipmap image to set.
`data` : sequence
String or array/list of bytes giving compressed image data.
Data must be in same format as specified in constructor.
'''
# Extend mipmap_data list to required level
self.mipmap_data += [None] * (level - len(self.mipmap_data))
self.mipmap_data[level - 1] = data
def _have_extension(self):
return self.extension is None or gl_info.have_extension(self.extension)
def _verify_driver_supported(self):
'''Assert that the extension required for this image data is
supported.
Raises `ImageException` if not.
'''
if not self._have_extension():
raise ImageException('%s is required to decode %r' % \
(self.extension, self))
def get_texture(self, rectangle=False, force_rectangle=False):
if force_rectangle:
raise ImageException(
'Compressed texture rectangles not supported')
if self._current_texture:
return self._current_texture
texture = Texture.create_for_size(
GL_TEXTURE_2D, self.width, self.height)
if self.anchor_x or self.anchor_y:
texture.anchor_x = self.anchor_x
texture.anchor_y = self.anchor_y
glBindTexture(texture.target, texture.id)
glTexParameteri(texture.target, GL_TEXTURE_MIN_FILTER, GL_LINEAR)
if self._have_extension():
glCompressedTexImage2DARB(texture.target, texture.level,
self.gl_format,
self.width, self.height, 0,
len(self.data), self.data)
else:
image = self.decoder(self.data, self.width, self.height)
texture = image.get_texture()
assert texture.width == self.width
assert texture.height == self.height
glFlush()
self._current_texture = texture
return texture
def get_mipmapped_texture(self):
if self._current_mipmap_texture:
return self._current_mipmap_texture
if not self._have_extension():
# TODO mip-mapped software decoded compressed textures. For now,
# just return a non-mipmapped texture.
return self.get_texture()
texture = Texture.create_for_size(
GL_TEXTURE_2D, self.width, self.height)
if self.anchor_x or self.anchor_y:
texture.anchor_x = self.anchor_x
texture.anchor_y = self.anchor_y
glBindTexture(texture.target, texture.id)
glTexParameteri(texture.target, GL_TEXTURE_MIN_FILTER,
GL_LINEAR_MIPMAP_LINEAR)
if not self.mipmap_data:
if not gl_info.have_version(1, 4):
raise ImageException(
'Require GL 1.4 to generate mipmaps for compressed textures')
glTexParameteri(texture.target, GL_GENERATE_MIPMAP, GL_TRUE)
glCompressedTexImage2DARB(texture.target, texture.level,
self.gl_format,
self.width, self.height, 0,
len(self.data), self.data)
width, height = self.width, self.height
level = 0
for data in self.mipmap_data:
width >>= 1
height >>= 1
level += 1
glCompressedTexImage2DARB(texture.target, level,
self.gl_format,
width, height, 0,
len(data), data)
glFlush()
self._current_mipmap_texture = texture
return texture
def blit_to_texture(self, target, level, x, y, z):
self._verify_driver_supported()
if target == GL_TEXTURE_3D:
glCompressedTexSubImage3DARB(target, level,
x - self.anchor_x, y - self.anchor_y, z,
self.width, self.height, 1,
self.gl_format,
len(self.data), self.data)
else:
glCompressedTexSubImage2DARB(target, level,
x - self.anchor_x, y - self.anchor_y,
self.width, self.height,
self.gl_format,
len(self.data), self.data)
def _nearest_pow2(v):
# From http://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
# Credit: Sean Anderson
v -= 1
v |= v >> 1
v |= v >> 2
v |= v >> 4
v |= v >> 8
v |= v >> 16
return v + 1
def _is_pow2(v):
# http://graphics.stanford.edu/~seander/bithacks.html#DetermineIfPowerOf2
return (v & (v - 1)) == 0
class Texture(AbstractImage):
'''An image loaded into video memory that can be efficiently drawn
to the framebuffer.
Typically you will get an instance of Texture by accessing the `texture`
member of any other AbstractImage.
:Ivariables:
`region_class` : class (subclass of TextureRegion)
Class to use when constructing regions of this texture.
`tex_coords` : tuple
12-tuple of float, named (u1, v1, r1, u2, v2, r2, ...). u, v, r
give the 3D texture coordinates for vertices 1-4. The vertices
are specified in the order bottom-left, bottom-right, top-right
and top-left.
`target` : int
The GL texture target (e.g., ``GL_TEXTURE_2D``).
`level` : int
The mipmap level of this texture.
'''
region_class = None # Set to TextureRegion after it's defined
tex_coords = (0., 0., 0., 1., 0., 0., 1., 1., 0., 0., 1., 0.)
tex_coords_order = (0, 1, 2, 3)
level = 0
images = 1
x = y = z = 0
def __init__(self, width, height, target, id):
super(Texture, self).__init__(width, height)
self.target = target
self.id = id
self._context = gl.current_context
def delete(self):
'''Delete the texture from video memory.
:deprecated: Textures are automatically released during object
finalization.
'''
warnings.warn(
'Texture.delete() is deprecated; textures are '
'released through GC now')
self._context.delete_texture(self.id)
self.id = 0
def __del__(self):
try:
self._context.delete_texture(self.id)
except:
pass
@classmethod
def create(cls, width, height, internalformat=GL_RGBA,
rectangle=False, force_rectangle=False):
'''Create an empty Texture.
If `rectangle` is ``False`` or the appropriate driver extensions are
not available, a larger texture than requested will be created, and
a `TextureRegion` corresponding to the requested size will be
returned.
:Parameters:
`width` : int
Width of the texture.
`height` : int
Height of the texture.
`internalformat` : int
GL constant giving the internal format of the texture; for
example, ``GL_RGBA``.
`rectangle` : bool
``True`` if a rectangular texture is permitted. See
`AbstractImage.get_texture`.
`force_rectangle` : bool
``True`` if a rectangular texture is required. See
`AbstractImage.get_texture`.
**Since:** pyglet 1.1.4.
:rtype: `Texture`
:since: pyglet 1.1
'''
target = GL_TEXTURE_2D
if rectangle or force_rectangle:
if not force_rectangle and _is_pow2(width) and _is_pow2(height):
rectangle = False
elif gl_info.have_extension('GL_ARB_texture_rectangle'):
target = GL_TEXTURE_RECTANGLE_ARB
rectangle = True
elif gl_info.have_extension('GL_NV_texture_rectangle'):
target = GL_TEXTURE_RECTANGLE_NV
rectangle = True
else:
rectangle = False
if force_rectangle and not rectangle:
raise ImageException('Texture rectangle extensions not available')
if rectangle:
texture_width = width
texture_height = height
else:
texture_width = _nearest_pow2(width)
texture_height = _nearest_pow2(height)
id = GLuint()
glGenTextures(1, byref(id))
glBindTexture(target, id.value)
glTexParameteri(target, GL_TEXTURE_MIN_FILTER, GL_LINEAR)
blank = (GLubyte * (texture_width * texture_height * 4))()
glTexImage2D(target, 0,
internalformat,
texture_width, texture_height,
0,
GL_RGBA, GL_UNSIGNED_BYTE,
blank)
texture = cls(texture_width, texture_height, target, id.value)
if rectangle:
texture._is_rectangle = True
texture.tex_coords = (0., 0., 0.,
width, 0., 0.,
width, height, 0.,
0., height, 0.)
glFlush()
if texture_width == width and texture_height == height:
return texture
return texture.get_region(0, 0, width, height)
@classmethod
def create_for_size(cls, target, min_width, min_height,
internalformat=None):
'''Create a Texture with dimensions at least min_width, min_height.
On return, the texture will be bound.
:Parameters:
`target` : int
GL constant giving texture target to use, typically
``GL_TEXTURE_2D``.
`min_width` : int
Minimum width of texture (may be increased to create a power
of 2).
`min_height` : int
Minimum height of texture (may be increased to create a power
of 2).
`internalformat` : int
GL constant giving internal format of texture; for example,
``GL_RGBA``. If unspecified, the texture will not be
initialised (only the texture name will be created on the
instance). If specified, the image will be initialised
to this format with zero'd data.
:rtype: `Texture`
'''
if target not in (GL_TEXTURE_RECTANGLE_NV, GL_TEXTURE_RECTANGLE_ARB):
width = _nearest_pow2(min_width)
height = _nearest_pow2(min_height)
tex_coords = cls.tex_coords
else:
width = min_width
height = min_height
tex_coords = (0., 0., 0.,
width, 0., 0.,
width, height, 0.,
0., height, 0.)
id = GLuint()
glGenTextures(1, byref(id))
glBindTexture(target, id.value)
glTexParameteri(target, GL_TEXTURE_MIN_FILTER, GL_LINEAR)
if internalformat is not None:
blank = (GLubyte * (width * height * 4))()
glTexImage2D(target, 0,
internalformat,
width, height,
0,
GL_RGBA, GL_UNSIGNED_BYTE,
blank)
glFlush()
texture = cls(width, height, target, id.value)
texture.tex_coords = tex_coords
return texture
def get_image_data(self, z=0):
'''Get the image data of this texture.
Changes to the returned instance will not be reflected in this
texture.
:Parameters:
`z` : int
For 3D textures, the image slice to retrieve.
:rtype: `ImageData`
'''
glBindTexture(self.target, self.id)
# Always extract complete RGBA data. Could check internalformat
# to only extract used channels. XXX
format = 'RGBA'
gl_format = GL_RGBA
glPushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT)
glPixelStorei(GL_PACK_ALIGNMENT, 1)
buffer = \
(GLubyte * (self.width * self.height * self.images * len(format)))()
glGetTexImage(self.target, self.level,
gl_format, GL_UNSIGNED_BYTE, buffer)
glPopClientAttrib()
data = ImageData(self.width, self.height, format, buffer)
if self.images > 1:
data = data.get_region(0, z * self.height, self.width, self.height)
return data
image_data = property(lambda self: self.get_image_data(),
doc='''An ImageData view of this texture.
Changes to the returned instance will not be reflected in this
texture. If the texture is a 3D texture, the first image will be
returned. See also `get_image_data`. Read-only.
:deprecated: Use `get_image_data`.
:type: `ImageData`
''')
def get_texture(self, rectangle=False, force_rectangle=False):
if force_rectangle and not self._is_rectangle:
raise ImageException('Texture is not a rectangle.')
return self
# no implementation of blit_to_texture yet (could use aux buffer)
def blit(self, x, y, z=0, width=None, height=None):
t = self.tex_coords
x1 = x - self.anchor_x
y1 = y - self.anchor_y
x2 = x1 + (width is None and self.width or width)
y2 = y1 + (height is None and self.height or height)
array = (GLfloat * 32)(
t[0], t[1], t[2], 1.,
x1, y1, z, 1.,
t[3], t[4], t[5], 1.,
x2, y1, z, 1.,
t[6], t[7], t[8], 1.,
x2, y2, z, 1.,
t[9], t[10], t[11], 1.,
x1, y2, z, 1.)
glPushAttrib(GL_ENABLE_BIT)
glEnable(self.target)
glBindTexture(self.target, self.id)
glPushClientAttrib(GL_CLIENT_VERTEX_ARRAY_BIT)
glInterleavedArrays(GL_T4F_V4F, 0, array)
glDrawArrays(GL_QUADS, 0, 4)
glPopClientAttrib()
glPopAttrib()
def blit_into(self, source, x, y, z):
glBindTexture(self.target, self.id)
source.blit_to_texture(self.target, self.level, x, y, z)
def get_region(self, x, y, width, height):
return self.region_class(x, y, 0, width, height, self)
def get_transform(self, flip_x=False, flip_y=False, rotate=0):
'''Create a copy of this image applying a simple transformation.
The transformation is applied to the texture coordinates only;
`get_image_data` will return the untransformed data. The
transformation is applied around the anchor point.
:Parameters:
`flip_x` : bool
If True, the returned image will be flipped horizontally.
`flip_y` : bool
If True, the returned image will be flipped vertically.
`rotate` : int
Degrees of clockwise rotation of the returned image. Only
90-degree increments are supported.
:rtype: `TextureRegion`
'''
transform = self.get_region(0, 0, self.width, self.height)
bl, br, tr, tl = 0, 1, 2, 3
transform.anchor_x = self.anchor_x
transform.anchor_y = self.anchor_y
if flip_x:
bl, br, tl, tr = br, bl, tr, tl
transform.anchor_x = self.width - self.anchor_x
if flip_y:
bl, br, tl, tr = tl, tr, bl, br
transform.anchor_y = self.height - self.anchor_y
rotate %= 360
if rotate < 0:
rotate += 360
if rotate == 0:
pass
elif rotate == 90:
bl, br, tr, tl = br, tr, tl, bl
transform.anchor_x, transform.anchor_y = \
transform.anchor_y, \
transform.width - transform.anchor_x
elif rotate == 180:
bl, br, tr, tl = tr, tl, bl, br
transform.anchor_x = transform.width - transform.anchor_x
transform.anchor_y = transform.height - transform.anchor_y
elif rotate == 270:
bl, br, tr, tl = tl, bl, br, tr
transform.anchor_x, transform.anchor_y = \
transform.height - transform.anchor_y, \
transform.anchor_x
else:
assert False, 'Only 90 degree rotations are supported.'
if rotate in (90, 270):
transform.width, transform.height = \
transform.height, transform.width
transform._set_tex_coords_order(bl, br, tr, tl)
return transform
def _set_tex_coords_order(self, bl, br, tr, tl):
tex_coords = (self.tex_coords[:3],
self.tex_coords[3:6],
self.tex_coords[6:9],
self.tex_coords[9:])
self.tex_coords = \
tex_coords[bl] + tex_coords[br] + tex_coords[tr] + tex_coords[tl]
order = self.tex_coords_order
self.tex_coords_order = \
(order[bl], order[br], order[tr], order[tl])
class TextureRegion(Texture):
'''A rectangular region of a texture, presented as if it were
a separate texture.
'''
def __init__(self, x, y, z, width, height, owner):
super(TextureRegion, self).__init__(
width, height, owner.target, owner.id)
self.x = x
self.y = y
self.z = z
self.owner = owner
owner_u1 = owner.tex_coords[0]
owner_v1 = owner.tex_coords[1]
owner_u2 = owner.tex_coords[3]
owner_v2 = owner.tex_coords[7]
scale_u = owner_u2 - owner_u1
scale_v = owner_v2 - owner_v1
u1 = x / float(owner.width) * scale_u + owner_u1
v1 = y / float(owner.height) * scale_v + owner_v1
u2 = (x + width) / float(owner.width) * scale_u + owner_u1
v2 = (y + height) / float(owner.height) * scale_v + owner_v1
r = z / float(owner.images) + owner.tex_coords[2]
self.tex_coords = (u1, v1, r, u2, v1, r, u2, v2, r, u1, v2, r)
def get_image_data(self):
image_data = self.owner.get_image_data(self.z)
return image_data.get_region(self.x, self.y, self.width, self.height)
def get_region(self, x, y, width, height):
x += self.x
y += self.y
region = self.region_class(x, y, self.z, width, height, self.owner)
region._set_tex_coords_order(*self.tex_coords_order)
return region
def blit_into(self, source, x, y, z):
self.owner.blit_into(source, x + self.x, y + self.y, z + self.z)
def __del__(self):
# only the owner Texture should handle deletion
pass
Texture.region_class = TextureRegion
class Texture3D(Texture, UniformTextureSequence):
'''A texture with more than one image slice.
Use `create_for_images` or `create_for_image_grid` classmethod to
construct.
'''
item_width = 0
item_height = 0
items = ()
@classmethod
def create_for_images(cls, images, internalformat=GL_RGBA):
item_width = images[0].width
item_height = images[0].height
for image in images:
if image.width != item_width or image.height != item_height:
raise ImageException('Images do not have same dimensions.')
depth = len(images)
if not gl_info.have_version(2,0):
depth = _nearest_pow2(depth)
texture = cls.create_for_size(GL_TEXTURE_3D, item_width, item_height)
if images[0].anchor_x or images[0].anchor_y:
texture.anchor_x = images[0].anchor_x
texture.anchor_y = images[0].anchor_y
texture.images = depth
blank = (GLubyte * (texture.width * texture.height * texture.images))()
glBindTexture(texture.target, texture.id)
glTexImage3D(texture.target, texture.level,
internalformat,
texture.width, texture.height, texture.images, 0,
GL_ALPHA, GL_UNSIGNED_BYTE,
blank)
items = []
for i, image in enumerate(images):
item = cls.region_class(0, 0, i, item_width, item_height, texture)
items.append(item)
image.blit_to_texture(texture.target, texture.level,
image.anchor_x, image.anchor_y, i)
glFlush()
texture.items = items
texture.item_width = item_width
texture.item_height = item_height
return texture
@classmethod
def create_for_image_grid(cls, grid, internalformat=GL_RGBA):
return cls.create_for_images(grid[:], internalformat)
def __len__(self):
return len(self.items)
def __getitem__(self, index):
return self.items[index]
def __setitem__(self, index, value):
if type(index) is slice:
for item, image in zip(self[index], value):
image.blit_to_texture(self.target, self.level,
image.anchor_x, image.anchor_y, item.z)
else:
value.blit_to_texture(self.target, self.level,
value.anchor_x, value.anchor_y, self[index].z)
def __iter__(self):
return iter(self.items)
class TileableTexture(Texture):
'''A texture that can be tiled efficiently.
Use `create_for_image` classmethod to construct.
'''
def __init__(self, width, height, target, id):
if not _is_pow2(width) or not _is_pow2(height):
raise ImageException(
'TileableTexture requires dimensions that are powers of 2')
super(TileableTexture, self).__init__(width, height, target, id)
def get_region(self, x, y, width, height):
raise ImageException('Cannot get region of %r' % self)
def blit_tiled(self, x, y, z, width, height):
'''Blit this texture tiled over the given area.
The image will be tiled with the bottom-left corner of the destination
rectangle aligned with the anchor point of this texture.
'''
u1 = self.anchor_x / float(self.width)
v1 = self.anchor_y / float(self.height)
u2 = u1 + width / float(self.width)
v2 = v1 + height / float(self.height)
w, h = width, height
t = self.tex_coords
array = (GLfloat * 32)(
u1, v1, t[2], 1.,
x, y, z, 1.,
u2, v1, t[5], 1.,
x + w, y, z, 1.,
u2, v2, t[8], 1.,
x + w, y + h, z, 1.,
u1, v2, t[11], 1.,
x, y + h, z, 1.)
glPushAttrib(GL_ENABLE_BIT)
glEnable(self.target)
glBindTexture(self.target, self.id)
glPushClientAttrib(GL_CLIENT_VERTEX_ARRAY_BIT)
glInterleavedArrays(GL_T4F_V4F, 0, array)
glDrawArrays(GL_QUADS, 0, 4)
glPopClientAttrib()
glPopAttrib()
@classmethod
def create_for_image(cls, image):
if not _is_pow2(image.width) or not _is_pow2(image.height):
# Potentially unnecessary conversion if a GL format exists.
image = image.get_image_data()
texture_width = _nearest_pow2(image.width)
texture_height = _nearest_pow2(image.height)
newdata = c_buffer(texture_width * texture_height * 4)
gluScaleImage(GL_RGBA,
image.width, image.height,
GL_UNSIGNED_BYTE,
image.get_data('RGBA', image.width * 4),
texture_width,
texture_height,
GL_UNSIGNED_BYTE,
newdata)
image = ImageData(texture_width, texture_height, 'RGBA',
newdata)
image = image.get_image_data()
return image.create_texture(cls)
class DepthTexture(Texture):
'''A texture with depth samples (typically 24-bit).'''
def blit_into(self, source, x, y, z):
glBindTexture(self.target, self.id)
source.blit_to_texture(self.level, x, y, z)
class BufferManager(object):
'''Manages the set of framebuffers for a context.
Use `get_buffer_manager` to obtain the instance of this class for the
current context.
'''
def __init__(self):
self.color_buffer = None
self.depth_buffer = None
aux_buffers = GLint()
glGetIntegerv(GL_AUX_BUFFERS, byref(aux_buffers))
self.free_aux_buffers = [GL_AUX0,
GL_AUX1,
GL_AUX2,
GL_AUX3][:aux_buffers.value]
stencil_bits = GLint()
glGetIntegerv(GL_STENCIL_BITS, byref(stencil_bits))
self.free_stencil_bits = range(stencil_bits.value)
self.refs = []
def get_viewport(self):
'''Get the current OpenGL viewport dimensions.
:rtype: 4-tuple of float.
:return: Left, top, right and bottom dimensions.
'''
viewport = (GLint * 4)()
glGetIntegerv(GL_VIEWPORT, viewport)
return viewport
def get_color_buffer(self):
'''Get the color buffer.
:rtype: `ColorBufferImage`
'''
viewport = self.get_viewport()
viewport_width = viewport[2]
viewport_height = viewport[3]
if (not self.color_buffer or
viewport_width != self.color_buffer.width or
viewport_height != self.color_buffer.height):
self.color_buffer = ColorBufferImage(*viewport)
return self.color_buffer
def get_aux_buffer(self):
'''Get a free auxiliary buffer.
If not aux buffers are available, `ImageException` is raised. Buffers
are released when they are garbage collected.
:rtype: `ColorBufferImage`
'''
if not self.free_aux_buffers:
raise ImageException('No free aux buffer is available.')
gl_buffer = self.free_aux_buffers.pop(0)
viewport = self.get_viewport()
buffer = ColorBufferImage(*viewport)
buffer.gl_buffer = gl_buffer
def release_buffer(ref, self=self):
self.free_aux_buffers.insert(0, gl_buffer)
self.refs.append(weakref.ref(buffer, release_buffer))
return buffer
def get_depth_buffer(self):
'''Get the depth buffer.
:rtype: `DepthBufferImage`
'''
viewport = self.get_viewport()
viewport_width = viewport[2]
viewport_height = viewport[3]
if (not self.depth_buffer or
viewport_width != self.depth_buffer.width or
viewport_height != self.depth_buffer.height):
self.depth_buffer = DepthBufferImage(*viewport)
return self.depth_buffer
def get_buffer_mask(self):
'''Get a free bitmask buffer.
A bitmask buffer is a buffer referencing a single bit in the stencil
buffer. If no bits are free, `ImageException` is raised. Bits are
released when the bitmask buffer is garbage collected.
:rtype: `BufferImageMask`
'''
if not self.free_stencil_bits:
raise ImageException('No free stencil bits are available.')
stencil_bit = self.free_stencil_bits.pop(0)
x, y, width, height = self.get_viewport()
buffer = BufferImageMask(x, y, width, height)
buffer.stencil_bit = stencil_bit
def release_buffer(ref, self=self):
self.free_stencil_bits.insert(0, stencil_bit)
self.refs.append(weakref.ref(buffer, release_buffer))
return buffer
def get_buffer_manager():
'''Get the buffer manager for the current OpenGL context.
:rtype: `BufferManager`
'''
context = gl.current_context
if not hasattr(context, 'image_buffer_manager'):
context.image_buffer_manager = BufferManager()
return context.image_buffer_manager
# XXX BufferImage could be generalised to support EXT_framebuffer_object's
# renderbuffer.
class BufferImage(AbstractImage):
'''An abstract framebuffer.
'''
#: The OpenGL read and write target for this buffer.
gl_buffer = GL_BACK
#: The OpenGL format constant for image data.
gl_format = 0
#: The format string used for image data.
format = ''
owner = None
# TODO: enable methods
def __init__(self, x, y, width, height):
self.x = x
self.y = y
self.width = width
self.height = height
def get_image_data(self):
buffer = (GLubyte * (len(self.format) * self.width * self.height))()
x = self.x
y = self.y
if self.owner:
x += self.owner.x
y += self.owner.y
glReadBuffer(self.gl_buffer)
glPushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT)
glPixelStorei(GL_PACK_ALIGNMENT, 1)
glReadPixels(x, y, self.width, self.height,
self.gl_format, GL_UNSIGNED_BYTE, buffer)
glPopClientAttrib()
return ImageData(self.width, self.height, self.format, buffer)
def get_region(self, x, y, width, height):
if self.owner:
return self.owner.get_region(x + self.x, y + self.y, width, height)
region = self.__class__(x + self.x, y + self.y, width, height)
region.gl_buffer = self.gl_buffer
region.owner = self
return region
class ColorBufferImage(BufferImage):
'''A color framebuffer.
This class is used to wrap both the primary color buffer (i.e., the back
buffer) or any one of the auxiliary buffers.
'''
gl_format = GL_RGBA
format = 'RGBA'
def get_texture(self, rectangle=False, force_rectangle=False):
texture = Texture.create(self.width, self.height, GL_RGBA,
rectangle, force_rectangle)
self.blit_to_texture(texture.target, texture.level,
self.anchor_x, self.anchor_y, 0)
return texture
def blit_to_texture(self, target, level, x, y, z):
glReadBuffer(self.gl_buffer)
glCopyTexSubImage2D(target, level,
x - self.anchor_x, y - self.anchor_y,
self.x, self.y, self.width, self.height)
class DepthBufferImage(BufferImage):
'''The depth buffer.
'''
gl_format = GL_DEPTH_COMPONENT
format = 'L'
def get_texture(self, rectangle=False, force_rectangle=False):
assert rectangle == False and force_rectangle == False, \
'Depth textures cannot be rectangular'
if not _is_pow2(self.width) or not _is_pow2(self.height):
raise ImageException(
'Depth texture requires that buffer dimensions be powers of 2')
texture = DepthTexture.create_for_size(GL_TEXTURE_2D,
self.width, self.height)
if self.anchor_x or self.anchor_y:
texture.anchor_x = self.anchor_x
texture.anchor_y = self.anchor_y
glReadBuffer(self.gl_buffer)
glCopyTexImage2D(texture.target, 0,
GL_DEPTH_COMPONENT,
self.x, self.y, self.width, self.height,
0)
return texture
def blit_to_texture(self, target, level, x, y, z):
glReadBuffer(self.gl_buffer)
glCopyTexSubImage2D(target, level,
x - self.anchor_x, y - self.anchor_y,
self.x, self.y, self.width, self.height)
class BufferImageMask(BufferImage):
'''A single bit of the stencil buffer.
'''
gl_format = GL_STENCIL_INDEX
format = 'L'
# TODO mask methods
class ImageGrid(AbstractImage, AbstractImageSequence):
'''An imaginary grid placed over an image allowing easy access to
regular regions of that image.
The grid can be accessed either as a complete image, or as a sequence
of images. The most useful applications are to access the grid
as a `TextureGrid`::
image_grid = ImageGrid(...)
texture_grid = image_grid.get_texture_sequence()
or as a `Texture3D`::
image_grid = ImageGrid(...)
texture_3d = Texture3D.create_for_image_grid(image_grid)
'''
_items = ()
_texture_grid = None
def __init__(self, image, rows, columns,
item_width=None, item_height=None,
row_padding=0, column_padding=0):
'''Construct a grid for the given image.
You can specify parameters for the grid, for example setting
the padding between cells. Grids are always aligned to the
bottom-left corner of the image.
:Parameters:
`image` : AbstractImage
Image over which to construct the grid.
`rows` : int
Number of rows in the grid.
`columns` : int
Number of columns in the grid.
`item_width` : int
Width of each column. If unspecified, is calculated such
that the entire image width is used.
`item_height` : int
Height of each row. If unspecified, is calculated such that
the entire image height is used.
`row_padding` : int
Pixels separating adjacent rows. The padding is only
inserted between rows, not at the edges of the grid.
`column_padding` : int
Pixels separating adjacent columns. The padding is only
inserted between columns, not at the edges of the grid.
'''
super(ImageGrid, self).__init__(image.width, image.height)
if item_width is None:
item_width = \
int((image.width - column_padding * (columns - 1)) / columns)
if item_height is None:
item_height = \
int((image.height - row_padding * (rows - 1)) / rows)
self.image = image
self.rows = rows
self.columns = columns
self.item_width = item_width
self.item_height = item_height
self.row_padding = row_padding
self.column_padding = column_padding
def get_texture(self, rectangle=False):
return self.image.get_texture(rectangle)
def get_texture(self, rectangle=False, force_rectangle=False):
return self.image.get_texture(rectangle, force_rectangle)
def get_texture_sequence(self):
if not self._texture_grid:
self._texture_grid = TextureGrid(self)
return self._texture_grid
def __len__(self):
return self.rows * self.columns
def _update_items(self):
if not self._items:
self._items = []
y = 0
for row in range(self.rows):
x = 0
for col in range(self.columns):
self._items.append(self.image.get_region(
x, y, self.item_width, self.item_height))
x += self.item_width + self.column_padding
y += self.item_height + self.row_padding
def __getitem__(self, index):
self._update_items()
# TODO tuples
return self._items[index]
def __iter__(self):
self._update_items()
return iter(self._items)
class TextureGrid(TextureRegion, UniformTextureSequence):
'''A texture containing a regular grid of texture regions.
To construct, create an `ImageGrid` first::
image_grid = ImageGrid(...)
texture_grid = TextureGrid(image_grid)
The texture grid can be accessed as a single texture, or as a sequence
of `TextureRegion`. When accessing as a sequence, you can specify
integer indexes, in which the images are arranged in rows from the
bottom-left to the top-right::
# assume the texture_grid is 3x3:
current_texture = texture_grid[3] # get the middle-left image
You can also specify tuples in the sequence methods, which are addressed
as ``row, column``::
# equivalent to the previous example:
current_texture = texture_grid[1, 0]
When using tuples in a slice, the returned sequence is over the
rectangular region defined by the slice::
# returns center, center-right, center-top, top-right images in that
# order:
images = texture_grid[(1,1):]
# equivalent to
images = texture_grid[(1,1):(3,3)]
'''
items = ()
rows = 1
columns = 1
item_width = 0
item_height = 0
def __init__(self, grid):
image = grid.get_texture()
if isinstance(image, TextureRegion):
owner = image.owner
else:
owner = image
super(TextureGrid, self).__init__(
image.x, image.y, image.z, image.width, image.height, owner)
items = []
y = 0
for row in range(grid.rows):
x = 0
for col in range(grid.columns):
items.append(
self.get_region(x, y, grid.item_width, grid.item_height))
x += grid.item_width + grid.column_padding
y += grid.item_height + grid.row_padding
self.items = items
self.rows = grid.rows
self.columns = grid.columns
self.item_width = grid.item_width
self.item_height = grid.item_height
def get(self, row, column):
return self[(row, column)]
def __getitem__(self, index):
if type(index) is slice:
if type(index.start) is not tuple and \
type(index.stop) is not tuple:
return self.items[index]
else:
row1 = 0
col1 = 0
row2 = self.rows
col2 = self.columns
if type(index.start) is tuple:
row1, col1 = index.start
elif type(index.start) is int:
row1 = index.start / self.columns
col1 = index.start % self.columns
assert row1 >= 0 and col1 >= 0 and \
row1 < self.rows and col1 < self.columns
if type(index.stop) is tuple:
row2, col2 = index.stop
elif type(index.stop) is int:
row2 = index.stop / self.columns
col2 = index.stop % self.columns
assert row2 >= 0 and col2 >= 0 and \
row2 <= self.rows and col2 <= self.columns
result = []
i = row1 * self.columns
for row in range(row1, row2):
result += self.items[i+col1:i+col2]
i += self.columns
return result
else:
if type(index) is tuple:
row, column = index
assert row >= 0 and column >= 0 and \
row < self.rows and column < self.columns
return self.items[row * self.columns + column]
elif type(index) is int:
return self.items[index]
def __setitem__(self, index, value):
if type(index) is slice:
for region, image in zip(self[index], value):
if image.width != self.item_width or \
image.height != self.item_height:
raise ImageException('Image has incorrect dimensions')
image.blit_into(region, image.anchor_x, image.anchor_y, 0)
else:
image = value
if image.width != self.item_width or \
image.height != self.item_height:
raise ImageException('Image has incorrect dimensions')
image.blit_into(self[index], image.anchor_x, image.anchor_y, 0)
def __len__(self):
return len(self.items)
def __iter__(self):
return iter(self.items)
# --------------------------------------------------------------------------
# Animation stuff here. Vote on if this should be in pyglet.image.animation
# or just leave it tacked on here.
# TODO:
# conversion Animation -> media.Source
# move to another module?
# pyglet.animation?
# pyglet.image.animation?
def load_animation(filename, file=None, decoder=None):
'''Load an animation from a file.
Currently, the only supported format is GIF.
:Parameters:
`filename` : str
Used to guess the animation format, and to load the file if `file`
is unspecified.
`file` : file-like object or None
File object containing the animation stream.
`decoder` : ImageDecoder or None
If unspecified, all decoders that are registered for the filename
extension are tried. If none succeed, the exception from the
first decoder is raised.
:rtype: Animation
'''
if not file:
file = open(filename, 'rb')
if not hasattr(file, 'seek'):
file = StringIO(file.read())
if decoder:
return decoder.decode(file, filename)
else:
first_exception = None
for decoder in codecs.get_animation_decoders(filename):
try:
image = decoder.decode_animation(file, filename)
return image
except codecs.ImageDecodeException, e:
first_exception = first_exception or e
file.seek(0)
if not first_exception:
raise codecs.ImageDecodeException('No image decoders are available')
raise first_exception
class Animation(object):
'''Sequence of images with timing information.
If no frames of the animation have a duration of ``None``, the animation
loops continuously; otherwise the animation stops at the first frame with
duration of ``None``.
:Ivariables:
`frames` : list of `AnimationFrame`
The frames that make up the animation.
'''
def __init__(self, frames):
'''Create an animation directly from a list of frames.
:Parameters:
`frames` : list of `AnimationFrame`
The frames that make up the animation.
'''
assert len(frames)
self.frames = frames
def add_to_texture_bin(self, bin):
'''Add the images of the animation to a `TextureBin`.
The animation frames are modified in-place to refer to the texture bin
regions.
:Parameters:
`bin` : `TextureBin`
Texture bin to upload animation frames into.
'''
for frame in self.frames:
frame.image = bin.add(frame.image)
def get_transform(self, flip_x=False, flip_y=False, rotate=0):
'''Create a copy of this animation applying a simple transformation.
The transformation is applied around the image's anchor point of
each frame. The texture data is shared between the original animation
and the transformed animation.
:Parameters:
`flip_x` : bool
If True, the returned animation will be flipped horizontally.
`flip_y` : bool
If True, the returned animation will be flipped vertically.
`rotate` : int
Degrees of clockwise rotation of the returned animation. Only
90-degree increments are supported.
:rtype: `Animation`
'''
frames = [AnimationFrame(
frame.image.get_texture().get_transform(
flip_x, flip_y, rotate), frame.duration) \
for frame in self.frames]
return Animation(frames)
def get_duration(self):
'''Get the total duration of the animation in seconds.
:rtype: float
'''
return sum([frame.duration for frame in self.frames \
if frame.duration is not None])
def get_max_width(self):
'''Get the maximum image frame width.
This method is useful for determining texture space requirements: due
to the use of ``anchor_x`` the actual required playback area may be
larger.
:rtype: int
'''
return max([frame.image.width for frame in self.frames])
def get_max_height(self):
'''Get the maximum image frame height.
This method is useful for determining texture space requirements: due
to the use of ``anchor_y`` the actual required playback area may be
larger.
:rtype: int
'''
return max([frame.image.height for frame in self.frames])
@classmethod
def from_image_sequence(cls, sequence, period, loop=True):
'''Create an animation from a list of images and a constant framerate.
:Parameters:
`sequence` : list of `AbstractImage`
Images that make up the animation, in sequence.
`period` : float
Number of seconds to display each image.
`loop` : bool
If True, the animation will loop continuously.
:rtype: `Animation`
'''
frames = [AnimationFrame(image, period) for image in sequence]
if not loop:
frames[-1].duration = None
return cls(frames)
class AnimationFrame(object):
'''A single frame of an animation.
'''
def __init__(self, image, duration):
'''Create an animation frame from an image.
:Parameters:
`image` : `AbstractImage`
The image of this frame.
`duration` : float
Number of seconds to display the frame, or ``None`` if it is
the last frame in the animation.
'''
self.image = image
self.duration = duration
def __repr__(self):
return 'AnimationFrame(%r, %r)' % (self.image, self.duration)
# Initialise default codecs
from pyglet.image import codecs as _codecs
_codecs.add_default_image_codecs()
|