GX_LoadBG2Bmp

C Specification

#include <nitro/gx/gx_load.h>
void GX_LoadBG2Bmp(const void *pSrc, u32 offset, u32 szByte);

Arguments

pSrc Pointer to transfer origin
offset Offset
szByte Transfer size (in bytes)

Return Values

None.

Description

For 256 color bitmap BGs, direct color bitmap BGs and large screen 256-bit colormap BGs, this function DMA transfers bitmap data to the BG2 screen base address in the BG-VRAM of the main 2-D engine. An offset can be specified for the transfer destination address. The DMA channel that is used is GX_DMAID (defined in gxcommon.h). Both offset and szByte must be 2-byte aligned. The transfer destination address is (u32) G2_GetBG2ScrPtr() + offset. GX_LoadBG2Scr is called internally.

Notes: Because the DMA transfer is carried out internally, the transfer source data must be flushed to the main memory using a function such as DC_FlushRange prior to the process. If the regions for transfer source and transfer destination overlap, the operation result is not guaranteed.

See Also

GX_LoadBGPltt, GX_LoadBG2Scr

Revision History

03/23/2004 Initial version.