GrPeekEvent

Name

GrPeekEvent -- Copy the next event from the event queue

Synopsis

int GrPeekEvent (
  GR_EVENT * ep
);

Parameters

ep

A pointer to a GR_EVENT structure that will hold the event returned from the queue.

Return Value

Returns 1 if an event exists in the queue and zero if the queue is empty.

Description

The GrPeekEvent function flushes any buffered graphics commands and returns the next event from the event queue, if one exists, and leaves the event on the queue. If no event exists, the GrPeekEvent function returns GR_EVENT_TYPE_NONE.

See Also

GrCheckNextEvent, GrGetNextEvent