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

# SDL_PeepEvents

イベントキューのメッセージをチェックし, それらを戻す

## 構文

`int SDL_PeepEvents(SDL_Event* events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)`

## 引数

events | 獲得したイベントを書き込むバッファ
numevents | actionがSDL_ADDEVENTのときキューに加えるイベントの数, SDL_PEEKEVENTまたはSDL_GETEVENTのとき獲得するイベントの最大数
action | 行うこと (詳細を参照すること)
minType | イベントの最小値. SDL_FIRSTEVENTを選択するのが安全
maxType | イベントの最大値. SDL_LASTEVENTを選択するのが安全

## 戻り値

獲得したイベントの数, または負の数のエラーコードを戻す. SDL_GetError()で詳細を知ることができる.

## 詳細

actionは次の値である.

SDL_ADDEVENT | 最大でnumevents個のイベントをキューの末尾に加える
SDL_PEEKEVENT | minTypeからmaxTypeの範囲の種類のイベントを, 先頭から最大でnumevents個を戻す. キューからは削除しない
SDL_GETEVENT | minTypeからmaxTypeの範囲の種類のイベントを, 先頭から最大でnumevents個を戻し, キューから削除する

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

SDL_PumpEvents()はこの関数の前に呼ぶ必要がある. そうしなければ, SDL_PeepEvents()を呼んだとき, イベントをフィルタする準備ができていない.

## 関連項目(関数)

SDL_PollEvent
SDL_PumpEvents
SDL_PushEvent

## SDL Wikiへのリンク

SDL_PeepEvents - SDL Wiki