1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: gd_Memory.h 4 5 Copyright (C)2011 Nintendo Co., Ltd. All rights reserved. 6 7 These coded instructions, statements, and computer programs contain 8 proprietary information of Nintendo of America Inc. and/or Nintendo 9 Company Ltd., and are protected by Federal copyright law. They may 10 not be disclosed to third parties or copied or duplicated in any form, 11 in whole or in part, without the prior written consent of Nintendo. 12 13 *---------------------------------------------------------------------------*/ 14 #ifndef NN_GD_CTR_GD_MEMORY_H_ 15 #define NN_GD_CTR_GD_MEMORY_H_ 16 17 #include <nn/gd/CTR/gd_Types.h> 18 #include <nn/gd/CTR/gd_Result.h> 19 20 #if NN_GD_DOCUMENT_TYPE == ENGLISH 21 /* Please see man pages for details 22 23 */ 24 #else 25 /* Please see man pages for details 26 27 */ 28 #endif 29 namespace nn { 30 namespace gd { 31 namespace CTR { 32 33 class RenderTarget; 34 class DepthStencilTarget; 35 class Texture2DResource; 36 class VertexBufferResource; 37 38 #if NN_GD_DOCUMENT_TYPE == ENGLISH 39 /* Please see man pages for details 40 41 42 43 */ 44 /* */ // defgroup memoryOperation 45 46 /* Please see man pages for details 47 48 49 50 51 52 53 54 55 56 */ 57 #else 58 /* Please see man pages for details 59 60 61 62 */ 63 /* */ // defgroup memoryOperation 64 65 /* Please see man pages for details 66 67 68 69 70 71 72 */ 73 #endif 74 class Memory 75 { 76 public: 77 #if NN_GD_DOCUMENT_TYPE == ENGLISH 78 /* Please see man pages for details */ 79 #else 80 /* Please see man pages for details */ 81 #endif 82 enum MemoryLocation 83 { 84 FCRAM = 1 << 0, // 85 VRAMA = 1 << 1, // 86 VRAMB = 1 << 2, // 87 88 MEMORY_RESERVED_MAX_U32 = 0xffffffffu 89 }; 90 91 #if NN_GD_DOCUMENT_TYPE == ENGLISH 92 /* Please see man pages for details */ 93 #else 94 /* Please see man pages for details */ 95 #endif 96 enum MemoryLayout 97 { 98 #if NN_GD_DOCUMENT_TYPE == ENGLISH 99 /* Please see man pages for details */ 100 #else 101 /* Please see man pages for details */ 102 #endif 103 LAYOUT_LINEAR = 0, 104 105 #if NN_GD_DOCUMENT_TYPE == ENGLISH 106 /* Please see man pages for details */ 107 #else 108 /* Please see man pages for details */ 109 #endif 110 LAYOUT_BLOCK_8 = 8, 111 112 #if NN_GD_DOCUMENT_TYPE == ENGLISH 113 /* Please see man pages for details */ 114 #else 115 /* Please see man pages for details */ 116 #endif 117 LAYOUT_BLOCK_32 = 32, 118 119 MEMORYLAYOUT_RESERVED_MAX_U32 = 0xffffffffu 120 }; 121 122 #if NN_GD_DOCUMENT_TYPE == ENGLISH 123 /* Please see man pages for details */ 124 #else 125 /* Please see man pages for details */ 126 #endif 127 enum DownScalingMode 128 { 129 #if NN_GD_DOCUMENT_TYPE == ENGLISH 130 // 131 #else 132 // 133 #endif 134 DOWNSCALING_NONE = 0, 135 136 #if NN_GD_DOCUMENT_TYPE == ENGLISH 137 // 138 #else 139 // 140 #endif 141 DOWNSCALING_2X1 = 1, 142 143 #if NN_GD_DOCUMENT_TYPE == ENGLISH 144 // 145 #else 146 // 147 #endif 148 DOWNSCALING_2X2 = 2, 149 150 DOWNSCALING_RESERVED_MAX_U32 = 0xffffffffu 151 }; 152 153 #if NN_GD_DOCUMENT_TYPE == ENGLISH 154 /* Please see man pages for details */ 155 #else 156 /* Please see man pages for details */ 157 #endif 158 class Rect 159 { 160 public: 161 #if NN_GD_DOCUMENT_TYPE == ENGLISH 162 /* Please see man pages for details */ 163 #else 164 /* Please see man pages for details */ 165 #endif 166 s32 m_PosX; 167 168 #if NN_GD_DOCUMENT_TYPE == ENGLISH 169 /* Please see man pages for details */ 170 #else 171 /* Please see man pages for details */ 172 #endif 173 s32 m_PosY; 174 175 #if NN_GD_DOCUMENT_TYPE == ENGLISH 176 /* Please see man pages for details */ 177 #else 178 /* Please see man pages for details */ 179 #endif 180 s32 m_Width; 181 182 #if NN_GD_DOCUMENT_TYPE == ENGLISH 183 /* Please see man pages for details */ 184 #else 185 /* Please see man pages for details */ 186 #endif 187 s32 m_Height; 188 189 public: 190 #if NN_GD_DOCUMENT_TYPE == ENGLISH 191 /* Please see man pages for details */ 192 #else 193 /* Please see man pages for details */ 194 #endif Rect(s32 x,s32 y,s32 w,s32 h)195 Rect(s32 x, s32 y, s32 w, s32 h): m_PosX(x), m_PosY(y), m_Width(w), m_Height(h) {} 196 }; 197 198 #if NN_GD_DOCUMENT_TYPE == ENGLISH 199 /* Please see man pages for details 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 */ 219 #else 220 /* Please see man pages for details 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 */ 240 #endif 241 static nnResult ClearTexture2DResource(const Texture2DResource* tex2DResource, s32 mipLevelIndexStart, s32 mipLevelIndexEnd, const u8 Components[4]); 242 243 #if NN_GD_DOCUMENT_TYPE == ENGLISH 244 /* Please see man pages for details 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 */ 263 #else 264 /* Please see man pages for details 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 */ 284 #endif 285 static nnResult ClearTexture2DResource(const Texture2DResource* tex2DResource, s32 mipLevelIndexStart, s32 mipLevelIndexEnd, u32 value); 286 287 #if NN_GD_DOCUMENT_TYPE == ENGLISH 288 /* Please see man pages for details 289 290 291 292 293 294 295 296 297 298 299 */ 300 #else 301 /* Please see man pages for details 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 #endif 332 static nnResult ClearTargets(const RenderTarget* renderTarget, const DepthStencilTarget* depthStencilTarget, const u8 ColorRGBA[4], float depth, u8 stencil); 333 /* */ // name 334 335 #if NN_GD_DOCUMENT_TYPE == ENGLISH 336 /* Please see man pages for details 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 */ 358 #else 359 /* Please see man pages for details 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 */ 382 #endif 383 static nnResult CopyTextureSubResource(const Texture2DResource* source, s32 srcMipLevelIndex, const Rect& rect, 384 const Texture2DResource* dest, s32 dstMipLevelIndex, s32 destPosX, s32 destPosY); 385 386 #if NN_GD_DOCUMENT_TYPE == ENGLISH 387 /* Please see man pages for details 388 389 390 391 392 393 394 395 396 397 398 399 400 */ 401 #else 402 /* Please see man pages for details 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 */ 419 #endif 420 static nnResult CopyVertexBufferSubResource(const VertexBufferResource* source, u32 sourceOffset, u32 size, const VertexBufferResource* dest, u32 destOffset); 421 /* */ // name 422 423 #if NN_GD_DOCUMENT_TYPE == ENGLISH 424 /* Please see man pages for details 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 #else 468 /* Please see man pages for details 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 #endif 511 static nnResult CopyTexture2DResourceBlockToLinear(const Texture2DResource* source, s32 srcMipLevelIndex, u32 srcOffsetY, s32 srcCountRow, 512 const Texture2DResource* dest, s32 dstMipLevelIndex, u32 dstOffestY, DownScalingMode downScalingMode, gdBool yFlip); 513 514 #if NN_GD_DOCUMENT_TYPE == ENGLISH 515 /* Please see man pages for details 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 #else 563 /* Please see man pages for details 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 #endif 606 static nnResult CopyTexture2DResourceBlockToLinear(const Texture2DResource* source, s32 srcMipLevelIndex, u32 srcOffsetY, 607 u8* dstAddr, u32 dstWidth, u32 dstHeight, u32 dstFormat, DownScalingMode downScalingMode, gdBool yFlip); 608 609 #if NN_GD_DOCUMENT_TYPE == ENGLISH 610 /* Please see man pages for details 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 #else 654 /* Please see man pages for details 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 #endif 696 static nnResult CopyTexture2DResourceLinearToBlock(const Texture2DResource* source, s32 srcMipLevelIndex, u32 srcOffsetY, s32 srcCountRow, 697 const Texture2DResource* dest, s32 dstMipLevelIndex, u32 dstOffestY); 698 699 #if NN_GD_DOCUMENT_TYPE == ENGLISH 700 /* Please see man pages for details 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 #else 738 /* Please see man pages for details 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 #endif 776 static nnResult CopyTexture2DResourceLinearToBlock(u8* srcAddr, u32 width, u32 height, const Texture2DResource* dest, s32 dstMipLevelIndex, u32 dstOffestY); 777 778 #if NN_GD_DOCUMENT_TYPE == ENGLISH 779 /* Please see man pages for details 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 */ 798 #else 799 /* Please see man pages for details 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 #endif 829 static nnResult GenerateMipMaps(const Texture2DResource* tex2DResource, u32 mipLevelSourceIndex, s32 mipLevelLastDestinationIndex); 830 /* */ // name 831 832 }; // Memory 833 834 } // namespace CTR 835 } // gd 836 } // nn 837 838 #endif // NN_GD_CTR_GD_MEMORY_H_ 839