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

annotate include/SDL_events.h @ 5036:c8f23a7c39d5

The clipboard API was missing from the 2010 project

author	Sam Lantinga <slouken@libsdl.org>
date	Wed, 19 Jan 2011 13:44:21 -0800
parents	22751715e11a
children	25d4feb7c127

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"
4659 063b9455bd1a Added some files I had previosuly missed Jim Grandpre <jim.tla@gmail.com> parents: 4658 diff changeset	39 #include "SDL_gesture.h"
063b9455bd1a Added some files I had previosuly missed Jim Grandpre <jim.tla@gmail.com> parents: 4658 diff changeset	40 #include "SDL_touch.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	42 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44 #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	45 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46 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	47 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	48 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	49
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	50 /* 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	51 #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	52 #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	53
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	55 * \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	56 */
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	57 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	58 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	59 SDL_FIRSTEVENT = 0, /*< Unused (do not remove) /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	60
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	61 /* Application events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	62 SDL_QUIT = 0x100, /*< User-requested quit /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	63
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	64 /* Window events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	65 SDL_WINDOWEVENT = 0x200, /*< Window state change /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	66 SDL_SYSWMEVENT, /*< System specific event /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	67
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	68 /* Keyboard events */
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4694 diff changeset	69 SDL_KEYDOWN = 0x300, /*< Key pressed /
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4694 diff changeset	70 SDL_KEYUP, /*< Key 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	71 SDL_TEXTEDITING, /*< Keyboard text editing (composition) /
1957 c7803e4c21d3 Implemented Cocoa mouse wheel events Sam Lantinga <slouken@libsdl.org> parents: 1914 diff changeset	72 SDL_TEXTINPUT, /*< Keyboard text input /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	73
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	74 /* Mouse events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	75 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	76 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	77 SDL_MOUSEBUTTONUP, /*< Mouse button released /
1957 c7803e4c21d3 Implemented Cocoa mouse wheel events Sam Lantinga <slouken@libsdl.org> parents: 1914 diff changeset	78 SDL_MOUSEWHEEL, /*< Mouse wheel motion /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	79
4465 3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	80 /* Tablet or multiple mice input device events */
3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	81 SDL_INPUTMOTION = 0x500, /*< Input moved /
3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	82 SDL_INPUTBUTTONDOWN, /*< Input button pressed /
3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	83 SDL_INPUTBUTTONUP, /*< Input button released /
3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	84 SDL_INPUTWHEEL, /*< Input wheel motion /
3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	85 SDL_INPUTPROXIMITYIN, /*< Input pen entered proximity /
3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	86 SDL_INPUTPROXIMITYOUT, /*< Input pen left proximity /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	87
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	88 /* Joystick events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	89 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	90 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	91 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	92 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	93 SDL_JOYBUTTONUP, /*< Joystick button released /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	94
4661 03dcb795c583 Merged changes from the main SDL codebase Sam Lantinga <slouken@libsdl.org> parents: 4659 4503 diff changeset	95 /* Touch events */
03dcb795c583 Merged changes from the main SDL codebase Sam Lantinga <slouken@libsdl.org> parents: 4659 4503 diff changeset	96 SDL_FINGERDOWN = 0x700,
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	97 SDL_FINGERUP,
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	98 SDL_FINGERMOTION,
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	99 SDL_TOUCHBUTTONDOWN,
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	100 SDL_TOUCHBUTTONUP,
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	101
4661 03dcb795c583 Merged changes from the main SDL codebase Sam Lantinga <slouken@libsdl.org> parents: 4659 4503 diff changeset	102 /* Gesture events */
03dcb795c583 Merged changes from the main SDL codebase Sam Lantinga <slouken@libsdl.org> parents: 4659 4503 diff changeset	103 SDL_DOLLARGESTURE = 0x800,
4659 063b9455bd1a Added some files I had previosuly missed Jim Grandpre <jim.tla@gmail.com> parents: 4658 diff changeset	104 SDL_DOLLARRECORD,
4657 eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	105 SDL_MULTIGESTURE,
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	106
4503 524dfefd554c Added an event when the clipboard is updated, triggered after the window gains the keyboard focus. Sam Lantinga <slouken@libsdl.org> parents: 4465 diff changeset	107 /* Clipboard events */
4662 3c4e0130c9b1 Added alternative finger tracking method. Still prefer IPHONE_TOUCH_EFFICIENT_DANGEROUS. Jim Grandpre <jim.tla@gmail.com> parents: 4661 diff changeset	108
4661 03dcb795c583 Merged changes from the main SDL codebase Sam Lantinga <slouken@libsdl.org> parents: 4659 4503 diff changeset	109 SDL_CLIPBOARDUPDATE = 0x900, /*< The clipboard changed /
4503 524dfefd554c Added an event when the clipboard is updated, triggered after the window gains the keyboard focus. Sam Lantinga <slouken@libsdl.org> parents: 4465 diff changeset	110
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	111 /* Obsolete events */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	112 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	113 SDL_EVENT_COMPAT2,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	114 SDL_EVENT_COMPAT3,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	115
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	116
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	117 /** 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	118 * and should be allocated with SDL_RegisterEvents()
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	119 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	120 SDL_USEREVENT = 0x8000,
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	121
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	122 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	123 * 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	124 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	125 SDL_LASTEVENT = 0xFFFF
1294 1760ceb23bc6 Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET) Sam Lantinga <slouken@libsdl.org> parents: 1258 diff changeset	126 } SDL_EventType;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	127
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	128 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	129 * \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	130 */
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	131 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	132 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	133 Uint32 type; /*< ::SDL_WINDOWEVENT /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	134 Uint32 windowID; /*< The associated window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	135 Uint8 event; /*< ::SDL_WindowEventID /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	136 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	137 Uint8 padding2;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	138 Uint8 padding3;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	139 int data1; /*< event dependent data /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	140 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	141 } SDL_WindowEvent;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	142
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	143 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	144 * \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	145 */
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	146 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	147 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	148 Uint32 type; /*< ::SDL_KEYDOWN or ::SDL_KEYUP /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	149 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	150 Uint8 state; /*< ::SDL_PRESSED or ::SDL_RELEASED /
4560 95352c671a6e Added support for keyboard repeat (only tested on Windows so far) Sam Lantinga <slouken@libsdl.org> parents: 4503 diff changeset	151 Uint8 repeat; /*< Non-zero if this is a key repeat /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	152 Uint8 padding2;
4465 3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	153 Uint8 padding3;
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	154 SDL_keysym keysym; /*< The key that was pressed or released /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	155 } SDL_KeyboardEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	156
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	157 #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	158 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	159 * \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	160 */
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	161 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	162 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	163 Uint32 type; /*< ::SDL_TEXTEDITING /
4434 5c64052fb476 changeset: 4433:25667ea797fa Sam Lantinga <slouken@libsdl.org> parents: 4429 diff changeset	164 Uint32 windowID; /*< The window with keyboard focus, if any /
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	165 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	166 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	167 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	168 } 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	169
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	170
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	171 #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	172 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	173 * \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	174 */
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	175 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	176 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	177 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	178 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	179 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	180 } 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	181
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	182 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	183 * \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	184 */
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	185 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	186 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	187 Uint32 type; /*< ::SDL_MOUSEMOTION /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	188 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	189 Uint8 state; /*< The current button state /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	190 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	191 Uint8 padding2;
4465 3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	192 Uint8 padding3;
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	193 int x; /*< X coordinate, relative to window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	194 int y; /*< Y coordinate, relative to window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	195 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	196 int yrel; /*< The relative motion in the Y direction /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	197 } SDL_MouseMotionEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	198
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	199 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	200 * \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	201 */
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 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	203 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	204 Uint32 type; /*< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	205 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	206 Uint8 button; /*< The mouse button index /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	207 Uint8 state; /*< ::SDL_PRESSED or ::SDL_RELEASED /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	208 Uint8 padding1;
4465 3e69e077cb95 Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API. Sam Lantinga <slouken@libsdl.org> parents: 4435 diff changeset	209 Uint8 padding2;
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	210 int x; /*< X coordinate, relative to window /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	211 int y; /*< Y coordinate, relative to window /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	212 } SDL_MouseButtonEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	213
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	214 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	215 * \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	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 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	218 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	219 Uint32 type; /*< ::SDL_MOUSEWHEEL /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	220 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	221 int x; /*< The amount scrolled horizontally /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	222 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	223 } 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	224
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	225 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	226 * \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	227 */
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	228 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	229 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	230 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	231 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	232 Uint8 axis; /*< The joystick axis index /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	233 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	234 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	235 int value; /*< The axis value (range: -32768 to 32767) /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	236 } SDL_JoyAxisEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	237
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	238 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	239 * \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	240 */
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	241 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	242 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	243 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	244 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	245 Uint8 ball; /*< The joystick trackball index /
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	246 Uint8 padding1;
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	247 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	248 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	249 int yrel; /*< The relative motion in the Y direction /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	250 } SDL_JoyBallEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	251
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	253 * \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	254 */
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	255 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	256 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	257 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	258 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	259 Uint8 hat; /*< The joystick hat index /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	260 Uint8 value; /**< The hat position value.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	261 * \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	262 * \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	263 * \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	264 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	265 * 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	266 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	267 Uint8 padding1;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	268 } SDL_JoyHatEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	269
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	270 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	271 * \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	272 */
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	273 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	274 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	275 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	276 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	277 Uint8 button; /*< The joystick button index /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	278 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	279 Uint8 padding1;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	280 } SDL_JoyButtonEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	281
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	282
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	283 /**
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	284 * \brief Touch finger motion/finger event structure (event.tmotion.*)
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	285 */
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	286 typedef struct SDL_TouchFingerEvent
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	287 {
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	288 Uint32 type; /**< ::SDL_FINGERMOTION OR
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	289 SDL_FINGERDOWN OR SDL_FINGERUP*/
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	290 Uint32 windowID; /*< The window with mouse focus, if any /
4678 f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	291 SDL_TouchID touchId; /*< The touch device id /
f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	292 SDL_FingerID fingerId;
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	293 Uint8 state; /*< The current button state /
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	294 Uint8 padding1;
4676 99b4560b7aa1 Upgraded touchId/fingerId to long. Changed position variables to floats. jimtla parents: 4662 diff changeset	295 Uint8 padding2;
99b4560b7aa1 Upgraded touchId/fingerId to long. Changed position variables to floats. jimtla parents: 4662 diff changeset	296 Uint8 padding3;
4678 f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	297 Uint16 x;
f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	298 Uint16 y;
4683 15dfe42edbfd Fixed gestureMulti. Disabled dollar gesture temporarily. Jim Grandpre <jim.tla@gmail.com> parents: 4678 diff changeset	299 Sint16 dx;
15dfe42edbfd Fixed gestureMulti. Disabled dollar gesture temporarily. Jim Grandpre <jim.tla@gmail.com> parents: 4678 diff changeset	300 Sint16 dy;
4678 f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	301 Uint16 pressure;
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	302 } SDL_TouchFingerEvent;
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	303
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	304
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	305 /**
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	306 * \brief Touch finger motion/finger event structure (event.tmotion.*)
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	307 */
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	308 typedef struct SDL_TouchButtonEvent
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	309 {
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	310 Uint32 type; /*< ::SDL_TOUCHBUTTONUP OR SDL_TOUCHBUTTONDOWN /
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	311 Uint32 windowID; /*< The window with mouse focus, if any /
4678 f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	312 SDL_TouchID touchId; /*< The touch device index /
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	313 Uint8 state; /*< The current button state /
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	314 Uint8 button; /*< The button changing state /
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	315 Uint8 padding1;
4676 99b4560b7aa1 Upgraded touchId/fingerId to long. Changed position variables to floats. jimtla parents: 4662 diff changeset	316 Uint8 padding2;
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	317 } SDL_TouchButtonEvent;
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	318
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	319
4657 eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	320 /**
5009 b21ad135d86b Minor documentation consistency cleanup Sam Lantinga <slouken@libsdl.org> parents: 4972 diff changeset	321 * \brief Multiple Finger Gesture Event (event.mgesture.*)
4657 eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	322 */
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	323 typedef struct SDL_MultiGestureEvent
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	324 {
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	325 Uint32 type; /*< ::SDL_MULTIGESTURE /
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	326 Uint32 windowID; /*< The window with mouse focus, if any /
4678 f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	327 SDL_TouchID touchId; /*< The touch device index /
4657 eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	328 float dTheta;
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	329 float dDist;
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	330 float x; //currently 0...1. Change to screen coords?
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	331 float y;
4683 15dfe42edbfd Fixed gestureMulti. Disabled dollar gesture temporarily. Jim Grandpre <jim.tla@gmail.com> parents: 4678 diff changeset	332 Uint16 numFingers;
15dfe42edbfd Fixed gestureMulti. Disabled dollar gesture temporarily. Jim Grandpre <jim.tla@gmail.com> parents: 4678 diff changeset	333 Uint16 padding;
4657 eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	334 } SDL_MultiGestureEvent;
eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	335
5014 22751715e11a Fixed compiler error Sam Lantinga <slouken@libsdl.org> parents: 5009 diff changeset	336 /* (event.dgesture.) /
22751715e11a Fixed compiler error Sam Lantinga <slouken@libsdl.org> parents: 5009 diff changeset	337 typedef struct SDL_DollarGestureEvent
4658 454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	338 {
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	339 Uint32 type; /*< ::SDL_DOLLARGESTURE /
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	340 Uint32 windowID; /*< The window with mouse focus, if any /
4678 f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	341 SDL_TouchID touchId; /*< The touch device index /
f8431f66613d Added SDL_TouchID, SDL_FingerID, SDL_GestureID types. Converted to integer cioordinates (<- not working). jimtla parents: 4676 diff changeset	342 SDL_GestureID gestureId;
4689 f9ab8df6d45a Added README.touch and README.gesture. Moved touchtest/gestureSDLTest to test/testgesture Jim Grandpre <jim.tla@gmail.com> parents: 4683 diff changeset	343 Uint32 numFingers;
4658 454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	344 float error;
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	345 /*
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	346 //TODO: Enable to give location?
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	347 float x; //currently 0...1. Change to screen coords?
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	348 float y;
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	349 */
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	350 } SDL_DollarGestureEvent;
454385d76845 Moved $1 Gestures into the SDL Library Jim Grandpre <jim.tla@gmail.com> parents: 4657 diff changeset	351
4657 eed063a0bf5b Moved Multi finger gesture recognition into the library. Jim Grandpre <jim.tla@gmail.com> parents: 4644 diff changeset	352
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	353 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	354 * \brief The "quit requested" event
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	355 */
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	356 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	357 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	358 Uint32 type; /*< ::SDL_QUIT /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	359 } SDL_QuitEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	360
5009 b21ad135d86b Minor documentation consistency cleanup Sam Lantinga <slouken@libsdl.org> parents: 4972 diff changeset	361
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	363 * \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	364 */
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 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	366 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	367 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	368 Uint32 windowID; /*< The associated window if any /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	369 int code; /*< User defined event code /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	370 void data1; /< User defined data pointer /
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	371 void data2; /< User defined data pointer /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	372 } SDL_UserEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	373
5009 b21ad135d86b Minor documentation consistency cleanup Sam Lantinga <slouken@libsdl.org> parents: 4972 diff changeset	374
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	375 struct SDL_SysWMmsg;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	376 typedef struct SDL_SysWMmsg SDL_SysWMmsg;
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	377
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	378 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	379 * \brief A video driver dependent system event (event.syswm.*)
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	380 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	381 * \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	382 */
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	383 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	384 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	385 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	386 SDL_SysWMmsg msg; /< driver dependent data, defined in SDL_syswm.h /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	387 } SDL_SysWMEvent;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	388
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	389 #ifndef SDL_NO_COMPAT
3407 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 * \addtogroup Compatibility
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	392 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	393 /@{/
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	394
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	395 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	396 * \name Typedefs for backwards compatibility
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	397 */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	398 /@{/
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	399 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	400 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	401 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	402 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	403 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	404 } 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	405
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	406 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	407 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	408 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	409 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	410 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	411 } SDL_ResizeEvent;
3407 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
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	414 /@}//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	415 #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	416
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	417 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	418 * \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	419 */
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	420 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	421 {
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	422 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	423 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	424 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	425 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	426 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	427 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	428 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	429 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	430 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	431 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	432 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	433 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	434 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	435 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	436 SDL_SysWMEvent syswm; /*< System dependent window event data /
4641 49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	437 SDL_TouchFingerEvent tfinger; /*< Touch finger event data /
49a97daea6ec Added touch event definitions. Heavily modified events/SDL_touch. Jim Grandpre <jim.tla@gmail.com>* parents: 4435 diff changeset	438 SDL_TouchButtonEvent tbutton; /*< Touch button event data /
4972 0a9a77f3d552 Fixed spacing in comments Sam Lantinga <slouken@libsdl.org> parents: 4971 diff changeset	439 SDL_MultiGestureEvent mgesture; /*< Multi Finger Gesture data /
0a9a77f3d552 Fixed spacing in comments Sam Lantinga <slouken@libsdl.org> parents: 4971 diff changeset	440 SDL_DollarGestureEvent dgesture; /*< Multi Finger Gesture 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	441
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	442 /** Temporarily here for backwards compatibility */
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	443 /@{/
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	444 #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	445 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	446 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	447 #endif
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	448 /@}/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	449 } SDL_Event;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	450
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	451
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	452 /* Function prototypes */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	453
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	454 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	455 * 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	456 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	457 * 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	458 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	459 * 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	460 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	461 extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	462
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	463 /@{/
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	464 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	465 {
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	466 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	467 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	468 SDL_GETEVENT
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	469 } SDL_eventaction;
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 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	472 * 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	473 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	474 * 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	475 * the back of the event queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	476 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	477 * If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front
4635 0a07d002f10b Fixed documentation error Sam Lantinga <slouken@libsdl.org> parents: 4560 diff changeset	478 * of the event queue, within the specified minimum and maximum type,
0a07d002f10b Fixed documentation error Sam Lantinga <slouken@libsdl.org> parents: 4560 diff changeset	479 * will be returned and will not be removed from the queue.
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 * If \c action is ::SDL_GETEVENT, up to \c numevents events at the front
4635 0a07d002f10b Fixed documentation error Sam Lantinga <slouken@libsdl.org> parents: 4560 diff changeset	482 * of the event queue, within the specified minimum and maximum type,
0a07d002f10b Fixed documentation error Sam Lantinga <slouken@libsdl.org> parents: 4560 diff changeset	483 * will be returned and will be removed from the queue.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	484 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	485 * \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	486 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	487 * This function is thread-safe.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	488 */
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	489 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	490 SDL_eventaction action,
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	491 Uint32 minType, Uint32 maxType);
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	492 /@}/
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	493
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	494 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	495 * 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	496 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	497 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	498 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	499
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	500 /**
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	501 * 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	502 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	503 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	504 extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	505
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	506 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	507 * \brief Polls for currently pending events.
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 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	510 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	511 * \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	512 * stored in that area.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	513 */
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	514 extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	515
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	516 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	517 * \brief Waits indefinitely for the next available event.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	518 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	519 * \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	520 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	521 * \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	522 * stored in that area.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	523 */
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	524 extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	525
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	526 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	527 * \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	528 * available event.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	529 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	530 * \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	531 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	532 * \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	533 * stored in that area.
3072 9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	534 */
9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	535 extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	536 int timeout);
9da8f57ab92c Fixed bug #684 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	537
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	538 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	539 * \brief Add an event to the event queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	540 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	541 * \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	542 * was full or there was some other error.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	543 */
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	544 extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	545
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	546 typedef int (SDLCALL * SDL_EventFilter) (void userdata, SDL_Event event);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	547
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	548 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	549 * 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	550 * are posted to the internal event queue.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	551 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	552 * The filter is protypted as:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	553 * \code
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	554 * int SDL_EventFilter(void userdata, SDL_Event event);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	555 * \endcode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	556 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	557 * 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	558 * 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	559 * 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	560 * dynamically arriving events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	561 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	562 * \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	563 * it may run in a different thread!
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	564 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	565 * 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	566 * 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	567 * 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	568 * 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	569 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	570 * 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	571 * 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	572 */
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	573 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	574 void *userdata);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	575
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	576 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	577 * 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	578 * 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	579 */
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	580 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	581 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	582
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	583 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	584 * 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	585 * events for which the filter returns 0.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	586 */
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	587 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	588 void *userdata);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	589
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	590 /@{/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	591 #define SDL_QUERY -1
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	592 #define SDL_IGNORE 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	593 #define SDL_DISABLE 0
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	594 #define SDL_ENABLE 1
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	595
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	596 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	597 * 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	598 * - 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	599 * 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	600 * - 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	601 * normally.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	602 * - 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	603 * current processing state of the specified event.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	604 */
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	605 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	606 /@}/
4429 faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	607 #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	608
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	609 /**
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	610 * 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	611 * 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	612 *
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	613 * 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	614 * returns (Uint32)-1
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	615 */
faa9fc8e7f67 General improvements for user custom event registration Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	616 extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	617
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	618 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	619 #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	620 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	621 }
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	622 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	623 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	624 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	625
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	626 #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	627
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	628 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_events.h @ 5036:c8f23a7c39d5