aboutsummaryrefslogtreecommitdiffstats
path: root/src/ginput/sys_defs.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/ginput/sys_defs.h')
-rw-r--r--src/ginput/sys_defs.h50
1 files changed, 50 insertions, 0 deletions
diff --git a/src/ginput/sys_defs.h b/src/ginput/sys_defs.h
new file mode 100644
index 00000000..33259da4
--- /dev/null
+++ b/src/ginput/sys_defs.h
@@ -0,0 +1,50 @@
+/*
+ * This file is subject to the terms of the GFX License. If a copy of
+ * the license was not distributed with this file, you can obtain one at:
+ *
+ * http://ugfx.org/license.html
+ */
+
+/**
+ * @file src/ginput/sys_defs.h
+ *
+ * @addtogroup GINPUT
+ *
+ * @brief Module to interface different hardware input sources such as touchscreens
+ *
+ * @details GINPUT provides an easy and common interface to use different input devices
+ * such as touchscreens and mices.
+ *
+ * @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
+ *
+ * @{
+ */
+#ifndef _GINPUT_H
+#define _GINPUT_H
+
+#include "gfx.h"
+
+#if GFX_USE_GINPUT || defined(__DOXYGEN__)
+
+/* How to use...
+
+ 1. Get source handles for all the inputs you are interested in.
+ - Attempting to get a handle for one instance of an input more than once will return the same handle
+ 2. Create a listener
+ 3. Assign inputs to your listener.
+ - Inputs can be assigned or released from a listener at any time.
+ - An input can be assigned to more than one listener.
+ 4. Loop on getting listener events
+ 5. When complete destroy the listener
+*/
+
+// Include various ginput types
+#include "src/ginput/mouse.h"
+#include "src/ginput/keyboard.h"
+#include "src/ginput/toggle.h"
+#include "src/ginput/dial.h"
+
+#endif /* GFX_USE_GINPUT */
+
+#endif /* _GINPUT_H */
+/** @} */