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

SDL_WaitEventTimeout

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

構文

int SDL_WaitEventTimeout(SDL_Event* event, int timeout)

引数

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

戻り値

成功のとき1, イベントを待っているときエラーが発生すれば0を戻す. SDL_GetError()で詳細を知ることができる. イベントが届かずタイムアウトした場合も0を戻す.

詳細

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

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

バージョン

2.0.0以降

関連項目(関数)

SDL_PollEvent
SDL_PumpEvents
SDL_WaitEvent

SDL Wikiへのリンク

SDL_WaitEventTimeout - SDL Wiki