222 lines
7.5 KiB
C
222 lines
7.5 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_options.h
|
|
* @brief GINPUT sub-system options header file.
|
|
*
|
|
* @addtogroup GINPUT
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _GINPUT_OPTIONS_H
|
|
#define _GINPUT_OPTIONS_H
|
|
|
|
/**
|
|
* @name GINPUT Functionality to be included
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Should mouse/touch functions be included.
|
|
* @details Defaults to GFXOFF
|
|
* @note Also add a mouse/touch hardware driver to your makefile.
|
|
* Eg.
|
|
* include $(GFXLIB)/drivers/ginput/touch/MCU/driver.mk
|
|
*/
|
|
#ifndef GINPUT_NEED_MOUSE
|
|
#define GINPUT_NEED_MOUSE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should keyboard functions be included.
|
|
* @details Defaults to GFXOFF
|
|
* @note Also add a keyboard hardware driver to your makefile.
|
|
* Eg.
|
|
* include $(GFXLIB)/drivers/ginput/keyboard/XXXX/driver.mk
|
|
*/
|
|
#ifndef GINPUT_NEED_KEYBOARD
|
|
#define GINPUT_NEED_KEYBOARD GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should hardware toggle/switch/button functions be included.
|
|
* @details Defaults to GFXOFF
|
|
* @note Also add a toggle hardware driver to your makefile.
|
|
* Eg.
|
|
* include $(GFXLIB)/drivers/ginput/toggle/Pal/driver.mk
|
|
*/
|
|
#ifndef GINPUT_NEED_TOGGLE
|
|
#define GINPUT_NEED_TOGGLE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should analog dial functions be included.
|
|
* @details Defaults to GFXOFF
|
|
* @note Also add a dial hardware driver to your makefile.
|
|
* Eg.
|
|
* include $(GFXLIB)/drivers/ginput/dial/analog/driver.mk
|
|
*/
|
|
#ifndef GINPUT_NEED_DIAL
|
|
#define GINPUT_NEED_DIAL GFXOFF
|
|
#endif
|
|
/**
|
|
* @}
|
|
*
|
|
* @name GINPUT Optional Sizing Parameters
|
|
* @{
|
|
*/
|
|
/**
|
|
* @}
|
|
*
|
|
* @name GINPUT Optional Low Level Driver Defines
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Start touch devices without loading or running calibration.
|
|
* @details Defaults to GFXOFF
|
|
* @note This is used if you want to manually control the initial calibration
|
|
* process. In practice this is only useful for a touch driver test program.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_STARTRAW
|
|
#define GINPUT_TOUCH_STARTRAW GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Turn off the touch calibration GUI.
|
|
* @details Defaults to GFXOFF
|
|
* @note Turning off the calibration GUI just turns off the manual calibration
|
|
* process. Readings may still be calibrated if calibration data
|
|
* can be loaded.
|
|
* @note Calibration requires a lot of code. If your device doesn't require it
|
|
* using this option can save a lot of space.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_NOCALIBRATE_GUI
|
|
#define GINPUT_TOUCH_NOCALIBRATE_GUI GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Turn off all touch calibration support.
|
|
* @details Defaults to GFXOFF
|
|
* @note With this set to GFXON touch readings will not be calibrated.
|
|
* @note This automatically turns off the calibration GUI too!
|
|
* @note Calibration requires a lot of code. If your device doesn't require it
|
|
* using this option can save a lot of space.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_NOCALIBRATE
|
|
#define GINPUT_TOUCH_NOCALIBRATE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Turn off all touch support.
|
|
* @details Defaults to GFXOFF
|
|
* @note This automatically turns off all calibration and the calibration GUI too!
|
|
* @note Touch device handling requires a lot of code. If your device doesn't require it
|
|
* using this option can save a lot of space.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_NOTOUCH
|
|
#define GINPUT_TOUCH_NOTOUCH GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Milliseconds between mouse polls.
|
|
* @details Defaults to 25 milliseconds
|
|
* @note How often mice should be polled. More often leads to smoother mouse movement
|
|
* but increases CPU usage.
|
|
*/
|
|
#ifndef GINPUT_MOUSE_POLL_PERIOD
|
|
#define GINPUT_MOUSE_POLL_PERIOD 25
|
|
#endif
|
|
|
|
/**
|
|
* @brief Maximum length of CLICK in milliseconds
|
|
* @details Defaults to 300 milliseconds
|
|
* @note Mouse down to Mouse up times greater than this are not clicks.
|
|
*/
|
|
#ifndef GINPUT_MOUSE_CLICK_TIME
|
|
#define GINPUT_MOUSE_CLICK_TIME 300
|
|
#endif
|
|
/**
|
|
* @brief Milliseconds to generate a CXTCLICK on a touch device.
|
|
* @details Defaults to 500 milliseconds
|
|
* @note If you hold the touch down for longer than this a CXTCLICK is generated
|
|
* but only on a touch device.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_CXTCLICK_TIME
|
|
#define GINPUT_TOUCH_CXTCLICK_TIME 500
|
|
#endif
|
|
/**
|
|
* @brief There is a user supplied routine to load mouse calibration data
|
|
* @details Defaults to GFXOFF
|
|
* @note If GFXON the user must supply the @p LoadMouseCalibration() routine.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_USER_CALIBRATION_LOAD
|
|
#define GINPUT_TOUCH_USER_CALIBRATION_LOAD GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief There is a user supplied routine to save mouse calibration data
|
|
* @details Defaults to GFXOFF
|
|
* @note If GFXON the user must supply the @p SaveMouseCalibration() routine.
|
|
*/
|
|
#ifndef GINPUT_TOUCH_USER_CALIBRATION_SAVE
|
|
#define GINPUT_TOUCH_USER_CALIBRATION_SAVE GFXOFF
|
|
#endif
|
|
#if defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Define multiple static mice
|
|
* @details When not defined the system automatically detects a single linked mouse driver
|
|
* @note The references to GMOUSEVMT_Win32 in the definition would be replaced
|
|
* by the names of the VMT for each of the static mice you want to
|
|
* include.
|
|
* @note Dynamic mice associated automatically with a display eg Win32, X or GFXnet
|
|
* do not need to be specified in this list as the associated display driver will register
|
|
* them automatically as the display is created.
|
|
*/
|
|
#define GMOUSE_DRIVER_LIST GMOUSEVMT_Win32, GMOUSEVMT_Win32
|
|
#endif
|
|
/**
|
|
* @brief Milliseconds between keyboard polls.
|
|
* @details Defaults to 200 milliseconds
|
|
* @note How often keyboards should be polled.
|
|
*/
|
|
#ifndef GINPUT_KEYBOARD_POLL_PERIOD
|
|
#define GINPUT_KEYBOARD_POLL_PERIOD 200
|
|
#endif
|
|
#if defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Define multiple static keyboards
|
|
* @details When not defined the system automatically detects a single linked keyboard driver
|
|
* @note The references to GKEYBOARDVMT_Win32 in the definition would be replaced
|
|
* by the names of the VMT for each of the static keyboards you want to
|
|
* include.
|
|
* @note Dynamic keyboards associated automatically with a display eg Win32, X or GFXnet
|
|
* do not need to be specified in this list as the display driver will register
|
|
* them automatically as the display is created.
|
|
*/
|
|
#define GKEYBOARD_DRIVER_LIST GMOUSEVMT_Win32, GMOUSEVMT_Win32
|
|
#endif
|
|
/**
|
|
* @brief Turn off the layout engine.
|
|
* @details When defined the layout engine is removed from the code and characters
|
|
* are passed directly from the keyboard driver to the application.
|
|
* @note Turning off the layout engine just saves code if it is not needed.
|
|
*/
|
|
#ifndef GKEYBOARD_LAYOUT_OFF
|
|
#define GKEYBOARD_LAYOUT_OFF GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Various Keyboard Layouts that can be included.
|
|
* @details A keyboard layout controls conversion of scancodes to characters
|
|
* and enables one keyboard to have multiple language mappings.
|
|
* @note Defining a layout does not make it active. The keyboard driver
|
|
* must have it active as the default or the application must
|
|
* use @p ginputSetKeyboardLayout() to set the active layout.
|
|
* @note Multiple layouts can be included but only one will be active
|
|
* at a time (per keyboard).
|
|
* @{
|
|
*/
|
|
#ifndef GKEYBOARD_LAYOUT_SCANCODE2_US
|
|
#define GKEYBOARD_LAYOUT_SCANCODE2_US GFXOFF // US Keyboard using the ScanCode 2 set.
|
|
#endif
|
|
/** @} */
|
|
/** @} */
|
|
|
|
#endif /* _GINPUT_OPTIONS_H */
|
|
/** @} */
|