GXS_LoadOBJExtPltt

Syntax

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

Arguments

pSrc Pointer to transfer origin
destSlotAddr Address to inside of the transfer source OBJ expanded palette slot
szByte Transfer size (in bytes)

Return Values

None.

Description

This function uses DMA to transfer OBJ palette data to the sub 2D Engine's OBJ Extended palette. The transfer destination address (in the OBJ Extended palette) can be specified. Use the GX_DMAID DMA channel (defined in gxcommon.h). Both destSlotAddr and szByte must be 4-byte aligned. Call this function between the GXS_BeginLoadOBJExtPltt and GXS_EndLoadOBJExtPltt 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_SetBankForSubOBJExtPltt, GX_ResetBankForSubOBJExtPltt, or GX_DisableBankForSubOBJExtPltt between GXS_BeginLoadOBJExtPltt and GXS_EndLoadOBJExtPltt.

See Also

GXS_BeginLoadOBJExtPltt
GXS_EndLoadOBJExtPltt

Revision History

2004/02/09 Initial version.


CONFIDENTIAL