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
|
/*
SCREENDrawText.c
AUTHORS:
Allen.Ingling@nyu.edu awi
mario.kleiner.de@gmail.com mk
PLATFORMS:
All. With OS specific #ifdefs...
HISTORY:
11/17/03 awi Spun off from SCREENTestTexture which also used Quartz and Textures to draw text but did not match the 'DrawText' specifications.
10/12/04 awi In useString: changed "SCREEN" to "Screen", and moved commas to inside [].
2/25/05 awi Added call to PsychUpdateAlphaBlendingFactorLazily(). Drawing now obeys settings by Screen('BlendFunction').
5/08/05 mk Bugfix for "Descenders of letters get cut/eaten away" bug introduced in PTB 1.0.5
10/12/05 mk Fix crash in DrawText caused by removing glFinish() while CLIENT_STORAGE is enabled!
-> Disabling CLIENT_STORAGE and removing glFinish() is the proper solution...
11/01/05 mk Finally the real bugfix for "Descenders of letters get cut/eaten away" bug introduced in PTB 1.0.5!
11/01/05 mk Removal of dead code + beautification.
11/21/05 mk Code for updating the "Drawing Cursor" and returning NewX, NewY values added.
01/01/06 mk Code branch for M$-Windoze implementation of DrawText added.
11/11/07 mk New GDI based Windoze text renderer implemented.
12/27/09 mk Massive refactoring of code for all platforms and support for plugin-based textrenderers.
-> Cleans up the mess of duplicated code and special cases. We share as much code as possible accross platforms.
-> Allows for unicode support on all platforms.
-> Allows for plugin renderer on Linux and OS/X for unicode, anti-aliasing etc.
-> Allows for better handling of unicode and multibyte character encodings.
11/02/13 mk Rewrite OSX renderer: Switch from deprecated ATSUI to "new" CoreText as supported on OSX 10.5 and later.
DESCRIPTION:
Unified file with text renderers for all platforms (OS/X, Windows, Linux).
REFERENCES:
http://www.cl.cam.ac.uk/~mgk25/unicode.html - A good FAQ about Unicode, UTF-8 with a special emphasis on Linux and Posix systems.
*/
#include "Screen.h"
// Reference to external dynamically loaded text renderer plugin:
static void* drawtext_plugin = NULL;
static psych_bool drawtext_plugin_firstcall = TRUE;
// Function prototypes for functions exported by drawtext plugins: Will be dynamically bound & linked:
int (*PsychPluginInitText)(void) = NULL;
int (*PsychPluginShutdownText)(int context) = NULL;
int (*PsychPluginSetTextFont)(int context, const char* fontName) = NULL;
const char* (*PsychPluginGetTextFont)(int context) = NULL;
int (*PsychPluginSetTextStyle)(int context, unsigned int fontStyle) = NULL;
int (*PsychPluginSetTextSize)(int context, double fontSize) = NULL;
void (*PsychPluginSetTextFGColor)(int context, double* color) = NULL;
void (*PsychPluginSetTextBGColor)(int context, double* color) = NULL;
void (*PsychPluginSetTextUseFontmapper)(unsigned int useMapper, unsigned int mapperFlags) = NULL;
void (*PsychPluginSetTextViewPort)(int context, double xs, double ys, double w, double h) = NULL;
int (*PsychPluginDrawText)(int context, double xStart, double yStart, int textLen, double* text) = NULL;
int (*PsychPluginMeasureText)(int context, int textLen, double* text, float* xmin, float* ymin, float* xmax, float* ymax, float* xadvance) = NULL;
void (*PsychPluginSetTextVerbosity)(unsigned int verbosity) = NULL;
void (*PsychPluginSetTextAntiAliasing)(int context, int antiAliasing) = NULL;
void (*PsychPluginSetAffineTransformMatrix)(int context, double matrix[2][3]) = NULL;
void (*PsychPluginGetTextCursor)(int context, double* xp, double* yp, double* height) = NULL;
// External renderplugins not yet supported on MS-Windows:
#if PSYCH_SYSTEM != PSYCH_WINDOWS
// Include for dynamic loading of external renderplugin:
#include <dlfcn.h>
#endif
// If you change useString then also change the corresponding synopsis string in ScreenSynopsis.
static char useString[] = "[newX,newY,textHeight]=Screen('DrawText', windowPtr, text [,x] [,y] [,color] [,backgroundColor] [,yPositionIsBaseline] [,swapTextDirection]);";
// 1 2 3 1 2 3 4 5 6 7 8
// Synopsis string for DrawText:
static char synopsisString[] =
"Draw text. \"text\" may include Unicode characters (e.g. Chinese).\n"
"A standard Matlab/Octave char()acter text string is interpreted according to Screen's "
"current character encoding setting. By default this is the \"system default locale\", as "
"selected in the language settings of your user account. You can change the encoding "
"anytime via a call to Screen('Preference', 'TextEncodingLocale', newencoding); "
"E.g., for UTF-8 multibyte character encoding you'd call Screen('Preference','TextEncodingLocale','UTF-8');\n"
"If you have a non-ASCII text string and want to make sure that Matlab or Octave doesn't "
"meddle with your string, convert it into a uint8() datatype before passing to this function.\n"
"If you want to pass a string which contains unicode characters directly, convert the "
"text to a double matrix, e.g., mytext = double(myunicodetext); then pass the double "
"matrix to this function. Screen will interpret all double numbers directly as unicode "
"code points.\n"
"Unicode text drawing is supported on all operating systems if you select the default "
"high quality text renderer. Of course you also have to select a text font which contains "
"the unicode character sets you want to draw - not all fonts contain all unicode characters.\n"
"The following optional parameters allow to control location and color of the drawn text:\n"
"\"x\" \"y\" defines the text pen start location. Default is the location of the pen from "
"previous draw text commands, or (0,0) at startup. \"color\" is the CLUT index (scalar or [r "
"g b] triplet or [r g b a] quadruple) for drawing the text; startup default produces black.\n"
"\"backgroundColor\" is the color of the background area behind the text. By default, "
"text is drawn transparent in front of whatever image content is stored in the window. "
"You need to set an explicit backgroundColor and possibly enable user defined alpha-blending "
"with Screen('Preference', 'TextAlphaBlending', 1); and Screen('Blendfunction', ...) to make "
"use of text background drawing. Appearance of the background + text may be different accross "
"different operating systems and text renderers, or it may not be supported at all, so this is "
"not a feature to rely on.\n"
"\"yPositionIsBaseline\" If specified, will override the global preference setting for text "
"positioning: It defaults to off. If it is set to 1, then the \"y\" pen start location defines "
"the base line of drawn text, otherwise it defines the top of the drawn text. Old PTB's had a "
"behaviour equivalent to setting 1, unfortunately this behaviour wasn't replicated in early "
"versions of Psychtoolbox-3, so now we stick to the new behaviour by default.\n"
"\"swapTextDirection\" If specified and set to 1, then the direction of the text is swapped "
"from the default left-to-right to the swapped right-to-left direction, e.g., to handle scripts "
"with right-to-left writing order like hebrew.\n"
"\"newX, newY\" optionally return the final pen location.\n"
"\"textHeight\" optionally return height of current text string. May return zero if this is "
"not supported by the current text renderer.\n"
"Btw.: Screen('Preference', ...); provides a couple of interesting text preference "
"settings that affect text drawing, e.g., setting alpha blending and anti-aliasing modes.\n"
"Selectable text renderers: The Screen('Preference', 'TextRenderer', Type); command allows "
"to select among different text rendering engines with different properties:\n"
"Type 0 is the legacy OS specific text renderer: On Linux this is implemented as a fast, "
"but low quality OpenGL display list renderer without any support for unicode or text "
"anti-aliasing. On MS-Windows, this is currently a GDI based renderer. On OSX this currently "
"selects Apples CoreText text renderer, which is slow but "
"does support anti-aliasing, unicode and other features. Normally you really don't want to use "
"the type 0 legacy renderer. It is provided for backwards compatibility to old experiment scripts "
"and may need to get removed completely in future versions of Psychtoolbox due to circumstances "
"out of our control.\n"
"Type 1 is the high quality renderer: It supports unicode, anti-aliasing, and many "
"other interesting features. This is a renderer loaded from an external plugin, and based on FTGL "
"for fast high quality text drawing with OpenGL.\n"
"This function doesn't provide support for text layout. Use the higher level DrawFormattedText() function "
"if you need basic support for text layout, e.g, centered text output, line wrapping etc.\n";
static char seeAlsoString[] = "TextBounds TextSize TextFont TextStyle TextColor TextBackgroundColor Preference";
// OS/X specific default renderer: CoreText framework. Requires OSX 10.6 or later.
#if PSYCH_SYSTEM == PSYCH_OSX
/*
PsychGetCTStyleAttributesFromPsychWindowRecord()
Use the Font Manager attributes for the given window, which are stored in the PsychFontStructType
struct within the window's record, to set the attributes for text rendering with CoreText.
For now we only set the font, the color, and the size. Boldness, italic, underline, condensed and
extended we assume are brought along with the font ID, or handled externally.
*/
static CFDictionaryRef PsychGetCTStyleAttributesFromPsychWindowRecord(PsychWindowRecordType *winRec, CGColorSpaceRef cgColorSpace)
{
GLdouble colorVector[4];
CGFloat components[4];
PsychFontStructType *psychFontRecord;
// Define font name and font size:
PsychGetFontRecordFromFontNumber(winRec->textAttributes.textFontNumber, &psychFontRecord);
if (psychFontRecord == NULL) PsychErrorExitMsg(PsychError_internal, "Failed to lookup the font from the font number!");
// Create font from cached fontDescriptor:
CTFontRef font = CTFontCreateWithFontDescriptor(psychFontRecord->fontDescriptor, winRec->textAttributes.textSize, NULL);
// Define font foreground color:
PsychCoerceColorMode(&(winRec->textAttributes.textColor));
PsychConvertColorToDoubleVector(&(winRec->textAttributes.textColor), winRec, colorVector);
components[0] = colorVector[0]; components[1] = colorVector[1]; components[2] = colorVector[2]; components[3] = colorVector[3];
CGColorRef fontColor = CGColorCreate(cgColorSpace, components);
// Define use of underlining:
int doUnderline = (winRec->textAttributes.textStyle & 4) ? kCTUnderlineStyleSingle : kCTUnderlineStyleNone;
CFNumberRef underline = CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &doUnderline);
// Create attributes for an attributed string:
CFStringRef keys[] = { kCTFontAttributeName, kCTForegroundColorAttributeName, kCTUnderlineStyleAttributeName };
CFTypeRef values[] = { font, fontColor, underline };
CFDictionaryRef attr = CFDictionaryCreate(NULL, (const void **)&keys, (const void **)&values,
sizeof(keys) / sizeof(keys[0]), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
// Release stuff, the attr dictionary retains its own references:
CFRelease(font);
CGColorRelease(fontColor);
CFRelease(underline);
// Return attr'ibutes:
return(attr);
}
PsychError PsychOSDrawUnicodeText(PsychWindowRecordType* winRec, PsychRectType* boundingbox, unsigned int stringLengthChars, double* textUniDoubleString, double* xp, double* yp, unsigned int yPositionIsBaseline, PsychColorType *textColor, PsychColorType *backgroundColor)
{
CGContextRef cgContext;
unsigned int memoryTotalSizeBytes, memoryRowSizeBytes;
UInt32 *textureMemory;
GLuint myTexture;
CGColorSpaceRef cgColorSpace;
CGRect quartzRect;
GLdouble backgroundColorVector[4];
UniChar *textUniString;
double textBoundsPRect[4], textBoundsPRectOrigin[4], textureRect[4];
double textureWidth, textureHeight, textHeight, textWidth, textureTextFractionY, textureTextFractionXLeft,textureTextFractionXRight, textHeightToBaseline;
double quadLeft, quadRight, quadTop, quadBottom;
GLenum normalSourceBlendFactor, normalDestinationBlendFactor;
int dummy1, dummy2;
int ix;
GLubyte *rpb;
psych_bool bigendian;
psych_bool slowMode;
// Detect endianity (byte-order) of machine:
ix = 255;
rpb = (GLubyte*) &ix;
bigendian = ( *rpb == 255 ) ? FALSE : TRUE;
ix = 0; rpb = NULL;
// Is a non-identity affine transformation matrix set? If so, we need to use slow mode to avoid the transformation
// causing the text to move outside its small bounding box:
if (winRec->text2DMatrix[0][0] != 1 || winRec->text2DMatrix[1][1] != 1 || winRec->text2DMatrix[1][0] != 0 ||
winRec->text2DMatrix[0][1] != 0 || winRec->text2DMatrix[0][2] != 0 || winRec->text2DMatrix[1][2] != 0) {
slowMode = TRUE;
if (PsychPrefStateGet_Verbosity() > 9) printf("PTB-INFO: Drawtext OSX slow mode engaged due to affine transformation.\n");
}
else {
slowMode = FALSE;
}
// Convert input text string from double-vector encoding to OS/X UniChar encoding:
textUniString = (UniChar*) PsychMallocTemp(sizeof(UniChar) * stringLengthChars);
for (dummy1 = 0; dummy1 < stringLengthChars; dummy1++) textUniString[dummy1] = (UniChar) textUniDoubleString[dummy1];
// Define color space to use: Since June 2015 we use kCGColorSpaceGenericRGBLinear instead of
// CGColorSpaceCreateDeviceRGB(). We also make sure to feed the same cgColorSpace to
// PsychGetCTStyleAttributesFromPsychWindowRecord() for definition of text color, as a mismatch
// triggers gamma corrections which screw up our color definitions. Inaccurate Apple docs made
// us believe we always used a consistent color space for the CGBitmapContext and for CoreText
// colors, but this wasn't the case! Yay for great documentation.
//
// Anyway, so our previous text rendered on OSX with the CoreText renderer was always off in color,
// sort of gamma mapped through a roughly 1/1.2 gamma function.
cgColorSpace = CGColorSpaceCreateWithName(kCGColorSpaceGenericRGBLinear);
// Compute attributes of text string from settings in window record:
CFDictionaryRef attributes = PsychGetCTStyleAttributesFromPsychWindowRecord(winRec, cgColorSpace);
// Build text string with attributes (which encode text appearance) from 'textUniString' input string and 'attributes':
CFStringRef myString = CFStringCreateWithCharactersNoCopy(kCFAllocatorDefault, textUniString, stringLengthChars, kCFAllocatorNull);
CFAttributedStringRef attrString = CFAttributedStringCreate(NULL, myString, attributes);
CFRelease(myString);
CFRelease(attributes);
// Build the single text line with the string and its attributes:
CTLineRef line = CTLineCreateWithAttributedString(attrString);
CFRelease(attrString);
// Get typographic bounds: Ascenders, Descenders, Leading space, line width:
CGFloat ascent, descent, leading;
double lineWidth = CTLineGetTypographicBounds(line, &ascent, &descent, &leading);
// Define the meaning of the y position of the specified drawing cursor.
if ((!slowMode && yPositionIsBaseline) || (slowMode && !yPositionIsBaseline)) {
// Y position of drawing cursor defines distance between top of text and
// baseline of text, i.e. the textheight excluding descenders of letters.
// ascent encodes the height of the text from the top-left corner to the
// baseline, so this defines the offset of y coordinates needed to make
// the y position the position of the text baseline:
textHeightToBaseline = ascent;
if (slowMode) textHeightToBaseline -= descent;
}
else {
// Y position of drawing cursor defines top of text, therefore no offset (==0) needed:
textHeightToBaseline = 0;
}
if (slowMode) {
// Use a full window size rect:
textBoundsPRect[kPsychLeft] = 0;
textBoundsPRect[kPsychTop] = 0;
textBoundsPRect[kPsychRight] = PsychGetWidthFromRect(winRec->clientrect);
textBoundsPRect[kPsychBottom] = PsychGetHeightFromRect(winRec->clientrect);
}
else {
// Compute generous bounding rectangle based on typographic bounds:
textBoundsPRect[kPsychLeft] = - (double) leading;
textBoundsPRect[kPsychRight] = lineWidth;
textBoundsPRect[kPsychTop] = - (double) ascent;
textBoundsPRect[kPsychBottom] = (double) descent;
}
// printf("Leading %f, Linewidth %f, Ascent %f, Descent %f -> textHeightToBaseline = %f\n", leading, lineWidth, ascent, descent, textHeightToBaseline);
// printf("R: Top %lf x Bottom %lf :: ",textBoundsPRect[kPsychTop], textBoundsPRect[kPsychBottom]);
// Normalize to a bounding rectangle with top-left = 0,0:
PsychNormalizeRect(textBoundsPRect, textBoundsPRectOrigin);
// printf("N: Top %lf x Bottom %lf :: ",textBoundsPRectOrigin[kPsychTop], textBoundsPRectOrigin[kPsychBottom]);
if (slowMode) {
// Normalize to a bounding rectangle with top-left = 0,0:
PsychNormalizeRect(textBoundsPRect, textureRect);
}
else {
// Compute smallest matching texture rectangle for classic power-of-two textures:
PsychFindEnclosingTextureRect(textBoundsPRectOrigin, textureRect);
}
//Allocate memory the size of the texture. The CG context will be the same size.
textureWidth = PsychGetWidthFromRect(textureRect);
// Make sure textureWidth is a multiple of 4 pixels, ergo (4 Bytes per pixel) a
// single pixel row will be a multiple of 16 Bytes. Why? Because Apple docs promise
// potentially higher drawing performance of CoreText for 16-Byte multiples:
textureWidth+= 4 - (((int) textureWidth) % 4);
// We make the texture canvas twice as high as needed, because some special fonts have a
// height bigger than the computed ascenders + descenders, ie., their typographics bounds
// are incorrect/inaccurate/too small. We over-allocate here, then recompute precise bounds
// below with the "more than big enough" graphics context and adjust properly to only render
// and draw the actual text bits:
textureHeight = PsychGetHeightFromRect(textureRect) * ((slowMode) ? 1 : 2);
// Reclamp maximum size of text bitmap to maximum supported texture size of GPU:
if (textureWidth > winRec->maxTextureSize) textureWidth = winRec->maxTextureSize;
if (textureHeight > winRec->maxTextureSize) textureHeight = winRec->maxTextureSize;
memoryRowSizeBytes=sizeof(UInt32) * textureWidth;
memoryTotalSizeBytes= memoryRowSizeBytes * textureHeight;
textureMemory=(UInt32 *)valloc(memoryTotalSizeBytes);
if(!textureMemory) {
CGColorSpaceRelease(cgColorSpace);
PsychErrorExitMsg(PsychError_system, "Failed to allocate texture memory for to be drawn text!");
}
// printf("N: TexWidth %lf x TexHeight %lf :: ", textureWidth, textureHeight);
// This zero-fill of memory should not be neccessary, but it is, as a workaround for some bug introduced
// by Apple into OS/X 10.6.0 -- Apparently fails to initialize memory properly, so pixeltrash gets through...
memset(textureMemory, 0, memoryTotalSizeBytes);
// Create the Core Graphics bitmap graphics context. We can tell CoreGraphics to use the same memory storage
// format as will our GL texture, and in fact use the idential memory for both.
// Setup Quartz2D offscreen rendering context into bitmap. The interesting bit is the use of the constant
// kCGBitmapByteOrder32Host if high quality LCD sub-pixel anti-aliasing is requested. Using that flag and
// the according byte order is needed for Apples CoreText renderer to enable subpixel anti-aliasing instead
// of only full-pixel anti-aliasing. This completely undocumented behaviour brought to you by Apples shoddy
// documentation. A second condition is that the text must be rendererd with a filled background of constant
// color via the Screen('TextBackgroundColor') setting, user controlled 'TextAlphaBlending' must be enabled
// and the text background color must be fully opaque, ie., have an alpha of 255:
cgContext = CGBitmapContextCreate(textureMemory, textureWidth, textureHeight, 8, memoryRowSizeBytes, cgColorSpace,
(CGBitmapInfo) kCGImageAlphaPremultipliedFirst | ((PsychPrefStateGet_TextAntiAliasing() >= 2) ? kCGBitmapByteOrder32Host : 0));
if(!cgContext){
free((void *)textureMemory);
printf("PTB-ERROR: In Screen('DrawText'): Failed to allocate CG Bitmap Context for: texWidth=%i, texHeight=%i, memRowSize=%i\n", textureWidth, textureHeight, memoryRowSizeBytes);
printf("PTB-ERROR: In Screen('DrawText'): xPos=%lf yPos=%lf StringLength=%i\nDecoded Unicode-String:\n", *xp, *yp, stringLengthChars);
for (ix=0; ix < stringLengthChars; ix++) printf("%i, ", (int) textUniString[ix]);
printf("\nPTB-ERROR: In Screen('DrawText'): Text corrupt?!?\n");
CGColorSpaceRelease(cgColorSpace);
goto drawtext_skipped;
}
// Define colorspace:
CGContextSetFillColorSpace(cgContext,cgColorSpace);
// Define affine text transformation matrix:
CGContextConcatCTM(cgContext, CGAffineTransformMakeTranslation(*xp, textureHeight - *yp - textHeightToBaseline));
CGContextConcatCTM(cgContext, CGAffineTransformMake((CGFloat) winRec->text2DMatrix[0][0], (CGFloat) winRec->text2DMatrix[1][0],
(CGFloat) winRec->text2DMatrix[0][1], (CGFloat) winRec->text2DMatrix[1][1],
(CGFloat) winRec->text2DMatrix[0][2], (CGFloat) winRec->text2DMatrix[1][2]));
CGContextConcatCTM(cgContext, CGAffineTransformMakeTranslation(-(*xp), - (textureHeight - *yp - textHeightToBaseline)));
// OSX only so far: Screen('TextMode') support:
CGContextSetTextDrawingMode(cgContext, (CGTextDrawingMode) winRec->textAttributes.textMode);
// Set anti-aliasing mode (on/off): Default is to leave it up to the system to decide when
// to anti-alias and when not. But this flag allows to always force anti-aliasing on or off:
if (PsychPrefStateGet_TextAntiAliasing() < 0) {
// Auto-Select anti-aliasing: At least that's what usercode requested.
// We unconditionally enable it, because there isn't any auto-setting
// in CoreText:
CGContextSetShouldAntialias(cgContext, true);
CGContextSetAllowsAntialiasing(cgContext, true);
CGContextSetShouldSmoothFonts(cgContext, true);
CGContextSetAllowsFontSmoothing(cgContext, true);
}
if (PsychPrefStateGet_TextAntiAliasing() == 0) {
// Disable anti-aliasing:
CGContextSetShouldAntialias(cgContext, false);
CGContextSetAllowsAntialiasing(cgContext, false);
CGContextSetShouldSmoothFonts(cgContext, false);
CGContextSetAllowsFontSmoothing(cgContext, false);
}
if (PsychPrefStateGet_TextAntiAliasing() > 0) {
// Enable and force anti-aliasing:
CGContextSetShouldAntialias(cgContext, true);
CGContextSetAllowsAntialiasing(cgContext, true);
CGContextSetShouldSmoothFonts(cgContext, true);
CGContextSetAllowsFontSmoothing(cgContext, true);
}
if (slowMode) {
// Define start position of text drawing cursor within bitmap. Must be shifted upwards by
// maximum height of descenders for this font, otherwise descenders would get clipped away:
CGContextSetTextPosition(cgContext, *xp, textureHeight - *yp - textHeightToBaseline);
}
else {
// Define start position of text drawing cursor within bitmap. Must be shifted upwards by
// maximum height of descenders for this font, otherwise descenders would get clipped away:
CGContextSetTextPosition(cgContext, 0, descent);
}
// Recompute true bounding box, now more accurate by use of cgContext:
CGRect boundingRect = CTLineGetImageBounds(line, cgContext);
if (PsychPrefStateGet_Verbosity() > 9)
printf("CGRect: x %f , y %f, w %f, h %f\n", boundingRect.origin.x, boundingRect.origin.y, boundingRect.size.width, boundingRect.size.height);
if (!slowMode) {
// Adapt bounding box and text baseline if needed for special types of fonts:
if (boundingRect.origin.y < 0) {
double shifty = floor(boundingRect.origin.y);
CGContextSetTextPosition(cgContext, 0, descent - shifty);
textBoundsPRectOrigin[kPsychBottom] -= shifty;
}
if (boundingRect.size.height > PsychGetHeightFromRect(textBoundsPRectOrigin)) {
double shifty = boundingRect.size.height - PsychGetHeightFromRect(textBoundsPRectOrigin);
// Move upper border up to make space for "super-ascenders"
textBoundsPRectOrigin[kPsychTop] -= shifty;
// Adapt baseline accordingly:
if (yPositionIsBaseline) textHeightToBaseline += shifty;
// Shift the whole bounding box down to adapt - This to allow return of proper bounding boxes:
textBoundsPRectOrigin[kPsychBottom] += shifty;
textBoundsPRectOrigin[kPsychTop] += shifty;
}
}
// Compute effective text width and height:
textWidth = PsychGetWidthFromRect(textBoundsPRectOrigin);
textHeight = PsychGetHeightFromRect(textBoundsPRectOrigin);
// Only text boundingbox in absolute coordinates requested?
if (boundingbox) {
// Yes. Compute and assign it:
if (!slowMode) {
(*boundingbox)[kPsychLeft] = textBoundsPRectOrigin[kPsychLeft] + *xp;
(*boundingbox)[kPsychRight] = textBoundsPRectOrigin[kPsychRight] + *xp;
(*boundingbox)[kPsychTop] = textBoundsPRectOrigin[kPsychTop] + *yp - textHeightToBaseline;
(*boundingbox)[kPsychBottom] = textBoundsPRectOrigin[kPsychBottom] + *yp - textHeightToBaseline;
}
else {
(*boundingbox)[kPsychLeft] = boundingRect.origin.x;
(*boundingbox)[kPsychRight] = boundingRect.origin.x + boundingRect.size.width;
(*boundingbox)[kPsychTop] = textureHeight - (boundingRect.origin.y + boundingRect.size.height);
(*boundingbox)[kPsychBottom] = textureHeight - boundingRect.origin.y;
}
// Release resources:
CFRelease(line);
CGColorSpaceRelease(cgColorSpace);
CGContextRelease(cgContext);
free((void *) textureMemory);
// Done.
return(PsychError_none);
}
// Also actual text rendering requested. Carry on!
// Clamp maximum size of text bitmap again to maximum supported texture size of GPU:
if (textWidth > winRec->maxTextureSize) textWidth = winRec->maxTextureSize;
if (textHeight > winRec->maxTextureSize) textHeight = winRec->maxTextureSize;
//printf("N2: Width %lf x Height %lf :: ", textWidth, textHeight);
// Fill in the text background. It's stored in the Window record in PsychColor format.
// We convert it to an OpenGL color vector then into a quartz vector:
quartzRect.origin.x=(float)0;
quartzRect.origin.y=(float)0;
quartzRect.size.width=(float)textureWidth;
quartzRect.size.height=(float)textureHeight;
PsychCoerceColorMode(backgroundColor);
PsychConvertColorToDoubleVector(backgroundColor, winRec, backgroundColorVector);
// Override alpha-blending settings if needed:
if(!PsychPrefStateGet_TextAlphaBlending()) backgroundColorVector[3]=0;
CGFloat bgColor[4] = { (float) backgroundColorVector[0], (float) backgroundColorVector[1], (float) backgroundColorVector[2], (float) backgroundColorVector[3] };
CGContextSetFillColor(cgContext, bgColor);
if (slowMode)
CGContextFillRect(cgContext, boundingRect);
else
CGContextFillRect(cgContext, quartzRect);
// Now draw the text and close up the CoreGraphics shop before we proceed to textures.
CTLineDraw(line, cgContext);
CFRelease(line);
CGContextFlush(cgContext);
if (slowMode) {
CGPoint tpos = CGContextGetTextPosition(cgContext);
*xp = tpos.x;
}
// Remove references from Core Graphics to the texture memory. CG and OpenGL can share concurrently, but we don't won't need this anymore.
CGColorSpaceRelease(cgColorSpace);
CGContextRelease(cgContext);
// From here on: Convert the CG graphics bitmap into a GL texture.
// Enable this windowRecords framebuffer as current drawingtarget:
PsychSetDrawingTarget(winRec);
// Save all state:
glPushAttrib(GL_ALL_ATTRIB_BITS);
// Disable draw shader:
PsychSetShader(winRec, 0);
if(!PsychPrefStateGet_TextAlphaBlending()){
PsychGetAlphaBlendingFactorsFromWindow(winRec, &normalSourceBlendFactor, &normalDestinationBlendFactor);
PsychStoreAlphaBlendingFactorsForWindow(winRec, GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
}
PsychUpdateAlphaBlendingFactorLazily(winRec);
// Explicitely disable Apple's Client storage extensions. For now they are not really useful to us.
glPixelStorei(GL_UNPACK_CLIENT_STORAGE_APPLE, GL_FALSE);
glDisable(GL_TEXTURE_RECTANGLE_EXT);
glEnable(GL_TEXTURE_2D);
glGenTextures(1, &myTexture); //create an index "name" for our texture
glBindTexture(GL_TEXTURE_2D, myTexture); //instantiate a texture of type associated with the index and set it to be the target for subsequent gl texture operators.
glPixelStorei(GL_UNPACK_ALIGNMENT, 1); //tell gl how to unpack from our memory when creating a surface.
// Text(ure) filtering settings:
if (PsychPrefStateGet_TextAntiAliasing() > 0) {
// Use Bilinear filtering for nice rotated/scaled/transformed, anti-aliased text:
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
}
else {
// Use nearest neighbour sampling for non-anti-aliased text. Text appearance is
// already jagged in that case, and usercode usually disables anti-aliasing only
// if it wants us to not mess with text appearance in any way, e.g., for proper
// display of text inside a clut based color-palette index display. This is important
// to avoid artifacts on devices with color overlay planes like the CRS Bits+ / Bits# or
// the ViewPixx/DataPixx/ProPixx devices from VPixx.
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
}
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
PsychTestForGLErrors();
// Subpixel anti-aliasing requested?
if (PsychPrefStateGet_TextAntiAliasing() >= 2) {
// Yes: Need to invert component order in pixel data buffer -- !bigendian instead of bigendian:
glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, (GLsizei)textureWidth, (GLsizei)textureHeight, 0, GL_BGRA,
(!bigendian) ? GL_UNSIGNED_INT_8_8_8_8_REV : GL_UNSIGNED_INT_8_8_8_8, textureMemory);
}
else {
// No: Standard component order in pixel data buffer:
glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, (GLsizei)textureWidth, (GLsizei)textureHeight, 0, GL_BGRA,
(bigendian) ? GL_UNSIGNED_INT_8_8_8_8_REV : GL_UNSIGNED_INT_8_8_8_8, textureMemory);
}
free((void *)textureMemory); // Free the texture memory: OpenGL has its own copy now in internal buffers.
textureMemory = NULL;
PsychTestForGLErrors();
glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_REPLACE);
//The texture holding the text is >= the bounding rect for the text because of the requirement for textures that they have sides 2^(integer)x.
//Therefore we texture only from the region of the texture which contains the text, not the entire texture. Therefore the rect which we texture is the dimensions
//of the text, not the dimensions of the texture.
textureTextFractionXLeft = 0;
textureTextFractionXRight = textWidth / textureWidth;
textureTextFractionY = 1.0 - textHeight / textureHeight;
if (!slowMode) {
// Final screen position of the textured text-quad:
quadLeft = *xp;
quadRight = *xp + textWidth;
// quadTop needs to be adjusted by textHeightToBaseline, see above:
quadTop = *yp - textHeightToBaseline;
quadBottom = quadTop + textHeight;
}
else {
// Final screen position of the textured text-quad:
quadLeft = 0;
quadRight = textWidth;
quadTop = 0;
quadBottom = textHeight;
}
// Enable alpha-test against an alpha-value greater zero during blit. This
// This way, non-text pixels (with alpha equal to zero) are discarded.
glEnable(GL_ALPHA_TEST);
glAlphaFunc(GL_GREATER, 0);
// Submit quad to pipeline:
glBegin(GL_QUADS);
glTexCoord2d(textureTextFractionXLeft, textureTextFractionY); glVertex2d(quadLeft, quadTop);
glTexCoord2d(textureTextFractionXRight, textureTextFractionY); glVertex2d(quadRight, quadTop);
glTexCoord2d(textureTextFractionXRight, 1.0); glVertex2d(quadRight, quadBottom);
glTexCoord2d(textureTextFractionXLeft, 1.0); glVertex2d(quadLeft, quadBottom);
glEnd();
glDisable(GL_ALPHA_TEST);
// Done with this texture:
glDisable(GL_TEXTURE_2D);
// Debug: Visualize bounding box of text on-screen:
if (false) {
glColor3f(1,1,1);
glBegin(GL_LINE_LOOP);
glVertex2d(quadLeft, quadTop);
glVertex2d(quadRight, quadTop);
glVertex2d(quadRight, quadBottom);
glVertex2d(quadLeft, quadBottom);
glEnd();
}
PsychTestForGLErrors();
if(!PsychPrefStateGet_TextAlphaBlending()) PsychStoreAlphaBlendingFactorsForWindow(winRec, normalSourceBlendFactor, normalDestinationBlendFactor);
// Remove references from gl to the texture memory & free gl's associated resources:
glDeleteTextures(1, &myTexture);
glPopAttrib();
// Update drawing cursor: Place cursor so that text could
// be appended right-hand of the drawn text.
if (!slowMode)
*xp = quadRight;
// We jump directly to this position in the code if the textstring is empty --> No op.
drawtext_skipped:
return(PsychError_none);
}
#else
// Implementations for Windows and Linux/X11:
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// Protototype of internal GDI text renderer to be called later in this file:
PsychError PsychOSDrawUnicodeTextGDI(PsychWindowRecordType* winRec, PsychRectType* boundingbox, unsigned int stringLengthChars, double* textUniDoubleString, double* xp, double* yp, unsigned int yPositionIsBaseline, PsychColorType *textColor, PsychColorType *backgroundColor);
// Microsoft-Windows implementation of DrawText...
// The code below will need to be restructured and moved to the proper
// places in PTB's source tree when things have stabilized a bit...
/* PsychOSReBuildFont
*
* (Re)Build a font for the specified winRec, based on OpenGL display lists.
*
* This routine examines the font settings for winRec and builds proper
* OpenGL display lists that represent a font as close as possible to the
* requested font. These routines are specific to Microsoft Windows, so they
* need to be reimplemented for other OS'es...
*/
psych_bool PsychOSRebuildFont(PsychWindowRecordType *winRec)
{
GLYPHMETRICSFLOAT gmf[256]; // Address Buffer For Font Storage
HFONT font, oldfont; // Windows Font ID
GLuint base;
int i;
// Does font need to be rebuild?
if (!winRec->textAttributes.needsRebuild) {
// No rebuild needed. We don't have anything to do.
return(TRUE);
}
// Rebuild needed. Do we have already a display list?
if (winRec->textAttributes.DisplayList > 0) {
// Yep. Destroy it...
glDeleteLists(winRec->textAttributes.DisplayList, 256);
winRec->textAttributes.DisplayList=0;
}
// Create Windows font object with requested properties:
font = NULL;
font = CreateFont(((int) (-MulDiv(winRec->textAttributes.textSize, GetDeviceCaps(winRec->targetSpecific.deviceContext, LOGPIXELSY), 72))), // Height Of Font, aka textSize
0, // Width Of Font: 0=Match to height
0, // Angle Of Escapement
0, // Orientation Angle
((winRec->textAttributes.textStyle & 1) ? FW_BOLD : FW_NORMAL), // Font Weight
((winRec->textAttributes.textStyle & 2) ? TRUE : FALSE), // Italic
((winRec->textAttributes.textStyle & 4) ? TRUE : FALSE), // Underline
FALSE, // Strikeout: Set it to false until we know what it actually means...
ANSI_CHARSET, // Character Set Identifier: Would need to be set different for "WingDings" fonts...
OUT_TT_PRECIS, // Output Precision: We try to get TrueType fonts if possible, but allow fallback to low-quality...
CLIP_DEFAULT_PRECIS, // Clipping Precision: Use system default.
ANTIALIASED_QUALITY, // Output Quality: We want antialiased smooth looking fonts.
FF_DONTCARE|DEFAULT_PITCH, // Family And Pitch: Use system default.
(char*) winRec->textAttributes.textFontName); // Font Name as requested by user.
// Child-protection:
if (font==NULL) {
// Something went wrong...
PsychErrorExitMsg(PsychError_user, "Couldn't select the requested font with the requested font settings from Windows-OS! ");
return(FALSE);
}
// Select the font we created: Retain old font handle for restore below...
oldfont=SelectObject(winRec->targetSpecific.deviceContext, font); // Selects The Font We Created
// Activate OpenGL context:
PsychSetGLContext(winRec);
// Generate 256 display lists, one for each ASCII character:
base = glGenLists(256);
// Build the display lists from the font: We want an outline font instead of a bitmapped one.
// Characters of outline fonts are build as real OpenGL 3D objects (meshes of connected polygons)
// with normals, texture coordinates and so on, so they can be rendered and transformed in 3D, including
// proper texturing and lighting...
wglUseFontOutlines(winRec->targetSpecific.deviceContext, // Select The Current DC
0, // Starting Character is ASCII char zero.
256, // Number Of Display Lists To Build: 256 for all 256 chars.
base, // Starting Display List handle.
0.0f, // Deviation From The True Outlines: Smaller value=Smoother, but more geometry.
0.2f, // Font Thickness In The Z Direction for 3D rendering.
((winRec->textAttributes.textStyle & 8) ? WGL_FONT_LINES : WGL_FONT_POLYGONS), // Type of rendering: Filled polygons or just outlines?
gmf); // Address Of Buffer To receive font metrics data.
// Assign new display list:
winRec->textAttributes.DisplayList = base;
// Clear the rebuild flag:
winRec->textAttributes.needsRebuild = FALSE;
// Copy glyph geometry info into winRec:
for(i=0; i<256; i++) {
winRec->textAttributes.glyphWidth[i]=(float) gmf[i].gmfCellIncX;
winRec->textAttributes.glyphHeight[i]=(float) gmf[i].gmfCellIncY;
}
// Clean up after font creation:
SelectObject(winRec->targetSpecific.deviceContext, oldfont);
DeleteObject(font);
// Our new font is ready to rock!
return(TRUE);
}
#endif
#if PSYCH_SYSTEM == PSYCH_LINUX
// Linux/X11 implementation of PsychOSRebuildFont():
// Include of tolower() function:
#include <ctype.h>
psych_bool PsychOSRebuildFont(PsychWindowRecordType *winRec)
{
char fontname[512];
char** fontnames=NULL;
Font font;
XFontStruct* fontstruct=NULL;
GLuint base;
int i, actual_count_return;
// Does font need to be rebuild?
if (!winRec->textAttributes.needsRebuild) {
// No rebuild needed. We don't have anything to do.
return(TRUE);
}
// No-op if no X-Display connection handle is available because we are not running
// on a X11 based display backend:
if (!winRec->targetSpecific.privDpy) return(TRUE);
// Rebuild needed. Do we have already a display list?
if (winRec->textAttributes.DisplayList > 0) {
// Yep. Destroy it...
glDeleteLists(winRec->textAttributes.DisplayList, 256);
winRec->textAttributes.DisplayList=0;
}
// Create X11 font object with requested properties:
if (winRec->textAttributes.textFontName[0] == '-') {
// Fontname supplied in X11 font name format. Just take it as is,
// the user seems to know how to handle X11 fonts...
snprintf(fontname, sizeof(fontname)-1, "*%s*", winRec->textAttributes.textFontName);
}
else {
// Standard Psychtoolbox font name spec: Use all the text settings that we have and
// try to synthesize a X11 font spec string.
snprintf(fontname, sizeof(fontname)-1, "-*-%s-%s-%s-*--%i-*-*-*", winRec->textAttributes.textFontName, ((winRec->textAttributes.textStyle & 1) ? "bold" : "regular"),
((winRec->textAttributes.textStyle & 2) ? "i" : "r"), winRec->textAttributes.textSize);
}
fontname[sizeof(fontname)-1]=0;
// Convert fontname to lower-case characters:
for(i = 0; i < (int) strlen(fontname); i++) fontname[i]=tolower(fontname[i]);
// Try to load font:
fontstruct = XLoadQueryFont(winRec->targetSpecific.privDpy, fontname);
// Child-protection against invalid fontNames or unavailable/unknown fonts:
if (fontstruct == NULL) {
// Something went wrong...
printf("Failed to load X11 font with name %s.\n\n", winRec->textAttributes.textFontName);
fontnames = XListFonts(winRec->targetSpecific.privDpy, "*", 1000, &actual_count_return);
if (fontnames) {
printf("Available X11 fonts are:\n\n");
for (i=0; i<actual_count_return; i++) printf("%s\n", (char*) fontnames[i]);
printf("\n\n");
XFreeFontNames(fontnames);
fontnames=NULL;
}
printf("Failed to load X11 font with name %s.\n", fontname);
printf("Try a Screen('TextFont') name according to one of the listed available fonts above.\n\n");
PsychErrorExitMsg(PsychError_user, "Couldn't select the requested font with the requested font settings from X11 system!");
return(FALSE);
}
// Get font handle from struct:
font = fontstruct->fid;
// Activate OpenGL context:
PsychSetGLContext(winRec);
// Generate 256 display lists, one for each ASCII character:
base = glGenLists(256);
// Build the display lists from the font:
glXUseXFont(font,
0, // Starting Character is ASCII char zero.
256, // Number Of Display Lists To Build: 256 for all 256 chars.
base // Starting Display List handle.
);
// Assign new display list:
winRec->textAttributes.DisplayList = base;
// Clear the rebuild flag:
winRec->textAttributes.needsRebuild = FALSE;
// Copy glyph geometry info into winRec:
for(i=0; i<256; i++) {
fontname[0]=(char) i;
fontname[1]=0;
winRec->textAttributes.glyphWidth[i]=(float) XTextWidth(fontstruct, fontname, 1);
winRec->textAttributes.glyphHeight[i]=(float) winRec->textAttributes.textSize;
}
// Release font and associated font info:
XFreeFontInfo(NULL, fontstruct, 1);
fontstruct=NULL;
XUnloadFont(winRec->targetSpecific.privDpy, font);
// Our new font is ready to rock!
return(TRUE);
}
#endif
// The DrawText implementation itself is identical on Windows and Linux for the simple displaylist-based renderers:
PsychError PsychOSDrawUnicodeText(PsychWindowRecordType* winRec, PsychRectType* boundingbox, unsigned int stringLengthChars, double* textUniDoubleString, double* xp, double* yp, unsigned int yPositionIsBaseline, PsychColorType *textColor, PsychColorType *backgroundColor)
{
char *textString;
unsigned int i;
float accumWidth, maxHeight, textHeightToBaseline;
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// Use GDI based text renderer on Windows, instead of display list based one?
if (PsychPrefStateGet_TextRenderer() >= 0) {
// Call the GDI based renderer instead:
return(PsychOSDrawUnicodeTextGDI(winRec, boundingbox, stringLengthChars, textUniDoubleString, xp, yp, yPositionIsBaseline, textColor, backgroundColor));
}
#else
(void) backgroundColor;
#endif
// Malloc charstring and convert unicode string to char string:
textString = (char*) PsychMallocTemp(stringLengthChars * sizeof(char));
for (i = 0; i < stringLengthChars; i++) textString[i] = (char) textUniDoubleString[i];
// Boundingbox computation or real text drawing?
if (boundingbox) {
// Enable this windowRecords OpenGL context:
PsychSetGLContext(winRec);
}
else {
// Enable this windowRecords framebuffer as current drawingtarget:
PsychSetDrawingTarget(winRec);
}
// Does the font (better, its display list) need to be build or rebuild, because
// font name, size or settings have changed?
// This routine will check it and perform all necessary ops if so...
PsychOSRebuildFont(winRec);
// Compute text-bounds as x and y increments:
accumWidth=0;
maxHeight=0;
for (i = 0; i < stringLengthChars; i++) {
accumWidth += winRec->textAttributes.glyphWidth[(int) textString[i]];
maxHeight = (winRec->textAttributes.glyphHeight[(int) textString[i]] > maxHeight) ? winRec->textAttributes.glyphHeight[(int) textString[i]] : maxHeight;
}
accumWidth *= (PSYCH_SYSTEM == PSYCH_WINDOWS) ? (float) winRec->textAttributes.textSize : 1.0f;
maxHeight *= (PSYCH_SYSTEM == PSYCH_WINDOWS) ? (float) winRec->textAttributes.textSize : 1.0f;
if (yPositionIsBaseline) {
// Y position of drawing cursor defines distance between top of text and
// baseline of text, i.e. the textheight excluding descenders of letters:
// FIXME: This is most likely plain wrong!!!
textHeightToBaseline = maxHeight;
}
else {
// Y position of drawing cursor defines top of text, therefore no offset (==0) needed:
textHeightToBaseline = 0;
}
// Boundingbox computation or real text drawing?
if (boundingbox) {
// Only computation of bounding box requested, no real text drawing:
// Top-Left bounds of text are current (x,y) position of text drawing cursor:
(*boundingbox)[kPsychLeft] = *xp;
(*boundingbox)[kPsychTop] = *yp;
(*boundingbox)[kPsychRight] = *xp + accumWidth;
// MK: This should work according to spec, but f%$!*g Windows only returns zero values
// for glyphHeight, so maxHeight is always zero :(
// (*boundingbox)[kPsychBottom] = *yp + maxHeight;
//
// As fallback, we use this: It gives correct Bottom-Bound for character strings with characters that
// don't contain descenders. The extra height of characters with descenders is not taken into account.
(*boundingbox)[kPsychBottom] = *yp + winRec->textAttributes.textSize;
// Done.
return(PsychError_none);
}
// Set default draw shader on Windows, but disable on Linux, as glBitmapped rendering doesn't work with it:
PsychSetShader(winRec, (PSYCH_SYSTEM == PSYCH_LINUX) ? 0 : -1);
// Set proper alpha-blending mode:
PsychUpdateAlphaBlendingFactorLazily(winRec);
// Set proper color:
PsychSetGLColor(textColor, winRec);
// Backup modelview matrix:
glMatrixMode(GL_MODELVIEW);
glPushMatrix();
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// Position our "cursor": These are 3D fonts where the glyphs are represented by 3D geometry.
glTranslated(*xp, *yp - textHeightToBaseline + winRec->textAttributes.textSize, -0.5);
{
float scalef;
// Scale to final size:
scalef = (float) MulDiv(winRec->textAttributes.textSize, GetDeviceCaps(winRec->targetSpecific.deviceContext, LOGPIXELSY), 72);
glScalef(scalef, -1 * scalef, 1);
}
#endif
#if PSYCH_SYSTEM == PSYCH_LINUX
// Position our "cursor": The X11 implementation uses glBitmap()'ed fonts, so we need to position
// the rasterposition cursor. We need the glColor4dv() here to handle a special case when using
// HDR framebuffers and HDR draw shaders -- this is not compatible with Linux glBitmapped() rendering...
glColor4dv(winRec->currentColor);
glRasterPos2f(*xp, *yp - textHeightToBaseline + winRec->textAttributes.textSize);
glPixelZoom(1,1);
#endif
// Backup display list state and state of glFrontFace(): The display lists on M$-Windows
// contain glFrontFace() commands to change front-face order, so we need to save and
// restore it.
glPushAttrib(GL_LIST_BIT | GL_POLYGON_BIT);
// Sets The Base Character to the start of our font display list:
glListBase(winRec->textAttributes.DisplayList);
// Render it...
glCallLists(stringLengthChars, GL_UNSIGNED_BYTE, textString);
// Restore state:
glPopAttrib();
glPopMatrix();
// Mark end of drawing op. This is needed for single buffered drawing:
PsychFlushGL(winRec);
// Update drawing cursor: Place cursor so that text could be appended right-hand of the drawn text.
*xp = *xp + accumWidth;
// Done.
return(PsychError_none);
}
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// GDI based text-renderer for MS-Windows:
//
// It's sloooow. However it provides accurate text positioning, Unicode rendering,
// anti-aliasing, proper text size and a higher quality text output in general.
//
// It uses GDI text renderer to render text to a memory device context,
// backed by a DIB device independent memory bitmap. Then it converts the
// DIB to an OpenGL compatible RGBA format and draws it via OpenGL,
// currently via glDrawPixels, in the future maybe via texture mapping if
// that should be faster.
//
// Reasons for slowness: GDI is slow and CPU only -- no GPU acceleration,
// GDI->OpenGL data format conversion (and our trick to get an anti-aliased
// alpha-channel) is slow and compute intense, data upload and blit in GL
// is slow due to hostmemory -> VRAM copy.
// The following variables must be released at Screen flush time the latest.
// The exit routine PsychCleanupTextRenderer() does this when invoked
// from the ScreenCloseAllWindows() function, as part of a Screen flush,
// error abort, or Screen('CloseAll').
// The current (last used) font for GDI text drawing:
static HFONT font=NULL; // Handle to current font.
// These static variables hold the memory bitmap buffers (device contexts)
// for GDI based text drawing. We keep them accross calls to DrawText, and
// only allocate them on first invocation, or reallocate them when the size
// of the target window has changed.
static HDC dc = NULL; // Handle to current memory device context.
static BYTE* pBits = NULL; // Pointer to dc's DIB bitmap memory.
static HBITMAP hbmBuffer; // DIB.
static HBITMAP defaultDIB;
static int oldWidth=-1; // Size of last target window for drawtext.
static int oldHeight=-1; // dto.
static PsychWindowRecordType* oldWin = NULL; // Last window to which text was drawn to.
void CleanupDrawtextGDI(void)
{
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In CleanupDrawtextGDI: Releasing GDI ressources for DrawTextGDI.\n");
if (font) {
if (!DeleteObject(font)) printf("PTB-WARNING: In CleanupDrawtextGDI: Failed to release font! Expect memory leaks!!!\n");
}
font = NULL;
if (dc) {
// Unselect hbmBuffer from dc by reselecting default DIB:
SelectObject(dc, defaultDIB);
// Release now detached hbmBuffer:
if (!DeleteObject((HGDIOBJ) hbmBuffer)) printf("PTB-WARNING: In CleanupDrawtextGDI: Failed to release DIB buffer! Expect memory leaks!!!\n");
// Delete device context:
if (!DeleteDC(dc)) printf("PTB-WARNING: In CleanupDrawtextGDI: Failed to release device context DC! Expect memory leaks!!!\n");
hbmBuffer = NULL;
pBits = NULL;
dc = NULL;
}
oldWidth = -1;
oldHeight = -1;
oldWin = NULL;
return;
}
PsychError PsychOSDrawUnicodeTextGDI(PsychWindowRecordType* winRec, PsychRectType* boundingbox, unsigned int stringLengthChars, double* textUniDoubleString, double* xp, double* yp, unsigned int yPositionIsBaseline, PsychColorType *textColor, PsychColorType *backgroundColor)
{
PsychRectType boundingRect;
WCHAR* textUniString;
int i;
GLdouble incolors[4];
unsigned char bincolors[4];
GLenum normalSourceBlendFactor, normalDestinationBlendFactor;
POINT xy;
int BITMAPINFOHEADER_SIZE = sizeof(BITMAPINFOHEADER) ;
static BITMAPINFOHEADER abBitmapInfo;
BITMAPINFOHEADER* pBMIH = (BITMAPINFOHEADER*) &abBitmapInfo;
RECT trect, brect;
HFONT defaultFont;
unsigned char colorkeyvalue;
unsigned char* scanptr;
int skiplines, renderheight;
DWORD outputQuality;
GLuint myTexture;
// Convert input double unicode string into WCHAR unicode string for Windows renderer:
textUniString = (WCHAR*) PsychMallocTemp(sizeof(WCHAR) * stringLengthChars);
for (i = 0; i < (int) stringLengthChars; i++) textUniString[i] = (WCHAR) textUniDoubleString[i];
// 'DrawText' mode?
if (boundingbox == NULL) {
// DRAWTEXT mode:
// Enable this windowRecords framebuffer as current drawingtarget:
PsychSetDrawingTarget(winRec);
// Set OpenGL drawing color:
PsychSetGLColor(textColor, winRec);
}
// Reallocate device context and bitmap if needed:
if ((dc!=NULL) && (oldWidth != PsychGetWidthFromRect(winRec->clientrect) || oldHeight!=PsychGetHeightFromRect(winRec->clientrect))) {
// Target windows size doesn't match size of our backingstore: Reallocate...
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In DrawTextGDI: Reallocating backing DC due to change in target window size: %i x %i pixels. \n", (int) PsychGetWidthFromRect(winRec->clientrect), (int) PsychGetHeightFromRect(winRec->clientrect));
// Unselect hbmBuffer from dc by reselecting default DIB:
SelectObject(dc, defaultDIB);
// Release now detached hbmBuffer:
if (!DeleteObject((HGDIOBJ) hbmBuffer)) printf("PTB-WARNING: In DrawTextGDI: Failed to release DIB buffer! Expect memory leaks!!!\n");
// Delete device context:
if (!DeleteDC(dc)) printf("PTB-WARNING: In DrawTextGDI: Failed to release device context DC! Expect memory leaks!!!\n");
hbmBuffer = NULL;
dc = NULL;
}
// (Re-)allocation of memory device context and DIB bitmap needed?
if (dc==NULL) {
oldWidth=(int) PsychGetWidthFromRect(winRec->clientrect);
oldHeight=(int) PsychGetHeightFromRect(winRec->clientrect);
// Fill in the header info.
memset(pBMIH, 0, BITMAPINFOHEADER_SIZE);
pBMIH->biSize = sizeof(BITMAPINFOHEADER);
pBMIH->biWidth = oldWidth;
pBMIH->biHeight = oldHeight;
pBMIH->biPlanes = 1;
pBMIH->biBitCount = 32;
pBMIH->biCompression = BI_RGB;
//
// Create the new 32-bpp DIB section.
//
dc = CreateCompatibleDC(NULL);
hbmBuffer = CreateDIBSection(dc,
(BITMAPINFO*) pBMIH,
DIB_RGB_COLORS,
(VOID **) &pBits,
NULL,
0);
// Select DIB into DC. Store reference to default DIB:
defaultDIB = (HBITMAP) SelectObject(dc, hbmBuffer);
}
// Does the font need to be build or rebuild, because
// font name, size or settings have changed? Or is the current window
// winRec not identical to the last target window oldWin? In that case,
// we'll need to reassign the font as well, as fonts are not cached
// on a per windowRecord basis.
//
// This routine will check it and perform all necessary ops if so...
if ((winRec->textAttributes.needsRebuild) || (oldWin != winRec)) {
// Need to realloc font:
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In DrawTextGDI: Rebuilding font due to window switch or rebuild request: needit = %i , oldwin = %p vs. newwin = %p \n", winRec->textAttributes.needsRebuild, oldWin, winRec);
// Delete the old font object, if any:
if (font) {
if (!DeleteObject(font)) printf("PTB-WARNING: In DrawTextGDI: Failed to release font! Expect memory leaks!!!\n");
}
font = NULL;
switch(PsychPrefStateGet_TextAntiAliasing()) {
case 0: // No anti-aliasing:
outputQuality = NONANTIALIASED_QUALITY;
break;
case 1: // Anti-aliased rendering:
outputQuality = ANTIALIASED_QUALITY;
break;
case 2: // WindowsXP and later only: Cleartype anti-aliasing.
outputQuality = 5; // This is #define CLEARTYPE_QUALITY ...
break;
default: // Default to anti-aliasing:
outputQuality = ANTIALIASED_QUALITY;
}
// Create new font object, according to new/changed specs:
font = CreateFont(((int) (-MulDiv(winRec->textAttributes.textSize, GetDeviceCaps(dc, LOGPIXELSY), 72))), // Height Of Font, aka textSize
0, // Width Of Font: 0=Match to height
0, // Angle Of Escapement
0, // Orientation Angle
((winRec->textAttributes.textStyle & 1) ? FW_BOLD : FW_NORMAL), // Font Weight
((winRec->textAttributes.textStyle & 2) ? TRUE : FALSE), // Italic
((winRec->textAttributes.textStyle & 4) ? TRUE : FALSE), // Underline
FALSE, // Strikeout: Set it to false until we know what it actually means...
ANSI_CHARSET, // Character Set Identifier: Would need to be set different for "WingDings" fonts...
OUT_TT_PRECIS, // Output Precision: We try to get TrueType fonts if possible, but allow fallback to low-quality...
CLIP_DEFAULT_PRECIS, // Clipping Precision: Use system default.
outputQuality, // Output Quality wrt. Anti-Aliasing.
FF_DONTCARE|DEFAULT_PITCH, // Family And Pitch: Use system default.
(char*) winRec->textAttributes.textFontName); // Font Name as requested by user.
// Child-protection:
if (font==NULL) {
// Something went wrong...
PsychErrorExitMsg(PsychError_user, "Couldn't select the requested font with the requested font settings from Windows-OS! ");
}
// Clear rebuild flag:
winRec->textAttributes.needsRebuild = FALSE;
}
// Update last target window:
oldWin = winRec;
// Select the font we created:
defaultFont = (HFONT) SelectObject(dc, font);
if (yPositionIsBaseline) {
// Y position of drawing cursor defines distance between top of text and
// baseline of text, i.e. the textheight excluding descenders of letters:
// Set text alignment mode to obey and update the drawing cursor position, with the
// y position being the text baseline:
SetTextAlign(dc, TA_UPDATECP | TA_LEFT | TA_BASELINE);
}
else {
// Y position of drawing cursor defines top of text:
// Set text alignment mode to obey and update the drawing cursor position, with the
// y position being the top of the text bounding box:
SetTextAlign(dc, TA_UPDATECP | TA_LEFT | TA_TOP);
}
// Define targetrectangle/cliprectangle for all drawing: It is simply the full
// target window area:
trect.left = 0;
trect.right = oldWidth-1;
trect.top = 0;
trect.bottom = oldHeight-1;
// Convert PTB color into text RGBA color and set it as text color:
PsychConvertColorToDoubleVector(textColor, winRec, incolors);
// Text drawing shall be transparent where no text pixels are drawn:
SetBkMode(dc, TRANSPARENT);
// Set text color to full white:
SetTextColor(dc, RGB(255, 255, 255));
// Set drawing cursor to requested position:
MoveToEx(dc, (int) *xp, (int) *yp, NULL);
brect = trect;
// printf("PRE: ltrb %d %d %d %d\n", brect.left, brect.top, brect.right, brect.bottom);
// Pseudo-Draw the textString: Don't rasterize, just find bounding box.
DrawTextW(dc, textUniString, stringLengthChars, &brect, DT_CALCRECT | DT_NOPREFIX);
MoveToEx(dc, (int) *xp, (int) *yp, NULL);
// renderheight is the total height of the rendered textbox, not taking clipping into account.
// Its the number of pixelrows to process...
renderheight = (int) brect.bottom - (int) brect.top;
// Calculate skiplines - the number of pixelrows to skip from start of the DIB/from
// bottom of targetwindow. Need to take into account, what the y position actually means:
if (yPositionIsBaseline) {
// y-Position is the baseline of text: Take height of "descender" area into account:
skiplines = oldHeight - ((renderheight - winRec->textAttributes.textSize) + (int) *yp);
}
else {
// y-Position is top of texts bounding box:
skiplines = oldHeight - (renderheight + (int) *yp);
}
// Calculate and store bounding rectangle:
boundingRect[kPsychTop] = oldHeight - 1 - skiplines - renderheight;
boundingRect[kPsychBottom] = oldHeight - 1 - skiplines;
boundingRect[kPsychLeft] = *xp;
boundingRect[kPsychRight] = *xp + (double) ((int) brect.right - (int) brect.left);
// Is this a 'Textbounds' op?
if (boundingbox) {
// "Textbounds" op, no real text drawing. Assign final bounding box, then return:
PsychCopyRect(*boundingbox, boundingRect);
// Restore to default font after text drawing:
SelectObject(dc, defaultFont);
// Done, return:
return(PsychError_none);
}
// Bounds checking: Need to take text into account that is partially or fully outside
// the windows drawing area:
if (skiplines < 0) {
// Lower bound of text is below lower border of window.
// Reduce size of processing area by the difference (we add a negative value == subtract):
renderheight = renderheight + skiplines;
// Start at bottom of screen and DIB with processing:
skiplines = 0;
}
if ((skiplines + renderheight) > (oldHeight - 1)) {
// Upper bound of text is above upper border of window.
// Reduce size of processing area by the difference:
renderheight = renderheight - ((skiplines + renderheight) - (oldHeight - 1));
}
// Negative or zero renderheight? In that case we would be done, because the area of text
// to really draw would be empty or less than empty!
if (renderheight <= 0) goto drawtext_noop;
// Ok, bounds checking left us with something to process and draw - Do it:
// "Erase" DIB with black background color:
scanptr = (unsigned char*) pBits + skiplines * oldWidth * 4;
memset((void*) scanptr, 0, oldWidth * renderheight * 4);
// Really draw the textString: Rasterize!
DrawTextW(dc, textUniString, stringLengthChars, &trect, DT_NOCLIP | DT_NOPREFIX);
// Sync the GDI so we have a final valid bitmap after this call:
GdiFlush();
// Loop through the bitmap: Set the unused MSB of each 32 bit DWORD to a
// meaningful alpha-value for OpenGL.
bincolors[0] = (unsigned int)(incolors[0] * 255);
bincolors[1] = (unsigned int)(incolors[1] * 255);
bincolors[2] = (unsigned int)(incolors[2] * 255);
bincolors[3] = (unsigned int)(incolors[3] * 255);
scanptr = (unsigned char*) pBits + skiplines * oldWidth * 4;
for (i=0; i< oldWidth * renderheight; i++) {
*(scanptr++) = bincolors[0]; // Copy blue text color to blue byte.
*(scanptr++) = bincolors[1]; // Copy green text color to green byte.
// Copy red byte to alpha-channel (its our anti-aliasing alpha-value), but
// multiply with user spec'd alpha. This multiply-shift is a fast trick to
// get normalization of the 16 bit multiply:
colorkeyvalue = (unsigned char)((((unsigned int) *scanptr) * bincolors[3]) >> 8);
*(scanptr++) = bincolors[2]; // Copy red text color to red byte.
*(scanptr++) = colorkeyvalue; // Copy final alpha value to alpha byte.
}
// Save all GL state:
glPushAttrib(GL_ALL_ATTRIB_BITS);
// Setup alpha-blending for anti-aliasing, unless user script requests us to obey
// the global blending settings set via Screen('Blendfunction') - which may be
// suboptimal for anti-aliased text drawing:
if(!PsychPrefStateGet_TextAlphaBlending()) {
PsychGetAlphaBlendingFactorsFromWindow(winRec, &normalSourceBlendFactor, &normalDestinationBlendFactor);
PsychStoreAlphaBlendingFactorsForWindow(winRec, GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
}
PsychUpdateAlphaBlendingFactorLazily(winRec);
// Enable alpha-test against an alpha-value greater zero during blit. This
// This way, non-text pixels (with alpha equal to zero) are discarded.
glEnable(GL_ALPHA_TEST);
glAlphaFunc(GL_GREATER, 0);
// To conform to the OS/X behaviour, we only draw a background if user-defined alpha blending
// is enabled:
if(PsychPrefStateGet_TextAlphaBlending()) {
// Draw a background color quad:
// Set GL drawing color:
PsychSetGLColor(backgroundColor, winRec);
// Set default draw shader:
PsychSetShader(winRec, -1);
// Draw background rect:
PsychGLRect(boundingRect);
}
// Setup unpack mode and position for blitting of the bitmap to screen:
glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
// Blit it to screen: The GL_BGRA swizzles RGBA <-> BGRA properly:
scanptr = (unsigned char*) pBits + skiplines * oldWidth * 4;
// Disable draw shader:
PsychSetShader(winRec, 0);
// Which rendering path to choose?
if (GL_TEXTURE_2D == PsychGetTextureTarget(winRec)) {
// Only 2D power-of-two textures supported. We use the old fallback path
// which does not allow to apply geometric transformations to the drawn
// text. Only extremely old cards and drivers will take this path...
glRasterPos2i(0, (int) oldHeight - skiplines);
glPixelZoom(1,1);
glDrawPixels(oldWidth, renderheight, GL_RGBA, GL_UNSIGNED_BYTE, scanptr);
}
else {
// Rectangle textures supported. Use texture mapping onto a quad, so
// geometric transformations apply correctly:
glEnable(GL_TEXTURE_RECTANGLE_EXT);
glGenTextures(1, &myTexture);
glBindTexture(GL_TEXTURE_RECTANGLE_EXT, myTexture);
// Text(ure) filtering settings:
if (PsychPrefStateGet_TextAntiAliasing() > 0) {
// Use Bilinear filtering for nice rotated/scaled/transformed, anti-aliased text:
glTexParameteri(GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
glTexParameteri(GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
}
else {
// Use nearest neighbour sampling for non-anti-aliased text. Text appearance is
// already jagged in that case, and usercode usually disables anti-aliasing only
// if it wants us to not mess with text appearance in any way, e.g., for proper
// display of text inside a clut based color-palette index display. This is important
// to avoid artifacts on devices with color overlay planes like the CRS Bits+ / Bits# or
// the ViewPixx/DataPixx/ProPixx devices from VPixx.
glTexParameteri(GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
glTexParameteri(GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
}
glTexParameteri(GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
glTexParameteri(GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_REPLACE);
glTexImage2D(GL_TEXTURE_RECTANGLE_EXT, 0, GL_RGBA, (GLsizei) oldWidth, (GLsizei) renderheight, 0, GL_RGBA, GL_UNSIGNED_BYTE, scanptr);
// Submit textured quad with text to pipeline:
glBegin(GL_QUADS);
glTexCoord2d(0, renderheight); glVertex2d(0, oldHeight - skiplines - renderheight);
glTexCoord2d(oldWidth, renderheight); glVertex2d(oldWidth, oldHeight - skiplines - renderheight);
glTexCoord2d(oldWidth, 0); glVertex2d(oldWidth, oldHeight - skiplines);
glTexCoord2d(0, 0); glVertex2d(0, oldHeight - skiplines);
glEnd();
// Done with this texture:
glBindTexture(GL_TEXTURE_RECTANGLE_EXT, 0);
glDeleteTextures(1, &myTexture);
glDisable(GL_TEXTURE_RECTANGLE_EXT);
}
// Disable alpha test after blit:
glDisable(GL_ALPHA_TEST);
// Restore state:
if(!PsychPrefStateGet_TextAlphaBlending()) PsychStoreAlphaBlendingFactorsForWindow(winRec, normalSourceBlendFactor, normalDestinationBlendFactor);
glPopAttrib();
// Mark end of drawing op. This is needed for single buffered drawing:
PsychFlushGL(winRec);
// We jump directly to this position if text appears to be completely outside the window:
drawtext_noop:
// Update drawing cursor: Place cursor so that text could
// be appended right-hand of the drawn text.
// Get updated "cursor position":
GetCurrentPositionEx(dc, &xy);
*xp = xy.x;
*yp = xy.y;
// Restore to default font after text drawing:
SelectObject(dc, defaultFont);
// Done.
return(PsychError_none);
}
// End of Windows specific part...
#endif
// End of non-OS/X (= Linux & Windows) specific part...
#endif
// Load and initialize an external text renderer plugin: Called while OpenGL
// context from 'windowRecord' is bound and active. Returns true on success,
// false on error. Reverts to builtin text renderer on error:
psych_bool PsychLoadTextRendererPlugin(PsychWindowRecordType* windowRecord)
{
char pluginPath[FILENAME_MAX];
char pluginName[100];
char pluginid[5];
double tDur;
unsigned int retrycount = 0;
// Try to load plugin if not already loaded: The dlopen call will search in all standard system
// search paths, the $HOME/lib directory if any, and relative to the current working directory.
// The functions in the plugin will be linked immediately and if successfull, made available
// directly for use within the code, with no need to dlsym() manually bind'em:
if (NULL == drawtext_plugin) {
while ((NULL == drawtext_plugin) && (retrycount < ((PSYCH_SYSTEM == PSYCH_LINUX) ? 2 : 1))) {
if (PsychPrefStateGet_TextRenderer() == 1) {
// Standard ftgl or ftgles plugin for text renderer 1:
sprintf(pluginid, "ftgl");
}
else {
// Plugin with numeric id as given by text renderer setting:
snprintf(pluginid, sizeof(pluginid), "%i_", PsychPrefStateGet_TextRenderer());
}
// Assign name of plugin shared library based on target OS:
if (PSYCH_SYSTEM == PSYCH_OSX) {
// OS/X: Only 64-Bit OpenGL plugin.
sprintf(pluginName, "libptbdrawtext_%s64.dylib", pluginid);
}
if (PSYCH_SYSTEM == PSYCH_WINDOWS) {
#if !defined(_WIN64) && !defined(__LP64__)
// 32-Bit:
sprintf(pluginName, "libptbdrawtext_%s.dll", pluginid);
#else
// 64-Bit:
sprintf(pluginName, "libptbdrawtext_%s64.dll", pluginid);
#endif
}
if (PSYCH_SYSTEM == PSYCH_LINUX) {
// Linux: More machine architectures, also support for OpenGL-ES et al.:
// Try 32-Bit Intel, or Debian machine arch specific version first:
if (retrycount == 0) sprintf(pluginName, "libptbdrawtext_%s%s.so.1", pluginid, (PsychIsGLES(windowRecord)) ? "es" : "");
// ARM 32-Bit has its own version suffix, unless provided by Debian:
#if defined(__arm__) || defined(__thumb__)
if (retrycount == 0) sprintf(pluginName, "libptbdrawtext_%s%s_arm.so.1", pluginid, (PsychIsGLES(windowRecord)) ? "es" : "");
#endif
// ARM 64-Bit has its own version suffix, unless provided by Debian:
#if defined(__aarch64__)
if (retrycount == 0) sprintf(pluginName, "libptbdrawtext_%s%s_arm64.so.1", pluginid, (PsychIsGLES(windowRecord)) ? "es" : "");
#endif
// Retry on Intel with 64-Bit or 32-Bit specific plugin:
#if defined(__LP64__)
if (retrycount == 1) sprintf(pluginName, "libptbdrawtext_%s%s64.so.1", pluginid, (PsychIsGLES(windowRecord)) ? "es" : "");
#else
if (retrycount == 1) sprintf(pluginName, "libptbdrawtext_%s%s.so.1", pluginid, (PsychIsGLES(windowRecord)) ? "es" : "");
#endif
}
// Try to auto-detect install location of plugin inside the Psychtoolbox/PsychBasic folder.
// If we manage to find the path to that folder, we can load with absolute path and thereby
// don't need the plugin to be installed in a system folder -- No need for user to manually
// install it, works plug & play :-)
if (strlen(PsychRuntimeGetPsychtoolboxRoot(FALSE)) > 0) {
// Yes! Assemble full path name to plugin:
if (PSYCH_SYSTEM == PSYCH_WINDOWS) {
sprintf(pluginPath, "%sPsychBasic\\PsychPlugins\\%s", PsychRuntimeGetPsychtoolboxRoot(FALSE), pluginName);
}
else {
sprintf(pluginPath, "%sPsychBasic/PsychPlugins/%s", PsychRuntimeGetPsychtoolboxRoot(FALSE), pluginName);
}
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: DrawText: Trying to load external text renderer plugin from following file: [ %s ]\n", pluginPath);
}
else {
// Failed! Assign only plugin name and hope the user installed the plugin into
// a folder on the system library search path:
sprintf(pluginPath, "%s", pluginName);
if (PsychPrefStateGet_Verbosity() > 2) printf("PTB-INFO: DrawText: Failed to find installation directory for text renderer plugin [ %s ].\nHoping it is somewhere in the library search path...\n", pluginPath);
}
#if PSYCH_SYSTEM == PSYCH_WINDOWS
drawtext_plugin = LoadLibrary(pluginPath);
if (NULL == drawtext_plugin) {
// First - and only - try failed:
if (PsychPrefStateGet_Verbosity() > 1) {
printf("PTB-DEBUG: DrawText: Failed to load external drawtext plugin [%s].\n", (const char*) "Unknown error");
}
}
#else
drawtext_plugin = dlopen(pluginPath, RTLD_NOW | RTLD_GLOBAL);
if (NULL == drawtext_plugin) {
// First try failed: Need higher verbosity for debug output on Linux, as failure
// during first try is expected on 64-Bit Non-NeuroDebian Linux, due to the way
// probing is done.
if (PsychPrefStateGet_Verbosity() > ((PSYCH_SYSTEM == PSYCH_LINUX) ? 3 : 1)) {
printf("PTB-WARNING: DrawText: Failed to load external drawtext plugin [%s]. Retrying under generic name [%s].\n", (const char*) dlerror(), pluginName);
}
sprintf(pluginPath, "%s", pluginName);
drawtext_plugin = dlopen(pluginPath, RTLD_NOW | RTLD_GLOBAL);
}
#endif
retrycount++;
}
drawtext_plugin_firstcall = TRUE;
}
else {
drawtext_plugin_firstcall = FALSE;
}
// Successfully loaded and bound?
if (NULL == drawtext_plugin) {
// Failed! Revert to standard text rendering code below:
if (PsychPrefStateGet_Verbosity() > 1) {
#if PSYCH_SYSTEM != PSYCH_WINDOWS
printf("PTB-WARNING: DrawText: Failed to load external drawtext plugin '%s' [%s]. Reverting to legacy text renderer.\n", pluginName, (const char*) dlerror());
printf("PTB-WARNING: DrawText: Functionality of Screen('DrawText') and Screen('TextBounds') may be limited and text quality may be impaired.\n");
printf("PTB-WARNING: DrawText: Type 'help DrawTextPlugin' at the command prompt to receive instructions for troubleshooting.\n\n");
#else
printf("PTB-INFO: DrawText: Failed to load external drawtext plugin '%s'. Reverting to legacy GDI text renderer. 'help DrawTextPlugin' for troubleshooting.\n", pluginName);
#endif
}
// Switch to renderer zero, which is the legacy fallback renderer on all operating systems:
PsychPrefStateSet_TextRenderer(0);
// Return failure code:
return(FALSE);
}
// Plugin loaded. Perform first time init, if needed:
if (drawtext_plugin_firstcall) {
// Dynamically bind all functions to their proper plugin entry points:
#if PSYCH_SYSTEM != PSYCH_WINDOWS
PsychPluginInitText = dlsym(drawtext_plugin, "PsychInitText");
PsychPluginShutdownText = dlsym(drawtext_plugin, "PsychShutdownText");
PsychPluginSetTextFont = dlsym(drawtext_plugin, "PsychSetTextFont");
PsychPluginGetTextFont = dlsym(drawtext_plugin, "PsychGetTextFont");
PsychPluginSetTextStyle = dlsym(drawtext_plugin, "PsychSetTextStyle");
PsychPluginSetTextSize = dlsym(drawtext_plugin, "PsychSetTextSize");
PsychPluginSetTextFGColor = dlsym(drawtext_plugin, "PsychSetTextFGColor");
PsychPluginSetTextBGColor = dlsym(drawtext_plugin, "PsychSetTextBGColor");
PsychPluginSetTextUseFontmapper = dlsym(drawtext_plugin, "PsychSetTextUseFontmapper");
PsychPluginSetTextViewPort = dlsym(drawtext_plugin, "PsychSetTextViewPort");
PsychPluginDrawText = dlsym(drawtext_plugin, "PsychDrawText");
PsychPluginMeasureText = dlsym(drawtext_plugin, "PsychMeasureText");
PsychPluginSetTextVerbosity = dlsym(drawtext_plugin, "PsychSetTextVerbosity");
PsychPluginSetTextAntiAliasing = dlsym(drawtext_plugin, "PsychSetTextAntiAliasing");
PsychPluginSetAffineTransformMatrix = dlsym(drawtext_plugin, "PsychSetAffineTransformMatrix");
PsychPluginGetTextCursor = dlsym(drawtext_plugin, "PsychGetTextCursor");
#else
PsychPluginInitText = (void*) GetProcAddress(drawtext_plugin, "PsychInitText");
PsychPluginShutdownText = (void*) GetProcAddress(drawtext_plugin, "PsychShutdownText");
PsychPluginSetTextFont = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextFont");
PsychPluginGetTextFont = (void*) GetProcAddress(drawtext_plugin, "PsychGetTextFont");
PsychPluginSetTextStyle = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextStyle");
PsychPluginSetTextSize = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextSize");
PsychPluginSetTextFGColor = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextFGColor");
PsychPluginSetTextBGColor = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextBGColor");
PsychPluginSetTextUseFontmapper = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextUseFontmapper");
PsychPluginSetTextViewPort = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextViewPort");
PsychPluginDrawText = (void*) GetProcAddress(drawtext_plugin, "PsychDrawText");
PsychPluginMeasureText = (void*) GetProcAddress(drawtext_plugin, "PsychMeasureText");
PsychPluginSetTextVerbosity = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextVerbosity");
PsychPluginSetTextAntiAliasing = (void*) GetProcAddress(drawtext_plugin, "PsychSetTextAntiAliasing");
PsychPluginSetAffineTransformMatrix = (void*) GetProcAddress(drawtext_plugin, "PsychSetAffineTransformMatrix");
PsychPluginGetTextCursor = (void*) GetProcAddress(drawtext_plugin, "PsychGetTextCursor");
#endif
// Assign current level of verbosity:
PsychPluginSetTextVerbosity((unsigned int) PsychPrefStateGet_Verbosity());
// Try to initialize plugin, time duration of init:
tDur = PsychGetAdjustedPrecisionTimerSeconds(NULL);
if (PsychPluginInitText()) PsychErrorExitMsg(PsychError_internal, "Drawtext plugin, PsychInitText() failed!");
// If duration of init is longer than typically expected, this could mean some non-standard cache rebuild happened, e.g.,
// a libfontconfig cache rebuild. Point this out, with possible pointers for troubleshooting if it happens too often:
tDur = PsychGetAdjustedPrecisionTimerSeconds(NULL) - tDur;
if ((tDur > 5) && (PsychPrefStateGet_Verbosity() > 2)) {
printf("PTB-INFO: Screen('DrawText') plugin init took relatively long (%f seconds). If this happens frequently, then you might\n", tDur);
printf("PTB-INFO: have a problem with fontconfig caches on your system. Read 'help DrawTextPlugin' for troubleshooting info in that case.\n");
}
// Enable use of plugins internal fontMapper for selection of font file, face type and rendering
// parameters, based on the font/text spec provided by us:
PsychPluginSetTextUseFontmapper(1, 0);
}
// Return success:
return(TRUE);
}
// Common cleanup routine for all text renderers: Called from PsychCloseWindow() during
// window destruction while OpenGL context of 'windowRecord' is bound and active. Has to
// decide if any ressource cleanup work for window(s) has to be done and call into the
// OS/Engine specific cleanup routines:
void PsychCleanupTextRenderer(PsychWindowRecordType* windowRecord)
{
// Do we have allocated display lists for the display list renderers on MS-Windows or Linux
// for this onscreen window?
if (windowRecord->textAttributes.DisplayList > 0) {
// Yep. Destroy them:
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In PsychCleanupTextRenderer: Releasing display list text renderer resources for window %i.\n", windowRecord->windowIndex);
glDeleteLists(windowRecord->textAttributes.DisplayList, 256);
windowRecord->textAttributes.DisplayList=0;
}
// Is this the last open onscreen window about to be destroyed, ie., after closing this one, will there be
// no further onscreen windows?
if ((PsychCountOpenWindows(kPsychDoubleBufferOnscreen) + PsychCountOpenWindows(kPsychSingleBufferOnscreen)) == 1) {
// Yes. Time to shutdown the text renderer(s) and release all associated resources:
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// Release GDI based MS-Windows text renderer:
CleanupDrawtextGDI();
#endif
// Do we have an external text rendering plugin installed and initialized?
if (drawtext_plugin) {
// Yes.
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In PsychCleanupTextRenderer: Releasing text renderer plugin completely.\n");
// Call plugin shutdown routine for this window:
PsychPluginShutdownText((PsychGetParentWindow(windowRecord))->windowIndex);
// Call master shutdown:
PsychPluginShutdownText(-1);
#if PSYCH_SYSTEM != PSYCH_WINDOWS
// Jettison plugin:
dlclose(drawtext_plugin);
#else
FreeLibrary(drawtext_plugin);
#endif
drawtext_plugin = NULL;
}
}
else {
// Not the last onscreen window. Only do per window cleanup:
// Do we have an external text rendering plugin installed and initialized?
if (drawtext_plugin) {
// Yes.
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In PsychCleanupTextRenderer: Releasing text renderer plugin resources for window %i.\n", windowRecord->windowIndex);
// Call plugin shutdown routine for this window:
PsychPluginShutdownText((PsychGetParentWindow(windowRecord))->windowIndex);
}
}
return;
}
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// MS-Windows:
#include <locale.h>
// When building against Octave-3 or the Microsoft Windows common C runtime MSCRT.dll,
// we don't have support for _locale_t datatype and associated functions like mbstowcs_l.
// Therefore we always use setlocale() and mbstowcs() instead to set/query/use the global
// process-wide locale instead to avoid special cases. Our code will backup the old/current locale,
// then apply the requested locale and use it for text conversion, then restore the old locale,
// so that the process global locale setting is only temporarily changed during execution of our
// text conversion function on the main thread. This should hopefully be fine:
static char oldmswinlocale[256] = { 0 };
static char drawtext_localestring[256] = { 0 };
unsigned int drawtext_codepage = 0;
// PsychSetUnicodeTextConversionLocale():
//
// Set the character encoding locale setting which is used by PsychAllocInTextAsUnicode(),
// e.g., when Screen('DrawText') is called with a char() string argument.
//
// The locale setting defines how to map the given (multibyte-)sequence of byte-characters
// into unicode codepoints, i.e., how the given string is translated into unicode.
//
// 'mnewlocale' can be one of the following:
// NULL -- Shutdown conversion routines, free all associated resources. Called at Screen exit time.
// "" -- An empty string: Set locale to the system default locale, as defined by system settings or
// environment variables at application startup time. E.g., $LANG, $LC_CTYPE, $LC_ALL on Posix...
// "xx" -- Some text string with the name of a locale supported by the system, e.g., "C" for default C
// language locale, "en_US.ISO8859-1" for ISO8859-1 (Latin-1) encoding, "UTF-8" for UTF-8 multibyte
// unicode encoding. On Unix, see "man xlocale", "man multibyte" for explanation.
// See e.g., <http://msdn.microsoft.com/en-us/library/wyzd2bce(VS.80).aspx> for locale support on
// MS-Windows.
//
// Returns TRUE on success, FALSE on error.
psych_bool PsychSetUnicodeTextConversionLocale(char* mnewlocale)
{
unsigned int mycodepage;
// Was only destruction/release of current locale requested?
if (NULL == mnewlocale) {
drawtext_codepage = 0;
drawtext_localestring[0] = 0;
return(TRUE);
}
// Special # symbol to directly set a codepage provided?
if (strstr(mnewlocale, "#") && (sscanf(mnewlocale, "#%i", &mycodepage) > 0)) {
// Yes, parse numeric codepage id and assign it:
strcpy(drawtext_localestring, mnewlocale);
drawtext_codepage = mycodepage;
return(TRUE);
}
else {
// Special case "UTF-8" string provided?
if (PsychMatch(mnewlocale, "UTF-8")) {
// Yes: Switch to UTF-8 codepage:
strcpy(drawtext_localestring, mnewlocale);
drawtext_codepage = CP_UTF8;
return(TRUE);
}
}
// Setting of a new locale requested: Try to set it globally for the
// whole process, return success status:
drawtext_codepage = 0;
if (strlen(mnewlocale) < 1) {
// Special locale "" given: Set namestring to current system
// default locale:
strcpy(drawtext_localestring, setlocale(LC_CTYPE, NULL));
return(TRUE);
}
strcpy(drawtext_localestring, mnewlocale);
return(TRUE);
}
// PsychGetUnicodeTextConversionLocale():
//
// Get the character encoding locale setting string which is used by PsychAllocInTextAsUnicode(),
// e.g., when Screen('DrawText') is called with a char() string argument.
//
// Returns NULL on error, a const char* string with the current locale setting on success.
const char* PsychGetUnicodeTextConversionLocale(void)
{
return(&drawtext_localestring[0]);
}
#else
// POSIX systems Linux and OS/X:
#include <locale.h>
// On GLIBC systems, xlocale.h's stuff is available as part of locale.h:
#if !defined(__GLIBC__)
#include <xlocale.h>
#endif
static locale_t drawtext_locale = NULL;
static char drawtext_localestring[256] = { 0 };
#if PSYCH_SYSTEM == PSYCH_LINUX
size_t mbstowcs_l(wchar_t *dest, const char *src, size_t n, locale_t theLocale);
/* mbstowcs_l reimplementation, because mbstowcs_l is only supported on OS/X,
* not on Linux :-(
*/
size_t mbstowcs_l(wchar_t *dest, const char *src, size_t n, locale_t theLocale)
{
size_t rcsize;
locale_t oldloc;
// Query current locale of this thread, store it in oldloc, set new
// locale theLocale:
oldloc = uselocale(theLocale);
// Execute mbstowcs with theLocale assigned:
rcsize = mbstowcs(dest, src, n);
// Restore old locale setting oldloc:
uselocale(oldloc);
// Return whatever mbstowcs returned:
return(rcsize);
}
#endif
psych_bool PsychSetUnicodeTextConversionLocale(char* mnewlocale)
{
locale_t myloc = NULL;
// Was only destruction/release of current locale requested?
if (NULL == mnewlocale) {
// Destroy/Release old locale, if any:
if (drawtext_locale) {
freelocale(drawtext_locale);
drawtext_locale = NULL;
}
drawtext_localestring[0] = 0;
// Done after destruction:
return(TRUE);
}
// Setting of a new locale requested:
myloc = newlocale(LC_CTYPE_MASK, mnewlocale, NULL);
if (myloc) {
// Destroy/Release old locale, if any:
if (drawtext_locale) {
freelocale(drawtext_locale);
drawtext_locale = NULL;
}
drawtext_localestring[0] = 0;
if (strlen(mnewlocale) < 1) {
// Special locale "" given: Set namestring to current system
// default locale:
strcpy(drawtext_localestring, setlocale(LC_CTYPE, NULL));
}
else {
// Named locale given: Assign its namestring:
strcpy(drawtext_localestring, mnewlocale);
}
drawtext_locale = myloc;
return(TRUE);
}
// Failed! No settings changed:
return(FALSE);
}
const char* PsychGetUnicodeTextConversionLocale(void)
{
#if PSYCH_SYSTEM == PSYCH_OSX
return(querylocale(LC_CTYPE_MASK, drawtext_locale));
#else
return(&drawtext_localestring[0]);
#endif
}
#endif
// Allocate in a text string argument, either in some string or bytestring format or as double-vector.
// Return the strings representation as a double vector in Unicode encoding.
//
// 'position' the position of the string argument.
// 'isRequired' Is the string required or optional, or required to be of a specific type?
// 'textLength' On return, store length of text string in characters at the int pointer target location.
// 'unicodeText' On return, the double* to which unicodeText points, shall contain the start adress of a vector of
// doubles. Each double encodes the unicode value of one unicode character in the string. Length of
// the array as given in 'textLength'.
//
// Returns TRUE on successfull allocation of an input string in unicode format. FALSE on any error.
//
psych_bool PsychAllocInTextAsUnicode(int position, PsychArgRequirementType isRequired, int *textLength, double **unicodeText)
{
int dummy1, dummy2;
unsigned char *textByteString = NULL;
char *textCString = NULL;
wchar_t *textUniString = NULL;
int stringLengthBytes = 0;
// Anything provided as argument? This checks for presence of the required arg. If an arg
// of mismatching type (not char or double) is detected, it errors-out. Otherwise it returns
// true on presence of a correct argument, false if argument is absent and optional.
if (!PsychCheckInputArgType(position, isRequired, (PsychArgType_char | PsychArgType_double | PsychArgType_uint8))) {
// The optional argument isn't present. That means there ain't any work for us to do:
goto allocintext_skipped;
}
// Some text string available, either double vector or char vector.
// Text string at 'position' passed as C-language encoded character string or string of uint8 bytes?
if ((PsychGetArgType(position) == PsychArgType_char) || (PsychGetArgType(position) == PsychArgType_uint8)) {
// Try to allocate in as unsigned byte string:
if (PsychAllocInUnsignedByteMatArg(position, kPsychArgAnything, &dummy1, &stringLengthBytes, &dummy2, &textByteString)) {
// Yep: Convert to null-terminated string for further processing:
if (dummy2!=1) PsychErrorExitMsg(PsychError_user, "Byte text matrices must be 2D matrices!");
stringLengthBytes = stringLengthBytes * dummy1;
// Nothing to do on empty string:
if (stringLengthBytes < 1 || textByteString[0] == 0) goto allocintext_skipped;
// A bytestring. Is it null-terminated? If not we need to make it so:
if (textByteString[stringLengthBytes-1] != 0) {
// Not null-terminated: Create a 1 byte larger temporary copy which is null-terminated:
textCString = (char*) PsychMallocTemp(stringLengthBytes + 1);
memcpy((void*) textCString, (void*) textByteString, stringLengthBytes);
textCString[stringLengthBytes] = 0;
}
else {
// Already null-terminated: Nice :-)
textCString = (char*) textByteString;
}
}
else {
// Null terminated C-Language text string ie., a sequence of bytes. Get it:
PsychAllocInCharArg(position, TRUE, &textCString);
}
// Get length in bytes, derived from location of null-terminator character:
stringLengthBytes = (int) strlen(textCString);
// Empty string? If so, we skip processing:
if (stringLengthBytes < 1) goto allocintext_skipped;
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// Windows:
// Compute number of Unicode wchar_t chars after conversion of multibyte C-String:
if (drawtext_codepage) {
// Codepage-based text conversion:
*textLength = MultiByteToWideChar(drawtext_codepage, 0, textCString, -1, NULL, 0) - 1;
if (*textLength <= 0) {
printf("PTB-ERROR: MultiByteToWideChar() returned conversion error code %i.", (int) GetLastError());
PsychErrorExitMsg(PsychError_user, "Invalid multibyte character sequence detected! Can't convert given char() string to Unicode for DrawText!");
}
}
else {
// Locale-based text conversion:
// Create backup copy of currently set process global locale:
sprintf(oldmswinlocale, "%s", setlocale(LC_CTYPE, NULL));
// Set process global locale to wanted locale:
setlocale(LC_CTYPE, drawtext_localestring);
// Perform text conversion:
*textLength = (int) mbstowcs(NULL, textCString, 0);
// Reset process global locale to old setting:
setlocale(LC_CTYPE, oldmswinlocale);
}
#else
// Unix: OS/X, Linux:
*textLength = mbstowcs_l(NULL, textCString, 0, drawtext_locale);
#endif
if (*textLength < 0) PsychErrorExitMsg(PsychError_user, "Invalid multibyte character sequence detected! Can't convert given char() string to Unicode for DrawText!");
// Empty string provided? Skip, if so.
if (*textLength < 1) goto allocintext_skipped;
// Allocate wchar_t buffer of sufficient size to hold converted unicode string:
textUniString = (wchar_t*) PsychMallocTemp((*textLength + 1) * sizeof(wchar_t));
// Perform conversion of multibyte character sequence to Unicode wchar_t:
#if PSYCH_SYSTEM == PSYCH_WINDOWS
// Windows:
if (drawtext_codepage) {
// Codepage-based text conversion:
if (MultiByteToWideChar(drawtext_codepage, 0, textCString, -1, textUniString, (*textLength + 1)) <= 0) {
printf("PTB-ERROR: MultiByteToWideChar() II returned conversion error code %i.", (int) GetLastError());
PsychErrorExitMsg(PsychError_user, "Invalid multibyte character sequence detected! Can't convert given char() string to Unicode for DrawText!");
}
}
else {
// Set process global locale to wanted locale:
setlocale(LC_CTYPE, drawtext_localestring);
// Locale-based text conversion:
mbstowcs(textUniString, textCString, (*textLength + 1));
// Reset process global locale to old setting:
setlocale(LC_CTYPE, oldmswinlocale);
}
#else
// Unix:
mbstowcs_l(textUniString, textCString, (*textLength + 1), drawtext_locale);
#endif
// Allocate temporary output vector of doubles and copy unicode string into it:
*unicodeText = (double*) PsychMallocTemp((*textLength + 1) * sizeof(double));
for (dummy1 = 0; dummy1 < (*textLength + 1); dummy1++) (*unicodeText)[dummy1] = (double) textUniString[dummy1];
}
else {
// Not a character string: Check if it is a double matrix which directly encodes Unicode text:
PsychAllocInDoubleMatArg(position, TRUE, &dummy1, &stringLengthBytes, &dummy2, unicodeText);
if (dummy2!=1) PsychErrorExitMsg(PsychError_user, "Unicode text matrices must be 2D matrices!");
stringLengthBytes = stringLengthBytes * dummy1;
// Empty string? If so, we skip processing:
if(stringLengthBytes < 1) goto allocintext_skipped;
// Nope. Assign output arguments. We can pass-through the unicode double vector as it is
// already in the proper format:
*textLength = stringLengthBytes;
}
if (PsychPrefStateGet_Verbosity() > 9) {
printf("PTB-DEBUG: Allocated unicode string: ");
for (dummy1 = 0; dummy1 < *textLength; dummy1++) printf("%f ", (float) (*unicodeText)[dummy1]);
printf("\n");
}
// Successfully allocated a text string as Unicode double vector:
return(TRUE);
// We reach this jump-label via goto if there isn't any text string to return:
allocintext_skipped:
*textLength = 0;
*unicodeText = NULL;
return(FALSE);
}
void PsychDrawCharText(PsychWindowRecordType* winRec, const char* textString, double* xp, double* yp, unsigned int yPositionIsBaseline, PsychColorType *textColor, PsychColorType *backgroundColor, PsychRectType* boundingbox)
{
// Convert textString to Unicode format double vector:
unsigned int ix;
unsigned int textLength = (unsigned int) strlen(textString);
double theight = 0; // theight unused by PsychDrawCharText().
double xAdvance = 0; // xAdvance unused.
double* unicodeText = (double*) PsychCallocTemp(textLength + 1, sizeof(double));
for (ix = 0; ix < textLength; ix++) unicodeText[ix] = (double) textString[ix];
// Call Unicode text renderer:
PsychDrawUnicodeText(winRec, boundingbox, textLength, unicodeText, xp, yp, &theight, &xAdvance, yPositionIsBaseline, (textColor) ? textColor : &(winRec->textAttributes.textColor), (backgroundColor) ? backgroundColor : &(winRec->textAttributes.textBackgroundColor), 0);
// Done.
return;
}
PsychError PsychDrawUnicodeText(PsychWindowRecordType* winRec, PsychRectType* boundingbox, unsigned int stringLengthChars, double* textUniDoubleString, double* xp, double* yp, double* theight, double* xAdvance, unsigned int yPositionIsBaseline, PsychColorType *textColor, PsychColorType *backgroundColor, int swapTextDirection)
{
GLdouble backgroundColorVector[4];
GLdouble colorVector[4];
GLenum normalSourceBlendFactor, normalDestinationBlendFactor;
float xmin, ymin, xmax, ymax, _xadvance;
double myyp;
double dummy;
unsigned int i;
int ctx;
int rc = 0;
*xAdvance = 0;
// Invert text string (read it "backwards") if swapTextDirection is requested:
if (swapTextDirection) {
for(i = 0; i < stringLengthChars/2; i++) {
dummy = textUniDoubleString[i];
textUniDoubleString[i] = textUniDoubleString[stringLengthChars - i - 1];
textUniDoubleString[stringLengthChars - i - 1] = dummy;
}
}
// Does usercode want us to use a text rendering plugin instead of our standard OS specific renderer?
// If so, load it if not already loaded:
if ((PsychPrefStateGet_TextRenderer() > 0) && PsychLoadTextRendererPlugin(winRec)) {
// Use external dynamically loaded plugin:
// Get ctx context id for this window:
ctx = (int) (PsychGetParentWindow(winRec))->windowIndex;
// Assign current level of verbosity:
PsychPluginSetTextVerbosity((unsigned int) PsychPrefStateGet_Verbosity());
// Assign current anti-aliasing settings:
PsychPluginSetTextAntiAliasing(ctx, PsychPrefStateGet_TextAntiAliasing());
// Assign font family name of requested font:
PsychPluginSetTextFont(ctx, (const char*) winRec->textAttributes.textFontName);
// Assign style settings, e.g., bold, italic etc.:
PsychPluginSetTextStyle(ctx, winRec->textAttributes.textStyle);
// Assign text size in pixels:
PsychPluginSetTextSize(ctx, (double) winRec->textAttributes.textSize);
// Retrieve true text font family name:
sprintf((char*) &(winRec->textAttributes.textFontName[0]), "%s", PsychPluginGetTextFont(ctx));
// Assign viewport settings for rendering:
PsychPluginSetTextViewPort(ctx, winRec->clientrect[kPsychLeft], winRec->clientrect[kPsychTop], PsychGetWidthFromRect(winRec->clientrect), PsychGetHeightFromRect(winRec->clientrect));
// Compute and assign text background color:
PsychCoerceColorMode(backgroundColor);
PsychConvertColorToDoubleVector(backgroundColor, winRec, backgroundColorVector);
PsychPluginSetTextBGColor(ctx, backgroundColorVector);
// Compute and assign text foreground color - the actual color of the glyphs:
PsychCoerceColorMode(textColor);
PsychConvertColorToDoubleVector(textColor, winRec, colorVector);
PsychPluginSetTextFGColor(ctx, colorVector);
// Apply affine 2D transformation matrix if the plugin supports this:
if (PsychPluginSetAffineTransformMatrix)
PsychPluginSetAffineTransformMatrix(ctx, winRec->text2DMatrix);
// Enable this windowRecords framebuffer as current drawingtarget:
PsychSetDrawingTarget(winRec);
// Save all state:
glPushAttrib(GL_ALL_ATTRIB_BITS);
// Disable draw shader:
PsychSetShader(winRec, 0);
// Override current alpha blending settings to GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA unless
// usercode explicitely requested to use the regular Screen('Blendfunction') settings.
// This is needed to perform proper text anti-aliasing via alpha-blending:
if (!PsychPrefStateGet_TextAlphaBlending()) {
PsychGetAlphaBlendingFactorsFromWindow(winRec, &normalSourceBlendFactor, &normalDestinationBlendFactor);
PsychStoreAlphaBlendingFactorsForWindow(winRec, GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
}
// Apply blending settings:
PsychUpdateAlphaBlendingFactorLazily(winRec);
// Disable apple client storage - it could interfere:
#if PSYCH_SYSTEM == PSYCH_OSX
glPixelStorei(GL_UNPACK_CLIENT_STORAGE_APPLE, GL_FALSE);
#endif
// Compute bounding box of drawn string:
rc = PsychPluginMeasureText(ctx, stringLengthChars, textUniDoubleString, &xmin, &ymin, &xmax, &ymax, &_xadvance);
// Handle definition of yp properly: Is it the text baseline, or the top of the text bounding box?
if (yPositionIsBaseline) {
myyp = *yp;
}
else {
myyp = *yp + ymax;
}
// Only bounding box requested?
if (boundingbox) {
// Yes. Return it:
PsychMakeRect((double*) boundingbox, xmin + *xp, myyp - ymax, xmax + *xp, myyp - ymin);
*xAdvance = (double) _xadvance;
}
else {
// Draw text by calling into the plugin:
rc += PsychPluginDrawText(ctx, *xp, myyp, stringLengthChars, textUniDoubleString);
}
// Restore alpha-blending settings if needed:
if (!PsychPrefStateGet_TextAlphaBlending()) PsychStoreAlphaBlendingFactorsForWindow(winRec, normalSourceBlendFactor, normalDestinationBlendFactor);
// Restore GL state:
glPopAttrib();
// Mark end of drawing op. This is needed for single buffered drawing:
PsychFlushGL(winRec);
// Plugin rendering successfull?
if (0 == rc) {
// Yes. Update x position of text drawing cursor:
if (PsychPluginGetTextCursor) {
// Plugin provides accurate text cursor measurement - use it:
PsychPluginGetTextCursor(ctx, xp, yp, theight);
if (!yPositionIsBaseline)
*yp = *yp - ymax;
}
else {
// Fallback, leave yp, update xp via bounding box:
*xp = *xp + (xmax - xmin + 1);
}
// Return control to calling function:
return(PsychError_none);
}
// If we reach this point then the plugin failed to render text:
if (PsychPrefStateGet_Verbosity() > 0) {
printf("PTB-ERROR: Text rendering failed. The most likely cause for this is that no suitable text font could be found\n");
printf("PTB-ERROR: by libfontconfig. This is often the case when the fontconfig cache gets somehow corrupted, especially\n");
printf("PTB-ERROR: on Windows or macOS. Deleting that cache manually and restarting the application may help.\n");
printf("PTB-ERROR: See 'help DrawTextPlugin' for other causes of trouble and for troubleshooting instructions.\n");
}
PsychErrorExitMsg(PsychError_user, "The external text renderer plugin failed to render the text string for some reason!");
}
// If we reach this point then either text rendering via OS specific legacy renderer is requested, or
// the external rendering plugin failed to load and we use the OS specific legacy renderer as fallback.
return(PsychOSDrawUnicodeText(winRec, boundingbox, stringLengthChars, textUniDoubleString, xp, yp, yPositionIsBaseline, textColor, backgroundColor));
}
// Unified 'DrawText' routine, as called by Screen('DrawText', ...);
PsychError SCREENDrawText(void)
{
PsychWindowRecordType *winRec;
psych_bool doSetColor, doSetBackgroundColor;
PsychColorType colorArg, backgroundColorArg;
int yPositionIsBaseline, swapTextDirection;
int stringLengthChars;
double* textUniDoubleString = NULL;
double theight = 0;
double xAdvance = 0;
// All subfunctions should have these two lines.
PsychPushHelp(useString, synopsisString, seeAlsoString);
if (PsychIsGiveHelp()) { PsychGiveHelp(); return(PsychError_none); };
PsychErrorExit(PsychCapNumInputArgs(8));
PsychErrorExit(PsychRequireNumInputArgs(2));
PsychErrorExit(PsychCapNumOutputArgs(3));
//Get the window structure for the onscreen window.
PsychAllocInWindowRecordArg(1, TRUE, &winRec);
// Check if input text string is present, valid and non-empty, get it as double vector
// of unicode characters: If this returns false then there ain't any work for us to do:
if(!PsychAllocInTextAsUnicode(2, kPsychArgRequired, &stringLengthChars, &textUniDoubleString)) goto drawtext_skipped;
// Get the X and Y positions.
PsychCopyInDoubleArg(3, kPsychArgOptional, &(winRec->textAttributes.textPositionX));
PsychCopyInDoubleArg(4, kPsychArgOptional, &(winRec->textAttributes.textPositionY));
//Get the new color record, coerce it to the correct mode, and store it.
doSetColor = PsychCopyInColorArg(5, kPsychArgOptional, &colorArg);
if (doSetColor) PsychSetTextColorInWindowRecord(&colorArg, winRec);
// Same for background color:
doSetBackgroundColor = PsychCopyInColorArg(6, kPsychArgOptional, &backgroundColorArg);
if (doSetBackgroundColor) {
PsychSetTextBackgroundColorInWindowRecord(&backgroundColorArg, winRec);
} else {
// This just to coerce background color into proper format in case it hasn't been done already:
PsychSetTextBackgroundColorInWindowRecord(&(winRec->textAttributes.textBackgroundColor), winRec);
}
// Special handling of offset for y position correction:
yPositionIsBaseline = PsychPrefStateGet_TextYPositionIsBaseline();
PsychCopyInIntegerArg(7, kPsychArgOptional, &yPositionIsBaseline);
// Get optional text writing direction flag: Defaults to left->right aka 0:
swapTextDirection = 0;
PsychCopyInIntegerArg(8, kPsychArgOptional, &swapTextDirection);
// Call Unicode text renderer: This will update the current text cursor positions as well.
PsychDrawUnicodeText(winRec, NULL, stringLengthChars, textUniDoubleString, &(winRec->textAttributes.textPositionX), &(winRec->textAttributes.textPositionY), &theight, &xAdvance, yPositionIsBaseline, &(winRec->textAttributes.textColor), &(winRec->textAttributes.textBackgroundColor), swapTextDirection);
// We jump directly to this position in the code if the textstring is empty --> No op.
drawtext_skipped:
// Copy out new, potentially updated, "cursor position":
PsychCopyOutDoubleArg(1, FALSE, winRec->textAttributes.textPositionX);
PsychCopyOutDoubleArg(2, FALSE, winRec->textAttributes.textPositionY);
PsychCopyOutDoubleArg(3, FALSE, theight);
// Done.
return(PsychError_none);
}
PsychError SCREENTextTransform(void)
{
// If you change useString then also change the corresponding synopsis string in ScreenSynopsis.
static char useString[] = "oldMatrix = Screen('TextTransform', windowPtr [, newMatrix]);";
// 1 1 2
// Synopsis string for DrawText:
static char synopsisString[] =
"Query or assign a 2D matrix defining a 2D affine transformation to apply to drawn text.\n"
"'windowPtr' is the handle to the window for which the affine transform should be assigned "
"or queried.\n"
"'newMatrix' is an optional new 2x3 affine transformation matrix to assign.\n"
"'oldMatrix' is the currently assigned 2x3 affine transformation matrix.\n"
"The first 2 columns encode the 2x2 matrix, the 3rd column encodes tx, ty translation:\n"
"[ xx, xy, tx ]\n"
"[ yx, yy, ty ]\n\n"
"The affine transformation matrix defaults to an identity transformation matrix, "
"in other words, no affine transformation is applied to a window by default.\n"
"Not all text renderers do support application of affine transformations to text. If a "
"renderer does not support affine transformations then the selected affine transformation "
"is silently ignored during text drawing. As of February 2016 only the standard FTGL text "
"renderer supports affine transforms in a meaningful way. The legacy Apple OSX CoreText "
"renderer only supports transforms in a somewhat broken and limited manner, at drastically "
"reduced performance.\n"
"The precision of text bounding boxes as returned by Screen('TextBounds') may be impaired "
"if non-identity affine transformations are applied. Text positioning may also be impaired. "
"Different text renderers may provide inconsistent results wrt. text positioning and bounding "
"boxes.\n"
"In most cases it is better to use the general geometric stimulus post-processing of the "
"Psychtoolbox image processing pipeline to apply geometric transformations to text and other "
"visual content. This allows you to work in an easy to understand coordinate frame, with accurate "
"text positioning, bounding boxes etc. and apply a consistent transformation to both text and other "
"visual stimulus content as a post-processing step.\n";
static char seeAlsoString[] = "TextBounds TextSize TextFont TextStyle TextColor TextBackgroundColor Preference";
PsychWindowRecordType *winRec;
int m, n, p;
double* inMatrix;
double* outMatrix;
// All subfunctions should have these two lines.
PsychPushHelp(useString, synopsisString, seeAlsoString);
if (PsychIsGiveHelp()) { PsychGiveHelp(); return(PsychError_none); };
PsychErrorExit(PsychCapNumInputArgs(2));
PsychErrorExit(PsychRequireNumInputArgs(1));
PsychErrorExit(PsychCapNumOutputArgs(1));
//Get the window structure for the onscreen window.
PsychAllocInWindowRecordArg(1, TRUE, &winRec);
// Optionally return old transformation matrix:
PsychAllocOutDoubleMatArg(1, kPsychArgOptional, 2, 3, 1, &outMatrix);
*(outMatrix++) = winRec->text2DMatrix[0][0];
*(outMatrix++) = winRec->text2DMatrix[1][0];
*(outMatrix++) = winRec->text2DMatrix[0][1];
*(outMatrix++) = winRec->text2DMatrix[1][1];
*(outMatrix++) = winRec->text2DMatrix[0][2];
*(outMatrix++) = winRec->text2DMatrix[1][2];
// Optionally get new transformation matrix:
if (PsychAllocInDoubleMatArg(2, kPsychArgOptional, &m, &n, &p, &inMatrix)) {
if (m != 2 || n != 3 || p > 1)
PsychErrorExitMsg(PsychError_user, "Invalid affine transformation matrix 'newMatrix' provided! Not a 2-by-3 matrix.");
winRec->text2DMatrix[0][0] = *(inMatrix++);
winRec->text2DMatrix[1][0] = *(inMatrix++);
winRec->text2DMatrix[0][1] = *(inMatrix++);
winRec->text2DMatrix[1][1] = *(inMatrix++);
winRec->text2DMatrix[0][2] = *(inMatrix++);
winRec->text2DMatrix[1][2] = *(inMatrix++);
}
// Done.
return(PsychError_none);
}
|