目次 - SDL 3.0 API(機能別) - イベント処理 - SDL_FlushEvent

SDL_FlushEvent

イベントキューからイベントを消去する

ヘッダ

SDL3/SDL_events.h

構文

void SDL_FlushEvent(Uint32 type);

引数

Uint32type消去するイベントの種類. SDL_EventTypeを参照すること

詳細

この関数はtypeが一致するイベントをキューから無条件に消去する. イベントの種類を範囲で指定したいならば, 代わりにSDL_FlushEvents()を使える.

この関数を呼ばずに, 単にイベントループでイベントを無視してもよい.

この関数は現在のイベントキューにのみ影響する. 待ち状態にある全てのOSのイベントを消去したいならば, この関数を呼ぶ前にSDL_PumpEvents()をメインスレッドで呼ぶとよい.

ユーザイベントに解放する必要のあるカスタムデータがある場合は, この関数を呼ぶ前にSDL_PeepEvents()で削除し, そのイベントの後処理をする必要がある.

スレッドセーフ

この関数はスレッドセーフである.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_FlushEvent - SDL Wiki