NNS_GfdFreePlttVram

C Specification

#include <nnsys/gfd.h>
int NNS_GfdFreePlttVram(NNSGfdPlttKey plttKey);

Arguments

plttKey Key data indicating the memory allocated for palette use

Return Values

0 if the palette-use memory has been freed successfully.

Description

This function frees the palette-use memory specified by plttKey. The NITRO-System library uses this function to free palette-use memory.

The NNS_GfdFreePlttVram function is defined as shown below. The only internal process this function conducts is to call the function set in the global function pointer NNS_GfdDefaultFuncFreePlttVram.

static inline int
NNS_GfdFreePlttVram(NNSGfdPlttKey plttKey)
{
return (*NNS_GfdDefaultFuncFreePlttVram)(plttKey);
}

NNS_GfdFreePlttVram functions by registering the appropriate function for freeing palette-use memory in this function pointer. With this setup, the user can control the freeing of palette-use memory from the library. In the initial state, the function that is set in NNS_GfdDefaultFuncFreePlttVram does nothing and returns an error.

See Also

NNS_GfdAllocPlttVram

Revision History

07/16/2004 Initial version.