G2S_GetBG2ScrPtr

Syntax

#include <nitro/gx/g2.h>
void *G2S_GetBG2ScrPtr();

Arguments

None.

Return Values

The pointer to the region storing the BG2 screen.

Description

This function returns a pointer to the region where sub 2D engine BG2 screen data is stored. The return values for character BGs are as follows:

HW_DB_BG_VRAM + (Value at the end of the name in the GXBGScrBase enumerated type specified by functions such as G2S_SetBG2ControlText)

The return values are as follows for bitmap BGs:

HW_DB_BG_VRAM + (Value at the end of the name in the GXBGBmpScrBase enumerated type specified by functions such as G2S_SetBG2Control256Bmp)

See Also

G2S_SetBG2ControlText, ... , G2S_SetBG2Priority, G2S_BG2Mosaic, G2S_GetBG2CharPtr, G2S_SetBG2Offset

Revision History

2004/02/09 Initial version.


CONFIDENTIAL