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

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

 *---------------------------------------------------------------------------*/
// -----------------------------------------------------------------------------
//  demoGfd.h
//
// -----------------------------------------------------------------------------

#ifndef __DEMO_GFD_H__
#define __DEMO_GFD_H__

#include <cafe/demo.h>

#ifdef __cplusplus
extern "C" {
#endif

/// @addtogroup demoGfd
/// @{

/// \brief Get a GX2VertexShader with actual shader data from a block of memory loaded from GX2 shader file (.gsh)
///
/// Given raw data loaded from .gsh shader file, and an initialized GX2VertexShader structure,
/// this fills the GX2VertexShader structure with data from the n'th vertex shader in the file.
///
/// \param ppShader             Pointer-pointer to GX2VertexShader structure
/// \param index                Index of vertex shader to extract.
/// \param pData                Input data, mapped from GX2 Shader file.
/// \retval                     True on success, or false if data is invalid or index is out of range.
///
BOOL DEMOGFDReadVertexShader(GX2VertexShader **ppShader, u32 index, const void *pData);

/// \brief Get a GX2PixelShader with actual shader data from a block of memory loaded from GX2 shader file (.gsh)
///
/// Given raw data loaded from .gsh shader file, and an initialized GX2PixelShader structure,
/// this fills the GX2PixelShader structure with data from the n'th pixel shader in the file.
///
/// \param ppShader             Pointer-pointer to GX2PixelShader structure
/// \param index                Index of pixel shader to extract.
/// \param pData                Input data, mapped from GX2 Shader file.
/// \retval                     True on success, or false if data is invalid or index is out of range.
///
BOOL DEMOGFDReadPixelShader(GX2PixelShader **ppShader, u32 index, const void *pData);

/// \brief Get a GX2GeometryShader with actual shader data from a block of memory loaded from GX2 shader file (.gsh)
///
/// Given raw data loaded from .gsh shader file, and an initialized GX2GeometryShader structure,
/// this fills the GX2GeometryShader structure with data from the n'th geometry shader in the file.
///
/// \param ppShader             Pointer-pointer to GX2GeometryShader structure
/// \param index                Index of geometry shader to extract.
/// \param pData                Input data, mapped from GX2 Shader file.
/// \retval                     True on success, or false if data is invalid or index is out of range.
///
BOOL DEMOGFDReadGeometryShader(GX2GeometryShader **ppShader, u32 index, const void *pData);

/// \brief Get a GX2ComputeShader with actual shader data from a block of memory loaded from GX2 shader file (.gsh)
///
/// Given raw data loaded from .gsh shader file, and an initialized GX2ComputeShader structure,
/// this fills the GX2ComputeShader structure with data from the n'th compute shader in the file.
///
/// \param ppShader             Pointer-pointer to GX2ComputeShader structure
/// \param index                Index of vertex shader to extract.
/// \param pData                Input data, mapped from GX2 Shader file.
/// \retval                     True on success, or false if data is invalid or index is out of range.
///
BOOL DEMOGFDReadComputeShader(GX2ComputeShader **ppShader, u32 index, const void *pData);

/// \brief Get a GX2Texture with actual texture data from a block of memory loaded from a GX2 texture file (.gtx)
///
/// Given raw data loaded from .gtx texture file, and an initialized GX2Texture structure,
/// this fills the GX2Texture structure with data for the n'th texture in the file.
///
/// \param ppTexture        Pointer-pointer to GX2Texture Structure
/// \param index            Which texture to extract.
/// \param pData            Input data, mapped from GX2 texture file (.gtx).
/// \retval                 True on success, or false if data is invalid or index is out of range.
///
BOOL DEMOGFDReadTexture(GX2Texture **ppTexture, u32 index, const void *pData);

/// \brief Free a GX2VertexShader data
///
/// \param pShader         Pointer to GX2VertexShader Structure
///
void DEMOGFDFreeVertexShader(GX2VertexShader *pShader);

/// \brief Free a GX2PixelShader data
///
/// \param pShader         Pointer to GX2PixelShader Structure
///
void DEMOGFDFreePixelShader(GX2PixelShader *pShader);

/// \brief Free a GX2GeometryShader data
///
/// \param pShader         Pointer to GX2GeometryShader Structure
///
void DEMOGFDFreeGeometryShader(GX2GeometryShader *pShader);


/// \brief Free a GX2ComputeShader data
///
/// \param pShader         Pointer to GX2ComputeShader Structure
///
void DEMOGFDFreeComputeShader(GX2ComputeShader *pShader);

/// \brief Free a GX2Texture data
///
/// \param pTexture         Pointer to GX2Texture Structure
///
void DEMOGFDFreeTexture(GX2Texture *pTexture);

/// \brief Get GX2Texture pointer with actual texture data from a block of memory loaded from an aligned GX2 texture file (.gtx)
///
/// This buffer is aligned with alignSize.
/// File is automatically closed after it's read from.
/// Call \ref DEMOGFDFreeAlignedTexture() to free this buffer.
///
/// \param pFileBuf Pointer-pointer to file buffer
/// \param index Which texture to extract
/// \param align Alignment size for buffer
/// \param fileName File string name to read
/// \retval GX2Texture pointer
///
GX2Texture* DEMOGFDReadAlignedTexture(void **pFileBuf, u32 index, u32 align, const char *fileName);

/// \brief Free an aligned GX2Texture File buffer
///
/// \param pFileBuf         Pointer to GX2Texture File buffer
///
void DEMOGFDFreeAlignedTexture(void *pFileBuf);

/// @}  // demoGfd

#ifdef __cplusplus
}
#endif

#endif /// __DEMO_GFD_H__