G2S_GetBG2ScrPtr

C Specification

#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 are as follows for character BGs:

The value at the end of the enumerator type value name GXBGScrBase that is specified by HW_DB_BG_VRAM + (G2S_SetBG2ControlText).

The return values are as follows for bitmap BGs:

The value at the end of the enumerator type value name GXBGBmpScrBase that is specified by HW_DB_BG_VRAM + (G2S_SetBG2Control256Bmp).

See Also

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

Revision History

02/09/2004 Initial version.