Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_PollEvent (3)

Name

SDL_PollEvent - Polls for currently pending events.

Synopsis

#include "SDL.h"

int SDL_PollEvent(SDL_Event *event);

Description

SDL_PollEvent(3)               SDL API Reference              SDL_PollEvent(3)



NAME
       SDL_PollEvent - Polls for currently pending events.

SYNOPSIS
       #include "SDL.h"

       int SDL_PollEvent(SDL_Event *event);

DESCRIPTION
       Polls  for  currently  pending  events,  and returns 1 if there are any
       pending events, or 0 if there are none available.

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

EXAMPLES
       SDL_Event event; /* Event structure */

       .
       .
       .
       /* Check for events */
       while(SDL_PollEvent(&event)){  /* Loop until there are no events left on the queue */
         switch(event.type){  /* Process the appropiate event type */
           case SDL_KEYDOWN:  /* Handle a KEYDOWN event */
             printf("Oh! Key press
       ");
             break;
           case SDL_MOUSEMOTION:
             .
             .
             .
           default: /* Report an unhandled event */
             printf("I don't know what this event is!
       ");
         }
       }

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


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



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_PollEvent(3)