ugfx/include/ginput/ginput.h
2013-03-06 23:11:01 +01:00

62 lines
1.9 KiB
C

/*
ChibiOS/GFX - Copyright (C) 2012, 2013
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/ginput.h
* @brief GINPUT GFX User Input subsystem header file.
*
* @addtogroup GINPUT
*
* @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 "ginput/mouse.h"
#include "ginput/keyboard.h"
#include "ginput/toggle.h"
#include "ginput/dial.h"
#endif /* GFX_USE_GINPUT */
#endif /* _GINPUT_H */
/** @} */