1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     tpl_ReadTexturePackage.h
4 
5   Copyright (C)2010 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   $Rev: 20937 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_TPL_CTR_TPL_READTEXTUREPACKAGE_H_
17 #define NN_TPL_CTR_TPL_READTEXTUREPACKAGE_H_
18 
19 #include "tpl_PackagerType.h"
20 
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 
27 namespace nn { namespace tpl { namespace CTR {
28 
29     /*!
30         @brief テクスチャインデックスを取得します。
31 
32         @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
33         @param[in]  texPath  検索するテクスチャのパス(全て小文字、拡張子なし)
34         @return  テクスチャのインデックス。見つからなかった場合は-1を返す。
35 
36         テクスチャ名のパスから、パッケージ内の該当テクスチャのインデックスを取得します。
37         引数texPathには、テクスチャをパッケージする時の設定ファイルに記述したsrcを
38         全て小文字に変換したものにしてください。
39     */
40     s16 GetTextureIndex(const void* pTexPackage, const char* texPath);
41 
42     /*!
43         @brief テクスチャを取得します。
44 
45         @param[out]  mipLevel  ミップマップの枚数
46         @param[out]  mipmapSize  各ミップマップのサイズ(配列を設定して下さい。)
47         @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
48         @param[in]  texIndex  テクスチャのインデックス。
49         @return  テクスチャの先頭ポインタ。見つからなかった場合は0を返す。
50 
51         パッケージ内の該当テクスチャのポインタを返します。
52         本体もミップマップの最大の大きさの物として考える為、
53         該当テクスチャがある場合、必ずmiplevelは1以上になります。
54     */
55     void* GetTexture(s32* mipLevel, u32* mipmapSize, const void* pTexPackage, const s16 texIndex);
56 
57     /*!
58         @brief テクスチャ情報を取得します。
59 
60         @param[out]  pTexInfo  該当テクスチャの情報を保持した構造体のポインタ
61         @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
62         @param[in]  texIndex  テクスチャのインデックス。
63         @return  テクスチャ情報を取得出来た場合true。何らかのエラーが起きた場合false
64 
65         該当テクスチャの情報を取得します。
66     */
67     bool GetTextureInfo(CtrTextureInfo* pTexInfo, const void* pTexPackage, const s16 texIndex);
68 
69     /*!
70         @brief テクスチャパッケージのチェックを行います。
71 
72         @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
73         @return  使用出来るテクスチャパッケージファイルの場合true。使用出来ないor何らかのエラーが起きた場合false
74 
75         読み込んだテクスチャパッケージファイルのヘッダ部分を見て、
76         使用出来るものかどうか?を判定します。
77     */
78     bool CheckTexturePackageHeader(const void* pTexPackage);
79 
80 
81 }}} // namespace
82 
83 
84 #ifdef __cplusplus
85 }
86 #endif
87 
88 #endif // NN_TPL_CTR_TPL_READTEXTUREPACKAGE_H_
89