1 /*---------------------------------------------------------------------------*
2 
3   Copyright (C) Nintendo.  All rights reserved.
4 
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 // tgaReader.h
14 //
15 // Declares functions for tgaReader library.
16 //
17 // -------------------------------------------------------
18 #ifndef TGAREADER_H
19 #define TGAREADER_H
20 
21 #include "TexConvert.h"
22 
23 namespace TGAReader
24 {
25 
26 /// @addtogroup GX2TexReaderGroup
27 /// @{
28 
29 #define TGAREADER_API __cdecl
30 
31 /// \brief Loading data from a TGA file
32 ///
33 /// \param pszFilename Input TGA texture file
34 /// \param pSurface GX2Surface created from TGA data
35 ///
36 /// \donotcall \threadsafe \hostonly \userheap \enddonotcall
37 ///
38 bool TGAREADER_API TGALoadFile(const TCHAR* pszFilename, GX2Surface* pSurface);
39 
40 /// \brief Free GX2Surface image (mip) buffer
41 ///
42 /// \param pSurface GX2Surface created from TGA data
43 ///
44 /// \donotcall \threadsafe \hostonly \userheap \enddonotcall
45 ///
46 bool TGAREADER_API TGAFree(GX2Surface* pSurface);
47 
48 /// @}
49 
50 }   //namespace TGAReader
51 
52 #endif  //#ifndef TGAREADER_H
53