FS_LoadOverlayImage

構文

#include <nitro/fs.h>

BOOL FS_LoadOverlayImage(FSOverlayInfo *p_ovi);

引数

返り値

オーバーレイモジュールのイメージが正しくロードされれば TRUE を返し、そうでない場合は、FALSE を返します。

説明

オーバーレイモジュールのイメージをメモリへロードします。
これにより、オーバーレイモジュールの"生の初期状態"がメモリ上に構築されます。
この後、FS_StartOverlay() によって static initializer を実行することで
オーバーレイモジュールが使用可能となります。

ロードされた既存のオーバーレイと領域を競合する他のオーバーレイをロードする場合、
必ず以前のオーバーレイをFS_UnloadOverlay() でアンロードする必要があります。

この処理は、FS_LoadOverlayImageAsync() を呼び出したのち
そのロード処理完了を待つことと等価です。

同等の処理を行う他のオーバーレイ関数との関係については
FS_LoadOverlay() のリファレンスに記載された例を参照ください。

参照

FSOverlayInfo
FS_LoadOverlayInfo FS_GetOverlayTotalSize FS_GetOverlayAddress FS_GetOverlayFileID FS_LoadOverlayImageAsync FS_StartOverlay FS_UnloadOverlayImage FS_LoadOverlay

履歴

2004/11/16 FS_LoadOverlayImageAsync() との対比を追加、処理内容に関する記述修正
2004/10/19 処理内容に関する記述追加
2004/09/24 各種オーバーレイ関数の関係について例を記述追加
2004/06/11 初版