diff options
| author | Tectu <joel@unormal.org> | 2012-12-16 08:58:59 -0800 |
|---|---|---|
| committer | Tectu <joel@unormal.org> | 2012-12-16 08:58:59 -0800 |
| commit | 4743790cd40832205f701a280acd622cd003a9fd (patch) | |
| tree | 088919aae5e2673621f6090dc79adac862c8c8a6 /include/ginput/dial.h | |
| parent | 09fc35864aa695cc46dcb95ed3951a365622b709 (diff) | |
| parent | f31a1f7f4aeb09bc09d49944daaf2f38fddd94e7 (diff) | |
| download | uGFX-4743790cd40832205f701a280acd622cd003a9fd.tar.gz uGFX-4743790cd40832205f701a280acd622cd003a9fd.tar.bz2 uGFX-4743790cd40832205f701a280acd622cd003a9fd.zip | |
Merge pull request #26 from inmarket/master
Many tidyups and restructure.
Diffstat (limited to 'include/ginput/dial.h')
| -rw-r--r-- | include/ginput/dial.h | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/include/ginput/dial.h b/include/ginput/dial.h new file mode 100644 index 00000000..90db94ac --- /dev/null +++ b/include/ginput/dial.h @@ -0,0 +1,72 @@ +/*
+ ChibiOS/GFX - Copyright (C) 2012
+ Joel Bodenmann aka Tectu <joel@unormal.org>
+
+ This file is part of ChibiOS/GFX.
+
+ ChibiOS/GFX is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/GFX 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file include/ginput/dial.h
+ * @brief GINPUT GFX User Input subsystem header file.
+ *
+ * @addtogroup GINPUT
+ * @{
+ */
+#ifndef _GINPUT_DIAL_H
+#define _GINPUT_DIAL_H
+
+#if GINPUT_NEED_DIAL || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Type definitions */
+/*===========================================================================*/
+
+// Event types for various ginput sources
+#define GEVENT_DIAL (GEVENT_GINPUT_FIRST+4)
+
+typedef struct GEventDial_t {
+ GEventType type; // The type of this event (GEVENT_DIAL)
+ uint16_t instance; // The dial instance
+ uint16_t value; // The dial value
+ } GEventDial;
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+ /* Dial Functions */
+ GSourceHandle ginputGetDial(uint16_t instance); // Instance = 0 to n-1
+ void ginputResetDialRange(uint16_t instance); // Reset the maximum value back to the hardware default.
+ uint16_t ginputGetDialRange(uint16_t instance); // Get the maximum value. The readings are scaled to be 0...max-1. 0 means over the full uint16_t range.
+ void ginputSetDialRange(uint16_t instance, uint16_t max); // Set the maximum value.
+ void ginputSetDialSensitivity(uint16_t instance, uint16_t diff); // Set the level change required before a dial event is generated.
+ // - This is done after range scaling
+ /* Get the current keyboard button status.
+ * Returns FALSE on error (eg invalid instance)
+ */
+ bool_t ginputGetDialStatus(uint16_t instance, GEventDial *pdial);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* GINPUT_NEED_DIAL */
+
+#endif /* _GINPUT_DIAL_H */
+/** @} */
|