G2S_GetBG3CharPtr

Syntax

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

Arguments

None.

Return Values

The pointer to the region where BG3 character data is stored.

Description

This function returns a pointer to the region where sub 2D engine BG3 character data is stored. The return values are as follows:

For character BGs:

HW_DB_BG_VRAM + (the value at the end of the name for the GXBGCharBase enumerated type specified by functions such as G2S_SetBG3ControlText)

Since there is no character data for bitmap BGs, NULL is returned.

See Also

G2S_SetBG3ControlText, ..., G2S_SetBG3Priority, G2S_BG3Mosaic, G2S_GetBG3ScrPtr, G2S_SetBG3Offset

Revision History

2004/02/09 Initial version.


CONFIDENTIAL