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

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

Description

Clears the overlay module's region. This function is called in the FS_LoadOverlayImage function.

This process is equivalent to invalidating the data and instruction caches for the range starting at the address retrieved by the FS_GetOverlayAddress function and extending for the length retrieved by FS_GetOverlayTotalSize, and then initializing the entire region to a value of zero.

This function is used together with other functions, such as FS_GetOverlayFileID, to load overlays asynchronously. For information about the relationship with other overlay functions that perform equivalent processes, see the examples in the FS_LoadOverlay function reference.

Revision History

2007/07/29 Corrected "TCM" to "cache".
2004/10/19 Changed text and some links.
2004/09/24 Added description of the relationship with each type of overlay function.
2004/09/09 Initial version.