ugfx/include/tdisp/options.h
2013-07-21 22:20:37 +02:00

79 lines
1.9 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.org/license.html
*/
/**
* @file include/tdisp/options.h
* @brief TDISP sub-system options header file.
*
* @addtogroup TDISP
* @{
*/
#ifndef _TDISP_OPTIONS_H
#define _TDISP_OPTIONS_H
#if GFX_USE_TDISP
/**
* @name TDISP Functionality to be included
* @{
*/
/**
* @brief Set if the display need reading from the display
* @details Defaults to FALSE
* @details If TRUE, the read function of the display wil be implemented into the source.
* @note Most users do not need reading from the display.
*/
#ifndef TDISP_NEED_READ
#define TDISP_NEED_READ FALSE
#endif
/**
* @}
*
* @name TDISP Multi-Threading Options
* @{
*/
/**
* @brief Do the display functions need to be thread-safe.
* @details Defaults to FALSE
*/
#ifndef TDISP_NEED_MULTITHREAD
#define TDISP_NEED_MULTITHREAD FALSE
#endif
/**
* @}
*
* @name TDISP Optional Low Level Driver Defines
* @{
*/
/**
* @brief Use a custom board definition even if a board definition exists.
* @details Defaults to FALSE
* @details If TRUE, add tdisp_lld_board.h to your project directory and customise it.
* @note Not all TDISP low level drivers currently use board definition files.
*/
#ifndef TDISP_USE_CUSTOM_BOARD
#define TDISP_USE_CUSTOM_BOARD FALSE
#endif
/**
* @brief Set the screen height and width.
* @note Ignored by some low level GDISP drivers, optional for others.
* @note Where these values are allowed, a default is always provided by the low level driver.
*/
#ifndef TDISP_COLUMNS
#define TDISP_COLUMNS 16
#endif
#ifndef TDISP_ROWS
#define TDISP_ROWS 2
#endif
/** @} */
#endif /* GFX_USE_TDISP */
#endif /* _TDISP_OPTIONS_H */
/** @} */