FS_StartOverlay

Syntax

#include <nitro/fs.h>

void FS_StartOverlay(FSOverlayInfo *p_ovi);

Arguments

p_ovi FSOverlayInfo structure that holds overlay module information.

Return Values

None.

Description

This function runs the overlay module's static initializer. A static initializer initializes an object that has a static memory duration. This function must be called once for an overlay module that has been prepared directly by either the FS_LoadOverlayImage or FS_LoadOverlayImageAsync function.
When loading an overlay whose area conflicts with an existing loaded overlay, you must unload the previous overlay using the FS_UnloadOverlay function.
For information about the relationship with other overlay functions that perform equivalent processes, see the example stated in the reference for the FS_LoadOverlay function.

Revision History

2004/11/16 2004/11/16 Added note concerning the FS_UnloadOverlay function.
2004/11/16 Added a link.
2004/10/19 Added a link.
2004/09/24 Added a description concerning the relationship with each type of overlay function.
2004/06/11 Initial version.