/*---------------------------------------------------------------------------*

  Copyright (C) 2010-2011 Nintendo.  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.

 *---------------------------------------------------------------------------*/
// -------------------------------------------------------
// tgaReader.h
//
// Declares functions for tgaReader library.
//
// -------------------------------------------------------
#ifndef TGAREADER_H
#define TGAREADER_H

#include "TexConvert.h"

namespace TGAReader
{

/// @addtogroup GX2TexReaderGroup
/// @{

#define TGAREADER_API __cdecl

/// \brief Loading data from a TGA file
///
/// \param pszFilename Input TGA texture file
/// \param pSurface GX2Surface created from TGA data
///
/// \donotcall \threadsafe \hostonly \userheap \enddonotcall
///
bool TGAREADER_API TGALoadFile(const TCHAR* pszFilename, GX2Surface* pSurface);

/// \brief Free GX2Surface image (mip) buffer
///
/// \param pSurface GX2Surface created from TGA data
///
/// \donotcall \threadsafe \hostonly \userheap \enddonotcall
///
bool TGAREADER_API TGAFree(GX2Surface* pSurface);

/// @}

}   //namespace TGAReader

#endif  //#ifndef TGAREADER_H