Función SDL_PeepEvents

Sintaxis

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

Descripción

Comprueba si hay mensajes en la cola de eventos y, opcionalmente, los devuelve.

Parámetros

events

Búfer de destino para los eventos recuperados.

numevents

Si la acción es SDL_ADDEVENT, el número de eventos a añadir a la cola de eventos; si la acción es SDL_PEEKEVENT o SDL_GETEVENT, el número máximo de eventos a recuperar.

action

Medidas que deben adoptarse.

minType

Valor mínimo del tipo de evento a considerar; SDL_FIRSTEVENT es una elección segura.

maxType

Valor máximo del tipo de evento a considerar; SDL_LASTEVENT es una elección segura.

Valor de retorno

Devuelve el número de eventos realmente almacenados o un código de error negativo en caso de fallo. Ver SDL_GetError.

Observaciones

action puede ser cualquiera de las siguientes:

• SDL_ADDEVENT: se añadirán hasta numevents eventos al final de la cola de eventos.
• SDL_PEEKEVENT: numevents eventos en la parte delantera de la cola de eventos, dentro del tipo mínimo y máximo especificado, serán devueltos a la persona que llama y no serán eliminados de la cola.
• SDL_GETEVENT: hasta numevents eventos en la parte delantera de la cola de eventos, dentro del tipo mínimo y máximo especificado, serán devueltos a la persona que llama y serán eliminados de la cola.

Es posible que haya que llamar a SDL_PumpEvents() antes de llamar a esta función. De lo contrario, los eventos pueden no estar listos para ser filtrados cuando se llame a SDL_PeepEvents().

Esta función es thread-safe.