#include <nitro/fs.h>
void FS_StartOverlay(FSOverlayInfo *p_ovi);
p_ovi | FSOverlayInfo structure that holds overlay module information. |
None.
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.
FSOverlayInfo, FS_LoadOverlay, FS_LoadOverlayInfo, FS_LoadOverlayImage, LoadOverlayImageAsync
11/16/2004 Added note concerning FS_UnloadOverlay
and added a link.
10/19/2004 Added a link.
09/24/2004 Added description concerning the relationship with each type of overlay function.
06/11/2004 Initial version.