GX_SetBGScrOffset

C Specification

#include <nitro/gx/gx.h>

void GX_SetBGScrOffset(GXBGScrOffset offset);

Arguments

offset BG screen data offset value

Return Values

None.

Description

This function selects an offset to apply to the address where the Main 2D Engine BG screen data is stored. The sum of the BG screen base offset set with this function and the screen base block set for each BG is the base address in the BG-VRAM space.

GX_BGSCROFFSET_0x00000 Sets 0x00000 as the offset.
GX_BGSCROFFSET_0x10000 Sets 0x10000 as the offset.
GX_BGSCROFFSET_0x20000 Sets 0x20000 as the offset.
GX_BGSCROFFSET_0x30000 Sets 0x30000 as the offset.
GX_BGSCROFFSET_0x40000 Sets 0x40000 as the offset.
GX_BGSCROFFSET_0x50000 Sets 0x50000 as the offset.
GX_BGSCROFFSET_0x60000 Sets 0x60000 as the offset.
GX_BGSCROFFSET_0x70000 Sets 0x70000 as the offset.

The following indicates the type definition for GXBGScrOffset format.

typedef enum
{
GX_BGSCROFFSET_0x00000 = 0x00,
GX_BGSCROFFSET_0x10000 = 0x01,
GX_BGSCROFFSET_0x20000 = 0x02,
GX_BGSCROFFSET_0x30000 = 0x03,
GX_BGSCROFFSET_0x40000 = 0x04,
GX_BGSCROFFSET_0x50000 = 0x05,
GX_BGSCROFFSET_0x60000 = 0x06,
GX_BGSCROFFSET_0x70000 = 0x07
}
GXBGScrOffset;

See Also

G2_SetBG0Control, G2_SetBG1Control, G2_SetBG2ControlText, G2_SetBG2ControlAffine, G2_SetBG2Control256x16Pltt, G2_SetBG2Control256Bmp, G2_SetBG2ControlDCBmp, G2_SetBG2ControlText, G2_SetBG2ControlAffine, G2_SetBG2Control256x16Pltt, G2_SetBG2Control256Bmp, G2_SetBG2ControlDCBmp G2_SetBG3ControlText, G2_SetBG3ControlAffine, G2_SetBG3Control256x16Pltt, G2_SetBG3Control256Bmp, G2_SetBG3ControlDCBmp

Revision History

02/09/2004

01/19/2004 Initial version