# G2_GetBG2ScrPtr

## Syntax

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

> `HW_BG_VRAM`
> + (Value at the end of the name in the `GXBGScrOffset` enumerated type specified by `GX_SetBGScrOffset`)
> + (Value at the end of the name in the `GXBGScrBase` enumerated type specified by `G2_SetBG2ControlText`)

The return values are as follows for bitmap BGs:

> `HW_BG_VRAM`
> + (Value at the end of the name in the `GXBGBmpScrBase` enumerated type that is specified by `G2_SetBG2Control256Bmp`)

## See Also

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

## Revision History

2006/03/01 Corrected description of bitmap BG.

2004/02/09

- Added to description.

2004/01/19 Initial version.

CONFIDENTIAL