Back to index

Index

EventQueue

Class and instance Methods

 get  peek  poll  post  pump  allowed=  blocked=  grab  grab=  grab  grab=  wait  flush

Events

Event

EventQueue

This class is the interface to the eventsystem in SDL. Don't be put off by the amount of non-implemented methods, their absence doesn't bother me and I don't plan on implementing them before someone comes up with a good reason for their existence.

Class and instance Methods

EventQueue.get
EventQueue#get

Returns all events in the queue and removes them from the queue.

EventQueue.get( eventmask )
EventQueue#get( eventmask )

Not implemented.

EventQueue.peek
EventQueue#peek

Returns the next event without removing it from the queue, or false when no events are available.

EventQueue.peek( eventmask )
EventQueue#peek( eventmask )

Not implemented.

EventQueue.poll
EventQueue#poll

Returns the next event, or nil if the queue is empty.

EventQueue.post( event )
EventQueue#post( event )

Not implemented.

EventQueue.pump
EventQueue#pump

This method is responsible for getting events from the operating system into the SDL eventqueue. If your application seems unresponsive, calling this method every now and then might help.

EventQueue.allowed=( eventtype )
EventQueue#allowed=( eventtype )

Not implemented.

EventQueue.blocked=( eventtype )
EventQueue#blocked=( eventtype )

Not implemented.

EventQueue.grab
EventQueue.grab=( grab )
EventQueue#grab
EventQueue#grab=( grab )

Controls grabbing of all mouse and keyboard input for the display. Grabbing the input is not neccessary to receive keyboard and mouse events, but it ensures all input will go to your application. It also keeps the mouse locked inside your window. It is best to not always grab the input, since it prevents the end user from doing anything else on their system. grab is true or false.

Returns self.

EventQueue.wait
EventQueue#wait

Wait for an event to arrive. Returns that event.

EventQueue.flush
EventQueue#flush

Flushes all events from the queue.

Events

Event

This is the baseclass for all event classes. It contains nothing.

Other events can be found in the documentation section they belong to.

Back to index