sdl-ios-xcode: include/SDL_events.h annotate

annotate include/SDL_events.h @ 1718:ed4d4f1ea201 SDL-1.3

Further progress on the new Windows video driver: * SDL_SetModuleHandle() is obsolete, I hope. * SDL 1.3 uses the UNICODE API * I'm ignoring Windows CE for the moment, we'll reevaluate what needs to be different for Windows CE later. * Pulled the stdio redirection from WinMain()

author	Sam Lantinga <slouken@libsdl.org>
date	Tue, 27 Jun 2006 07:46:36 +0000
parents	8d7fecceb9ef
children	5daa04d862f1

rev	line source
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2 SDL - Simple DirectMedia Layer
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	3 Copyright (C) 1997-2006 Sam Lantinga
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	6 modify it under the terms of the GNU Lesser General Public
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	7 License as published by the Free Software Foundation; either
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	8 version 2.1 of the License, or (at your option) any later version.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	13 Lesser General Public License for more details.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	15 You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	16 License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1301 diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	19 Sam Lantinga
251 b8688cfdc232 Updated the headers with the correct e-mail address Sam Lantinga <slouken@libsdl.org> parents: 0 diff changeset	20 slouken@libsdl.org
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	23 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	24 * \file SDL_events.h
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	25 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	26 * Include file for SDL event handling
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	27 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	28
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29 #ifndef _SDL_events_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	30 #define _SDL_events_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	31
1356 67114343400d * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	32 #include "SDL_stdinc.h"
1358 c71e05b4dc2e More header massaging... works great on Windows. ;-) Sam Lantinga <slouken@libsdl.org> parents: 1356 diff changeset	33 #include "SDL_error.h"
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	34 #include "SDL_video.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35 #include "SDL_keyboard.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36 #include "SDL_mouse.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37 #include "SDL_joystick.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38 #include "SDL_quit.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	40 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	42 #ifdef __cplusplus
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	43 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44 extern "C" {
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	45 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	47
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	48 /* General keyboard/mouse state definitions */
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	49 #define SDL_RELEASED 0
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	50 #define SDL_PRESSED 1
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	51
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	52 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	53 * \enum SDL_EventType
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	54 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	55 * \brief The types of events that can be delivered
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	56 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	57 typedef enum
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	58 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	59 SDL_NOEVENT = 0, /*< Unused (do not remove) /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	60 SDL_WINDOWEVENT, /*< Window state change /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	61 SDL_KEYDOWN, /*< Keys pressed /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	62 SDL_KEYUP, /*< Keys released /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	63 SDL_MOUSEMOTION, /*< Mouse moved /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	64 SDL_MOUSEBUTTONDOWN, /*< Mouse button pressed /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	65 SDL_MOUSEBUTTONUP, /*< Mouse button released /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	66 SDL_JOYAXISMOTION, /*< Joystick axis motion /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	67 SDL_JOYBALLMOTION, /*< Joystick trackball motion /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	68 SDL_JOYHATMOTION, /*< Joystick hat position change /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	69 SDL_JOYBUTTONDOWN, /*< Joystick button pressed /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	70 SDL_JOYBUTTONUP, /*< Joystick button released /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	71 SDL_QUIT, /*< User-requested quit /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	72 SDL_SYSWMEVENT, /*< System specific event /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	73 SDL_EVENT_RESERVED1, /*< Reserved for future use... /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	74 SDL_EVENT_RESERVED2, /*< Reserved for future use... /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	75 SDL_EVENT_RESERVED3, /*< Reserved for future use... /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	76 /* Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	77 SDL_USEREVENT = 24,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	78 /* This last event is only for bounding internal arrays
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	79 It is the number of bits in the event mask datatype -- Uint32
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	80 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	81 SDL_NUMEVENTS = 32
1294 1760ceb23bc6 Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET) Sam Lantinga <slouken@libsdl.org> parents: 1258 diff changeset	82 } SDL_EventType;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	83
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	84 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	85 * \enum SDL_EventMask
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	86 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	87 * \brief Predefined event masks
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	88 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	89 #define SDL_EVENTMASK(X) (1<<(X))
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	90 typedef enum
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	91 {
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	92 SDL_WINDOWEVENTMASK = SDL_EVENTMASK(SDL_WINDOWEVENT),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	93 SDL_KEYDOWNMASK = SDL_EVENTMASK(SDL_KEYDOWN),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	94 SDL_KEYUPMASK = SDL_EVENTMASK(SDL_KEYUP),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	95 SDL_KEYEVENTMASK = SDL_EVENTMASK(SDL_KEYDOWN) \| SDL_EVENTMASK(SDL_KEYUP),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	96 SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	97 SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	98 SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	99 SDL_MOUSEEVENTMASK = SDL_EVENTMASK(SDL_MOUSEMOTION) \|
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	100 SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN) \| SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	101 SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	102 SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK(SDL_JOYBALLMOTION),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	103 SDL_JOYHATMOTIONMASK = SDL_EVENTMASK(SDL_JOYHATMOTION),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	104 SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK(SDL_JOYBUTTONDOWN),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	105 SDL_JOYBUTTONUPMASK = SDL_EVENTMASK(SDL_JOYBUTTONUP),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	106 SDL_JOYEVENTMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION) \|
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	107 SDL_EVENTMASK(SDL_JOYBALLMOTION) \|
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	108 SDL_EVENTMASK(SDL_JOYHATMOTION) \|
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	109 SDL_EVENTMASK(SDL_JOYBUTTONDOWN) \| SDL_EVENTMASK(SDL_JOYBUTTONUP),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	110 SDL_QUITMASK = SDL_EVENTMASK(SDL_QUIT),
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	111 SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT)
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	112 } SDL_EventMask;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	113 #define SDL_ALLEVENTS 0xFFFFFFFF
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	114
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	115 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	116 * \struct SDL_WindowEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	117 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	118 * \brief Window state change event data
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	119 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	120 typedef struct SDL_WindowEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	121 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	122 Uint8 type; /*< SDL_WINDOWEVENT /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	123 Uint8 event; /*< SDL_WindowEventID /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	124 int data1; /*< event dependent data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	125 int data2; /*< event dependent data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	126 SDL_WindowID windowID; /*< The associated window /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	127 } SDL_WindowEvent;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	128
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	129 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	130 * \struct SDL_KeyboardEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	131 *
1686 8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	132 * \brief Keyboard button event structure
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	133 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	134 typedef struct SDL_KeyboardEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	135 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	136 Uint8 type; /*< SDL_KEYDOWN or SDL_KEYUP /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	137 Uint8 which; /*< The keyboard device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	138 Uint8 state; /*< SDL_PRESSED or SDL_RELEASED /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	139 SDL_keysym keysym; /*< The key that was pressed or released /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	140 SDL_WindowID windowID; /*< The window with keyboard focus, if any /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	141 } SDL_KeyboardEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	142
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	143 /**
1686 8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	144 * \struct SDL_CharEvent
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	145 *
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	146 * \brief Keyboard input event structure
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	147 */
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	148 typedef struct SDL_CharEvent
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	149 {
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	150 Uint8 type; /*< SDL_CHARINPUT (FIXME: NYI) /
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	151 Uint8 which; /*< The keyboard device index /
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	152 char text[32]; /*< The input text /
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	153 SDL_WindowID windowID; /*< The window with keyboard focus, if any /
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	154 } SDL_CharEvent;
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	155
8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	156 /**
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	157 * \struct SDL_MouseMotionEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	158 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	159 * \brief Mouse motion event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	160 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	161 typedef struct SDL_MouseMotionEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	162 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	163 Uint8 type; /*< SDL_MOUSEMOTION /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	164 Uint8 which; /*< The mouse device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	165 Uint8 state; /*< The current button state /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	166 int x; /*< X coordinate, relative to window /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	167 int y; /*< Y coordinate, relative to window /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	168 int xrel; /*< The relative motion in the X direction /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	169 int yrel; /*< The relative motion in the Y direction /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	170 SDL_WindowID windowID; /*< The window with mouse focus, if any /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	171 } SDL_MouseMotionEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	172
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	173 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	174 * \struct SDL_MouseButtonEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	175 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	176 * \brief Mouse button event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	177 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	178 typedef struct SDL_MouseButtonEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	179 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	180 Uint8 type; /*< SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	181 Uint8 which; /*< The mouse device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	182 Uint8 button; /*< The mouse button index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	183 Uint8 state; /*< SDL_PRESSED or SDL_RELEASED /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	184 int x; /*< X coordinate, relative to window /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	185 int y; /*< Y coordinate, relative to window /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	186 SDL_WindowID windowID; /*< The window with mouse focus, if any /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	187 } SDL_MouseButtonEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	188
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	189 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	190 * \struct SDL_JoyAxisEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	191 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	192 * \brief Joystick axis motion event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	193 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	194 typedef struct SDL_JoyAxisEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	195 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	196 Uint8 type; /*< SDL_JOYAXISMOTION /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	197 Uint8 which; /*< The joystick device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	198 Uint8 axis; /*< The joystick axis index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	199 int value; /*< The axis value (range: -32768 to 32767) /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	200 } SDL_JoyAxisEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	201
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	202 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	203 * \struct SDL_JoyBallEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	204 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	205 * \brief Joystick trackball motion event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	206 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	207 typedef struct SDL_JoyBallEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	208 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	209 Uint8 type; /*< SDL_JOYBALLMOTION /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	210 Uint8 which; /*< The joystick device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	211 Uint8 ball; /*< The joystick trackball index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	212 int xrel; /*< The relative motion in the X direction /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	213 int yrel; /*< The relative motion in the Y direction /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	214 } SDL_JoyBallEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	215
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	216 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	217 * \struct SDL_JoyHatEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	218 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	219 * \brief Joystick hat position change event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	220 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	221 typedef struct SDL_JoyHatEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	222 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	223 Uint8 type; /*< SDL_JOYHATMOTION /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	224 Uint8 which; /*< The joystick device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	225 Uint8 hat; /*< The joystick hat index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	226 Uint8 value; /**< The hat position value:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	227 SDL_HAT_LEFTUP SDL_HAT_UP SDL_HAT_RIGHTUP
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	228 SDL_HAT_LEFT SDL_HAT_CENTERED SDL_HAT_RIGHT
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	229 SDL_HAT_LEFTDOWN SDL_HAT_DOWN SDL_HAT_RIGHTDOWN
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	230 Note that zero means the POV is centered.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	231 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	232 } SDL_JoyHatEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	233
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	234 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	235 * \struct SDL_JoyButtonEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	236 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	237 * \brief Joystick button event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	238 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	239 typedef struct SDL_JoyButtonEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	240 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	241 Uint8 type; /*< SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	242 Uint8 which; /*< The joystick device index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	243 Uint8 button; /*< The joystick button index /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	244 Uint8 state; /*< SDL_PRESSED or SDL_RELEASED /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	245 } SDL_JoyButtonEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	246
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	247 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	248 * \struct SDL_QuitEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	249 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	250 * \brief The "quit requested" event
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	251 */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	252 typedef struct SDL_QuitEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	253 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	254 Uint8 type; /*< SDL_QUIT /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	255 } SDL_QuitEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	256
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	257 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	258 * \struct SDL_UserEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	259 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	260 * \brief A user-defined event type
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	261 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	262 typedef struct SDL_UserEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	263 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	264 Uint8 type; /*< SDL_USEREVENT through SDL_NUMEVENTS-1 /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	265 int code; /*< User defined event code /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	266 void data1; /< User defined data pointer /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	267 void data2; /< User defined data pointer /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	268 } SDL_UserEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	269
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	270 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	271 * \struct SDL_SysWMEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	272 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	273 * \brief A video driver dependent system event
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	274 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	275 * \note If you want to use this event, you should include SDL_syswm.h
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	276 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	277 struct SDL_SysWMmsg;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	278 typedef struct SDL_SysWMmsg SDL_SysWMmsg;
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	279 typedef struct SDL_SysWMEvent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	280 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	281 Uint8 type; /*< SDL_SYSWMEVENT /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	282 SDL_SysWMmsg msg; /< driver dependent data, defined in SDL_syswm.h /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	283 } SDL_SysWMEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	284
1669 9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	285 /* Typedefs for backwards compatibility */
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	286 typedef struct SDL_ActiveEvent
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	287 {
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	288 Uint8 type;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	289 Uint8 gain;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	290 Uint8 state;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	291 } SDL_ActiveEvent;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	292 typedef struct SDL_ResizeEvent
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	293 {
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	294 Uint8 type;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	295 int w;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	296 int h;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	297 } SDL_ResizeEvent;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	298
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	299 /**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	300 * \union SDL_Event
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	301 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	302 * \brief General event structure
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	303 */
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	304 typedef union SDL_Event
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	305 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	306 Uint8 type; /*< Event type, shared with all events /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	307 SDL_WindowEvent window; /*< Window event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	308 SDL_KeyboardEvent key; /*< Keyboard event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	309 SDL_MouseMotionEvent motion; /*< Mouse motion event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	310 SDL_MouseButtonEvent button; /*< Mouse button event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	311 SDL_JoyAxisEvent jaxis; /*< Joystick axis event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	312 SDL_JoyBallEvent jball; /*< Joystick ball event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	313 SDL_JoyHatEvent jhat; /*< Joystick hat event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	314 SDL_JoyButtonEvent jbutton; /*< Joystick button event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	315 SDL_QuitEvent quit; /*< Quit request event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	316 SDL_UserEvent user; /*< Custom event data /
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	317 SDL_SysWMEvent syswm; /*< System dependent window event data /
1669 9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	318
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	319 /* Temporarily here for backwards compatibility */
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	320 SDL_ActiveEvent active;
9857d21967bb The test programs compile again. Sam Lantinga <slouken@libsdl.org> parents: 1668 diff changeset	321 SDL_ResizeEvent resize;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	322 } SDL_Event;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	323
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	324
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	325 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	326
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	327 /* Pumps the event loop, gathering events from the input devices.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	328 This function updates the event queue and internal input device state.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	329 This should only be run in the thread that sets the video mode.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	330 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	331 extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	332
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	333 /* Checks the event queue for messages and optionally returns them.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	334 If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	335 the back of the event queue.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	336 If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	337 of the event queue, matching 'mask', will be returned and will not
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	338 be removed from the queue.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	339 If 'action' is SDL_GETEVENT, up to 'numevents' events at the front
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	340 of the event queue, matching 'mask', will be returned and will be
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	341 removed from the queue.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	342 This function returns the number of events actually stored, or -1
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	343 if there was an error. This function is thread-safe.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	344 */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	345 typedef enum
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	346 {
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	347 SDL_ADDEVENT,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	348 SDL_PEEKEVENT,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	349 SDL_GETEVENT
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	350 } SDL_eventaction;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	351 /* */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	352 extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	353 SDL_eventaction action,
4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	354 Uint32 mask);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	355
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	356 /* Polls for currently pending events, and returns 1 if there are any pending
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	357 events, or 0 if there are none available. If 'event' is not NULL, the next
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	358 event is removed from the queue and stored in that area.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	359 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	360 extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	361
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	362 /* Waits indefinitely for the next available event, returning 1, or 0 if there
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	363 was an error while waiting for events. If 'event' is not NULL, the next
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	364 event is removed from the queue and stored in that area.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	365 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	366 extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	367
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	368 /* Add an event to the event queue.
844 cd0c77df70a4 * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 769 diff changeset	369 This function returns 0 on success, or -1 if the event queue was full
cd0c77df70a4 * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 769 diff changeset	370 or there was some other error.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	371 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	372 extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	373
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	374 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	375 This function sets up a filter to process all events before they
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	376 change internal state and are posted to the internal event queue.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	377
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	378 The filter is protypted as:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	379 */
1686 8d7fecceb9ef Added the unicode keysym memory again for backwards compatibility. Sam Lantinga <slouken@libsdl.org> parents: 1669 diff changeset	380 typedef int (SDLCALL * SDL_EventFilter) (SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	381 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	382 If the filter returns 1, then the event will be added to the internal queue.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	383 If it returns 0, then the event will be dropped from the queue, but the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	384 internal state will still be updated. This allows selective filtering of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	385 dynamically arriving events.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	386
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	387 WARNING: Be very careful of what you do in the event filter function, as
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	388 it may run in a different thread!
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	389
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	390 There is one caveat when dealing with the SDL_QUITEVENT event type. The
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	391 event filter is only called when the window manager desires to close the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	392 application window. If the event filter returns 1, then the window will
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	393 be closed, otherwise the window will remain open if possible.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	394 If the quit event is generated by an interrupt signal, it will bypass the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	395 internal queue and be delivered to the application at the next event poll.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	396 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	397 extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	398
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	399 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	400 Return the current event filter - can be used to "chain" filters.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	401 If there is no event filter set, this function returns NULL.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	402 */
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	403 extern DECLSPEC SDL_EventFilter SDLCALL SDL_GetEventFilter(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	404
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	405 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	406 This function allows you to set the state of processing certain events.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	407 If 'state' is set to SDL_IGNORE, that event will be automatically dropped
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	408 from the event queue and will not event be filtered.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	409 If 'state' is set to SDL_ENABLE, that event will be processed normally.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	410 If 'state' is set to SDL_QUERY, SDL_EventState() will return the
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	411 current processing state of the specified event.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	412 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	413 #define SDL_QUERY -1
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	414 #define SDL_IGNORE 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	415 #define SDL_DISABLE 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	416 #define SDL_ENABLE 1
1668 4da1ee79c9af more tweaking indent options Sam Lantinga <slouken@libsdl.org> parents: 1662 diff changeset	417 extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	418
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	419
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	420 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	421 #ifdef __cplusplus
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	422 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	423 }
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	424 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	425 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	426 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	427
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	428 #endif /* _SDL_events_h */
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	429
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	430 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_events.h @ 1718:ed4d4f1ea201 SDL-1.3