Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_PushEvent (3)

Name

SDL_PushEvent - Pushes an event onto the event queue

Synopsis

#include "SDL.h"

int SDL_PushEvent(SDL_Event *event);

Description

SDL_PushEvent(3)               SDL API Reference              SDL_PushEvent(3)



NAME
       SDL_PushEvent - Pushes an event onto the event queue

SYNOPSIS
       #include "SDL.h"

       int SDL_PushEvent(SDL_Event *event);

DESCRIPTION
       The  event  queue can actually be used as a two way communication chan-
       nel. Not only can events be read from the queue, but the user can  also
       push  their  own events onto it. event is a pointer to the event struc-
       ture you wish to push onto the queue.

              Note:

              Pushing device input events onto the queue  doesn't  modify  the
              state of the device within SDL.

RETURN VALUE
       Returns 0 on success or -1 if the event couldn't be pushed.

EXAMPLES
       See SDL_Event.


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


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



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