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

SDL_WaitEventTimeout

次のイベントが発生するまで指定の時間(ミリ秒)待つ

ヘッダ

SDL3/SDL_events.h

構文

bool SDL_WaitEventTimeout(SDL_Event *event, Sint32 timeoutMS);

引数

eventキューから得たイベントを代入するSDL_EventまたはNULL
timeout次のイベントを待つミリ秒単位の最大時間

戻り値

(bool) 成功のとき真, イベントが届かずタイムアウトした場合は偽を戻す.

詳細

eventがNULLでない場合, イベントはキューから削除され, SDL_Event構造体のeventに代入される.

この関数は暗黙のうちにSDL_PumpEvents()を呼んでいる. この関数はビデオモードを設定したスレッドのみで呼べる.

timeoutの時間には保証はない. 実際の待ち時間はシステムのスケジューリングによって長くなる可能性がある.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_WaitEventTimeout - SDL Wiki