G2S_GetBG3ScrPtr

Syntax

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

Arguments

None.

Return Values

A pointer to the region storing the BG3 screen.

Description

This function returns a pointer to the region where sub 2D engine BG3 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_SetBG3ControlText)

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_SetBG3Control256Bmp)

See Also

G2S_SetBG3ControlText, ... , G2S_SetBG3Priority, G2S_BG3Mosaic, G2S_GetBG3CharPtr, G2S_SetBG3Offset

Revision History

2004/02/09 Initial version.


CONFIDENTIAL