summaryrefslogtreecommitdiff
path: root/include/SDL_input.h
diff options
context:
space:
mode:
authorSam Lantinga <slouken@libsdl.org>2010-05-09 20:47:22 -0700
committerSam Lantinga <slouken@libsdl.org>2010-05-09 20:47:22 -0700
commit338f95eb06f26846ab1a8a9d6e9a687564137a5e (patch)
treee22d3571f1e0db6a11243bd30df092a178a89893 /include/SDL_input.h
parentd12afdaedbe72a4058c63c526a1f4ff80b2594ae (diff)
Removed multi-mouse / multi-keyboard support in anticipation of a real multi-mouse and multi-touch API.
Plus, this lets me start implementing cursor support.
Diffstat (limited to 'include/SDL_input.h')
-rw-r--r--include/SDL_input.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/include/SDL_input.h b/include/SDL_input.h
new file mode 100644
index 00000000..455138f1
--- /dev/null
+++ b/include/SDL_input.h
@@ -0,0 +1,88 @@
+/*
+ SDL - Simple DirectMedia Layer
+ Copyright (C) 1997-2010 Sam Lantinga
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+ Sam Lantinga
+ slouken@libsdl.org
+*/
+
+/**
+ * \file SDL_input.h
+ *
+ * Include file for lowlevel SDL input device handling.
+ *
+ * This talks about individual devices, and not the system cursor. If you
+ * just want to know when the user moves the pointer somewhere in your
+ * window, this is NOT the API you want. This one handles things like
+ * multi-touch, drawing tablets, and multiple, separate mice.
+ *
+ * The other API is in SDL_mouse.h
+ */
+
+#ifndef _SDL_input_h
+#define _SDL_input_h
+
+#include "SDL_stdinc.h"
+#include "SDL_error.h"
+#include "SDL_video.h"
+
+#include "begin_code.h"
+/* Set up for C function definitions, even when using C++ */
+#ifdef __cplusplus
+/* *INDENT-OFF* */
+extern "C" {
+/* *INDENT-ON* */
+#endif
+
+
+/* Function prototypes */
+
+/* !!! FIXME: real documentation
+ * - Redetect devices
+ * - This invalidates all existing device information from previous queries!
+ * - There is an implicit (re)detect upon SDL_Init().
+ */
+extern DECLSPEC int SDLCALL SDL_RedetectInputDevices(void);
+
+/**
+ * \brief Get the number of mouse input devices available.
+ */
+extern DECLSPEC int SDLCALL SDL_GetNumInputDevices(void);
+
+/**
+ * \brief Gets the name of a device with the given index.
+ *
+ * \param index is the index of the device, whose name is to be returned.
+ *
+ * \return the name of the device with the specified index
+ */
+extern DECLSPEC const char *SDLCALL SDL_GetInputDeviceName(int index);
+
+
+extern DECLSPEC int SDLCALL SDL_IsDeviceDisconnected(int index);
+
+/* Ends C function definitions when using C++ */
+#ifdef __cplusplus
+/* *INDENT-OFF* */
+}
+/* *INDENT-ON* */
+#endif
+#include "close_code.h"
+
+#endif /* _SDL_mouse_h */
+
+/* vi: set ts=4 sw=4 expandtab: */