1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     gd_Resource.h
4   Copyright (C)2011 Nintendo Co., Ltd.  All rights reserved.
5   These coded instructions, statements, and computer programs contain
6   proprietary information of Nintendo of America Inc. and/or Nintendo
7   Company Ltd., and are protected by Federal copyright law. They may
8   not be disclosed to third parties or copied or duplicated in any form,
9   in whole or in part, without the prior written consent of Nintendo.
10  *---------------------------------------------------------------------------
11 
12 
13 */
14 #ifndef NN_GD_CTR_GD_RESOURCE_H_
15 #define NN_GD_CTR_GD_RESOURCE_H_
16 
17 #include <nn/gd/CTR/gd_Types.h>
18 #include <nn/gd/CTR/gd_Result.h>
19 
20 #include <nn/gd/CTR/gd_Memory.h>
21 
22 #if NN_GD_DOCUMENT_TYPE == ENGLISH
23 /* Please see man pages for details
24 
25 */
26 #else
27 /* Please see man pages for details
28 
29 */
30 #endif
31 
32 namespace nn {
33 namespace gd {
34 namespace CTR {
35 
36 #if NN_GD_DOCUMENT_TYPE == ENGLISH
37 /* Please see man pages for details
38 */
39 #else
40 /* Please see man pages for details
41 */
42 #endif
43 class VertexBufferResourceDescription;
44 
45 #if NN_GD_DOCUMENT_TYPE == ENGLISH
46 /* Please see man pages for details
47 */
48 #else
49 /* Please see man pages for details
50 */
51 #endif
52 class VertexBufferResourceProperties;
53 
54 #if NN_GD_DOCUMENT_TYPE == ENGLISH
55 /* Please see man pages for details
56 */
57 #else
58 /* Please see man pages for details
59 */
60 #endif
61 class VertexBufferResource;
62 
63 #if NN_GD_DOCUMENT_TYPE == ENGLISH
64 /* Please see man pages for details
65 */
66 #else
67 /* Please see man pages for details
68 */
69 #endif
70 class Texture2DResourceDescription;
71 
72 #if NN_GD_DOCUMENT_TYPE == ENGLISH
73 /* Please see man pages for details
74 */
75 #else
76 /* Please see man pages for details
77 */
78 #endif
79 class Texture2DResourceProperties;
80 
81 #if NN_GD_DOCUMENT_TYPE == ENGLISH
82 /* Please see man pages for details
83 */
84 #else
85 /* Please see man pages for details
86 */
87 #endif
88 class Texture2DResource;
89 
90 
91 #if NN_GD_DOCUMENT_TYPE == ENGLISH
92 /* Please see man pages for details
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 #else
148 /* Please see man pages for details
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 #endif
207 class Resource
208 {
209 public:
210 
211     #if NN_GD_DOCUMENT_TYPE == ENGLISH
212     /* Please see man pages for details
213 
214 
215     */
216     #else
217     /* Please see man pages for details
218 
219 
220     */
221     #endif
222     enum NativeResourceFormat
223     {
224        NATIVE_FORMAT_RGBA_8888            = 0,
225        NATIVE_FORMAT_RGB_888              = 1,
226        NATIVE_FORMAT_RGBA_5551            = 2,
227        NATIVE_FORMAT_RGB_565              = 3,
228        NATIVE_FORMAT_RGBA_4444            = 4,
229        NATIVE_FORMAT_LUMINANCE_ALPHA_88   = 5,
230        NATIVE_FORMAT_HILO_88              = 6,
231        NATIVE_FORMAT_LUMINANCE_8          = 7,
232        NATIVE_FORMAT_ALPHA_8              = 8,
233        NATIVE_FORMAT_LUMINANCE_ALPHA_44   = 9,
234        NATIVE_FORMAT_LUMINANCE_4          = 10,
235        NATIVE_FORMAT_ALPHA_4              = 11,
236        NATIVE_FORMAT_ETC1_RGB8            = 12,
237        NATIVE_FORMAT_ETC1_A4              = 13,
238        NATIVE_FORMAT_GAS                  = 14,
239        NATIVE_FORMAT_SHADOW               = 15,
240        NATIVE_FORMAT_DEPTH_16             = 16,
241        NATIVE_FORMAT_DEPTH_24             = 17,
242        NATIVE_FORMAT_DEPTH_24_STENCIL_8   = 18,
243 
244        NATIVE_FORMAT_RESERVED_MAX_U32 = 0xffffffffu
245     };
246 
247     #if NN_GD_DOCUMENT_TYPE == ENGLISH
248     /* Please see man pages for details
249 
250 
251 
252     */
253     #else
254     /* Please see man pages for details
255 
256 
257 
258     */
259     #endif
260     enum ResourceFormat
261     {
262         FORMAT_RGBA_8888             = 100,
263         FORMAT_RGB_888               = 101,
264         FORMAT_RGBA_5551             = 102,
265         FORMAT_RGB_565               = 103,
266         FORMAT_RGBA_4444             = 104,
267         FORMAT_LUMINANCE_ALPHA_88    = 105,
268         FORMAT_LUMINANCE_8           = 106,
269         FORMAT_ALPHA_8               = 107,
270         FORMAT_LUMINANCE_ALPHA_44    = 108,
271         FORMAT_LUMINANCE_4           = 109,
272         FORMAT_ALPHA_4               = 110,
273         FORMAT_RESERVED_MAX_U32 = 0xffffffffu
274     };
275 
276     #if NN_GD_DOCUMENT_TYPE == ENGLISH
277     /* Please see man pages for details */
278     #else
279     /* Please see man pages for details */
280     #endif
281     enum CompressedResourceFormat
282     {
283         FORMAT_ETC1_RGB8        = 111,
284         FORMAT_ETC1_A4          = 112,
285         FORMAT_ETC1_RESERVED_MAX_U32 = 0xffffffffu
286     };
287 
288     #if NN_GD_DOCUMENT_TYPE == ENGLISH
289     /* Please see man pages for details */
290     #else
291     /* Please see man pages for details */
292     #endif
293     enum MapUsage
294     {
295         MAP_READ_ONLY = 0,
296         MAP_WRITE_ONLY = 1,
297         MAP_READ_WRITE = 2,
298 
299         MAP_RESERVED_MAX_U32 = 0xffffffffu
300     };
301 
302     /* Please see man pages for details
303 
304     */
305     #if NN_GD_DOCUMENT_TYPE == ENGLISH
306     /* Please see man pages for details
307 
308     */
309     #else
310     /* Please see man pages for details
311 
312     */
313     #endif
314     class Helper
315     {
316     public:
317         #if NN_GD_DOCUMENT_TYPE == ENGLISH
318         /* Please see man pages for details
319 
320 
321 
322 
323 
324 
325 
326 
327         */
328         #else
329         /* Please see man pages for details
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         #endif
361         static nnResult ConvertTextureResourceToNativeFormat(ResourceFormat format, u32 width, u32 height, const u8* dataSrc, u8* dataDst, NativeResourceFormat* pnativeFormat = NULL);
362 
363         #if NN_GD_DOCUMENT_TYPE == ENGLISH
364         /* Please see man pages for details
365 
366 
367 
368 
369 
370 
371 
372 
373         */
374         #else
375         /* Please see man pages for details
376 
377 
378 
379 
380 
381 
382 
383 
384 
385 
386 
387 
388 
389 
390 
391 */
392         #endif
393         static nnResult ConvertCompressedTextureResourceToNativeFormat(CompressedResourceFormat format, u32 width, u32 height, u8* dataSrc, u8* dataDst, NativeResourceFormat* pnativeFormat = NULL);
394     };
395 
396     #if NN_GD_DOCUMENT_TYPE == ENGLISH
397     /* Please see man pages for details
398 
399 
400 
401 
402 
403 
404 
405 
406 
407 
408 
409     */
410     #else
411     /* Please see man pages for details
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     #endif
437     static nnResult CreateTexture2DResource(const Texture2DResourceDescription* description, const void* initialData, gdBool autoGenerateMipMapsFromData, Texture2DResource** texture2DResource);
438 
439     #if NN_GD_DOCUMENT_TYPE == ENGLISH
440     /* Please see man pages for details
441 
442 
443 
444 
445 
446 
447 
448 
449 
450     */
451     #else
452     /* Please see man pages for details
453 
454 
455 
456 
457 
458 
459 
460 
461     */
462     #endif
463     static nnResult CreateTexture2DResourceCastFrom(const Texture2DResource* initialTexture2DResource, Resource::NativeResourceFormat format, Memory::MemoryLayout layout, Texture2DResource** texture2DResource);
464 
465     #if NN_GD_DOCUMENT_TYPE == ENGLISH
466     /* Please see man pages for details
467 
468 
469     */
470     #else
471     /* Please see man pages for details
472 
473 
474 
475 
476 
477 
478 */
479     #endif
480     static nnResult GetTexture2DResourceProperties(const Texture2DResource* texture2DResource, Texture2DResourceProperties* properties);
481 
482     #if NN_GD_DOCUMENT_TYPE == ENGLISH
483     /* Please see man pages for details
484 
485     */
486     #else
487     /* Please see man pages for details
488 
489 
490 
491 
492 
493 
494 */
495     #endif
496     static nnResult ReleaseTexture2DResource(Texture2DResource* texture2DResource);
497 
498     #if NN_GD_DOCUMENT_TYPE == ENGLISH
499     /* Please see man pages for details
500 
501 
502 
503 
504 
505 
506 
507     */
508     #else
509     /* Please see man pages for details
510 
511 
512 
513 
514 
515 
516 
517 
518 
519 
520 
521 
522 
523 */
524     #endif
525     static nnResult MapTexture2DResource(Texture2DResource* texture2DResource, s32 mipLevelIndex, MapUsage usage, void** data);
526 
527     #if NN_GD_DOCUMENT_TYPE == ENGLISH
528     /* Please see man pages for details
529 
530     */
531     #else
532     /* Please see man pages for details
533 
534 
535 
536 
537 
538 */
539     #endif
540     static nnResult UnmapTexture2DResource(Texture2DResource* texture2DResource);
541     /*  */ // Name
542 
543 
544     /* Please see man pages for details
545 
546     */
547     #if NN_GD_DOCUMENT_TYPE == ENGLISH
548     /* Please see man pages for details
549 
550 
551 
552 
553 
554 
555 
556     */
557     #else
558     /* Please see man pages for details
559 
560 
561 
562 
563 
564 
565 
566 
567 
568 
569 
570 
571 
572 
573 
574 */
575     #endif
576     static nnResult CreateVertexBufferResource(VertexBufferResourceDescription *description, const void* initialData, VertexBufferResource **buffer);
577 
578     #if NN_GD_DOCUMENT_TYPE == ENGLISH
579     /* Please see man pages for details
580 
581 
582     */
583     #else
584     /* Please see man pages for details
585 
586 
587 
588 
589 
590 
591 */
592     #endif
593     static nnResult GetVertexBufferResourceProperties(const VertexBufferResource* buffer, VertexBufferResourceProperties* properties);
594 
595     #if NN_GD_DOCUMENT_TYPE == ENGLISH
596     /* Please see man pages for details
597 
598 
599 
600 
601 
602     */
603     #else
604     /* Please see man pages for details
605 
606 
607 
608 
609 
610 
611 
612 
613 
614 
615 
616 */
617     #endif
618     static nnResult MapVertexBufferResource(VertexBufferResource *buffer, MapUsage usage, void** data);
619 
620     #if NN_GD_DOCUMENT_TYPE == ENGLISH
621     /* Please see man pages for details
622 
623     */
624     #else
625     /* Please see man pages for details
626 
627 
628 
629 
630 
631 */
632     #endif
633     static nnResult UnmapVertexBufferResource(VertexBufferResource *buffer);
634 
635     #if NN_GD_DOCUMENT_TYPE == ENGLISH
636     /* Please see man pages for details
637 
638     */
639     #else
640     /* Please see man pages for details
641 
642 
643 
644 
645 
646 */
647     #endif
648     static nnResult ReleaseVertexBufferResource(VertexBufferResource *buffer);
649     /*  */ // Name
650 
651 };  // Resource
652 
653 
654 /*****************************************************************************************************************************/
655 /********************************************* Descriptor/Properties class definition ****************************************/
656 #if NN_GD_DOCUMENT_TYPE == ENGLISH
657 /* Please see man pages for details
658 
659 
660 */
661 #else
662 /* Please see man pages for details
663 
664 
665 */
666 #endif
667 class Texture2DResourceDescription
668 {
669 public:
670     #if NN_GD_DOCUMENT_TYPE == ENGLISH
671     /* Please see man pages for details */
672     #else
673     /* Please see man pages for details */
674     #endif
675     u32 m_Width;
676 
677     #if NN_GD_DOCUMENT_TYPE == ENGLISH
678     /* Please see man pages for details */
679     #else
680     /* Please see man pages for details */
681     #endif
682     u32 m_Height;
683 
684     #if NN_GD_DOCUMENT_TYPE == ENGLISH
685     /* Please see man pages for details */
686     #else
687     /* Please see man pages for details */
688     #endif
689     u32 m_CountMipLevels;
690 
691     #if NN_GD_DOCUMENT_TYPE == ENGLISH
692     /* Please see man pages for details */
693     #else
694     /* Please see man pages for details */
695     #endif
696     Resource::NativeResourceFormat m_Format;
697 
698     #if NN_GD_DOCUMENT_TYPE == ENGLISH
699     /* Please see man pages for details */
700     #else
701     /* Please see man pages for details */
702     #endif
703     Memory::MemoryLayout m_MemLayout;
704     #if NN_GD_DOCUMENT_TYPE == ENGLISH
705     /* Please see man pages for details */
706     #else
707     /* Please see man pages for details */
708     #endif
709     Memory::MemoryLocation m_MemLocation;
710 };  // Texture2DResourceDescription
711 
712 
713 #if NN_GD_DOCUMENT_TYPE == ENGLISH
714 /* Please see man pages for details
715 
716 
717 */
718 #else
719 /* Please see man pages for details
720 
721 
722 */
723 #endif
724 class MipmapResourceInfo
725 {
726 public:
727     #if NN_GD_DOCUMENT_TYPE == ENGLISH
728     /* Please see man pages for details */
729     #else
730     /* Please see man pages for details */
731     #endif
732     u32 m_Width;
733 
734     #if NN_GD_DOCUMENT_TYPE == ENGLISH
735     /* Please see man pages for details */
736     #else
737     /* Please see man pages for details */
738     #endif
739     u32 m_Height;
740 
741     #if NN_GD_DOCUMENT_TYPE == ENGLISH
742     /* Please see man pages for details */
743     #else
744     /* Please see man pages for details */
745     #endif
746     u8* m_MemAddr;
747 };
748 
749 
750 #if NN_GD_DOCUMENT_TYPE == ENGLISH
751 /* Please see man pages for details
752 
753 
754 */
755 #else
756 /* Please see man pages for details
757 
758 
759 */
760 #endif
761 class Texture2DResourceProperties
762 {
763 public:
764     #if NN_GD_DOCUMENT_TYPE == ENGLISH
765     /* Please see man pages for details */
766     #else
767     /* Please see man pages for details */
768     #endif
769     u32 m_Width;
770 
771     #if NN_GD_DOCUMENT_TYPE == ENGLISH
772     /* Please see man pages for details */
773     #else
774     /* Please see man pages for details */
775     #endif
776     u32 m_Height;
777 
778     #if NN_GD_DOCUMENT_TYPE == ENGLISH
779     /* Please see man pages for details */
780     #else
781     /* Please see man pages for details */
782     #endif
783     u32 m_CountMipLevels;
784 
785     #if NN_GD_DOCUMENT_TYPE == ENGLISH
786     /* Please see man pages for details */
787     #else
788     /* Please see man pages for details */
789     #endif
790     u32 m_PixelSize;
791 
792     #if NN_GD_DOCUMENT_TYPE == ENGLISH
793     /* Please see man pages for details */
794     #else
795     /* Please see man pages for details */
796     #endif
797     Resource::NativeResourceFormat m_Format;
798 
799     #if NN_GD_DOCUMENT_TYPE == ENGLISH
800     /* Please see man pages for details */
801     #else
802     /* Please see man pages for details */
803     #endif
804     Memory::MemoryLayout m_MemLayout;
805 
806     #if NN_GD_DOCUMENT_TYPE == ENGLISH
807     /* Please see man pages for details */
808     #else
809     /* Please see man pages for details */
810     #endif
811     Memory::MemoryLocation m_MemLocation;
812 
813     #if NN_GD_DOCUMENT_TYPE == ENGLISH
814     /* Please see man pages for details */
815     #else
816     /* Please see man pages for details */
817     #endif
818     u8* m_MemAddr;
819 
820     #if NN_GD_DOCUMENT_TYPE == ENGLISH
821     /* Please see man pages for details
822 
823     */
824     #else
825     /* Please see man pages for details
826 
827     */
828     #endif
GetMipmapAddress(u32 mipmapLevel)829     MipmapResourceInfo GetMipmapAddress(u32 mipmapLevel)
830     {
831         MipmapResourceInfo mipmapInfo;
832         mipmapInfo.m_Width = m_Width;
833         mipmapInfo.m_Height = m_Height;
834         mipmapInfo.m_MemAddr = m_MemAddr;
835         for (u32 i=0; i<mipmapLevel; ++i)
836         {
837             mipmapInfo.m_MemAddr += (mipmapInfo.m_Width * mipmapInfo.m_Height * m_PixelSize) >> 3;
838             mipmapInfo.m_Width >>= 1;
839             mipmapInfo.m_Height >>= 1;
840         }
841         return mipmapInfo;
842     }
843 };
844 
845 
846 #if NN_GD_DOCUMENT_TYPE == ENGLISH
847 /* Please see man pages for details
848 
849 
850 */
851 #else
852 /* Please see man pages for details
853 
854 
855 */
856 #endif
857 class VertexBufferResourceDescription
858 {
859 public:
860 #if NN_GD_DOCUMENT_TYPE == ENGLISH
861     /* Please see man pages for details */
862 #else
863     /* Please see man pages for details */
864 #endif
865     u32 m_ByteSize;
866 
867 #if NN_GD_DOCUMENT_TYPE == ENGLISH
868     /* Please see man pages for details */
869 #else
870     /* Please see man pages for details */
871 #endif
872     Memory::MemoryLocation m_MemLocation;
873 };
874 
875 
876 #if NN_GD_DOCUMENT_TYPE == ENGLISH
877 /* Please see man pages for details
878 
879 
880 */
881 #else
882 /* Please see man pages for details
883 
884 
885 */
886 #endif
887 class VertexBufferResourceProperties
888 {
889 public:
890 #if NN_GD_DOCUMENT_TYPE == ENGLISH
891     /* Please see man pages for details */
892 #else
893     //
894 #endif
895     u32 m_ByteSize;
896 
897 #if NN_GD_DOCUMENT_TYPE == ENGLISH
898     /* Please see man pages for details */
899 #else
900     /* Please see man pages for details */
901 #endif
902     Memory::MemoryLocation m_MemLocation;
903 
904 #if NN_GD_DOCUMENT_TYPE == ENGLISH
905     /* Please see man pages for details */
906 #else
907     /* Please see man pages for details */
908 #endif
909     u8* m_MemAddr;
910 };
911 
912 
913 }  // namespace CTR
914 }  // namespace gd
915 }  // namespace nn
916 
917 #endif //NN_GD_CTR_GD_RESOURCE_H_
918