FS_ClearOverlayImage

Syntax

#include <nitro/fs.h>

BOOL FS_ClearOverlayImage(FSOverlayInfo *p_ovi);

Arguments

p_ovi FSOverlayInfo structure that holds overlay module information.

Return Values

Returns TRUE if the overlay module's region is cleared properly; returns FALSE otherwise.

Description

This function clears the overlay module's region. This function is called from the FS_LoadOverlayImage function. This process is equivalent to first disabling DTCM and ITCM starting at the address that is retrieved by the FS_GetOverlayAddress function, clearing the range retrieved by the FS_GetOverlayTotalSize function, and then initializing the entire region with a value of 0. This function is used with the FS_GetOverlayFileID function to asynchronously load overlays. For information about the relationship with other overlay functions that perform equivalent processes, see the examples in the reference for the FS_LoadOverlay function.

See Also

FSOverlayInfo
FS_LoadOverlayInfo
FS_GetOverlayTotalSize
FS_GetOverlayAddress
FS_GetOverlayFileID
FS_StartOverlay
FS_LoadOverlayImage
FS_LoadOverlay
FS_UnloadOverlayImage

Revision History

2004/10/19 Changed the description and some links.
2004/09/24 Added description concerning the relationship with each type of overlay function.
2004/09/09 Initial version.


CONFIDENTIAL