GX_LoadBG3Bmp

Syntax

#include <nitro/gx/gx_load.h>
void GX_LoadBG3Bmp(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 and direct color bitmap BGs this function DMA transfers bitmap data to the BG3 screen base address in the BG-VRAM of the main 2D 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_GetBG3ScrPtr() + offset.
GX_LoadBG3Scr is called internally.

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

See Also

GX_LoadBGPltt, GX_LoadBG3Scr

Revision History

2004/03/23 Initial version.


CONFIDENTIAL