EventSupplier Class Reference

List of all members.

Public Member Functions
bool	PollEvent (SDL_Event *event)
	Polls for currently pending events, and returns true if there are any pending events, or false if there are none available.
bool	PeepEvent (SDL_Event *event)
	Checks if an event is in the queue.
int	WaitEvent (SDL_Event *event)
	Waits indefinitely for the next available event.

---

Detailed Description

Definition at line 68 of file paradialog.cpp.

---

Member Function Documentation

bool EventSupplier::PollEvent

(

SDL_Event *

event

)

[inline]

Polls for currently pending events, and returns true if there are any pending events, or false if there are none available.

If event is not NULL, the next event is removed from the queue and stored in that area.

Parameters:

event

pointer to an event structure

Returns:

true - events are available

Definition at line 78 of file paradialog.cpp.

References getQueuedEvent().

bool EventSupplier::PeepEvent

(

SDL_Event *

event

)

[inline]

Checks if an event is in the queue.

If there is, it will be copied into the event structure, WITHOUT being removed from the event queue.

Parameters:

event

pointer to an event structure

Returns:

true - events are available

Definition at line 92 of file paradialog.cpp.

References peekEvent().

int EventSupplier::WaitEvent

(

SDL_Event *

event

)

[inline]

Waits indefinitely for the next available event.

Parameters:

event

pointer to an event structure

Returns:

return 0 if there was an error while waiting for events

Definition at line 102 of file paradialog.cpp.

References getQueuedEvent(), and releasetimeslice().

---

The documentation for this class was generated from the following file:

• paradialog.cpp

---