# NNS_G2dGetUnpacked*

## C Specification

  `#include <nnsys/g2d/g2d_load.h>`

  `BOOL NNS_G2dGetUnpackedCellBank( void* pNcerFile, NNSG2dCellDataBank** ppCellBank );`
  `BOOL NNS_G2dGetUnpackedAnimBank( void* pNanrFile, NNSG2dAnimBankData** ppAnimBank );`
  `BOOL NNS_G2dGetUnpackedMCAnimBank( void* pNanrFile, NNSG2dAnimBankData** ppAnimBank );`
  `BOOL NNS_G2dGetUnpackedCharacterData( void* pNcgrFile, NNSG2dCharacterData** ppCharData );`
  `BOOL NNS_G2dGetUnpackedPaletteData( void* pNclrFile, NNSG2dPaletteData** ppPltData );`
  `BOOL NNS_G2dGetUnpackedPaletteCompressInfo( void* pNclrFile, NNSG2dPaletteCompressInfo** ppPltCmpInfo );`
  `BOOL NNS_G2dGetUnpackedEntityBank( void* pNenrFile, NNSG2dEntityDataBank** ppEntityBank );`
  `BOOL NNS_G2dGetUnpackedMultiCellBank( void* pNmcrFile, NNSG2dMultiCellDataBank** ppMCBank );`
  `BOOL NNS_G2dGetUnpackedBGCharacterData( void* pNcgrFile, NNSG2dCharacterData** ppCharData );`
  `BOOL NNS_G2dGetUnpackedScreenData( void* pNscrFile, NNSG2dScreenData** ppScrData );`
  `BOOL NNS_G2dGetUnpackedCharacterPosInfo( void* pNcgrFile, NNSG2dCharacterPosInfo** ppCharPosInfo );`

## Arguments

pNcerFile | [OUT] NCER file load result
pNanrFile | [OUT] NANR file load result
pNcgrFile | [OUT] NCGR file load result
pNclrFile | [OUT] NCLR file load result
pNenrFile | [OUT] NENR file load result
pNmcrFile | [OUT] NMCR file load result
pNscrFile | [OUT] NSCR file load result
ppCellBank | [OUT] Cell data bank
ppAnimBank | [OUT] Animation definition data bank
ppCharData | [OUT] Character data
ppPltData | [OUT] Palette data
ppPltCmpInfo | [OUT] Palette compression data
ppEntityBank | [OUT] Entity definition data bank
ppMCBank | [OUT] Multicell data bank
ppScrData | [OUT] Screen data
ppCharPosInfo | [OUT] Character region position data

## Return Values

Indicates if the data is successfully obtained.

## Description

These functions get the associated type of unpacked data from the binary file. The functions return a value of FALSE if unable to get the data. This function must be executed before any binary data is used. Execute the function only once for the data. Internally, extraction occurs to the memory offset pointer value.

## Note

#### About the proper use of NNS_G2dGetUnpackedCharacterData() and NNS_G2dGetUnpackedBGCharacterData():

There are two functions that can be used to expand Character data: NNS_G2dGetUnpackedCharacterData() and NNS_G2dGetUnpackedBGCharacterData(). NNS_G2dGetUnpackedCharacterData() is a function that processes OBJ-use Character data. NNS_G2dGetUnpackedBGCharacterData() is a function that processes BG-use Character data. The two functions operate almost identically, but the conditions set for the ASSERT statement that checks for invalid data differ. Therefore, using the wrong function may cause the processes to not operate correctly during a debug build.

## See Also

None.

## Revision History

09/01/2005 Added NNS_G2dGetUnpackedCharacterPosInfo and the Note section.

10/04/2004 Added NNS_G2dGetUnpackedPaletteCompressInfo.

09/02/2004 Added NNS_G2dGetUnpackedBGCharacterData and NNS_G2dGetUnpackedScreenData.

05/28/2004 Initial version.