/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     tpl_ReadTexturePackage.h

  Copyright (C)2010 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 20937 $
 *---------------------------------------------------------------------------*/

#ifndef NN_TPL_CTR_TPL_READTEXTUREPACKAGE_H_
#define NN_TPL_CTR_TPL_READTEXTUREPACKAGE_H_

#include "tpl_PackagerType.h"


#ifdef __cplusplus
extern "C" {
#endif


namespace nn { namespace tpl { namespace CTR {

    /*!
        @brief テクスチャインデックスを取得します。
        
        @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
        @param[in]  texPath  検索するテクスチャのパス(全て小文字、拡張子なし)
        @return  テクスチャのインデックス。見つからなかった場合は-1を返す。

        テクスチャ名のパスから、パッケージ内の該当テクスチャのインデックスを取得します。
        引数texPathには、テクスチャをパッケージする時の設定ファイルに記述したsrcを
        全て小文字に変換したものにしてください。
    */
    s16 GetTextureIndex(const void* pTexPackage, const char* texPath);

    /*!
        @brief テクスチャを取得します。
        
        @param[out]  mipLevel  ミップマップの枚数
        @param[out]  mipmapSize  各ミップマップのサイズ(配列を設定して下さい。)
        @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
        @param[in]  texIndex  テクスチャのインデックス。
        @return  テクスチャの先頭ポインタ。見つからなかった場合は0を返す。

        パッケージ内の該当テクスチャのポインタを返します。
        本体もミップマップの最大の大きさの物として考える為、
        該当テクスチャがある場合、必ずmiplevelは1以上になります。
    */
    void* GetTexture(s32* mipLevel, u32* mipmapSize, const void* pTexPackage, const s16 texIndex);

    /*!
        @brief テクスチャ情報を取得します。
        
        @param[out]  pTexInfo  該当テクスチャの情報を保持した構造体のポインタ
        @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
        @param[in]  texIndex  テクスチャのインデックス。
        @return  テクスチャ情報を取得出来た場合true。何らかのエラーが起きた場合false

        該当テクスチャの情報を取得します。
    */
    bool GetTextureInfo(CtrTextureInfo* pTexInfo, const void* pTexPackage, const s16 texIndex);

    /*!
        @brief テクスチャパッケージのチェックを行います。
        
        @param[in]  pTexPackage  テクスチャパッケージファイルを読み込んだ先頭ポインタ
        @return  使用出来るテクスチャパッケージファイルの場合true。使用出来ないor何らかのエラーが起きた場合false

        読み込んだテクスチャパッケージファイルのヘッダ部分を見て、
        使用出来るものかどうか？を判定します。
    */
    bool CheckTexturePackageHeader(const void* pTexPackage);


}}} // namespace


#ifdef __cplusplus
}
#endif

#endif // NN_TPL_CTR_TPL_READTEXTUREPACKAGE_H_