Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_SetEventFilter (3)

Name

SDL_SetEventFilter - Sets up a filter to process all events before they are posted to the event queue.

Synopsis

#include "SDL.h"

void SDL_SetEventFilter(SDL_EventFilter filter);

Description

SDL_SetEventFilter(3)          SDL API Reference         SDL_SetEventFilter(3)



NAME
       SDL_SetEventFilter - Sets up a filter to process all events before they
       are posted to the event queue.

SYNOPSIS
       #include "SDL.h"

       void SDL_SetEventFilter(SDL_EventFilter filter);

DESCRIPTION
       This function sets up a filter to process all events  before  they  are
       posted  to  the  event queue. This is a very powerful and flexible fea-
       ture. The filter is prototyped as:

       typedef int (*SDL_EventFilter)(const SDL_Event *event);

        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.
       This allows selective filtering of dynamically.

       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.

              Note:

              Events pushed onto the queue  with  SDL_PushEvent  or  SDL_Peep-
              Events do not get passed through the event filter.

              Note:

              Be  Careful!  The  event  filter function may run in a different
              thread so be careful what you do within it.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_Event, SDL_GetEventFilter, SDL_PushEvent



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was        downloaded        from         https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 22:59       SDL_SetEventFilter(3)