SDL_PeepEvents

Name

SDL_PeepEvents --  メッセージがあるかどうかイベントキューをチェックし、随時返します。

Synopsis

#include "SDL.h"

int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);

Description

メッセージがあるかどうかイベントキューをチェックし、随時返します。

actionSDL_ADDEVENT ならば、 numevents 個までのイベントが イベントキューの最後に追加されます。

actionSDL_PEEKEVENT ならば、 mask に該当する イベントキューの最初から numevents 個までのイベントが 返されますが、イベントキューからは削除されません。

actionSDL_GETEVENT ならば、 mask に該当する イベントキューの最初から numevents 個までのイベントが 返され、イベントキューから削除されます。

mask パラメータは、 あなたにとって興味のあるすべての種類のイベントについて、 SDL_EVENTMASK(event_type) を ビット OR したものです。

この関数はスレッドセーフです。

Return Value

この関数は実際に格納されたイベントの数か、 エラーがあった時は -1 を返します。

See Also

SDL_Event, SDL_PollEvent, SDL_PushEvent