README.jp 83.3 KB
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
-------------------------------------------------------------------------------
===============================================================================
	スプライトマイクロコード S2DEX ドキュメント
	
					Release 1.07
					Apr 10, 1998.
					Copyright (C) 1997-1998, Nintendo.
					任天堂株式会社開発第 3 部    安本吉孝
===============================================================================
-------------------------------------------------------------------------------
目次
	1. S2DEX マイクロコードとは

	2. S2DEX の機能
		2.1  描画プリミティブ
		2.2  自己ロード機能
		2.3  DEBUG 用マイクロコード
		2.4  RSP から RDP へのコマンドの受け渡し

	3. F3DEX との互換性
		3.1  S2DEX, F3DEX 双方でサポートされている GBI
		3.2  S2DEX ではサポートされていない GBI
		3.3  新たに追加された GBI
		3.4  GBI に関する注意事項

	4. S2DEX の GBI
		4.1  BG 描画 GBI
			4.1.1  uObjBg 構造体
				4.1.1.1  uObjBg_t 構造体
				4.1.1.2  uObjScaleBg_t 構造体
			4.1.2  gSPBgRectCopy
			4.1.3  gSPBgRect1Cyc

		4.2  Sprite 描画 GBI 
			4.2.1  uObjSprite 構造体
			4.2.2  uObjMtx/uObjSubMtx 構造体
			4.2.3  gSPObjRectangle
			4.2.4  gSPObjRectangleR
			4.2.5  gSPObjSprite

		4.3  2D マトリクス操作
			4.3.1  gSPObjMatrix
			4.3.2  gSPObjSubMatrix

		4.4  Object レンダーモード設定
			4.4.1  gSPObjRenderMode
			4.4.2  Sprite 描画時の RenderMode について

		4.5  テクスチャロード GBI
			4.5.1  uObjTxtr 構造体
			4.5.2  gSPObjLoadTxtr

		4.6  複合処理 GBI
			4.6.1  uObjTxSprite 構造体
			4.6.2  gSPObjLoadTxRect
			4.6.3  gSPObjLoadTxRectR
			4.6.4  gSPObjLoadTxSprite

		4.7  条件分岐 GBI
			4.7.1  gSPSetStatus
			4.7.2  gSPSelectDL
			4.7.3  gSPSelectBranchDL

	5. エミュレート関数
		5.1  guS2DEmuBgRect1Cyc
		5.2  guS2DEmuSetScissor

	6. DEBUG 情報出力機能

	7. S2DEX パッケージのインストール

	8. 変更履歴


-------------------------------------------------------------------------------
1. S2DEX マイクロコードとは.

  S2DEX マイクロコードは従来のゲームハードにおいてハードウェアで実現さ
れていたスプライトおよび BG 機能を Nintendo 64 (以下 N64) 上で使用でき
るようにするために開発されました. これによりスプライトゲームの作成が従
来よりも容易となります. また 描画オブジェクトを Sprite と BG 面という
概念で二分して扱うことで従来のスプライトゲーム作成方法になじみやすくなっ
ています.


-------------------------------------------------------------------------------
2. S2DEX の機能


---------------------
2.1 描画プリミティブ

  S2DEX は 2D 表現の処理に特化して, チューニングされているため,
Fast3D, F3DEX における 3D プリミティブの描画はサポートされなくなりまし
た. その代りに以下のようなプリミティブが, S2DEX マイクロコードで描画可
能となっています.
   
   1) Rectangle A -------- gSPObjRectangle,gSPObjRectangleR (Copy モード)

		固定サイズ. 拡大,縮小,回転共に不可
		テクスチャ縦横反転可能.
		Copy モードでの描画.
		テクスチャ補間表示, サブピクセル移動不可.
		AntiAlias 処理不可.
		テクスチャは既に TMEM へロードされていなければならない.

   2) Rectangle B -------- gSPObjRectangle,gSPObjRectangleR (1,2 Cycle モード)

		拡大縮小可能. 回転不可
		テクスチャ縦横反転可能.
		1,2 Cycle モードでの描画.
		テクスチャ補間表示, サブピクセル移動可能
		AntiAlias 処理可能.
		テクスチャは既に TMEM へロードされていなければならない.

   3) Sprite ------------- gSPObjSprite

		拡大,縮小,回転共に可能.
		テクスチャ縦横反転可能.
		Copy モードでの描画は不可.
		テクスチャ補間表示, サブピクセル移動可能
		AntiAlias 処理可能.
		テクスチャは既に TMEM へロードされていなければならない.

   4) BackGround(BG) A --- gSPBgRectCopy

		拡大,縮小不可.
		上下, 左右をそれぞれループさせた閉領域でのスクロールが可能.
		テクスチャ横反転のみ可能. 縦反転は不可.
		Copy モードでの描画専用.
		テクスチャ補間表示, サブピクセル移動不可.
		AntiAlias 処理不可.
		DRAM 上のテクスチャデータを GBI 側で逐次 TMEM にロードして描画

   5) BackGround(BG) B --- gSPBgRect1Cyc
		           CPU によるエミュレーションルーチンあり.

		拡大,縮小可能.
		上下, 左右をそれぞれループさせた閉領域でのスクロールが可能.
		テクスチャ横反転のみ可能. 縦反転は不可.
		1 Cycle モードでの描画専用.
		テクスチャ補間表示可能, 横方向のみサブピクセル移動可.
		AntiAlias 処理不可.
		DRAM 上のテクスチャデータを GBI 側で逐次 TMEM にロードして描画

   6) 従来の GBI の一部
		使用可能なもの
		    FillRectangle
		    TextureRectangle
		    TextureRectangleFlip
		使用不可なもの
		    1Triangle
		    2Triangle
		    1Quadrangle

  以上のように S2DEX では, 従来の Sprite2D マイクロコードとは機能の上
ではあまり類似性がありません. S2DEX は Sprite2Dの上位版というイメージ
ではなく, 全く新規のマイクロコードという位置づけになります. また 
spInit() などのスプライトライブラリは 3D マイクロコードを使用するため
S2DEX と組み合わせては使用できません. S2DEX はスプライトライブラリとは
別のものです.


--------------------
2.2  自己ロード機能

  S2DEX には前述した通り 3D プリミティブを描画する機能はありません. し
かし, F3DEX の Release 1.20 以降においてサポートされたマイクロコードの
自己ロード機能が S2DEX でも実装されています. このため F3DEX マイクロコー
ドをロードすることによって 3D プリミティブを描画することが可能となって
います.

  ただし, F3DEX マイクロコードは Release 1.22 以降または開発環境 
2.0I 以降のものでなければ S2DEX マイクロコードとの切り替えをサポートし
ておりませんのでご注意ください.


------------------------
2.3  DEBUG 情報出力機能

  S2DEX マイクロコードには, 2 種類のコードが用意されています.  1 つは, 
通常のゲーム出荷時に組み込まれるものであり, もう 1 つは, DEBUG 時に使
用するものです. DEBUG 用のマイクロコードは出荷用のものと比較して以下の
ような機能があります.

	o ディスプレイリストの処理ログの出力
	o 不正な入力値および不正なコマンドがあったときには RSP を終了
          させ, そのことを CPU へ伝える.

  詳しい使い方についでは, 後述します.


-----------------------------------------
2.4  RSP から RDP へのコマンドの受け渡し

  S2DEX では F3DEX シリーズと同様に fifo バージョンのみのサポートとなっ
ております. 

  ただし, S2DEX では要求される FIFO バッファのサイズが F3DEX シリーズ
より大きくなっています. F3DEX シリーズでは 0x300 bytes 以上である必要
がありますが, S2DEX では 0x800 bytes 以上でなければなりません. F3DEX 
シリーズと S2DEX とで FIFO バッファを共有したい場合は S2DEX の方にあわ
せ 0x800 bytes 以上にする必要があるのでご注意ください.

(*) 一部のマニュアルページでは _fifo のマイクロコードにおける FIFO サ
イズの最低値が 0x100 bytes となっていますが, それは誤りです. 必要な 
FIFO サイズは各マイクロコードによって異なります. F3DEX シリーズ, S2DEX 
では前述した通りで, Fast3D においては 0x180 bytes 必要です.


-------------------------------------------------------------------------------
3. F3DEX との互換性

  S2DEX の GBI は F3DEX から派生したものです. そのため Fast3D の GBI 
との互換性はありません. S2DEX を使用する場合は F3DEX と同様に 
F3DEX_GBI を ultra64.h がインクルードされる前に定義しておく必要があり
ます.

  また S2DEX の GBI を使用するためには, ヘッダファイル <PR/gs2dex.h> 
をインクルードする必要があります. このインクルード指定は <ultra64.h> 
インクルード指定の後に挿入してください.

  ここで S2DEX の GBI を F3DEX と対比させて説明します. 大まかなイメー
ジとしては 3D プリミティブの操作, 4x4 マトリクスの操作, ライトの定義に
関する GBI が S2DEX ではサポートされていないと考えればよいでしょう. 

  以下は gSP*, gDP* のみ表記していますが対応する gsSP*, gsDP* について
も同様です.


----------------------------------------------
3.1  S2DEX,F3DEX 双方でサポートされている GBI

  ---------------------------------------------------------------------
  DL 処理制御		gSPDisplayList(*)	gSPBranchList
			gSPEndDisplayList

  セグメント設定	gSPSegment(*)

  マイクロコードロード	gSPLoadUcode*

  シザリング		gDPSetScissor		gDPSetScissorFrac

  RDP モード設定	gSPSetOtherMode		gDPSetCycleType
			gDPSetTexturePersp	gDPSetTextureDetail
			gDPSetTextureLOD	gDPSetTextureLUT
			gDPSetTextureFilter	gDPSetTextureConvert
			gDPSetCombineKey	gDPSetColorDither
			gDPSetAlphaDither	gDPSetBlendMask
			gDPSetAlphaCompare	gDPSetDepthSource
			gDPSetRenderMode	gDPSetColorImage
			gDPSetDepthImage	gDPSetTextureImage
			gDPSetCombineMode

  カラー値等の設定	gDPSetEnvColor		gDPSetBlendColor
			gDPSetFogColor		gDPSetFillColor
			gDPSetPrimColor		gDPSetPrimDepth
			gDPSetConvert		gDPSetKeyR
			gDPSetKeyGB

  TMEM へのロード	gDPSetTileSize		gDPLoadTile
			gDPSetTile		gDPLoadTextureBlock*
			gDPLoadMultiBlock*	gDPLoadTextureTile*
			gDPLoadMultiTile*	gDPLoadTLUT_pal16
			gDPLoadTLUT_pal256

  プリミティブ		gDPFillRectangle	gDPScisFillRectangle
			gSPTextureRectangle	gSPScisTextureRectangle
			gsSPTextureRectangleFlip

  Sync 処理		gDPFullSync		gDPTileSync
			gDPPipeSync		gDPLoadSync

  NOOP			gSPNoOp			gDPNoOp
			gDPNoOpTag
  ---------------------------------------------------------------------
	(*) S2DEX は F3DEX と同じく gSPSegment によるセグメント数は 16,
	    gSPDisplayList による DL リンク数は 18 となっています.


----------------------------------------
3.2  S2DEX ではサポートされていない GBI

  ---------------------------------------------------------------------
  視野の設定		gSPViewport		gSPClipRatio
			gSPPerspNormalize

  マトリクス操作	gSPMatrix		gSPPopMatrix
			gSPInsertMatrix		gSPForceMatrix

  頂点操作		gSPVertex		gSPModifyVertex

  条件分岐		gSPCullDisplayList	gSPBranchLessZ*

  ポリゴン種設定	gSPSetGeometryMode	gSPClearGeometryMode
			gSPTexture		gSPTextureL

  プリミティブ		gSP1Triangle		gSP2Triangles
			gSP1Quadrangle		gSPLine3D
			gSPLineW3D

  ライティング		gSPNumLights		gSPLight
			gSPLightColor		gSPSetLights[0-7]
			gSPLookAt*		gDPSetHilite1Tile
			gDPSetHilite2Tile

  フォグ		gSPFogFactor		gSPFogPosition

  旧 Sprite2D 用	gSPSprite2DBase		gSPSprite2DScaleFlip
			gSPSprite2DDraw
  ---------------------------------------------------------------------


--------------------------
3.3  新たに追加された GBI

  ---------------------------------------------------------------------
  BG 描画		gSPBgRectCopy		gSPBgRect1Cyc
	
  Sprite 描画		gSPObjRectangle		gSPObjRectangleR
			gSPObjSprite

  2D マトリクス操作	gSPObjMatrix		gSPObjSubMatrix

  描画モード設定	gSPObjRenderMode

  Load Texture 処理	gSPObjLoadTxtr

  複合命令		gSPObjLoadTxRect	gSPObjLoadTxRectR
			gSPObjLoadTxSprite

  条件分岐		gSPSelectDL		gSPSelectBranchDL
  ---------------------------------------------------------------------


--------------------------
3.4  GBI に関する注意事項

  * OtherMode によるモードの書換えについて.

     F3DEX では g[s]SPSetOtherMode を使用し, モードの変更を行なう場合, 
   1 つの g[s]SPSetOtherMode コマンドで最大 31 bits 分の設定しかできま
   せんでした. S2DEX では 1 つのコマンドで 32 bit 分のパラメータを一度
   に変更できるように修正しました.

     また, F3DEX では, モードの書換えを行なうときに g[s]DPSetOtherMode
   コマンドと g*SPSetOtherMode 系のコマンドを混ぜて使用すると正常に動
   作が行なわれませんでした. (g*SPSetOtherMode で正常な設定が行なわれ
   ない) これを S2DEX では混在できるように修正しました.


-------------------------------------------------------------------------------
4. S2DEX の GBI


-----------------	
4.1  BG 描画 GBI

  S2DEX には従来のゲームハードに備わっていた上下, 左右をそれぞれループ
させた閉領域でのスクロール面を容易に作成するための機能が備わっています.
これによって 2D Mario のようなスクロールゲームを作るのに要する手間がか
なり軽減することになるでしょう.


---------------------
4.1.1  uObjBg 構造体

  uObjBg 構造体は BG の描画情報を保持したものです. BG 描画 GBI の引数と
してこの構造体へのポインタを与えます.

  uObjBg 構造体は, 正確には 3 つの構造体の共用体となっています. 1 つは
構造体を 8 bytes 境界に整列させるためのものなので, 注意を払う必要はあ
りません.  残りの 2 つはそれぞれ, 後述する 2 つの BG 描画 GBI に対応し
たデータ構造を持っています. 

  4.1.2 で述べる Copy モードによる BG 描画 GBI に対応する構造体が 
uObjBg_t であり, 4.1.3 で述べる 1 Cycle モードによる BG 描画 GBI に対
応する構造体が uObjScaleBg_t となっています.

 --------------------------------------------------------------------------
  typedef union {
    uObjBg_t        b;
    uObjScaleBg_t   s;
    long long int   force_structure_alignment;
  } uObjBg;
 --------------------------------------------------------------------------


-------------------------
4.1.1.1  uObjBg_t 構造体

  uObjBg_t 構造体のメンバーは前半と後半の 2 つのグループに分けることが
できます.

  前半ははユーザが直接設定するメンバー変数です. この値を制御することで 
BG 面の描画をコントロールします. この前半部は uObjScaleBg_t 構造体と共
用できます.

  それに対して後半は, マイクロコードの手助けをするために CPU が予め値
を計算しておく必要があるメンバー変数です. このメンバー変数は uObjBg 構
造体へのポインタを引数として関数 guS2DInitBg() を呼び出すことで設定さ
れます. ただし, 毎回 guS2DInitBg 呼び出す必要はありません.

  後半のメンバー変数は 前半のメンバー変数である imageLoad, imageFmt,
imageSiz, imageW, frameW から導き出されるため, guS2DInitBg を呼び出す
必要があるのは, これらの値が変化した直後のみとなります. 

  通常, uObjBg を BG 面として使用する場合, これらの値を頻繁に変更する
ことはないので BG 面を使用する前に一度だけ guS2DInitBg を呼び出せば十
分でしょう.

  ただし, uObjBg_t 構造体と共用体になっている uObjScaleBg_t 構造体を使
用し, uObjBg のデータを変更した場合, 具体的には uObjScaleBg_t 構造体の
メンバ変数 scaleW, scaleH, imageYorig を変更した場合, uObjBg_t の後半
のメンバー変数が書換えられてしまうことがあります. このような場合には 
guS2DInitBg を再度呼び出す必要があるでしょう.

  以下はヘッダファイル gs2dex.h 内の uObjBg の定義部分です. uObjBg の
サイズは 40 bytes で, uObjBg は 8 byte で整列されていなければなりませ
ん.

  前半のメンバーについては実際の GBI の解説の項目で説明します. メンバー
変数の並びが少し複雑ですが, これは RSP の処理の最適化による都合上やむ
を得ないものですので, ご了承くださるようお願い致します.

  S2DEX Release 1.00 以降, メンバー変数 imagePal, imageFlip の型が
u8 から u16 へ変更になりましたのでご注意ください.

 --------------------------------------------------------------------------
  typedef struct  {
    u16   imageX;         // BG image の左上位置 X 座標 (u10.5)
    u16   imageW;         // BG image の幅              (u10.2)
    s16   frameX;         // 転送フレームの左上位置     (s10.2)
    u16   frameW;         // 転送フレームの幅           (u10.2)

    u16   imageY;         // BG image の左上位置 Y 座標 (u10.5)
    u16   imageH;         // BG image の高さ            (u10.2)       
    s16   frameY;         // 転送フレームの左上位置     (s10.2)
    u16   frameH;         // 転送フレームの高さ         (u10.2)
  
    u64  *imagePtr;       // BG image 左上位置のテクスチャアドレス  
    u16   imageLoad;      // LoadBlock, LoadTile のどちらを使用するか
    u8    imageFmt;       // BG image のフォーマット    G_IM_FMT_*   
    u8    imageSiz;       // BG image のサイズ          G_IM_SIZ_*   
    u16   imagePal;       // パレット番号                        
    u16   imageFlip;      // イメージの左右反転 G_BG_FLAG_FLIPS で反転
    // ここまでが uObjScaleBg_t と共通
  
    // 以下は初期化ルーチン guS2DInitBg() 内で設定されるのでユーザが設
    // 定する必要はない
    u16   tmemW;          // frame 1 ラインの TMEM 幅 Word サイズ
                          // LoadBlock の時 GS_PIX2TMEM(imageW/4,imageSiz)
                          // LoadTile  の時 GS_PIX2TMEM(frameW/4,imageSiz)+1
    u16   tmemH;          // 一度にロードできる TMEM 高さ (s13.2) 4倍値
                          // 通常テクスチャの時   512/tmemW*4
                          // CI  テクスチャの時   256/tmemW*4
    u16   tmemLoadSH;     // SH 値
                          // LoadBlock の時 tmemSize/2-1
                          // LoadTile  の時 tmemW*16-1       
    u16   tmemLoadTH;     // TH 値 or Stride 値
                          // LoadBlock の時 GS_CALC_DXT(tmemW)
                          // LoadTile  の時 tmemH-1
    u16   tmemSizeW;      // image 1 ライン分の imagePtr のスキップ値 
                          // LoadBlock の時 tmemW*2
                          // LoadTile  の時 GS_PIX2TMEM(imageW/4,imageSiz)*2
    u16   tmemSize;       // ロード一回分の imagePtr のスキップ値 
                          // = tmemSizeW*tmemH
  } uObjBg_t;             // 40 bytes
 --------------------------------------------------------------------------

  初期化関数 guS2DInitBg の定義です.
 --------------------------------------------------------------------------
	void    guS2DInitBg(uObjBg *bg);

	説明:   uObjBg 構造体 (uObjBg_t) の初期化を行なう. 
		gSPBgRectCopy GBI によって uObjBg_t を描画する場合に使
		用する. 呼び出すのは uObjBg_t に初期値を代入した直後, 
		およびメンバー変数 imageLoad, imageFmt, imageSiz, imageW,
		imageH の幾つかを変更した直後となる.

	引数:	bg	uObjBg 構造体へのポインタ

	注意:	uObjScaleBg_t 構造体を使用するときはこの関数を呼び出しては
		いけない. (uObjScaleBg_t のメンバーの値を破壊する)	
 --------------------------------------------------------------------------

-------------------------
4.1.1.2  uObjScaleBg_t 構造体

  uObjScaleBg_t 構造体のメンバーは uObjBg_t のように CPU で値を予め計
算しておく必要のあるメンバー変数はありません. 全てのメンバー変数はユーザ
によって直接設定され, これによって BG 面の描画をコントロールします.

  また uObjBg 構造体によって共用されている場合, uObjScaleBg_t 構造体の
メンバー変数 imageX から imageFlip までが uObjBg_t 構造体と共用される
ことになります.

 --------------------------------------------------------------------------
  typedef struct  {
    u16   imageX;         // BG image の左上位置 X 座標 (u10.5)
    u16   imageW;         // BG image の幅              (u10.2)
    s16   frameX;         // 転送フレームの左上位置     (s10.2)
    u16   frameW;         // 転送フレームの幅           (u10.2)

    u16   imageY;         // BG image の左上位置 Y 座標 (u10.5)
    u16   imageH;         // BG image の高さ            (u10.2)       
    s16   frameY;         // 転送フレームの左上位置     (s10.2)
    u16   frameH;         // 転送フレームの高さ         (u10.2)
  
    u64  *imagePtr;       // BG image 左上角のテクスチャアドレス  
    u16   imageLoad;      // LoadBlock, LoadTile のどちらを使用するか
    u8    imageFmt;       // BG image のフォーマット    G_IM_FMT_*   
    u8    imageSiz;       // BG image のサイズ          G_IM_SIZ_*   
    u16   imagePal;       // パレット番号                        
    u16   imageFlip;      // イメージの左右反転 G_BG_FLAG_FLIPS で反転
    // ここまで uObjBg_t と共通

    u16   scaleW;         // X 方向スケール値               (u5.10)
    u16   scaleH;         // Y 方向スケール値               (u5.10)
    s32   imageYorig;     // image における描画始点         (s20.5)
    
    u8    padding[4];
  } uObjScaleBg_t;        // 40 bytes
 --------------------------------------------------------------------------


----------------------
4.1.2  gSPBgRectCopy

	----------------------------------------------------------
	 gSPBgRectCopy(Gfx *gdl, uObjBg *bg)
	 gsSPBgRectCopy(uObjBg *bg)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjBg		*bg;	BG の描画データ構造体へのポインタ
	----------------------------------------------------------

  g[s]SPBgRectCopy は S2DEX が提供する BG 面描画 GBI の 1 つで, 最も単
純なものです. これは以下のような特徴をもっています. 

	----------------------------------------------------------------
	 拡大,縮小不可.
	 上下, 左右をそれぞれループさせた閉領域でのスクロールが可能.
	 テクスチャ横反転のみ可能. 縦反転は不可.
	 Copy モードでの描画専用.
	 テクスチャ補間表示, サブピクセル移動不可.
	 AntiAlias 処理不可.
	 DRAM 上のテクスチャデータを GBI 側で逐次 TMEM にロードして描画
	----------------------------------------------------------------

  Copy モードでの描画を前提としているので最も高速であるということが最
大の利点です. そのためこの GBI を使用するときには CycleType が Copy モー
ドになっている必要があります.

  S2DEX における BG 機能は以下のように BG image バッファから, 実際のフ
レームバッファ上の矩形領域へデータを転送するものです. このときのフレー
ムバッファ矩形領域(以下 転送フレーム)の左上角が BG image バッファのど
こと対応するかを imageX, imageY で指定することでスクロールが可能となり
ます. この imageX, imageY は (u10.5) フォーマットで指定できるようになっ
ていますが Copy モード使用における制限上, imageX, imageY の値は整数値に
丸められます.


        BG image                       Color Frame Buffer
                                     +--------------------+
     +------------+  ^               |(frameX,frameY)     |
     |  |         |  |               |   *------------+ ^ |
     |--*---------|  |               |   |            | | |
     |  |(imageX, | imageH           |   |            | | |
     |  | imageY) |  |               |   |            |frameH
     |  |         |  |               |   |            | | | 
     +------------+  v               |   |転送フレーム| | |
     <-- imageW -->                  |   +------------+ v |
                                     |   <-- frameW -->   |
                                     +--------------------+

  BG image の大きさは imageW, imageH で設定し, 先頭アドレス (左上角の
アドレス) を imagePtr で指定します. すなわち, BG image はアドレス 
imagePtr を先頭とする幅 imageW 高さ imageH の大きなテクスチャデータと
見なすことができます.

  BG image の横幅 imageW は 8 bytes で整列させねばなりません. 実際に使
用する imageW, imageH の値は (u10.2) フォーマットなので実際は 4 倍の値
を代入する必要があります. (u10.2) フォーマットを考慮し 4 倍化した時の 
imageW の制限は具体的に以下のようになります. imageH の整列は必要ありま
せん.

       ---------------------------------------------
	G_IM_SIZ_4b  の場合:	imageW は 64 の倍数
	G_IM_SIZ_8b  の場合:	imageW は 32 の倍数
	G_IM_SIZ_16b の場合:	imageW は 16 の倍数
	G_IM_SIZ_32b の場合:	imageW は  8 の倍数
       ---------------------------------------------

  また横スクロールをする場合には, imageW は frameW よりも大きくなければ
なりません. 以下の値は (u10.2) フォーマットを考慮した値です. G_IM_SIZ_16b
の時には 4 Pixel 大きくなければなりません.

       ---------------------------------------------
	G_IM_SIZ_4b  の場合:	frameW+64 <= imageW
	G_IM_SIZ_8b  の場合:	frameW+32 <= imageW
	G_IM_SIZ_16b の場合:	frameW+16 <= imageW
	G_IM_SIZ_32b の場合:	frameW+ 8 <= imageW
       ---------------------------------------------
  

  転送フレームの大きさは frameW, frameH で指定し, 転送フレームの左上角
のスクリーン上の位置を frameX, frameY で指定します. frameW/frameH の
パラメータは (u10.2) フォーマットで frameX/frameY のパラメータは (s10.2)
フォーマットです. すなわち frameX, frameY の値として負の数字も指定可
能で, もし g[s]DPSetScissor で指定したシザーボックスから転送フレームが
はみ出した場合, マイクロコードは, はみ出た部分をクリップします.

  BG image が転送フレームより大きくても問題はありませんが, 逆に転送フ
レームの方が BG image より大きい場合の動作は保証できません. 転送フレー
ムが BG image より大きくならないよう注意してください.

  また BG image の右端と左端は Y 方向に 1 段分ずれて繋がっています. 具
体的にはBG image 上の右端のピクセル (imageW-1, n) の 1 ピクセル右側は 
(0, n+1) となります. これは Texture のロードにおける RDRAM のアクセス
効率を向上させるために必要です. アプリケーションを作られる方はこのこと
に十分注意してください.

  BG image におけるテクスチャのフォーマットおよびサイズは imageFmt と 
imageSiz にそれぞれマクロ G_IM_FMT_*, G_IM_SIZ_* を用いて代入します.
また CI4 テクスチャを使用する場合は imagePal に TLUT の番号を指定します.

  BG image においてテクスチャロード方法として 2 種類の方式があります.
LoadBlock を使用する方法と LoadTile を使用する方法です.  この 2 つの方
法にはそれぞれ一長一短があるため, 本 GBI においては, この 2 種類のロー
ド方法をユーザーがメンバー変数 imageLoad により選択出来るようになって
います. 以下の値 (G_BGLT_*) を imageLoad に代入します.

	---------------------------------------------
	 imageLoad の値		意味
	 G_BGLT_LOADBLOCK	LoadBlock を使用する		
	 G_BGLT_LOADTILE	LoadTile  を使用する		
	---------------------------------------------
  
  LoadBlock を使用する方法はある条件下において最大のパフォーマンスを発
揮しますが, その条件が満たされない場合には使用できなかったり, 処理に対
するオーバーヘッドが大きくなってしまったりします. それに対し LoadTile 
はいかなる場合にも適度なパフォーマンスで処理を行ないます. そのため 
LoadBlock が有効に動作する条件下では, LoadBlock を使用し, それ以外の場
合は LoadTile を使用するというように切り替えることをお勧めします.

  LoadBlock の使用時の条件とは使用可能な BG image の横幅に制限があると
いうことです. LoadBlock で処理可能な imageW の値は imageSiz が 16bit 
の場合以下の通りです.

	  4,  8, 12, 16, 20, 24, 28, 32, 36, 40,
	 48, 64, 72, 76,100,108,128,144,152,164,
	200,216,228,256,304,328,432,456,512,684,
	820,912

  imageSiz が 8bit の場合は上記の数列の各項をそれぞれ 2 倍したときの数
列が使用可能な imageW の値となります. 同様に 4bit の場合は 4 倍, 32bit 
の場合は 1/2 にした数列となります. これは N64 プログラミングマニュアル
の 13 章 付録 A の "LoadBLock コマンドで転送できる行数の限界" の表と一
致します. BG image の幅が LoadBlock で処理できない場合は LoadTile を使
用するしかありません.

  LoadBlock は転送フレームの 1 ラインを描画するために, 対応する BG
image の 1 ライン分全てを読み込みます. 通常のスクロールする BG 面は BG 
の更新用の領域のため少し大きめに BG image を用意する必要があるので,
imageW > frameW とします. このために LoadBlock を使用すると余分なデー
タをロードすることになります.

  それに対し LoadTile は必要な分のデータのみしかロードしませ
ん. LoadBlock コマンドは LoadTile コマンドより高速に処理されるため, こ
の差が数ピクセルなら LoadBlock の方が有利となりますが, imageW が 
frameW よりかなり大きい場合には, この余分なロード処理は大きなオーバー
ヘッドとなり, LoadTile を使用した方が有利となる場合があります. この点
を考慮し, どちらを使用するかを選択する必要があるでしょう.

  具体的な例として画面全体 (320x240) を覆う BG 面を定義するとします.

  まず転送フレームは画面全体ですから frameW = 320 pixel となります. そ
して BG 更新用エリア分として 8 pixel を用意すると imageW = 328 pixel 
となります.  この場合は, frameW と imageW の差は僅かなので LoadBlock 
を 328 pixel で使用すれば良いでしょう. 

  本 GBI では BG image の横方向のみの反転をサポートしています.  メンバー
変数 imageFlip に G_BG_FLAG_FLIPS を代入するとテクスチャイメージが反転
します. 通常の表示 (反転なし) の場合は 0 を代入しておいてください.


----------------------
4.1.3  gSPBgRect1Cyc

	----------------------------------------------------------
	 gSPBgRect1Cyc(Gfx *gdl, uObjBg *bg)
	 gsSPBgRect1Cyc(uObjBg *bg)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjBg		*bg;	BG の描画データ構造体へのポインタ
	----------------------------------------------------------

  g[s]SPBgRect1Cyc は S2DEX が提供する BG 面描画 GBI の 1 つで, BG 面
を拡大縮小させることができます. この特徴を以下に示します.

	----------------------------------------------------------------
	 拡大,縮小可能.
	 上下, 左右をそれぞれループさせた閉領域でのスクロールが可能.
	 テクスチャ横反転のみ可能. 縦反転は不可.
	 1 Cycle モードでの描画専用.
	 テクスチャ補間表示可能, 横方向のみサブピクセル移動可.
	 AntiAlias 処理不可.
	 DRAM 上のテクスチャデータを GBI 側で逐次 TMEM にロードして描画
	----------------------------------------------------------------

  この GBI は Copy モードでは使用できないということに注意してください.

  g[s]SPBgRect1Cyc で描画のために必要なパラメータは 4.1.2 で述べた 
g[s]SPBgRectCopy を使用するときに必要なパラメータに scaleW, scaleH,
imageYorig を追加したものです. g[s]SPBgRectCopy と共通なパラメータにつ
いての説明は 4.1.2 章を参照してください. ここでは追加されたパラメータ
について解説します.

  g[s]SPBgRect1Cyc の g[s]SPBgRectCopy との大きな違いは, BG のスケーリ
ングをサポートしている点です. BG のスケーリングは uObjScaleBg_t 構造体
のメンバー変数の scaleW, scaleH で制御します. このときのスケーリングの
中心は Bg image 上の (imageX, imageY) となります.

  すなわち, スケーリングした場合においても Bg image の (imageX,
imageY) は無スケーリング時と同様にフレームバッファ上の (frameX,
frameY) の位置に描画されます. (ただし, 左右反転時はフレームバッファ上
の (frameX+frameW-1, frameY) の位置に描画されます.)

  また拡大時には, フレームのサイズでイメージはクランプされます. また逆
に縮小時にはイメージのサイズによってフレームがクランプされる場合があり
ます. これについては S2DEX のサンプルプログラムを参考にしてください.

  ただし縮小時におけるフレームのクランプは, 計算誤差のため僅かに大きく, 
または小さくなる場合があります. 厳密なサイズを必要とされる場合は, CPU 
側で frameW, frameH の値を計算し設定してください.

  g[s]SPBgRect1Cyc では image のバイリニア補間表示をサポートしています.
バイリニア補間表示を使用すると, 通常のポイントサンプリング表示と比べ, 
拡大時におけるテクセルのギザギザは目立たなくなり, 見た目に滑らかになり
ます. ただし, この効果は縮小時において小さくなります. 

  バイリニア補間を使用する場合は, 使わない場合と比べて RDP の描画パフォー
マンスが低下します. この低下率は TMEM 内に一度にロードできる image ラ
イン数が少ないほど大きくなるため, 320x240 の frame に 320x240 の image 
を等倍で描画する場合と, 640x480 の image を 1/2 に縮小して描画する場合
とを比較すると 640x480 の image を縮小する方がバイリニア補間を使用する
ことによるオーバーヘッドの割合は大きくなり, ポイントサンプリングによっ
て同じように 640x480 の縮小表示を行なったときよりもパフォーマンスかな
り低下します. 上で述べたように, 縮小時においてはバイリニア補間の効果は
小さくなることを考慮し, 縮小時にはポイントサンプル表示に切り替えること
も検討するべきでしょう.

  g[s]SPBgRect1Cyc は image を自動的に幾つかのサブプレーンに分割して描
画しますが, 不用意にこの分割処理を行なうと描画結果に不自然なしわが生じ
る可能性があります. 特にこればスクロール処理時において顕著に起こります.
このしわを防ぐため uObjScaleBg_t にメンバー変数 imageYorig を用意しま
した. imageYorig の値はスケーリングの原点の Y 座標を意味しますが, これ
は同時にサブプレーンの分割原点をも意味します. これによる前述したしわを
防止することが可能です. 具体的には imageYorig を以下のように操作します.

o 初期化時:
	imageYorig に imageY の値を代入

o scaleH の値が変化した時:
	imageYorig に imageY の値を代入

o imageX, imageY のラップ処理をした時:
	imageY に対する処理と同等の処理を imageYorig にも行なう

o imageY のみを変化させる場合(ラップ処理に伴わない変化)
	imageYorig は変化させない.

以上に基づき, image を dx, dy だけスクロールさせる時の処理は以下のよう
になります.

	------------------------------------------
	  /* imageW,imageH 値の桁合わせ */
	  s16	bg_imageW = bg->s.imageW << 3;
	  s16	bg_imageH = bg->s.imageW << 3;
	  
	  /* スクロール値の加算 */
	  bg->s.imageX += dx;
	  bg->s.imageY += dy;

	  /* 画面端のラップ処理 */
	  if (bg->s.imageX < 0){
	    bg->s.imageX     += bg_imageW;
	    bg->s.imageY     -= 32;
	    bg->s.imageYorig -= 32;
	  }
	  if (bg->s.imageX >= bg_imageW){
	    bg->s.imageX     -= bg_imageW;
	    bg->s.imageY     += 32;
	    bg->s.imageYorig += 32;
	  }
	  if (bg->s.imageY < 0){
	    bg->s.imageY     += bg_imageH;
	    bg->s.imageYorig += bg_imageH;
	  }
	  if (bg->s.imageY >= bg_imageH){
	    bg->s.imageY     -= bg_imageH;
	    bg->s.imageYorig -= bg_imageH;
	  }
	------------------------------------------

  本 GBI では COPY モード時と同様に BG image の横方向のみの反転をサポー
トしています.  メンバー変数 imageFlip に G_BG_FLAG_FLIPS を代入すると
テクスチャイメージが反転します. 通常の表示 (反転なし) の場合は 0 を代
入しておいてください.

  本 GBI を使用する場合には uObjScaleBg_t 構造体のメンバー変数 
imagePtr の値に制限があります. imagePtr の値として RDRAM の先頭から 
4096 byte までの位置を指定してはいけません. これは物理アドレスでいうと
ころの 0x00000000 から 0x00000fff で, セグメント変換後の imagePtr がこ
の範囲であってはいけないということです. ご注意ください.

  本 GBI は S2DEX Release 1.00 以降で実装されています.

  また S2DEX Release 0.75 から gSPBgRect1Cyc と等価の処理を 
gSPTextureRectangle 等の GBI を幾つか組合わせることによってエミュレー
トする guS2DEmuBgRect1Cyc 関数を追加しました. これを使用しても, スケー
リング可能な BG 面の描画を行なうことが可能です. 詳しくは 5 章を参照し
てください.


---------------------
4.2  Sprite 描画 GBI 

  ここで言う Sprite とは従来の Famicom や SuperFamicom での OBJECT に
あたるものです. Sprite は BG 面より小さい領域を描画するために使用し歴
史的には, Player キャラクタとして良く使用されてきました. S2DEX では, 
従来の Sprite に拡大縮小や回転やなどの処理も可能となっています. また拡
大時においてバイリニア補間処理をすることが可能であるため, より自然な表
現を行なうことが可能となっています.

  Sprite の回転をサポートするために 2D 座標系における変換行列を用意し
ました. このマトリクスの各要素を設定することで Sprite を自由に回転させ
ることが可能です. このマトリクスの設定は Sprite の描画処理前に行なう必
要があります. また Fast3D, F3DEX マイクロコードのマトリクスとは異なり
マトリクススタックが存在しないので Push/Pop が出来ません. また行列乗算
も出来ません. ロード操作のみ可能です. (項 4.3 を参照)

  S2DEX の Sprite 機能において, TMEM のロード処理と Sprite 描画処理と
は別の GBI でそれぞれ行なうという仕様になっています. すなわち Sprite 
描画時にはその Sprite で使用するテクスチャはテクスチャロード GBI (項
 4.5 参照) によって既にロードされていなければなりません.

  Sprite の描画モードは回転するかしないかで大きく 2 つに分けることがで
き, それぞれ以下のように対応した GBI によって処理されます.

	--------------------------------------------------------
	 描画モード	対応する GBI
	 回転しない	g[s]SPObjRectangle, g[s]SPObjRectangleR
	 回転する	g[s]SPObjSprite
	--------------------------------------------------------


-------------------------
4.2.1  uObjSprite 構造体

  uObjSprite 構造体は Sprite の情報をしている構造体です. Sprite 描画 
GBI には, この構造体へのポインタを引数として与えます.

 --------------------------------------------------------------------------
  typedef struct {
    s16  objX;            // s10.2 OBJ 左上端 X 座標
    u16  scaleW;          // u5.10 幅方向スケーリング
    u16  imageW;          // u10.5 テクスチャの幅 (S 方向の長さ)
    u16	 paddingX;	  // 未使用   常に 0
  
    s16  objY;            // s10.2 OBJ 左上端 Y 座標
    u16  scaleH;          // u5.10 高さ方向スケーリング
    u16  imageH;          // u10.5 テクスチャの高さ (T 方向の長さ)  
    u16	 paddingY;        // 未使用   常に 0

    u16  imageStride;     // テクセルの折り返し幅 (64bit word 単位)
    u16  imageAdrs;       // TMEM 内のテクスチャ先頭位置 (64bit word 単位)
   
    u8   imageFmt;        // テクセルのフォーマット G_IM_FMT_*
    u8   imageSiz;        // テクセルのサイズ       G_IM_SIZ_*
    u8   imagePal;        // パレット番号
    u8   imageFlags;      // 表示フラグ

  } uObjSprite_t;         // 24 bytes

  typedef union {
    uObjSprite_t    s;
    long long int   force_structure_alignment;
  } uObjSprite;
 --------------------------------------------------------------------------

メンバー変数の並びが少し複雑ですが, これは uObjBg 構造体同様に RSP の
処理の最適化による都合上やむを得ないものですので, ご了承くださるようお
願い致します.


---------------------------------
4.2.2  uObjMtx/uObjSubMtx 構造体

  S2DEX マイクロコードには Sprite の回転を制御するための 2D マトリクス
を保持する領域が設けられています. そのパラメータは { A, B, C, D, X, Y,
BaseScaleX, BaseScaleY } の 8 つです.

  uObjMtx 構造体は, この 2D マトリクス領域と 1 対 1 に対応し, 2D マト
リクス全体の変更のために使用されます. この 2D マトリクスによる回転処理
については, 4.2.5 項で説明します.

 ------------------------------------------------------
  typedef struct {
    s32   A, B, C, D;     /* s15.16 */
    s16   X, Y;           /* s10.2  */
    u16   BaseScaleX;     /* u5.10  */
    u16   BaseScaleY;     /* u5.10  */
  } uObjMtx_t;            /* 24 bytes */

  typedef union {
    uObjMtx_t     m;
    long long int force_structure_alignment;
  } uObjMtx;
 ------------------------------------------------------

  uObjSubMtx は uObjMtx のサブセットで 2D マトリクスの回転行列以外の要
素 { X, Y, BaseScaleX, BaseScaleY } のみを変更するために使用し, 主に
g[s]SPObjRectangleR による Sprite 描画時に使用します. 詳しくは 4.2.4 
項で説明します.

 ------------------------------------------------------  
  typedef struct {
    s16   X, Y;           /* s10.2  */
    u16   BaseScaleX;     /* u5.10  */
    u16   BaseScaleY;     /* u5.10  */
  } uObjSubMtx_t;         /* 8 bytes */

  typedef union {
    uObjSubMtx_t  m;
    long long int force_structure_alignment;
  } uObjSubMtx;
 ------------------------------------------------------

  2D マトリクスの 8 つの要素 { A, B, C, D, X, Y, BaseScaleX,
BaseScaleY }は, g[s]SPObjSprite と g[s]SPRectangleR で参照されます. た
だし, 8 つの要素を全て参照するわけではありません. 具体的には以下のよう
になります. { X,Y } は双方で参照されます.

                +- g[s]SPObjSprite で参照 -+
                |                          |
                |     A, B   +-------------+----------------+
                |     C, D   |    X, Y     |   BaseScaleX   |
                +------------+-------------+   BaseScaleY   |
                             |                              |
                             +- g[s]SPObjRectangleR で参照 -+


-----------------------
4.2.3  gSPObjRectangle

	--------------------------------------------------------------
	 gSPObjRectangle(Gfx *gdl, uObjSprite *sp)
	 gsSPObjRectangle(uObjSprite *sp)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjSprite	*sp;	Sprite の描画データ構造体へのポインタ
	--------------------------------------------------------------

  g[s]SPObjRectangle は S2DEX が提供する Sprite 描画 GBI の 1 つで, 回
転しない Sprite の描画に使用します. RSP の内部処理としては, 入力された 
uObjSprite 構造体のデータから TextureRectangle 命令を作成し RDP に送る
というものです. 

  g[s]SPObjRectangle GBI は, 左上角のスクリーン座標を (objX, objY), 右
下角の座標を (objX+imageW/scaleW-1, objY+imageH/scaleH-1) とする矩形領
域に対し, テクスチャを描画します. 描画されるテクスチャ領域は, 左上角が 
(0,0), 右下角が (imageW-1, imageH-1) となります. scaleW, scaleH が 
1<<10 ならばテクスチャはスケーリングなしに等倍比率で描画されます.


    +--------TMEM--------+      +---------Frame Buffer---------+
    |                    |      |(objX,objY)                   |
    |      (0,0)         |      |  X-------------+             |
  imageAdrs->X---------+ |      |  |             |             |
    |        | Texture | |      |  | Sprite 領域 |             |
    |        |  領域   | | ===> |  |             |             |
    |        |         | |      |  |             |             |
    |        +---------X |      |  |             |             |
    +------------- (imageW-1,   |  +-------------X             |
                    imageH-1)   |       (objX+imageW/scaleW-1, |
                                |        objY+imageH/scaleH-1) |
                                |                              |
                                +------------------------------+

  また Sprite 描画時に gDPSetScissor で設定したシザーボックスを参照し, 
自動的に描画範囲のクリップ処理を行ないます. このため objX, objY の値と
して負の値を設定することも可能となっています.

  テクスチャ領域の原点 (0,0) に対応する TMEM アドレスは imageAdrs で指
定可能です. 通常, テクスチャロード GBI において指定した TMEM の先頭ロー
ド位置をimageAdrs に指定します. この指定の際にマクロ GS_PIX2TMEM() を
使うと便利でしょう. GS_PIX2TMEM() は, ピクセル単位の数値を TMEM アドレ
ス単位に変換してくれるマクロで gs2dex.h 内で定義されています.

	----------------------------------------------
	 GS_PIX2TMEM(pix,siz)
	 pix:	ピクセル数
	 siz:	1 テクセルのサイズ  G_IM_SIZ_* で指定
	----------------------------------------------

  またテクスチャのロード時における横幅 (折り返し幅) を imageStride に
設定します. これはロードしたときのテクスチャの幅と実際に描画する 
Sprite の imageW の値が異なることが有り得るからです. これも TMEM アド
レス単位で指定するので GS_PIX2TMEM() が使用できます. 

  この imageAdrs と imageStride の指定を応用すると, TMEM 内に複数の小
さなテクスチャ (サブテクスチャ) をロードしておき, imageAdrs に以下の値
を設定することでその中から描画するテクスチャを選ぶことができます.

  imageW      = (サブテクスチャ幅);
  imageH      = (サブテクスチャ高さ);
  imageAdrs   = GS_PIX2TMEM((TMEM 内 S 座標)+
			    (TMEM 内 T 座標)*(ロード時のテクスチャ横幅),
			     G_IM_SIZ_*);
  imageStride = GS_PIX2TMEM(ロード時のテクスチャ幅);

  具体的には, 先ず以下のような 4 つのテクスチャを組み合わせた大きなテ
クスチャを用意します. 

     <---------- 64 --------->
   ^ +-----------+-----+-----+
   | |           |     |     |
   | |           |  B  |  C  | 16
  32 |     A     +-----+-----+
   | |           |           | 
   | |           |     D     | 16
   v +-----------+-----------+ 
     <---- 32 --->  16    16

  このテクスチャを 64x32 のテクスチャとしてロードを行ない, 実際に 
Sprite を描画するときには各テクスチャのそれぞれを以下のように指定して
使用できます.

    サブテクスチャ A:	imageW = 32;
			imageH = 32;
			imageAdrs   = GS_PIX2TMEM(0*64+0,  G_IM_SIZ_16b);
			imageStride = GS_PIX2TMEM(64, G_IM_SIZ_16b);

    サブテクスチャ B:	imageW = 16;
			imageH = 16;
			imageAdrs   = GS_PIX2TMEM(0*64+32,  G_IM_SIZ_16b);
			imageStride = GS_PIX2TMEM(64, G_IM_SIZ_16b);

    サブテクスチャ C:	imageW = 16;
			imageH = 16;
			imageAdrs   = GS_PIX2TMEM(0*64+48,  G_IM_SIZ_16b);
			imageStride = GS_PIX2TMEM(64, G_IM_SIZ_16b);

    サブテクスチャ D:	imageW = 32;
			imageH = 16;
			imageAdrs   = GS_PIX2TMEM(16*64+32,  G_IM_SIZ_16b);
			imageStride = GS_PIX2TMEM(64, G_IM_SIZ_16b);


  ただしこの指定方法には制限があります. それは, テクスチャデータの 
TMEM への保存形式が奇数番目のラインと偶数番目のラインとで異なるという
ことです. このためテクスチャロード時に奇数番目のラインに対応していた 
TMEM アドレスは imageAdrs には指定できません. すなわち前述した 
imageAdrs の算出式における (TMEM 内 T 座標) に奇数値を設定することは出
来ませんのでご了承下さい.

  g[s]SPObjRectangle におけるテクスチャのフォーマットおよびサイズは 
imageFmt と imageSiz にそれぞれマクロ G_IM_FMT_*, G_IM_SIZ_* を用いて
代入します. また CI4 テクスチャを使用する場合は imagePal に TLUT の番
号を指定します.

  g[s]SPObjRectangle ではテクスチャパターンの S 方向, T 方向の反転をサ
ポートしています. imageFlags 以下の値を設定することで描画方向が変化し
ます.

  ----------------------------------------------------------------------
   imageFlags の値			描画方向
   0					反転なし
   G_OBJ_FLAG_FLIPS			S 方向(X) 反転
   G_OBJ_FLAG_FLIPT			T 方向(Y) 反転
   G_OBJ_FLAG_FLIPS|G_OBJ_FLAG_FLIPT	S 方向(X) および T 方向(Y) 反転
  ----------------------------------------------------------------------

  g[s]SPObjRectangle は CycleType として 1 Cycle, 2 Cycle モードと 
Copy モードで共通に使用できます. Copy モードにおける描画速度は他のモー
ドよりも速くなりますが, その反面 Copy モードでは, 描画機能に制限があり
ます. 

  Copy モードではバイリニア補間やサブピクセル処理および X 方向の拡大縮
小処理がサポートされていません. Copy モードでこれらの機能を使用した場
合の動作は保証できません. 最悪 RDP が暴走状態になる可能性もあります. 
必要な機能に応じてモードを使い分けることをお勧めします.

  バイリニア補間やその他のレンダーモードの設定によって 
g[s]SPObjRectangle の描画結果は変化します. これについては 4.3 項の 
"Object レンダーモード設定" で詳しく説明します.

  g[s]SPObjRectangle では 2D マトリクスの設定を参照しません. そのため,
2D マトリクスの設定は, 本 GBI の描画結果に影響を与えません.


------------------------
4.2.4  gSPObjRectangleR

	--------------------------------------------------------------
	 gSPObjRectangleR(Gfx *gdl, uObjSprite *sp)
	 gsSPObjRectangleR(uObjSprite *sp)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjSprite	*sp;	Sprite の描画データ構造体へのポインタ
	--------------------------------------------------------------

  g[s]SPObjRectangleR は S2DEX が提供する Sprite 描画 GBI の 1 つで, 
前述した g[s]SPObjRectangle と同様に, 回転しない Sprite の描画に使用し
ます. g[s]SPObjRectangleR が g[s]SPObjRectangle と異なる点は, 2D マト
リクスの設定を参照し, 描画するスクリーン座標値を変更するという点です.

  g[s]SPObjRectangleR では 2D マトリクスの内, { X, Y, BaseScaleX,
BaseScaleY } の値を参照し, 以下の計算式で Sprite の頂点座標を決定しま
す.

     左上座標値 ( X + objX / BaseScaleX, Y+objY/BaseScaleY )
     右下座標値 ( X + (objX + imageW / scaleW) / BaseScaleX - 1,
                  Y + (objY + imageH / scaleH) / BaseScaleY - 1 )

  { X,Y,BaseScaleX,BaseScaleY } を変更するためには, g[s]SPObjSubMatrix
GBI を使用します. X = Y = 0 かつ BaseScaleX = BaseScaleY = 1.0 の時に
は g[s]SPObjRectangle と同じ結果となります.

  この 2Dマトリクス { X,Y, BaseScaleX, BaseScaleY } の設定を変更するこ
とによって, 数枚の Sprite を一まとめにして移動させたり, スケーリングさ
せたりすることが出来ます. 

  例えば, Sprite A, B, C を以下のように横に並べる場合を考えます.

       32      32      32
    +-------+-------+-------+
    |       |       |       |
 32 |   A   |   B   |   C   |
    |       |       |       |
    +-------+-------+-------+

  これを実現したいときは, それぞれの (objX, objY) に以下のようなデータ
を設定します.

    A: (objX, objY) = ( 0<<2, 0<<2)
    B: (objX, objY) = (32<<2, 0<<2)
    C: (objX, objY) = (64<<2, 0<<2)

  こうした設定の元で X, Y を変更すると, この 3 枚の Sprite は 1 つの大
きな Sprite のように一度に動きます.
  
  ただし, 実際には乗算などによる計算誤差のために A,B 間 B,C 間に隙間が
出来る場合があります.  その場合には以下のように隣り合った Sprite を少
し重ねておくなどの対処が必要です.
 
    B: (objX, objY) = ((32<<2)-2, 0<<2)
    C: (objX, objY) = ((64<<2)-4, 0<<2)

  g[s]SPObjRectangleR が g[s]SPObjRectangle と異なる点は以上です. その
他の機能についての説明は g[s]SPObjRectangle の説明を参照してください.


--------------------
4.2.5  gSPObjSprite

	--------------------------------------------------------------
	 gSPObjSprite(Gfx *gdl, uObjSprite *sp)
	 gsSPObjSprite(uObjSprite *sp)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjSprite	*sp;	Sprite の描画データ構造体へのポインタ
	--------------------------------------------------------------

  g[s]SPObjSprite は S2DEX が提供する Sprite 描画 GBI の 1 つです.  こ
の GBI は回転する Sprite の描画に使用します. Sprite を回転させるために 
g[s]SPObjSprite では 2D マトリクスの要素 { A,B,C,D,X,Y } を使用します.
この 2D マトリクスの設定には, g[s]SPObjMatrix を使用します. (4.3.1 項
参照)

  2D マトリクスの乗算によって, 無回転時の Sprite 上の点 (x,y) は, 以下
の位置 (x',y')に移動します.

	x' = A * x + B * y + X
	y' = C * x + D * y + Y

  Sprite の各頂点もこれにより移動し, 移動した頂点による 4 辺形領域に 
Sprite が描画されます. 

  2D マトリクス A,B,C,D に次の回転行列を設定すると Sprite は T の回転を行
ないます.

		|A  B|   |  cosT  sinT |
		|    | = |             |
		|C  D|   | -sinT  cosT |

  この場合 Sprite はスクリーン座標 (X,Y) を原点とした回転を行ないます.
さらにスケーリングを追加する場合は, { A, B, C, D } 各項にスケール値を
乗じてください.

  (objX, objY) の値によって回転中心 (X,Y) を Sprite のどの位置に対応さ
せるかを決められます. objX = objY = 0 の時, Sprite の回転中心は無回転
時における左上の頂点となります. ここで, Sprite をその中央を中心として
回転させたい場合は, 次のように objX, objY を設定します.

		objX = - (imageW / scaleW) / 2;
		objY = - (imageH / scaleH) / 2;

  また g[s]SPObjRectangleR と同様に objX, objY の値を調整することで, 
複数枚の Sprite を 1 度にまとめて回転させたりすることができます. この
ときも g[s]SPObjRectangleR の場合のように少し重ねるように描画した方が
計算誤差によるすきまの発生を抑えることができるでしょう.

  無回転時 ( A = D = 1.0, B = C = 0.0 ) としたときの Sprite の位置は,
BaseScaleX = BaseScaleY = 1.0 のときの g[s]SPObjRectangleR による描画
領域と一致します. 回転したりしなかったりする Sprite の場合, 回転しない
ときは g[s]SPObjRectangle で描画し, 回転するときは g[s]SPObjSprite で
描画するというように切り替えて描画されることをお勧めします. なぜなら 
g[s]SPObjSprite は Sprite を 2 つのポリゴンの組合わせで描画するため 
g[s]SPObjRectangleR よりも RSP/RDP 共に処理が重くなるからです.

  また無回転時における Sprite を拡大した時などにおいて, その描画結果が 
g[s]SPObjRectangle での描画結果と僅かにことなる場合があります. これは
描画方法が異なるためやむを得ないもの (ポリゴン張り合わせと, 矩形描画の
違いによるもの)ですのでご了承下さい.

  Sprite 上に張りつけられるテクスチャに関する設定は g[s]SPObjRectangle 
と共通です. 詳しくは前述した該当項を参照にしてください.


-----------------------
4.3  2D マトリクス操作

  S2DEX マイクロコードには前述したように 2D マトリクスを描画パラメータ
として用いるようになっています. この 2D マトリクスを変更するための GBI 
が幾つか用意されています.


--------------------
4.3.1  gSPObjMatrix

	--------------------------------------------------------
	 gSPObjMatrix(Gfx *gdl, uObjMtx *mtx)
	 gsSPObjMatrix(uObjMtx *mtx)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjMtx	*mtx;	2D マトリクス構造体へのポインタ
	--------------------------------------------------------

  uObjMtx 構造体内の 2D マトリクスパラメータを RSP 内の 2D マトリクス
領域へロードします. 通常, この GBI は回転 Sprite の設定のために使用し
ます. 

  回転処理に必要なマトリクス要素は { A,B,C,D,X,Y } の 6 要素なので 2D 
マトリクス全体の転送をする必要はないように思えますが, メインメモリから 
RSP のマトリクス領域への転送は, 8 バイト単位でなければならないため, 
{ BaseScaleX, BaseScaleY } の転送も一緒に行ない, 24 バイトとしています.

  そのため BaseScaleX, BaseScaleY の値は必ず上書きされます. このパラメー
タを使用しない場合 (直後に g[s]SPObjRectangleR を使用しない場合) は, 
取りあえず BaseScaleX, BaseScaleY の値としてデフォルト値の 1024 
(s5.10 フォーマットでいうところの 1.0 ) を代入されることをお勧めします.


-----------------------
4.3.2  gSPObjSubMatrix

	--------------------------------------------------------
	 gSPObjSubMatrix(Gfx *gdl, uObjMtx *mtx)
	 gsSPObjSubMatrix(uObjMtx *mtx)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjSubMtx	*mtx;	2D マトリクス構造体へのポインタ
	--------------------------------------------------------

  g[s]SPObjSubMatrix は, uObjSubMtx 構造体内のデータを RSP 内の 2D マ
トリクス領域へロードします. ただし, uObjSubMtx 構造体は uObjMtx 構造体
のサブセットとなっており, g[s]SPObjRectangleR で使用する 2D マトリクス
要素{ X, Y, BaseScaleX, BaseScaleY } の値を保持します.

  本 GBI は, uObjSubMtx 構造体のメンバー変数に対応する 2D マトリクスパ
ラメータ{ X, Y, BaseScaleX, BaseScaleY } のみを変更し, その他のパラメー
タ { A, B, C, D } の値には影響を与えません.

  本 GBI は主に g[s]SPObjRectangleR と連携し使用されます.


-------------------------------
4.4  Object レンダーモード設定

  Sprite/BG の描画を司る RDP にはさまざまな描画パラメータが存在します. 
この RDP のモードによって, ポリゴン描画および矩形描画処理は微妙に影響
を受けます. 例えばバイリニア補間の有効時と無効時においてテクスチャ座標
が 0.5 ずれたりします. S2DEX マイクロコードはこうした影響を RSP が補正
し, ユーザーがその影響をあまり意識する必要がないように努めました. RSP 
の補正処理は RDP のモードと対応しています. この RSP の補正処理のモード
を Object レンダーモード (あるいは OBJ レンダーモード) と呼びます. 

  このモードの選択を RSP が自動で行なうことは RSP に対してオーバーヘッ
ドがかかるので, 現状では CopyMode と 1,2CycleMode の判定のみしか行なっ
ていません. その他のモードついては GBI の形で RSP に伝える必要がありま
す. 現在, 実装された Object レンダーモードは RDP のモードによる影響の
修正機能以外に, 独自のレンダリング機能が追加されています. 詳しくは次項
で述べます.


------------------------
4.4.1  gSPObjRenderMode

	--------------------------------------------------------
	 gSPObjRenderMode(Gfx *gdl, u32 mode)
	 gsSPObjRenderMode(u32 mode)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 u32		mode;	Object レンダーモード
	--------------------------------------------------------


  g[s]SPObjRenderMode は RSP における Object レンダーモードを変更する
ためのものです. 通常は, 画面モードに応じて設定します. 

  設定できるフラグは以下の通りです. 複数指定する場合は, 論理和(OR)で連
結してください. ただし, G_OBJRM_SHRINKSIZE_1 と G_OBJRM_SHRINKSIZE_2 
は同時に指定できません.

	-----------------------------------------------------------------
	 マクロ名		機能説明
	 G_OBJRM_NOTXCLAMP	テクスチャ外周のクランプ処理を行なわない
	 G_OBJRM_BILERP		バイリニア補間時に ON にする
	 G_OBJRM_SHRINKSIZE_1	描画イメージを周囲 0.5 テクセル分削る.
	 G_OBJRM_SHRINKSIZE_2	描画イメージを周囲 1.0 テクセル分削る.
	 G_OBJRM_WIDEN		描画イメージを 3/8 テクセル分拡張する.
	-----------------------------------------------------------------

以下に各フラグを詳しく説明します.


o G_OBJRM_NOTXCLAMP:

  テクスチャを Sprite に貼り付ける場合, テクスチャのサイズ 
imageW,imageH とスケール値 scaleW, scaleH と Sprite のサイズに objW,
objH には以下のような関係が成り立ちます.

	objW = imageW / scaleW;
	objH = imageH / scaleH;

この Sprite にテクスチャを貼るとテクスチャ座標で (0,0) -
(imageW-1,imageH-1) の領域が Sprite 上に描画されます. しかしながら, 計
算誤差などのため, この範囲外のテクスチャが僅かながらも Sprite の最外周
に表示されてしまうことがあります.

  RSP はこれを防ぐためにテクスチャの描画対象範囲の外側にクランプ処理を
行ないます. これにより上記の問題を回避することが可能です. クランプ処理
についての詳細は N64 マニュアルの 13 章 "テクスチャマッピング" を参照
してください.

  フラグ G_OBJRM_NOTXCLAMP は, このクランプ処理を行なわないように RSP 
に指定します. 通常このフラグを ON にする必要はありません.


o G_OBJRM_BILERP

  このフラグはテクスチャのバイリニア補間をするときに設定してください.
このフラグは前項で例に出したように, バイリニア補間時に生じるテクスチャ
の 0.5 のずれを補正します. 

  またこのフラグが有効の時, RSP はバイリニア補間機能を利用して, 内部イ
メージのサブピクセル単位の移動をサポートします. これにより Sprite を 
1/4 ピクセル単位で移動させることが出来ます.


o G_OBJRM_SHRINKSIZE_1

  バイリニア補間された複数の Sprite を並べ, 大きなバイリニア補間された 
Sprite として扱いたい場合, 問題となるのはその境界上のイメージの連続性
です. この連続性を保つためには, それぞれの Sprite のテクスチャを 1 ラ
イン分ずつダブらせる必要があります. このときに外周の 0.5 テクセル分 
(以下の図の '#' の部分) は不要になります. この部分は隣に位置する 
Sprite が担当することになるためです.

       0  0.5  1       2       3  S
     0 +-------+-------+-------+--
       |#######|#######|#######|##
   0.5 |###+---+-------+-------+--
       |###|   |       |       |
     1 +---+---+-------+-------+--
       |###|   |       |       |
       |###|   |       |       |
       |###|   |       |       |
     2 +---+---+-------+-------+--
   T   |###|   |       |       |


  フラグ G_OBJRM_SHRINKSIZE_1 が ON になっていると RSP は, Sprite の描
画イメージを一回り小さくし, 上記の周囲 0.5 テクセル分を削ったテクスチャ
イメージによる描画を行ないます. テクスチャイメージとしてはそれぞれ 0.5 
だけ小さくなりますが, 左上のスクリーン座標は変らないので, 描画結果は以
下の図のようになります.

                                 1/scaleX
	      (objX,objY)           -> <-
	           +-----------------+-+
	           |                 | |
	           |              <--+-+------- G_OBJRM_SHRINKSIZE_1 有効時
	           |                 | |
	           |                 | |<------ G_OBJRM_SHRINKSIZE_1 無効時
	           |                 | |  
	           |                 | |  
	         | |                 | |  
	         v +-----------------+ |  
	1/scaleY   +-------------------+
                 ^
                 |

o G_OBJRM_SHRINKSIZE_2

  これは G_OBJRM_SHRINKSIZE_1 とよく似ています. ただ 1 つの違いは, イ
メージの縮小量が 2 倍になったことです. (外周それぞれにつき 1 テクセル)
  
  サブピクセル処理を行なう場合において, より連続性を求める場合などに隣
り合った Sprite のテクセルを 2 ライン分ずつダブらせたいときには, この
フラグを使用してください.

o G_OBJRM_WIDEN

  描画イメージを 3/8 ピクセル分 S,T の正の方向へ拡張します.
  このフラグは, Sprite を組み合わせて TMEM より大きな回転 Object 等を
表示するときに, その継ぎ目に空白が空いてしまうのを防ぐために使用します.

  本フラグは S2DEX 1.04 以降において Sprite の描画計算処理をより厳密し
た結果, その重要度が減りましたが, 現在でも使用可能です.


##### 注意 ##### 以下のフラグは現在サポートされていません.

o G_OBJRM_ANTIALIAS ---- S2DEX 1.04 以降ではサポートを止めています.

  このフラグは RDP のレンダーモードの AntiAlias 処理の ON/OFF に対応し
ます.  RDP のレンダーモードとして AntiAlias(G_RM_AA_*) および 
ReducedAlias(G_RM_RA_*) を使用する場合に ON にします.

  このフラグが ON のときは外部エッジのサブピクセル計算が有効になります. 
外部エッジとは Sprite の描画領域における最外周のことです. この最外周の
全てが透明(いわゆる "ヌキ") である Sprite にとって, このフラグは意味を
持ちません.

  S2DEX 1.04 以降では, この処理は video ハードウェア側にまかせているため,
このフラグは無視されます.


o G_OBJRM_XLU

  半透明 Sprite を描画するときに設定します. 半透明描画では RDP の 
RenderMode として G_RM_XLU_SPRITE を指定します.

  このフラグは S2DEX 1.02 以降でサポートされました. これによって, 半透
明 Sprite を並べて描画したときに継ぎ目が目立たなくなります.

  S2DEX 1.04 以降では, Sprite の描画計算を厳密に行なうことで, この継ぎ
目を無くしました. そのためこのフラグは無視されます.


-------------------------------------------
4.4.2  Sprite 描画時の RenderMode について

  Sprite を描画するときに設定すべき RDP の RenderMode がヘッダファイル 
gs2dex.h 内に定義されています. Sprite の描画時にはこれをご使用ください.

AntiAlias off のとき
	不透明 Sprite	G_RM_SPRITE*
	半透明 Sprite	G_RM_XLU_SPRITE*

AntiAlias on  のとき
	不透明 Sprite	G_RM_AA_SPRITE* (G_RM_RA_SPRITE*)
	半透明 Sprite	G_RM_AA_XLU_SPRITE*

ただし AntiAlias on のときに半透明 Sprite を使用して, 2 枚の Sprite を
重ねた場合, 下側の Sprite のエッジ部分が上側の Sprite のエッジ部分に影
響を与えることがあります. これは避けられないので, 気になられる場合は 
G_RM_XLU_SPRITE をご使用ください.


--------------------------
4.5  テクスチャロード GBI

  S2DEX の Sprite 機能において, Sprite 描画処理については Sprite GBI 
で記述した通りです. ここではもう 1 つの柱である TMEM のロード処理につ
いて述べます.


-----------------------
4.5.1  uObjTxtr 構造体

  テクスチャロード GBI では, 異なる 3 つの方式のテクスチャデータを共通
の GBI で処理します. この 3 つの方式は GBI に与える uObjTxtr 構造体の
メンバー変数 type によって区別されます. 以下にその 3 つの方式を示します.

    1) LoadBlock を使用したテクスチャのロード
    2) LoadTile  を使用したテクスチャのロード
    3) TLUT のロード

  1) の LoadBlock を使用したテクスチャのロードは 2) の LoadTile のもの
よりも高速に処理が出来ますが, ロード可能なテクスチャの幅に制限がありま
す. この制限は 4.1.2 項において LoadBlock についての説明と同じなので詳
しくはそちらを参照してください.
  このそれぞれの方式に対応した構造体がそれぞれ定義されています.  ただ
し, それぞれの構造体はメンバー変数の名前が異なるだけで構造は同じです.
そしてこれらの 3 つの構造体をまとめて共用体としたのが uObjTxtr 構造体
となります.


1) LoadBlock を使用したテクスチャのロード用構造体  uObjTxtrBlock_t
-----------------------------------------------------------------------------
typedef	struct	{
  u32	type;		// Type 種別 G_OBJLT_TXTRBLOCK
  u64	*image;		// DRAM 上のテクスチャソースアドレス
  u16	tmem;		// ロード先の TMEM ワードアドレス (8byteWORD)
  u16	tsize;		// Texture サイズ     マクロ GS_TB_TSIZE() で指定
  u16	tline;		// Texture 1 ライン幅 マクロ GS_TB_TLINE() で指定
  u16	sid;		// Status ID  { 0, 4, 8, 12 } のどれか
  u32	flag;		// Status flag
  u32	mask;		// Status mask
} uObjTxtrBlock_t;	// 24 bytes
-----------------------------------------------------------------------------

2) LoadTile を使用したテクスチャのロード用構造体  uObjTxtrTile_t
-----------------------------------------------------------------------------
typedef	struct	{
  u32	type;		// Type 種別 G_OBJLT_TXTRTILE
  u64	*image;		// DRAM 上のテクスチャソースアドレス
  u16	tmem;		// ロード先の TMEM ワードアドレス (8byteWORD)
  u16	twidth;		// Texture 幅      マクロ GS_TT_TWIDTH()  で指定
  u16	theight;	// Texture 高さ    マクロ GS_TT_THEIGHT() で指定
  u16	sid;		// Status ID  { 0, 4, 8, 12 } のどれか
  u32	flag;		// Status flag
  u32	mask;		// Status mask
} uObjTxtrTile_t;	// 24 bytes
-----------------------------------------------------------------------------

3) TLUT のロード用構造体 uObjTxtrTLUT_t
-----------------------------------------------------------------------------
typedef	struct	{
  u32	type;		// Type 種別 G_OBJLT_TLUT
  u64	*image;		// DRAM 上のテクスチャソースアドレス
  u16	phead;		// ロード先頭の TLUT 領域の番号 256 以上 511 以下
  u16	pnum;		// ロードする TLUT 数 - 1
  u16   zero;		// 常に 0 を代入する
  u16	sid;		// Status ID  { 0, 4, 8, 12 } のどれか
  u32	flag;		// Status flag
  u32	mask;		// Status mask
} uObjTxtrTLUT_t;	// 24 bytes
-----------------------------------------------------------------------------

uObjTxtr 共用体
-----------------------------------------------------------------------------
typedef union {
  uObjTxtrBlock_t      block;	// LoadBlock によるテクスチャロードパラメータ
  uObjTxtrTile_t       tile;	// LoadTile  によるテクスチャロードパラメータ
  uObjTxtrTLUT_t       tlut;	// TLUT ロードパラメータ
  long long int        force_structure_alignment;
} uObjTxtr;
-----------------------------------------------------------------------------


----------------------
4.5.2  gSPObjLoadTxtr

	-----------------------------------------------------------------
	 gSPObjLoadTxtr(Gfx *gdl, uObjTxtr *tx)
	 gsSPObjLoadTxtr(uObjTxtr *tx)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjTxtr	*tx;	テクスチャロードデータ構造体へのポインタ
	-----------------------------------------------------------------

  gSPObjLoadTxtr は, 前述した異なる 3 つの構造体に保持されたテクスチャ
ロードパラメータを参照してそれぞれのロード処理を行ないます. 3 つの構造
体は, 共通のメンバー変数 type, image, sid, flag, mask を持ちます. 先ず
は, この 5 つの共通メンバー変数について説明します.

o type 

  構造体のメンバー変数 type の値によって gSPObjLoadTxtr はそれぞれの構
造体を識別します. type の値と対応する構造体および処理は以下の通りです.

  ------------------------------------------------------------------------
   type の値          構造体            処理
   G_OBJLT_TXTRBLOCK  uObjTxtrBlock_t   LoadBlock によるテクスチャロード
   G_OBJLT_TXTRTILE   uObjTxtrTile_t    LoadTile  によるテクスチャロード
   G_OBJLT_TLUT       uObjTLUT_t        TLUT のロード
  ------------------------------------------------------------------------

o image

  メンバー変数 image にはメインメモリ上に置かれているロードしたいテク
スチャデータあるいは TLUT データのアドレスを指定します. このテクスチャ
データは 8 bytes 整列されていなければなりません.

o sid, flag, mask

  この 3 つのメンバー変数は, 既にロードされているテクスチャを再度ロー
ドする必要がないように判定するために用意されたものです. これからロード
しようとしているテクスチャが既にロードされていると判定されたら,
g[s]SPObjLoadTxtr はそのロードをせずに終了します.

  あるテクスチャが TMEM 内部に存在するかどうかの判定を RSP で完全に処
理するためには RSP テクスチャがロードされる都度, ロード先の領域につい
ての解析を行なわねばなりません. この判定処理に時間を費やすことは正しい
選択ではありません. 

  そのため S2DEX では RSP 側でロードするテクスチャの解析を行なうより, 
テクスチャデータ構造体にロードされる領域に関するデータを予め追加してお
き, これによって簡単な演算でロード判定を行なうことにしました.

  例えば, TMEM にデータをロードするときに RSP 内部のある Status 領域に
ロードするテクスチャに応じた ID を書き込んでおき, 次回の TMEM へのデー
タロード時にその ID を比較するという方法で簡単なロード判定ができます.

  S2DEX に実装しているロード判定処理は, この考え方を延長させたものです. 
32bit 幅の flag と mask の 2 つの値を設定することで, ロード判定処理を 
TMEM の領域を分割して部分的にロードを行なう場合にも対応できます.

  RSP では のように Status 領域として 32bit の変数 Status を 4 つ用意
しています. マイクロコード起動時のこれらの値は 0 です. どの Status 
値を使用するかは sid によって決定します. sid の取り得る値は { 0,4,8,12} 
です.
 
  実際に g[s]ObjLoadTxtr は, 以下のような処理でロード判定を行ない, テ
クスチャのロードをするかどうかを決定します. 

  + (Status[sid] & mask) == flag を調べる.
  + 結果が真なら, 既にロードされていると判定し, ロード処理を終了する.
  + 結果が偽なら, テクスチャのロードを行ない, 
                  Status[sid] = (Status[sid] & ~mask) | (flag & mask);
                  のように Status[sid] を更新.

  一番簡単な flag の使い方は, mask に -1(=0xffffffff), flag にテクスチャ
のソースデータのアドレス (= メンバー変数 image の値)を代入しておくこと
です. 同一番地から始まる他のテクスチャデータが無いのなら, これは単一の
テクスチャキャッシュとして動作します.

  また (flag & ~mask) != 0 の場合は, 必ず判定式は偽となるため, 常にロー
ドを行なうことになります.

  次は, TMEM を 2 つに分割し, 管理する場合の例です. ここでは, TMEM 領
域の前半に Status[0] の bit 31-16 を割り当て, 後半に bit 15-0 を割り当
て, 各テクスチャに通し番号を割り振ります. sid の値は常に 0 です.

                             ロードする領域       flag          mask
  A:テクスチャ 1                0 から 255     0x00010000    0xffff0000   
  B:テクスチャ 2              256 から 511     0x00000002    0x0000ffff
  C:テクスチャ 3                0 から 511     0x00030003    0xffffffff
  D:テクスチャ 3 の後半のみ   256 から 511     0x00000003    0x0000ffff

  C でテクスチャ 3 の全体をロードした後で A のロードで TMEM の前半部を
変更しても, TMEM の後半には テクスチャ 3 のデータが保持されているので,
D のテクスチャ 3 の後半部のみをロードを行なっても, 実際のロードは行な
われないというわけです.

  S2DEX には, この Status による処理を応用し, 同様の判定によって DL の
分岐を行なう GBI gSPSelectDL/gSPSelectBranchDL があります.


  次に各処理におけるその他の構造体のメンバー変数の説明をします.

1) LoadBlock によるテクスチャロード (uObjTxtrBlock_t 構造体)

o tmem

  メンバー変数 tmem にはロード先の TMEM のアドレスを DoubleWord 
単位で指定します. このロード先の値を uObjSprite 構造体における 
imageAdrs の値として使用するのが一般的です. この値をピクセル単位として
指定するときは, 前述のマクロ GS_PIX2TMEM() が役に立つでしょう.

o tsize

  メンバー変数 tsize にはロードしたいテクスチャのサイズの情報を与えま
す. テクスチャサイズからこの値を求めるときは, マクロ GS_TB_TSIZE() を
使用します.

	---------------------------------------------------------
	 GS_TB_TSIZE(pix,siz): tsize の設定値
	 pix:	ロードするテクセル数 (= テクスチャの横幅 x 縦幅)
	 siz:	1 テクセルのサイズ  G_IM_SIZ_* で指定
	---------------------------------------------------------

o tline

  メンバー変数 tline にはロードしたいテクスチャの横幅の情報を与えます.
テクスチャの幅からこの値を求めるときは, マクロ GS_TB_TLINE() を使用し
ます.

	----------------------------------------------
	 GS_TB_TLINE(pix,siz): tline の設定値
	 pix:	テクスチャの横幅のテクセル数
	 siz:	1 テクセルのサイズ  G_IM_SIZ_* で指定
	----------------------------------------------


2) LoadTile によるテクスチャロード (uObjTxtrTile_t 構造体)

o tmem

  このメンバーは LoadBlock によるロード処理時と共通です. メンバー変数 
tmem にはロード先の TMEM のアドレスを DoubleWord 単位で指定します.

o twidth

  メンバー変数 twidth にはロードしたいテクスチャの幅に関する情報を与え
ます. テクスチャの幅からこの値を求めるときは, マクロ GS_TT_TWIDTH() 
を使用します.

	---------------------------------------------------------
	 GS_TT_TWIDTH(pix,siz): twidth の設定値
	 pix:	テクスチャの幅
	 siz:	1 テクセルのサイズ  G_IM_SIZ_* で指定
	---------------------------------------------------------

o theight

  メンバー変数 theight にはロードしたいテクスチャの高さの情報を与えま
す.  テクスチャの高さからこの値を求めるときは, マクロ GS_TT_THEIGHT() 
を使用します.

	----------------------------------------------
	 GS_TT_THEIGHT(pix,siz): theight の設定値
	 pix:	テクスチャの高さ
	 siz:	1 テクセルのサイズ  G_IM_SIZ_* で指定
	----------------------------------------------


3) TLUT のロード (uObjTLUT_t 構造体)

o phead

  メンバー変数 phead にはロードしたい TLUT 領域の先頭番号を設定します.
TLUT 領域の番号は通常の TLUT の ID に 256 を加えた値になっています. そ
のため設定する値は 256 から 511 までとなっています. この設定のためにマ
クロ GS_PAL_HEAD() を用意しています.

	----------------------------------------------------------------
	 GS_PAL_HEAD(head): phead の設定値 (head に 256 を加算するだけ)
	 head:	ロードしたい TLUT の先頭 ID
	----------------------------------------------------------------

o pnum

  メンバー変数 pnum には(ロードする TLUT の色数-1)を設定します.
この設定にマクロ GS_PAL_NUM() を用意しています.

	----------------------------------------------------------
	 GS_PAL_NUM(num): pnum の設定値 (num から 1 を減ずるたけ)
	 num:	ロードしたい TLUT の数
	----------------------------------------------------------

o zero

  このメンバーは uObjTLUT_t では使用されていません. ただし他の構造体と
の互換性のため, 必ず 0 を代入してください.


以下は 3 つの構造体の設定例です.

  (1) LoadBlock による RGBA16 Texture ロード

	uObjTxtr objTxtrBlock_RGBA16 = {
	  G_OBJLT_TXTRBLOCK,                    /* type    */
	  (u64 *)textureRGBA16,                 /* image   */
	  GS_PIX2TMEM(0,     G_IM_SIZ_16b),     /* tmem    */
	  GS_TB_TSIZE(32*32, G_IM_SIZ_16b),     /* tsize   */
	  GS_TB_TLINE(32,    G_IM_SIZ_16b),     /* tline   */
	  0,                                    /* sid     */
	  (u32)textureRGBA16,                   /* flag    */
	  -1                                    /* mask    */
	};

  (2) LoadTile による CI4 Texture ロード 

	uObjTxtr objTxtrTile_CI4 = {
	  G_OBJLT_TXTRTILE,                     /* type    */
	  (u64 *)textureCI4,                    /* image   */
	  GS_PIX2TMEM  (0,  G_IM_SIZ_4b),	/* tmem    */
	  GS_TT_TWIDTH (32, G_IM_SIZ_4b),	/* twidth  */
	  GS_TT_THEIGHT(32, G_IM_SIZ_4b),	/* theight */
	  0,                                    /* sid     */
	  (u32)textureCI4,                      /* flag    */
	  -1                                    /* mask    */
	};

  (3) TLUT ロード

	uObjTxtr objTLUT_CI4 = {
	  G_OBJLT_TLUT,                         /* type    */
	  (u64 *)textureCI4pal,                 /* image   */
	  GS_PAL_HEAD(0),                       /* phead   */
	  GS_PAL_NUM(16),                       /* pnum    */
	  0,                                    /* zero    */
	  0,                                    /* sid     */
	  (u32)textureCI4pal,                   /* flag    */
	  -1                                    /* mask    */
	};


------------------
4.6  複合処理 GBI

  実際のゲームの製作においては, テクスチャのロード GBI と Sprite の描
画の GBI を一まとめにした方が Sprite の管理などの面で有利である場合が
あります. S2DEX ではこの 2 つの GBI を 1 つの GBI で処理できるような仕
組みを用意しました. この複合処理のための GBI について説明します.


---------------------------
4.6.1  uObjTxSprite 構造体

  uObjTxSprite 構造体は, uObjTxtr 構造体と uObjSprite 構造体を連結した
もので, 以下の形式を取ります. 複合処理 GBI には, この構造体へのポイン
タを引数として与えます.

		----------------------------------------
		 typedef struct  {
		   uObjTxtr      txtr;
		   uObjSprite    sprite;
		 } uObjTxSprite;         /* 48 bytes */
		----------------------------------------


------------------------
4.6.2  gSPObjLoadTxRect

	------------------------------------------------------------------
	 gSPObjLoadTxRect(Gfx *gdl, uObjTxSprite *txsp)
	 gsSPObjLoadTxRect(uObjTxSprite *txsp)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjTxSprite	*txsp;	テクスチャロード, Sprite 描画データ構造体
				へのポインタ
	------------------------------------------------------------------

  g[s]SPObjLoadTxRect GBI は, テクスチャのロード処理を行なってから, 回
転しない Sprite の描画を行ないます. 

  この命令は, 2 つの GBI g[s]SPObjLoadTxtr と g[s]SPObjRectangle とを 
1 つの GBI で順次処理するものです. 以下の (A) と (B) の処理結果は等し
くなります.

	(A) gsSPObjLoadTxRect(txsp);

	(B) gsSPObjLoadTxtr(&(txsp->txtr));
	    gsSPObjRectangle(&(txsp->sprite));


------------------------
4.6.3  gSPObjLoadTxRectR

	------------------------------------------------------------------
	 gSPObjLoadTxRectR(Gfx *gdl, uObjTxSprite *txsp)
	 gsSPObjLoadTxRectR(uObjTxSprite *txsp)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjTxSprite	*txsp;	テクスチャロード, Sprite 描画データ構造体
				へのポインタ
	------------------------------------------------------------------

  g[s]SPObjLoadTxRectR GBI は, テクスチャのロード処理を行なってから,
2D マトリクスを参照する回転しない Sprite の描画を行ないます.

  この命令は, 2 つの GBI g[s]SPObjLoadTxtr と g[s]SPObjRectangleR とを 
1 つの GBI で順次処理するものです. 以下の (A) と (B) の処理結果は等し
くなります.

	(A) gsSPObjLoadTxRectR(txsp);

	(B) gsSPObjLoadTxtr(&(txsp->txtr));
	    gsSPObjRectangleR(&(txsp->sprite));


------------------------
4.6.4  gSPObjLoadTxSprite

	------------------------------------------------------------------
	 gSPObjLoadTxSprite(Gfx *gdl, uObjTxSprite *txsp)
	 gsSPObjLoadTxSprite(uObjTxSprite *txsp)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 uObjTxSprite	*txsp;	テクスチャロード, Sprite 描画データ構造体
				へのポインタ
	------------------------------------------------------------------

  g[s]SPObjLoadTxSprite GBI は, テクスチャのロード処理を行なってから,
回転する Sprite の描画を行ないます.

  この命令は, 2 つの GBI g[s]SPObjLoadTxtr と g[s]SPObjSprite とを 1 
つの GBI で順次処理するものです. 以下の (A) と (B) の処理結果は等しく
なります.

	(A) gsSPObjLoadTxSprite(txsp);

	(B) gsSPObjLoadTxtr(&(txsp->txtr));
	    gsSPObjSprite(&(txsp->sprite));


------------------
4.7  条件分岐 GBI

  S2DEX では RSP の Status を用いたテクスチャのロード判定を行なってい
ることは以前に説明しました. ここでは, その Status を DL の分岐およびリ
ンクに応用した GBI について説明します.


--------------------
4.7.1  gSPSetStatus

	------------------------------------------------------------------
	 gSPSetStatus(Gfx *gdl, u8 sid, u32 val)
	 gsSPSetStatus(u8 sid, u32 val)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 u8		 sid;	Status ID { 0, 4, 8, 12 } のどれか
	 u32		 val;	セットしたい値
	------------------------------------------------------------------

  g[s]SPSetStatus は, sid で指定した Status 領域 (Status[sid]) に val 
値を代入します. この Status 値は, テクスチャロード時や分岐判定時に参照
されます.


-------------------
4.7.2  gSPSelectDL

	------------------------------------------------------------------
	 gSPSelectDL(Gfx *gdl, Gfx *ldl, u8 sid, u32 flag, u32 mask)
	 gsSPSelectDL(Gfx *ldl, u8 sid, u32 flag, u32 mask)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 Gfx		*ldl;	リンクするディスプレイリスト
	 u8		 sid;	Status ID { 0, 4, 8, 12 } のどれか
	 u32		 flag;	Status flag
	 u32		 mask;	Status mask
	------------------------------------------------------------------

  g[s]SPSelectDL は, テクスチャロード判定時と同様の判定式を用いて 
Status[sid] を検査し, その真偽に応じて他のディスプレイリストを呼び出し
ます.

  g[s]SPSelectDL は, 以下のような処理で分岐判定を行ない, ディスプレイ
リストを呼び出すかどうかを決定します.

  + (Status[sid] & mask) == flag を調べる.
  + 結果が真なら, 何もせずに GBI を終了する.
  + 結果が偽なら, Status[sid] = (Status[sid] & ~mask) | (flag & mask);
                  のように Status[sid] を更新し, ディスプレイリスト ldl
                  を呼び出す.


-------------------------
4.7.3  gSPSelectBranchDL

	--------------------------------------------------------------------
	 gSPSelectBranchDL(Gfx *gdl, Gfx *bdl, u8 sid, u32 flag, u32 mask)
	 gsSPSelectBranchDL(Gfx *bdl, u8 sid, u32 flag, u32 mask)

	 Gfx		*gdl;	ディスプレイリストポインタ
	 Gfx		*link;	リンクするディスプレイリスト
	 u8		 sid;	Status ID { 0, 4, 8, 12 } のどれか
	 u32		 flag;	Status flag
	 u32		 mask;	Status mask
	--------------------------------------------------------------------

  g[s]SPSelectBranchDL は, テクスチャロード判定時と同様の判定式を用い
て Status[sid] を検査し, その真偽に応じて他のディスプレイリストへ分岐
します.

  g[s]SPSelectBranchDL は, 以下のような処理で分岐判定を行ない, ディス
プレイリストを呼び出すかどうかを決定します.

  + (Status[sid] & mask) == flag を調べる.
  + 結果が真なら, 何もせずに GBI を終了する.
  + 結果が偽なら, Status[sid] = (Status[sid] & ~mask) | (flag & mask);
                  のように Status[sid] を更新し, ディスプレイリスト bdl
                  へ分岐する.


-------------------------------------------------------------------------------
5. エミュレート関数

  S2DEX GBI の機能を CPU でエミュレートするための関数です.

------------------------
5.1  guS2DEmuBgRect1Cyc

 --------------------------------------------------------------------------
	void	guS2DEmuBgRect1Cyc(Gfx **gdl_p, uObjBg *bg);

	説明:	S2DEX マイクロコードの gSPBgRect1Cyc GBI の動作を他の GBI
		を組み合わせることによって CPU でエミュレートする.
	
	引数:	gdl_p	ディスプレィリストへのポインタのポインタ
			*gdl_p の値は自動的に加算される.
		bg	uObjBg 構造体へのポインタ
 --------------------------------------------------------------------------

  gSPBgRect1Cyc(gdl ++, bg) の呼び出しは guS2DEmuBgRect1Cyc(&gdl, bg) 
に置き換えることができます. 引数 bg についての説明は gSPBgRect1Cyc の
項を参照してください.

  またシザリングボックスの設定および Texture Filter の設定を本ルーチン
に知らせるために後述の guS2DEmuSetScissor 関数を guS2DEmuBgRect1Cyc よ
り前に呼び出しておく必要があります.

  この関数は S2DEX のみでなく F3DEX シリーズでも処理可能な GBI を生成
します. そのためスケーリングされたスクロール BG 面と 3D モデルとを一緒
に表示するときにも 1 つのマイクロコードで処理できます.


------------------------
5.2  guS2DEmuSetScissor

 --------------------------------------------------------------------------
	void	guS2DEmuSetScissor(u32 ulx, u32 uly,
		                   u32 lrx, u32 lry, u8 bilerp);

	説明:	関数 guS2DEmuBgRect1Cyc の処理時に参照されるシザリング
		パラメータおよび Texture Filter を設定する.
	
	引数:	ulx	シザーボックス 左上 X 座標 (u10.0)
		uly	シザーボックス 左上 Y 座標 (u10.0)
		lrx	シザーボックス 右下 X 座標 (u10.0)
		lry	シザーボックス 右下 Y 座標 (u10.0)
		bilerp	イメージに Bilerp 補間処理を掛けるなら 0 以外の
			値を, PointSample なら 0 を設定する.

 --------------------------------------------------------------------------
 
  通常この関数には g[s]DPSetScissor で設定したシザーボックスの範囲を引
数として渡します. また, ulx, uly, lrx, lry, bilerp の初期値はそれぞれ,
0, 0, 320, 240, 0 となっており, 320x240 画素のフレームバッファに 
PointSample で描画するという設定になっています.

  この関数は, guS2DEmuBgRect1Cyc が呼ばれる前に一度だけ呼んでおけば十
分です.  シザ─ボックスおよび Texture Filter に変化が無い場合は, ゲー
ムの初期化時に一度だけ呼び出せば良く, フレーム描画時に毎回呼び出す必要
はありません.


-------------------------------------------------------------------------------
6. DEBUG 情報出力機能

  S2DEX には出荷時に組み込まれる通常のマイクロコードとは別に, DEBUG 時
のためのマイクロコードを用意しています. この 2 つのマイクロコードの関
係は, libultra_rom.a と libultra_d.a の関係と同じです.

  DEBUG 用のマイクロコード S2DEX_D は, 通常のマイクロコードよりも処理速度は遅くなっていますが, 以下の機能があります.

	o ディスプレイリストの処理ログの出力
	o 不正な入力値および未定義のコマンドがあったときには RSP を停
	  止させ, そのことを CPU へ伝える.

  特にディスプレイリストの処理ログを調べることで RSP の暴走などの原因
の調査が楽になります. 

  S2DEX_D を使用するためには, RSP ディスプレイリストの処理ログの出力バッ
ファを用意する必要があります. これはディスプレイリストの長さと同じだけ
の領域が必要です. また 8 bytes で整列されていなければなりません.

  この領域を確保したら, 領域の先頭へのポインタを OSTask 構造体のメンバー
変数 data_size に設定します. このメンバー変数は S2DEX および F3DEX シ
リーズでは本来の DL のサイズという意味には使用されていません. これは,
N64 開発ライブラリの Ver 1.0 におけるなごりで残っているだけですので, 
これをログの出力バッファとして流用します.

  このアドレスは Segment アドレスであってはいけません. この後, マイク
ロコードとして gspS2DEX.fifo_d.o を起動すれば処理ログが指定したアドレ
スに格納されていきます.

  処理ログの表示方法に関しては付属のサンプルプログラムの uc_assert.c 
内の関数 ucDebugGfxLogPrint() を参考にしてください. また RSP の停止の
判定に関しては同じファイルの ucCheckAssert() を参考にしてください.

(注意)
  S2DEX のバージョン 0.75 以前はログバッファの設定用として, OSTask 構
造体のメンバー変数 yield_data_size を使用していましたが, 0.76 以降では 
data_size を使用することになりました. それに伴い表示用の関数 
ucDebugGfxLogPrint() も修正されましたのでご注意ください.


-------------------------------------------------------------------------------
7. S2DEX パッケージのインストール

  ------------------------------------------------------------------------
     本章の記述は, S2DEX マイクロコードが別パッケージで配布されている場合
   に関するもので, 既に N64 開発環境に本パッケージが含まれている場合はこ
   こに記載されている作業は必要ありません.
  ------------------------------------------------------------------------

  S2DEX マイクロコードのパッケージは以下のファイルからなります.

	--------------------------------------------------------
	 README			本ファイル
	 gspS2DEX.fifo.o	S2DEX マイクロコード
	 gspS2DEX.fifo_d.o	S2DEX マイクロコード (DEBUG 用)
	 include/gs2dex.h	S2DEX 用インクルードファイル
	 libultra/Makefile	libultra アップデート用 makefile
	 libultra/us2dex.o	BG 構造体初期化ルーチン
	 libultra/us2dex_emu.o	拡大縮小可能な BG 描画ルーチン
	 sample/*		S2DEX サンプルプログラム
	--------------------------------------------------------	

  ディレクトリ libultra の下で, make をかければ libultra*.a が作成され
ます. 作成された libultra*.a を /usr/lib 以下へコピーしてください.
  また gspS2DEX.fifo.o, gspS2DEX.fifo_d.o を /usr/lib/PR へ
include/gs2dex.h を /usr/include/PR へコピーしてお使い下さい.

  また付属のサンプルプログラムのコンパイルには perl が必要です.
IRIX 5.3/6.X CD 内の以下のパッケージをインストールしてください.

	eoe2.sw.gifts_perl (IRIX 5.3 の場合)
	eoe.sw.gifts_perl  (IRIX 6.X の場合)

-------------------------------------------------------------------------------
8. 変更履歴

03/26/97:
    Release 0.70 (beta 1)
	* 初版作成.

03/28/97:
    Release 0.71 (beta 2)
	* libultra のパッチの追加.
	* インストール情報の修正.

04/01/97:
    Release 0.72 (beta 3)
	* BG 描画における S 反転の動作が正しくなかったのを修正.
	* サンプルプログラムを一部変更.

04/10/97:
    Release 0.73 (beta 4)
	* 新たな RenderMode を定義.
	* gSPObjRenderMode に新しい機能 G_OBJRM_WIDEN を追加した.
	* サンプルプログラムを変更し, 半透明 Sprite および BG に CI8 
	  テクスチャを使用できるようにした.

04/21/97:
    Release 0.74 (beta 5)
	* 小さな FIFO バッファを使用したときにバッファの状態チェックが
	  不十分だったのを修正. 
	* 構造体 uObjBg のメンバ変数 imageX, imageY のフォーマットが
	  (u10.2) で実装されていたのを (u10.5) に修正.
	* 構造体 uObjBg のメンバ変数 frameX, frameY を signed に変更.

05/09/97:
    Release 0.75 (beta6)
	* 拡大縮小可能な BG 面の DL を CPU によって生成する関数
	  guS2DEmuBgRect1Cyc() および guS2DEmuSetScissor() を作成し,
	  Patch として配布, またこれに関する README の項の追加した.
	* マイクロコードは 0.74 と変化なし
	* perl のインストール方法の記述の追加

05/16/97:
    Release 0.80 (beta7)
	* ログ出力バッファの設定方法の変更 (yield_data_size ->
	  data_size)
	* yield 処理におけるバグの修正.
	* README ファイル 2.4 項の FIFO バッファのサイズに関する記述の
	  追加.
	* BG 描画 GBI/エミュレーション関数における Sync 処理の修正.

06/03/97:
    Release 1.00
	* 拡大縮小可能な BG 面を描画する GBI である g[s]SPBgRect1Cyc 
	  を実装した.
	* 構造体の Alignment のため, uObjBg_t 構造体と uObjScaleBg_t 
	  構造体のメンバー変数 imagePal, imageFlip の型を u8 から u16 
	  へ変更した.
	* ドキュメントに "3.4 GBI に関する注意事項" を追加.
	* uObjMtx 構造体の BaseScaleX, BaseScaleY および uObjSprite 構
	  造体の scaleW, scaleH を unsigned に変更.

06/13/97:
    Release 1.01
	* g[s]SPBgRect1Cyc で, 時々無駄なテクスチャロード処理が行なわ
	  れ, RDP 処理時間が大幅に増大するというバグを修正.

07/03/97:
    Release 1.02
	* 複数の半透明 Sprite を継いだ時に, 継ぎ目のラインが 2 度ブ
	  レンドされてしまうのを修正. これに伴い, ObjRenderMode として
	  G_OBJRM_XLU モードを追加した. (4.4.1 参照)
	* 同じ Sprite データを g[s]SPObjRectangle と g[s]SPObjSprite で
	  描画したときに実際に描画されるサイズの差を小さくした.

07/04/97:
    Release 1.03
	* G_OBJRM_XLU モードのバグを修正した.
	* サンプルプログラムで Bilerp 時における複数枚の Sprite を組み
	  合わせて Object を表現するときの処理例(Ball の描画)を追加.

07/31/97:
    Release 1.04
	* Release 1.02 で行なった半透明表示時における継ぎ目のラインの
	  処理が不十分だったので抜本的な対策を行なう. 具体的には,
	  Sprite の描画処理の精度を上げた. この影響で G_OBJRM_XLU モー
	  ドおよび G_OBJRM_ANTIALIAS モードが不要になる. (4.4.1 参照)
	* RDP の RenderMode の定義を整備した. 特に半透明の Sprite 表示
	  時におけるモードを AntiAlias On と Off の時とに分離した.
	  またこの説明のために 4.4.2 項を追加した.

08/07/97:
    Release 1.05
	* 細長い Sprite を描画時にテクスチャがずれるのを Sprite の描画
	  処理の精度をさらに上げることで修正.
	* Rectangle の計算精度を上げる. これにより RectR 系命令を使って
	  Rectangle を並べたときに発生する隙間をなくす. (従来は 
	  ObjRenderMode の G_OBJRM_WIDEN で塞いでいた.)
	* サンプルプログラムに RectR を使用したボールを追加. 
	  また, G_OBJRM_WIDEN を使わないように修正.

10/29/97:
    Release 1.06 (N64 Dev Env. 2.0i)
	* g[s]SPSelectDL, g[s]SPSelectBranchDL のマクロ定義の誤りを修正.
	* gSPBgRect1Cyc 処理後の gSPObjLoadTxRectR の動作が不正であるこ
	  との修正.
	* gSPObjLoadTxRect の動作が不正であることの修正.
	* マイクロコードの Data 領域のサイズを縮小させた. これにより僅か
	  ながらもユーザが使用できる RAM の領域が増えた.

12/25/97:
    Release 1.06+
	* 本 README.jp ファイルの誤植および意味が判りにくい点の修正.

04/10/98:
    Release 1.07
	* gSPBgRectCopy 命令で幅の狭いフレームに対する描画処理が正常に
	  機能しなかったことを修正.

-------------------------------------------------------------------------------