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

  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.

 *---------------------------------------------------------------------------*/
// -------------------------------------------------------
// ddsReader.h
//
// Declares functions for ddsReader library.
//
// -------------------------------------------------------
#ifndef DDSREADER_H
#define DDSREADER_H

#include "TexConvert.h"

namespace DDSReader
{
#define DDSREADER_API __cdecl

/// @addtogroup GX2TexReaderGroup
/// @{

/// \brief Using data from a DDS file, fill in the supplied GX2Surface with surface data.
///
/// This routine provides a common interface for loading various surface formats
/// via the DirectDraw Surface file format (.dds). The contents of the file are
/// loaded into the provided GX2Surface structure, creating memory for surface
/// data and filling in descriptive fields in the structure appropriately.
///
/// \param pszFilename Input DDS texture file
/// \param pOutSurface GX2Surface structure to fill with converted DDS file data.
///
/// \donotcall \notthreadsafe \hostonly \enddonotcall
///
bool DDSREADER_API DDSLoadFile(const TCHAR* pszFilename, GX2Surface* pOutSurface);

/// \brief Free GX2Surface image (mip) buffer
///
/// \param pSurface GX2Surface created from DDS data
///
/// \donotcall \notthreadsafe \hostonly \enddonotcall
///
bool DDSREADER_API DDSFree(GX2Surface* pSurface);

/// \brief Creating DDS file using data from a GX2 Surface
///
/// \param pszFilename Output DDS texture file
/// \param pSurface GX2Surface to create dds
///
/// \donotcall \notthreadsafe \hostonly \enddonotcall
///
bool DDSREADER_API DDSSaveFile(const TCHAR* pszFilename, const GX2Surface* pSurface);

/// @}

}   //namespace DDSReader


#endif  //#ifndef DDSREADER_H