G2S_GetBG2ScrPtr


C Specification

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

Description

This function returns a pointer to the region where sub 2D engine BG2 screen data is stored. That is, the return value is, in the case of character BG, the value at the end of the enumerator type value name GXBGScrBase that is specified by HW_DB_BG_VRAM + (G2S_SetBG2ControlText), etc. In the case of bitmapped BG it will be the value at the end of the enumerator type value name GXBGBmpScrBase that is specified by HW_DB_BG_VRAM + (G2S_SetBG2Control256Bmp), etc.

Arguments

None

Return Values

Pointer to the region where the BG2 screen data is stored.

See Also

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

Revision History

02/09/2004 Initial Version