NNS_G2dGetUnpacked*

Syntax

#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. These functions must be executed before the various types of binary data are used.
Execute these functions only once on any particular set of data. Internally, these functions extract the data to the memory offset value's pointer value.

Note

Differentiating between 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 character data which uses OBJs. NNS_G2dGetUnpackedBGCharacterData() processes character data which uses BGs. The two functions carry out nearly identical processing, but the conditions set for the ASSERT statements that check for invalid data differ. Therefore, using the wrong function may cause the processes to not operate correctly during a debug build.

Revision History

2005/09/01 Added NNS_G2dGetUnpackedCharacterPosInfo and the cautionary Note.
2004/10/04 Added NNS_G2dGetUnpackedPaletteCompressInfo.
2004/09/02 Added NNS_G2dGetUnpackedBGCharacterData and NNS_G2dGetUnpackedScreenData.
2004/05/28 Initial version.

CONFIDENTIAL