NNS_G3dPlttLoad

C Specification

#include <nnsys/g3d/kernel.h>
void
NNS_G3dPlttLoad(
    NNSG3dResTex* pTex,
    BOOL          exec_begin_end
);

Arguments

pTex Pointer to the texture resource
exec_begin_end When TRUE, calls the GX_BeginLoadTexPltt and GX_EndLoadTexPltt functions of NITRO-SDK automatically

Return Values

None.

Description

The palette data stored in the texture resource is loaded to the VRAM region indicated by the palette key. Also, sets the flag indicating the palette is loaded. The palette key must be configured with the NNS_G3dPlttSetPlttKey function before calling this function.

When exec_begin_end = TRUE, both of the NITRO-SDK API commands, the GX_BeginLoadTexPltt and GX_EndLoadTexPltt functions, are called automatically before and after loading texture data to the VRAM. When exec_begin_end = FALSE, the GX_BeginLoadTexPltt and GX_EndLoadTexPltt functions must be called on the user side. When continuously loading palette data, it is more efficient to designate FALSE in exec_begin_end and call the GX_BeginLoadTexPltt and GX_EndLoadTexPltt functions on the user side.

See Also

NNS_G3dPlttSetPlttKey, NNS_G3dPlttReleasePlttKey

Revision History

2004/08/02 Initial version.


CONFIDENTIAL