Wiki Page Content

Differences between revisions 1 and 2
Revision 1 as of 2010-05-14 22:36:08
Size: 1922
Editor: SheenaSmith
Comment: create page, add content (Wed Mar 10 ver; changeset 4428)
Revision 2 as of 2010-05-14 23:08:07
Size: 1997
Editor: SheenaSmith
Comment: added question
Deletions are marked like this. Additions are marked like this.
Line 22: Line 22:
<<Color2(green,Is this really a RV or just a note on how to set it up?)>>

DRAFT

SDL_SetEventFilter

Use this function to set up a filter to process all events before they change internal state and are posted to the internal event queue.

Syntax

void SDL_SetEventFilter(SDL_EventFilter filter,
                        void*           userdata)

Function Parameters

filter

typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event); ??? the SDL_!EventFilter to be referenced/run ???

userdata

a pointer filled with user-specified information to be filtered

Return Value

green

green

If the filter returns 1, then the event will be added to the internal queue. If it returns 0, then the event will be dropped from the queue, but the internal state will still be updated. This allows selective filtering of dynamically arriving events.

Code Examples

The filter is protypted as:
 int SDL_EventFilter(void *userdata, SDL_Event * event);

You can add your code example here

Remarks

/!\ Be very careful of what you do in the event filter function, as it may run in a different thread!

There is one caveat when dealing with the SDL_QUITEVENT event type. The event filter is only called when the window manager desires to close the application window. If the event filter returns 1, then the window will be closed, otherwise the window will remain open if possible.

If the quit event is generated by an interrupt signal, it will bypass the internal queue and be delivered to the application at the next event poll.


CategoryAPI, CategoryEvents

None: SDL_SetEventFilter (last edited 2017-08-11 17:54:24 by Sam Lantinga)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit