# G2_GetBG2ScrPtr

## C Specification

      #include <nitro/gx/g2.h>

      void *G2_GetBG2ScrPtr();

## Arguments

None.

## Return Values

The pointer to the region storing the BG2 screen.

## Description

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

> `HW_BG_VRAM` + (Last value in the value name of `GXBGScrOffset` enum type specified by `GX_SetBGScrOffset`) + (Last value in the value name of `GXBGScrBase` enum type specified by `G2_SetBG2ControlText`)

The return values are as follows for bitmap BGs:

> `HW_BG_VRAM` + (Last value in the value name of `GXBGScrOffset` enum type specified by `GX_SetBGScrOffset`) + (Last value in the value name of `GXBGBmpScrBase` enum type specified by `G2_SetBG2Control256Bmp`)

## See Also

`G2_SetBG2ControlText, ... G2_SetBG2Priority, G2_BG2Mosaic, G2_GetBG2CharPtr, G2_SetBG2Offset`

## Revision History

02/09/2004

- Added to description.

01/19/2004 Initial version.