G2S_GetBG3CharPtr


C Specification

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

Description

This function returns a pointer to the region where sub 2D engine BG3 character 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 GXBGCharBase that is specified by HW_DB_BG_VRAM + (G2S_SetBG3ControlText), etc. It will return a NULL in the case of bitmapped BG because there is no character data.

Arguments

None

Return Values

Pointer to the region where the BG3 character data is stored.

See Also

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

Revision History

02/09/2004 Initial Version