GX_LoadClearImageDepth

Syntax

#include <nitro/gx/gx_load.h>

void GX_LoadClearImageDepth(const void *pSrc, u32 szByte);

Arguments

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

Return Values

None.

Description

This function uses DMA to transfer the clear image (depth) to the clear image slot. Use the GX_DMAID DMA channel (defined in gxcommon.h). szByte must be a multiple of 4. Call this function between the GX_BeginLoadClearImage and GX_EndLoadClearImage functions.

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 undefined. Do not call GX_SetBankForClearImage, GX_ResetBankForClearImage, or GX_DisableBankForClearImage between GX_BeginLoadClearImage and GX_EndLoadClearImage.

See Also

GX_BeginLoadClearImage
GX_LoadClearImageColor
GX_EndLoadClearImage

Revision History

2004/01/19 Initial version.


CONFIDENTIAL