ugfx/src/ginput/ginput.h
2018-10-01 17:34:15 +02:00

51 lines
1.3 KiB
C

/*
* 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.io/license.html
*/
/**
* @file src/ginput/ginput.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 GFXON 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 */
/** @} */