NNS_G2dBGLoadElements*

Syntax

#include <nnsys/g2d/g2d_Screen.h>
void NNS_G2dBGLoadElements(
    NNSG2dBGSelect bg,
    const NNSG2dScreenData* pScnData,
    const NNSG2dCharacterData* pChrData,
    const NNSG2dPaletteData* pPltData,
);
void NNS_G2dBGLoadElementsEx(
    NNSG2dBGSelect bg,
    const NNSG2dScreenData* pScnData,
    const NNSG2dCharacterData* pChrData,
    const NNSG2dPaletteData* pPltData,
    const NNSG2dCharacterPosInfo* pPosInfo,
    const NNSG2dPaletteCompressInfo* pCmpInfo
);

Arguments

bg [IN] The BG screen using the data to be loaded.
pScnData [IN] Pointer to screen data. NULL can be specified for this pointer only when pPltData is NULL.
pChrData [IN] Pointer to the character data. NULL can also be specified.
pPltData [IN] Pointer to the palette data. NULL can also be specified.
pPosInfo [IN] Information about the character extraction region for pChrData. Specify NULL for this pointer if pChrData is not a partial character.
pCmpInfo [IN] The palette compression information of pPltData. Specify NULL if pPltData is not a compressed palette.

Return Values

None.

Description

Loads the graphics data used for Character BG to the appropriate VRAM. The load destination is determined from the BG settings, so the BG mode and BGControl for the target BG must be set appropriately. This function does not change the BG-related settings. It does not support BMP BG.

The load destination slot for the BG0 and BG1 extended palettes is determined automatically from the allocation status of the VRAM allocated to the extended palettes. If extended palettes are enabled, the Text BG 256 x 1 palette is loaded to the extended palette. Otherwise, it is loaded to the standard palette.

When NULL is specified for each parameter, the corresponding graphics data is not loaded. Use NULL when graphics data must be shared by multiple BG.

The following settings affect the result of this function. It is important to set these appropriately before calling the function.

To learn about the NNSG2dBGSelect type, see NNS_G2dBGSetup.

See Also

NNS_G2dBGSetup

Revision History

2004/09/02 Initial version.

CONFIDENTIAL