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

annotate include/SDL_events.h @ 4429:faa9fc8e7f67

General improvements for user custom event registration * Switched event type to enum (int32) * Switched polling by mask to polling by type range * Added SDL_RegisterEvents() to allow dynamic user event registration * Spread events out to allow inserting new related events without breaking binary compatibility * Added padding to event structures so they're the same size regardless of 32-bit compiler structure packing settings * Split SDL_HasEvent() to SDL_HasEvent() for a single event and SDL_HasEvents() for a range of events * Added SDL_GetEventState() as a shortcut for SDL_EventState(X, SDL_QUERY) * Added SDL_FlushEvent() and SDL_FlushEvents() to clear events from the event queue

author	Sam Lantinga <slouken@libsdl.org>
date	Thu, 25 Mar 2010 01:08:26 -0700
parents	f7b03b6838cb
children	5c64052fb476

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
3697 f7b03b6838cb Fixed bug #926 Sam Lantinga <slouken@libsdl.org> parents: 3685 diff changeset	3 Copyright (C) 1997-2010 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
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	23 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	24 * \file SDL_events.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	25 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	26 * Include file for SDL event handling.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. 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"
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. 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
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. 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" {
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. 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
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	52 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	53 * \brief The types of events that can be delivered.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	54 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	55 typedef enum
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	56 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	57 SDL_FIRSTEVENT = 0, /*< Unused (do not remove) /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	58
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	59 /* Application events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	60 SDL_QUIT = 0x100, /*< User-requested quit /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	61
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	62 /* Window events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	63 SDL_WINDOWEVENT = 0x200, /*< Window state change /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	64 SDL_SYSWMEVENT, /*< System specific event /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	65
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	66 /* Keyboard events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	67 SDL_KEYDOWN = 0x300, /*< Keys pressed /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	68 SDL_KEYUP, /*< Keys released /
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	69 SDL_TEXTEDITING, /*< Keyboard text editing (composition) /
1957 c7803e4c21d3 Implemented Cocoa mouse wheel events Sam Lantinga <slouken@libsdl.org> parents: 1914 diff changeset	70 SDL_TEXTINPUT, /*< Keyboard text input /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	71
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	72 /* Mouse events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	73 SDL_MOUSEMOTION = 0x400, /*< Mouse moved /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	74 SDL_MOUSEBUTTONDOWN, /*< Mouse button pressed /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	75 SDL_MOUSEBUTTONUP, /*< Mouse button released /
1957 c7803e4c21d3 Implemented Cocoa mouse wheel events Sam Lantinga <slouken@libsdl.org> parents: 1914 diff changeset	76 SDL_MOUSEWHEEL, /*< Mouse wheel motion /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	77
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	78 /* Tablet events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	79 SDL_PROXIMITYIN = 0x500, /*< Proximity In event /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	80 SDL_PROXIMITYOUT, /*< Proximity Out event /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	81
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	82 /* Joystick events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	83 SDL_JOYAXISMOTION = 0x600, /*< Joystick axis motion /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	84 SDL_JOYBALLMOTION, /*< Joystick trackball motion /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	85 SDL_JOYHATMOTION, /*< Joystick hat position change /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	86 SDL_JOYBUTTONDOWN, /*< Joystick button pressed /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	87 SDL_JOYBUTTONUP, /*< Joystick button released /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	88
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	89 /* Obsolete events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	90 SDL_EVENT_COMPAT1 = 0x7000, /*< SDL 1.2 events for compatibility /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	91 SDL_EVENT_COMPAT2,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	92 SDL_EVENT_COMPAT3,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	93
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	94 /** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	95 * and should be allocated with SDL_RegisterEvents()
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	96 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	97 SDL_USEREVENT = 0x8000,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	98
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	99 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	100 * This last event is only for bounding internal arrays
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	101 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	102 SDL_LASTEVENT = 0xFFFF
1294 1760ceb23bc6 Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET) Sam Lantinga <slouken@libsdl.org> parents: 1258 diff changeset	103 } SDL_EventType;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	104
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	105 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	106 * \brief Window state change event data (event.window.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	107 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	108 typedef struct SDL_WindowEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	109 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	110 Uint32 type; /*< ::SDL_WINDOWEVENT /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	111 Uint32 windowID; /*< The associated window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	112 Uint8 event; /*< ::SDL_WindowEventID /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	113 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	114 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	115 Uint8 padding3;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	116 int data1; /*< event dependent data /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	117 int data2; /*< event dependent data /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	118 } SDL_WindowEvent;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	119
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	120 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	121 * \brief Keyboard button event structure (event.key.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	122 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	123 typedef struct SDL_KeyboardEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	124 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	125 Uint32 type; /*< ::SDL_KEYDOWN or ::SDL_KEYUP /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	126 Uint32 windowID; /*< The window with keyboard focus, if any /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	127 Uint8 which; /*< The keyboard device index /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	128 Uint8 state; /*< ::SDL_PRESSED or ::SDL_RELEASED /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	129 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	130 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	131 SDL_keysym keysym; /*< The key that was pressed or released /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	132 } SDL_KeyboardEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	133
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	134 #define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	135 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	136 * \brief Keyboard text editing event structure (event.edit.*)
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	137 */
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	138 typedef struct SDL_TextEditingEvent
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	139 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	140 Uint32 type; /*< ::SDL_TEXTEDITING /
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	141 char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE]; /*< The editing text /
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	142 int start; /*< The start cursor of selected editing text /
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	143 int length; /*< The length of selected editing text /
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	144 } SDL_TextEditingEvent;
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	145
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	146
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	147 #define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	148 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	149 * \brief Keyboard text input event structure (event.text.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	150 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	151 typedef struct SDL_TextInputEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	152 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	153 Uint32 type; /*< ::SDL_TEXTINPUT /
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3572 diff changeset	154 Uint32 windowID; /*< The window with keyboard focus, if any /
2300 c97ad1abe05b Minimal implementation of textinput events for x11. It only works for latin-1. Bob Pendleton <bob@pendleton.com> parents: 2152 diff changeset	155 Uint8 which; /*< The keyboard device index /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	156 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	157 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	158 Uint8 padding3;
2300 c97ad1abe05b Minimal implementation of textinput events for x11. It only works for latin-1. Bob Pendleton <bob@pendleton.com> parents: 2152 diff changeset	159 char text[SDL_TEXTINPUTEVENT_TEXT_SIZE]; /*< The input text /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	160 } SDL_TextInputEvent;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	161
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	162 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	163 * \brief Mouse motion event structure (event.motion.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	164 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	165 typedef struct SDL_MouseMotionEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	166 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	167 Uint32 type; /*< ::SDL_MOUSEMOTION /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	168 Uint32 windowID; /*< The window with mouse focus, if any /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	169 Uint8 which; /*< The mouse device index /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	170 Uint8 state; /*< The current button state /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	171 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	172 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	173 int x; /*< X coordinate, relative to window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	174 int y; /*< Y coordinate, relative to window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	175 int z; /*< Z coordinate, for future use /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	176 int pressure; /*< Pressure reported by tablets /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	177 int pressure_max; /*< Maximum value of the pressure reported by the device /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	178 int pressure_min; /*< Minimum value of the pressure reported by the device /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	179 int rotation; /*< For future use /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	180 int tilt_x; /*< For future use /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	181 int tilt_y; /*< For future use /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	182 int cursor; /*< The cursor being used in the event /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	183 int xrel; /*< The relative motion in the X direction /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	184 int yrel; /*< The relative motion in the Y direction /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	185 } SDL_MouseMotionEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	186
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	187 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	188 * \brief Mouse button event structure (event.button.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	189 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	190 typedef struct SDL_MouseButtonEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	191 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	192 Uint32 type; /*< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	193 Uint32 windowID; /*< The window with mouse focus, if any /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	194 Uint8 which; /*< The mouse device index /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	195 Uint8 button; /*< The mouse button index /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	196 Uint8 state; /*< ::SDL_PRESSED or ::SDL_RELEASED /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	197 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	198 int x; /*< X coordinate, relative to window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	199 int y; /*< Y coordinate, relative to window /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	200 } SDL_MouseButtonEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	201
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	202 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	203 * \brief Mouse wheel event structure (event.wheel.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	204 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	205 typedef struct SDL_MouseWheelEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	206 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	207 Uint32 type; /*< ::SDL_MOUSEWHEEL /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	208 Uint32 windowID; /*< The window with mouse focus, if any /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	209 Uint8 which; /*< The mouse device index /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	210 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	211 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	212 Uint8 padding3;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	213 int x; /*< The amount scrolled horizontally /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	214 int y; /*< The amount scrolled vertically /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	215 } SDL_MouseWheelEvent;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	216
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	217 /**
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	218 * \brief Tablet pen proximity event
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	219 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	220 typedef struct SDL_ProximityEvent
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	221 {
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	222 Uint32 type; /*< ::SDL_PROXIMITYIN or ::SDL_PROXIMITYOUT /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	223 Uint32 windowID; /*< The associated window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	224 Uint8 which;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	225 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	226 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	227 Uint8 padding3;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	228 int cursor;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	229 int x;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	230 int y;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	231 } SDL_ProximityEvent;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	232
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	233 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	234 * \brief Joystick axis motion event structure (event.jaxis.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	235 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	236 typedef struct SDL_JoyAxisEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	237 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	238 Uint32 type; /*< ::SDL_JOYAXISMOTION /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	239 Uint8 which; /*< The joystick device index /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	240 Uint8 axis; /*< The joystick axis index /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	241 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	242 Uint8 padding2;
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	243 int value; /*< The axis value (range: -32768 to 32767) /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	244 } SDL_JoyAxisEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	245
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	246 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	247 * \brief Joystick trackball motion event structure (event.jball.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	248 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	249 typedef struct SDL_JoyBallEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	250 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	251 Uint32 type; /*< ::SDL_JOYBALLMOTION /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	252 Uint8 which; /*< The joystick device index /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	253 Uint8 ball; /*< The joystick trackball index /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	254 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	255 Uint8 padding2;
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	256 int xrel; /*< The relative motion in the X direction /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	257 int yrel; /*< The relative motion in the Y direction /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	258 } SDL_JoyBallEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	259
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	260 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	261 * \brief Joystick hat position change event structure (event.jhat.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	262 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	263 typedef struct SDL_JoyHatEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	264 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	265 Uint32 type; /*< ::SDL_JOYHATMOTION /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	266 Uint8 which; /*< The joystick device index /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	267 Uint8 hat; /*< The joystick hat index /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	268 Uint8 value; /**< The hat position value.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	269 * \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	270 * \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	271 * \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	272 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	273 * Note that zero means the POV is centered.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	274 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	275 Uint8 padding1;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	276 } SDL_JoyHatEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	277
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	278 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	279 * \brief Joystick button event structure (event.jbutton.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	280 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	281 typedef struct SDL_JoyButtonEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	282 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	283 Uint32 type; /*< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	284 Uint8 which; /*< The joystick device index /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	285 Uint8 button; /*< The joystick button index /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	286 Uint8 state; /*< ::SDL_PRESSED or ::SDL_RELEASED /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	287 Uint8 padding1;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	288 } SDL_JoyButtonEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	289
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	290 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	291 * \brief The "quit requested" event
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	292 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	293 typedef struct SDL_QuitEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	294 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	295 Uint32 type; /*< ::SDL_QUIT /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	296 } SDL_QuitEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	297
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	298 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	299 * \brief A user-defined event type (event.user.*)
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	300 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	301 typedef struct SDL_UserEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	302 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	303 Uint32 type; /*< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	304 Uint32 windowID; /*< The associated window if any /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	305 int code; /*< User defined event code /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	306 void data1; /< User defined data pointer /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	307 void data2; /< User defined data pointer /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	308 } SDL_UserEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	309
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	310 struct SDL_SysWMmsg;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	311 typedef struct SDL_SysWMmsg SDL_SysWMmsg;
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	312
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	313 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	314 * \brief A video driver dependent system event (event.syswm.*)
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	315 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	316 * \note If you want to use this event, you should include SDL_syswm.h.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	317 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	318 typedef struct SDL_SysWMEvent
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	319 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	320 Uint32 type; /*< ::SDL_SYSWMEVENT /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	321 SDL_SysWMmsg msg; /< driver dependent data, defined in SDL_syswm.h /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	322 } SDL_SysWMEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	323
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	324 #ifndef SDL_NO_COMPAT
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	325 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	326 * \addtogroup Compatibility
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	327 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	328 /@{/
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	329
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	330 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	331 * \name Typedefs for backwards compatibility
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	332 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	333 /@{/
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	334 typedef struct SDL_ActiveEvent
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	335 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	336 Uint32 type;
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	337 Uint8 gain;
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	338 Uint8 state;
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	339 } SDL_ActiveEvent;
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	340
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	341 typedef struct SDL_ResizeEvent
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	342 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	343 Uint32 type;
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	344 int w;
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	345 int h;
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	346 } SDL_ResizeEvent;
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	347 /@}/
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	348
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	349 /@}//Compatibility/
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	350 #endif
0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	351
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	352 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	353 * \brief General event structure
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	354 */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	355 typedef union SDL_Event
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	356 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	357 Uint32 type; /*< Event type, shared with all events /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	358 SDL_WindowEvent window; /*< Window event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	359 SDL_KeyboardEvent key; /*< Keyboard event data /
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 3191 diff changeset	360 SDL_TextEditingEvent edit; /*< Text editing event data /
2300 c97ad1abe05b Minimal implementation of textinput events for x11. It only works for latin-1. Bob Pendleton <bob@pendleton.com> parents: 2152 diff changeset	361 SDL_TextInputEvent text; /*< Text input event data /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	362 SDL_MouseMotionEvent motion; /*< Mouse motion event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	363 SDL_MouseButtonEvent button; /*< Mouse button event data /
2300 c97ad1abe05b Minimal implementation of textinput events for x11. It only works for latin-1. Bob Pendleton <bob@pendleton.com> parents: 2152 diff changeset	364 SDL_MouseWheelEvent wheel; /*< Mouse wheel event data /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	365 SDL_JoyAxisEvent jaxis; /*< Joystick axis event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	366 SDL_JoyBallEvent jball; /*< Joystick ball event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	367 SDL_JoyHatEvent jhat; /*< Joystick hat event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	368 SDL_JoyButtonEvent jbutton; /*< Joystick button event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	369 SDL_QuitEvent quit; /*< Quit request event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	370 SDL_UserEvent user; /*< Custom event data /
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	371 SDL_SysWMEvent syswm; /*< System dependent window event data /
2710 44e49d3fa6cf Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: 2300 diff changeset	372 SDL_ProximityEvent proximity; /*< Proximity In or Out event /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	373
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	374 /** Temporarily here for backwards compatibility */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	375 /@{/
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	376 #ifndef SDL_NO_COMPAT
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	377 SDL_ActiveEvent active;
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	378 SDL_ResizeEvent resize;
3167 0c85abc61e47 Added a #ifndef SDL_NO_COMPAT around SDL_ActiveEvent and SDL_ResizeEvent so that code Bob Pendleton <bob@pendleton.com> parents: 3072 diff changeset	379 #endif
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	380 /@}/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	381 } SDL_Event;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	382
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	383
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	384 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	385
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	386 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	387 * Pumps the event loop, gathering events from the input devices.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	388 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	389 * This function updates the event queue and internal input device state.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	390 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	391 * This should only be run in the thread that sets the video mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	392 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	393 extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	394
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	395 /@{/
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	396 typedef enum
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	397 {
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	398 SDL_ADDEVENT,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	399 SDL_PEEKEVENT,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	400 SDL_GETEVENT
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	401 } SDL_eventaction;
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	402
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	403 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	404 * Checks the event queue for messages and optionally returns them.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	405 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	406 * If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	407 * the back of the event queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	408 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	409 * If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	410 * of the event queue, matching \c mask, will be returned and will not
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	411 * be removed from the queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	412 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	413 * If \c action is ::SDL_GETEVENT, up to \c numevents events at the front
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	414 * of the event queue, matching \c mask, will be returned and will be
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	415 * removed from the queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	416 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	417 * \return The number of events actually stored, or -1 if there was an error.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	418 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	419 * This function is thread-safe.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	420 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	421 extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	422 SDL_eventaction action,
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	423 Uint32 minType, Uint32 maxType);
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	424 /@}/
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	425
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	426 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	427 * Checks to see if certain event types are in the event queue.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	428 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	429 extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	430 extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	431
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	432 /**
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	433 * This function clears events from the event queue
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	434 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	435 extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	436 extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	437
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	438 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	439 * \brief Polls for currently pending events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	440 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	441 * \return 1 if there are any pending events, or 0 if there are none available.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	442 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	443 * \param event If not NULL, the next event is removed from the queue and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	444 * stored in that area.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	445 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	446 extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	447
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	448 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	449 * \brief Waits indefinitely for the next available event.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	450 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	451 * \return 1, or 0 if there was an error while waiting for events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	452 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	453 * \param event If not NULL, the next event is removed from the queue and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	454 * stored in that area.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	455 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	456 extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	457
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	458 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	459 * \brief Waits until the specified timeout (in milliseconds) for the next
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	460 * available event.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	461 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	462 * \return 1, or 0 if there was an error while waiting for events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	463 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	464 * \param event If not NULL, the next event is removed from the queue and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	465 * stored in that area.
3072 9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	466 */
9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	467 extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	468 int timeout);
9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	469
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	470 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	471 * \brief Add an event to the event queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	472 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	473 * \return 1 on success, 0 if the event was filtered, or -1 if the event queue
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	474 * was full or there was some other error.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	475 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	476 extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	477
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	478 typedef int (SDLCALL * SDL_EventFilter) (void userdata, SDL_Event event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	479
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	480 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	481 * Sets up a filter to process all events before they change internal state and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	482 * are posted to the internal event queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	483 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	484 * The filter is protypted as:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	485 * \code
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	486 * int SDL_EventFilter(void userdata, SDL_Event event);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	487 * \endcode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	488 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	489 * If the filter returns 1, then the event will be added to the internal queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	490 * If it returns 0, then the event will be dropped from the queue, but the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	491 * internal state will still be updated. This allows selective filtering of
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	492 * dynamically arriving events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	493 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	494 * \warning Be very careful of what you do in the event filter function, as
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	495 * it may run in a different thread!
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	496 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	497 * There is one caveat when dealing with the ::SDL_QUITEVENT event type. The
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	498 * event filter is only called when the window manager desires to close the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	499 * application window. If the event filter returns 1, then the window will
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	500 * be closed, otherwise the window will remain open if possible.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	501 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	502 * If the quit event is generated by an interrupt signal, it will bypass the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	503 * internal queue and be delivered to the application at the next event poll.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	504 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	505 extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	506 void *userdata);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	507
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	508 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	509 * Return the current event filter - can be used to "chain" filters.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	510 * If there is no event filter set, this function returns SDL_FALSE.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	511 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	512 extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	513 void **userdata);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	514
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	515 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	516 * Run the filter function on the current event queue, removing any
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	517 * events for which the filter returns 0.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	518 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	519 extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	520 void *userdata);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	521
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	522 /@{/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	523 #define SDL_QUERY -1
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	524 #define SDL_IGNORE 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	525 #define SDL_DISABLE 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	526 #define SDL_ENABLE 1
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	527
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	528 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	529 * This function allows you to set the state of processing certain events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	530 * - If \c state is set to ::SDL_IGNORE, that event will be automatically
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	531 * dropped from the event queue and will not event be filtered.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	532 * - If \c state is set to ::SDL_ENABLE, that event will be processed
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	533 * normally.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	534 * - If \c state is set to ::SDL_QUERY, SDL_EventState() will return the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	535 * current processing state of the specified event.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	536 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	537 extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	538 /@}/
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	539 #define SDL_GetEventState(type) SDL_EventState(type, SDL_QUERY)
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	540
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	541 /**
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	542 * This function allocates a set of user-defined events, and returns
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	543 * the beginning event number for that set of events.
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	544 *
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	545 * If there aren't enough user-defined events left, this function
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	546 * returns (Uint32)-1
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	547 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	548 extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	549
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	550 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	551 #ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	552 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	553 }
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	554 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	555 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	556 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	557
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	558 #endif /* _SDL_events_h */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	559
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	560 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_events.h @ 4429:faa9fc8e7f67