ugfx/include/tdisp/tdisp.h

148 lines
3.7 KiB
C
Raw Normal View History

2013-01-09 13:29:32 +00:00
/*
ChibiOS/GFX - Copyright (C) 2012
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/tdisp/tdisp.h
* @brief TDISP Graphic Driver subsystem header file.
*
* @addtogroup TDISP
*
* @details The TDISP module provides high level abstraction to interface pixel oriented graphic displays.
2013-01-11 14:20:57 +00:00
* Due the TDISP module is completely encapsulated from the other modules, it's very fast and lightweight.
2013-01-09 13:29:32 +00:00
*
* @pre GFX_USE_TDISP must be set to TRUE in gfxconf.h
*
* @{
*/
#ifndef _TDISP_H
#define _TDISP_H
#include "gfx.h"
#if GFX_USE_TDISP || defined(__DOXYGEN__)
/* Include the low level driver information */
#include "tdisp/lld/tdisp_lld.h"
2013-01-11 12:25:38 +00:00
/**
* @name TDISP display attributes
* @{
*/
2013-01-11 13:39:27 +00:00
#define TDISP_ON 0x01
#define TDISP_OFF 0x02
#define TDISP_CURSOR_ON 0x03
#define TDISP_CURSOR_OFF 0x04
#define TDISP_CURSOR_BLINK_ON 0x05
#define TDISP_CURSOR_BLINK_OFF 0x06
2013-01-11 12:25:38 +00:00
/** @} */
2013-01-10 13:51:31 +00:00
2013-01-10 18:47:50 +00:00
/**
* @brief TDISP driver initialisation
* @note This function is not implicitly invoked by @p halInit().
* It must be called manually.
*
* @return TRUE if success, FALSE otherwise
*
* @init
*/
2013-01-09 13:29:32 +00:00
bool_t tdispInit(void);
2013-01-10 18:47:50 +00:00
2013-01-11 12:25:38 +00:00
/**
* @brief Control different display properties
2013-01-17 08:16:59 +00:00
* @note A wrapper macro exists for each option, please use them
* instead of this function manually.
2013-01-11 12:25:38 +00:00
*
2013-01-17 08:16:59 +00:00
* @param[in] what What you want to control
* @param[in] value The value to be assigned
2013-01-11 12:25:38 +00:00
*/
2013-01-17 08:16:59 +00:00
void tdispControl(uint16_t what, void *value);
2013-01-11 12:25:38 +00:00
2013-01-10 18:47:50 +00:00
/**
* @brief Clears the display
*/
2013-01-09 13:29:32 +00:00
void tdispClear(void);
2013-01-10 18:47:50 +00:00
/**
* @brief Sets the cursor to it's home position ( 0/0 )
*/
2013-01-09 13:29:32 +00:00
void tdispHome(void);
2013-01-10 18:47:50 +00:00
/**
* @brief Set cursor to a certain position
*
* @param[in] col The column
* @param[in] row The row
*/
2013-01-16 09:27:42 +00:00
void tdispSetCursor(coord_t col, coord_t row);
2013-01-10 18:47:50 +00:00
2013-01-12 08:38:38 +00:00
/**
2013-01-12 09:00:17 +00:00
* @brief Store a custom character in RAM
2013-01-12 08:38:38 +00:00
*
* @note This usually must be done after each power-up since most
* LCDs lose their RAM content.
*
2013-01-16 09:27:42 +00:00
* @param[in] address On which address to store the character (from 0 up to max)
2013-01-12 09:00:17 +00:00
* @param[in] charmap The character to be stored.
2013-01-12 08:38:38 +00:00
*/
2013-01-16 09:27:42 +00:00
void tdispCreateChar(uint8_t address, char *charmap);
2013-01-12 08:38:38 +00:00
2013-01-10 18:47:50 +00:00
/**
* @brief Draws a single character at the current cursor position
*
* @param[in] c The character to be drawn
*/
2013-01-09 13:29:32 +00:00
void tdispDrawChar(char c);
2013-01-10 18:47:50 +00:00
/**
* @brief Draws a string at the current cursor position
*
* @param[in] s The string to be drawn
*/
2013-01-09 13:29:32 +00:00
void tdispDrawString(char *s);
2013-01-10 18:47:50 +00:00
/**
* @brief Draws a single character at a given position
* @note This function manipulates the cursor position and it will not be
* reset to it's original state
*
* @param[in] col The column
* @param[in] row The row
* @param[in] c The character to be drawn
*/
void tdispDrawCharLocation(coord_t col, coord_t row, char c);
/**
* @brief Draws a string at a given position
* @note This function manipulates the cursor position and it will not be
* reset to it's original state
*
* @param[in] col The column
* @param[in] row The row
* @param[in] s The string to be drawn
*/
void tdispDrawStringLocation(coord_t col, coord_t row, char *s);
2013-01-09 13:29:32 +00:00
#endif /* GFX_USE_TDISP */
#endif /* _TDISP_H */
2013-01-10 18:47:50 +00:00
/** @} */
2013-01-09 13:29:32 +00:00