FS_ClearOverlayImage

構文

#include <nitro/fs.h>

BOOL FS_ClearOverlayImage(FSOverlayInfo *p_ovi);

引数

p_ovi オーバーレイモジュールの情報が格納されたFSOverlayInfo構造体

返り値

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

説明

オーバーレイモジュールの領域をクリアします。
この関数は、FS_LoadOverlayImage() の内部で呼び出されます。

この処理は、FS_GetOverlayAddress() で取得されるアドレスから
FS_GetOverlayTotalSize() で取得される範囲に対して
データキャッシュおよび命令キャッシュを無効化したのちに全領域を0で初期化することと等価です。

この関数は、FS_GetOverlayFileID() などを組み合わせて
オーバーレイのロードを非同期に行うために使用されます。
同等の処理を行う他のオーバーレイ関数との関係については
FS_LoadOverlay() のリファレンスに記載された例を参照ください。

参照

FSOverlayInfo
FS_LoadOverlayInfo FS_GetOverlayTotalSize FS_GetOverlayAddress FS_GetOverlayFileID FS_StartOverlay FS_LoadOverlayImage FS_LoadOverlay FS_UnloadOverlayImage

履歴

2007/07/29 「キャッシュ」を「TCM」としていた誤記を訂正
2004/10/19 記述とリンク先を若干修正
2004/09/24 各種オーバーレイ関数の関係について例を記述追加
2004/09/09 初版