version 2.8
ginput.h
Go to the documentation of this file.
1 /*
2  * This file is subject to the terms of the GFX License. If a copy of
3  * the license was not distributed with this file, you can obtain one at:
4  *
5  * http://ugfx.org/license.html
6  */
7 
8 /**
9  * @file src/ginput/ginput.h
10  *
11  * @addtogroup GINPUT
12  *
13  * @brief Module to interface different hardware input sources such as touchscreens
14  *
15  * @details GINPUT provides an easy and common interface to use different input devices
16  * such as touchscreens and mices.
17  *
18  * @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
19  *
20  * @{
21  */
22 #ifndef _GINPUT_H
23 #define _GINPUT_H
24 
25 #include "../../gfx.h"
26 
27 #if GFX_USE_GINPUT || defined(__DOXYGEN__)
28 
29 /* How to use...
30 
31  1. Get source handles for all the inputs you are interested in.
32  - Attempting to get a handle for one instance of an input more than once will return the same handle
33  2. Create a listener
34  3. Assign inputs to your listener.
35  - Inputs can be assigned or released from a listener at any time.
36  - An input can be assigned to more than one listener.
37  4. Loop on getting listener events
38  5. When complete destroy the listener
39 */
40 
41 // Include various ginput types
42 #include "ginput_mouse.h"
43 #include "ginput_keyboard.h"
44 #include "ginput_toggle.h"
45 #include "ginput_dial.h"
46 
47 #endif /* GFX_USE_GINPUT */
48 
49 #endif /* _GINPUT_H */
50 /** @} */