madhu sudhana / Mbed OS newTFTLCD_

1.44 tft lcd display

Dependencies:   TFT_fonts mbed-os

Fork of newTFTLCD by madhu sudhana

lcd_base.h@3:64a5b67d5b51, 2012-12-02 (annotated)

Committer:
ttodorov
Date:
Sun Dec 02 01:44:23 2012 +0000
Revision:
3:64a5b67d5b51
Parent:
2:81ed304b7e9b
Child:
4:3ac4239f6c9c
- fixed documentation; - renamed ssd* source files to match the name of the LCD controller

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 0:881ff0b71102 1 /** \file lcd_base.h
ttodorov 0:881ff0b71102 2 * \brief Base class for all LCD controller implementations.
ttodorov 0:881ff0b71102 3 * \copyright GNU Public License, v2. or later
ttodorov 0:881ff0b71102 4 *
ttodorov 0:881ff0b71102 5 * Generic object painting and screen control.
ttodorov 0:881ff0b71102 6 *
ttodorov 0:881ff0b71102 7 * This library is based on the Arduino/chipKIT UTFT library by Henning
ttodorov 0:881ff0b71102 8 * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 9 *
ttodorov 0:881ff0b71102 10 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 0:881ff0b71102 11 * Copyright (C)2012 Todor Todorov.
ttodorov 0:881ff0b71102 12 *
ttodorov 0:881ff0b71102 13 * This library is free software; you can redistribute it and/or
ttodorov 0:881ff0b71102 14 * modify it under the terms of the GNU Lesser General Public
ttodorov 0:881ff0b71102 15 * License as published by the Free Software Foundation; either
ttodorov 0:881ff0b71102 16 * version 2.1 of the License, or (at your option) any later version.
ttodorov 0:881ff0b71102 17 *
ttodorov 0:881ff0b71102 18 * This library is distributed in the hope that it will be useful,
ttodorov 0:881ff0b71102 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 0:881ff0b71102 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 0:881ff0b71102 21 * Lesser General Public License for more details.
ttodorov 0:881ff0b71102 22 *
ttodorov 0:881ff0b71102 23 * You should have received a copy of the GNU Lesser General Public
ttodorov 0:881ff0b71102 24 * License along with this library; if not, write to:
ttodorov 0:881ff0b71102 25 *
ttodorov 0:881ff0b71102 26 * Free Software Foundation, Inc.
ttodorov 0:881ff0b71102 27 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 0:881ff0b71102 28 *
ttodorov 0:881ff0b71102 29 *********************************************************************/
ttodorov 3:64a5b67d5b51 30 #ifndef TFTLCD_BASE_H
ttodorov 3:64a5b67d5b51 31 #define TFTLCD_BASE_H
ttodorov 0:881ff0b71102 32
ttodorov 0:881ff0b71102 33 #include "mbed.h"
ttodorov 0:881ff0b71102 34 #include "fonts.h"
ttodorov 0:881ff0b71102 35
ttodorov 0:881ff0b71102 36 /** \def RGB(r,g,b)
ttodorov 0:881ff0b71102 37 * \brief Creates a RGB-565 color value.
ttodorov 0:881ff0b71102 38 *
ttodorov 0:881ff0b71102 39 * Displays which use 16 bits to assign colors to a specific pixel, use
ttodorov 0:881ff0b71102 40 * 5 bits for the red component, 6 bits for the green component and 5
ttodorov 0:881ff0b71102 41 * bits for the blue component. This macro converts the 3 full-size
ttodorov 0:881ff0b71102 42 * RGB bytes into one 16-bit RGB-565 value.
ttodorov 0:881ff0b71102 43 */
ttodorov 0:881ff0b71102 44 #define RGB( r, g, b ) ( ( ( ( r ) & 248 ) | ( ( g ) >> 5 ) ) << 8 ) | ( ( ( ( g ) & 28 ) << 3 ) | ( ( b ) >> 3 ) )
ttodorov 0:881ff0b71102 45 /** \def COLOR_BLACK
ttodorov 0:881ff0b71102 46 * \brief Shorthand for RGB( 0, 0, 0 ).
ttodorov 0:881ff0b71102 47 */
ttodorov 0:881ff0b71102 48 #define COLOR_BLACK RGB( 0x00, 0x00, 0x00 )
ttodorov 0:881ff0b71102 49 /** \def COLOR_WHITE
ttodorov 0:881ff0b71102 50 * \brief Shorthand for RGB( 255, 255, 255 ).
ttodorov 0:881ff0b71102 51 */
ttodorov 0:881ff0b71102 52 #define COLOR_WHITE RGB( 0xFF, 0xFF, 0xFF )
ttodorov 0:881ff0b71102 53 /** \def COLOR_RED
ttodorov 0:881ff0b71102 54 * \brief Shorthand for RGB( 255, 0, 0 ).
ttodorov 0:881ff0b71102 55 */
ttodorov 0:881ff0b71102 56 #define COLOR_RED RGB( 0xFF, 0x00, 0x00 )
ttodorov 0:881ff0b71102 57 /** \def COLOR_GREEN
ttodorov 0:881ff0b71102 58 * \brief Shorthand for RGB( 0, 255, 0 ).
ttodorov 0:881ff0b71102 59 */
ttodorov 0:881ff0b71102 60 #define COLOR_GREEN RGB( 0x00, 0xFF, 0x00 )
ttodorov 0:881ff0b71102 61 /** \def COLOR_BLUE
ttodorov 0:881ff0b71102 62 * \brief Shorthand for RGB( 0, 0, 255 ).
ttodorov 0:881ff0b71102 63 */
ttodorov 0:881ff0b71102 64 #define COLOR_BLUE RGB( 0x00, 0x00, 0xFF )
ttodorov 0:881ff0b71102 65
ttodorov 0:881ff0b71102 66 /** \typedef orientation_t
ttodorov 0:881ff0b71102 67 * \brief Display orientation.
ttodorov 0:881ff0b71102 68 */
ttodorov 0:881ff0b71102 69 typedef enum Orientation_enum
ttodorov 0:881ff0b71102 70 {
ttodorov 0:881ff0b71102 71 PORTRAIT = 0, /**< Display height is bigger than its width. */
ttodorov 0:881ff0b71102 72 LANDSCAPE = 1, /**< Display width is bigger than its height. */
ttodorov 0:881ff0b71102 73 } orientation_t;
ttodorov 0:881ff0b71102 74
ttodorov 0:881ff0b71102 75 /** \typedef align_t
ttodorov 0:881ff0b71102 76 * \brief Horizontal text alignment on the line.
ttodorov 0:881ff0b71102 77 */
ttodorov 0:881ff0b71102 78 typedef enum Alignment_enum
ttodorov 0:881ff0b71102 79 {
ttodorov 0:881ff0b71102 80 LEFT = 0, /**< Left-oriented, naturally gravitate closer to the left edge of the screen. */
ttodorov 0:881ff0b71102 81 CENTER = 9998, /**< Center-oriented, try to fit in the middle of the available space with equal free space to the left and right of the text. */
ttodorov 0:881ff0b71102 82 RIGHT = 9999, /**< Right-oriented, naturally gravitate closer to the right edge of the screen, leaving any remaining free space to the left of the text. */
ttodorov 0:881ff0b71102 83 } align_t;
ttodorov 0:881ff0b71102 84
ttodorov 0:881ff0b71102 85 /** \typedef font_metrics_t
ttodorov 0:881ff0b71102 86 * \brief Describes fonts and their properties.
ttodorov 0:881ff0b71102 87 * \sa Comments in fonts.h
ttodorov 0:881ff0b71102 88 */
ttodorov 0:881ff0b71102 89 typedef struct Font_struct
ttodorov 0:881ff0b71102 90 {
ttodorov 0:881ff0b71102 91 const char* font; /**< A pointer to the first byte in the font. */
ttodorov 0:881ff0b71102 92 unsigned char width; /**< The width of each character, in pixels. */
ttodorov 0:881ff0b71102 93 unsigned char height; /**< Height of each character, in pixels. */
ttodorov 0:881ff0b71102 94 unsigned char offset; /**< Offset of the first character in the font. */
ttodorov 0:881ff0b71102 95 unsigned char numchars; /**< Count of the available characters in the font. */
ttodorov 0:881ff0b71102 96 } font_metrics_t;
ttodorov 0:881ff0b71102 97
ttodorov 0:881ff0b71102 98 /** \typedef bitmap_t
ttodorov 0:881ff0b71102 99 * \brief Pointer to the start of a block of pixel data, describing a picture.
ttodorov 0:881ff0b71102 100 */
ttodorov 0:881ff0b71102 101 typedef unsigned short* bitmap_t;
ttodorov 0:881ff0b71102 102
ttodorov 0:881ff0b71102 103 /** Base class for LCD implementations.
ttodorov 0:881ff0b71102 104 *
ttodorov 0:881ff0b71102 105 * All separate LCD controller implementations have to subclass this one.
ttodorov 0:881ff0b71102 106 *
ttodorov 0:881ff0b71102 107 * \version 0.1
ttodorov 0:881ff0b71102 108 * \author Todor Todorov
ttodorov 0:881ff0b71102 109 */
ttodorov 0:881ff0b71102 110 class LCD
ttodorov 0:881ff0b71102 111 {
ttodorov 0:881ff0b71102 112 public:
ttodorov 0:881ff0b71102 113
ttodorov 0:881ff0b71102 114 /** Initialize display.
ttodorov 0:881ff0b71102 115 *
ttodorov 0:881ff0b71102 116 * Wakes up the display from sleep, initializes power parameters.
ttodorov 0:881ff0b71102 117 * This function must be called first, befor any painting on the
ttodorov 0:881ff0b71102 118 * display is done, otherwise the positioning of graphical elements
ttodorov 0:881ff0b71102 119 * will not work properly and any paynt operation will not be visible
ttodorov 0:881ff0b71102 120 * or produce garbage.
ttodorov 0:881ff0b71102 121 *
ttodorov 0:881ff0b71102 122 * This function is controller-specific and needs to be implemented
ttodorov 0:881ff0b71102 123 * separately for each available implementation.
ttodorov 0:881ff0b71102 124 * \param oritentation The display orientation, landscape is default.
ttodorov 0:881ff0b71102 125 */
ttodorov 0:881ff0b71102 126 virtual void Initialize( orientation_t orientation ) = 0;
ttodorov 0:881ff0b71102 127
ttodorov 0:881ff0b71102 128 /** Set the foreground color for painting.
ttodorov 0:881ff0b71102 129 *
ttodorov 0:881ff0b71102 130 * This is the default foreground color to be used in painting operations.
ttodorov 0:881ff0b71102 131 * If a specific output function allows for a different color to be specified
ttodorov 0:881ff0b71102 132 * in place, the new setting will be used for that single operation only and
ttodorov 0:881ff0b71102 133 * will not change this value.
ttodorov 0:881ff0b71102 134 *
ttodorov 0:881ff0b71102 135 * \param color The color to be used. The value must be in RGB-565 format.
ttodorov 0:881ff0b71102 136 * \sa #RGB(r,g,b)
ttodorov 0:881ff0b71102 137 */
ttodorov 0:881ff0b71102 138 virtual void SetForeground( unsigned short color = COLOR_WHITE );
ttodorov 0:881ff0b71102 139
ttodorov 0:881ff0b71102 140 /** Set the background color for painting.
ttodorov 0:881ff0b71102 141 *
ttodorov 0:881ff0b71102 142 * This is the default color to be used for "empty" pixels while painting.
ttodorov 0:881ff0b71102 143 * If a particular function allows for a different value to be specified
ttodorov 0:881ff0b71102 144 * when the function is called, the new value will be used only for this
ttodorov 0:881ff0b71102 145 * single call and will not change this setting.
ttodorov 0:881ff0b71102 146 *
ttodorov 0:881ff0b71102 147 * \param color The background color as RGB-565 value.
ttodorov 0:881ff0b71102 148 * \sa #RGB(r,g,b)
ttodorov 0:881ff0b71102 149 */
ttodorov 0:881ff0b71102 150 virtual void SetBackground( unsigned short color = COLOR_BLACK );
ttodorov 0:881ff0b71102 151
ttodorov 0:881ff0b71102 152 /** Sets the font to be used for painting of text on the screen.
ttodorov 0:881ff0b71102 153 * \param font A pointer to the font data.
ttodorov 0:881ff0b71102 154 * \sa Comments in file fonts.h
ttodorov 0:881ff0b71102 155 */
ttodorov 0:881ff0b71102 156 virtual void SetFont( const char* font );
ttodorov 0:881ff0b71102 157
ttodorov 0:881ff0b71102 158 /** Gets the display width.
ttodorov 0:881ff0b71102 159 * \return Display width in pixels.
ttodorov 0:881ff0b71102 160 */
ttodorov 0:881ff0b71102 161 unsigned short GetWidth( void );
ttodorov 0:881ff0b71102 162
ttodorov 0:881ff0b71102 163 /** Gets the display height.
ttodorov 0:881ff0b71102 164 * \return Display height in pixels.
ttodorov 0:881ff0b71102 165 */
ttodorov 0:881ff0b71102 166 unsigned short GetHeight( void );
ttodorov 0:881ff0b71102 167
ttodorov 0:881ff0b71102 168 /** Fills the whole screen with a single color.
ttodorov 0:881ff0b71102 169 * \param color The color to be used. The value must be in RGB-565 format.
ttodorov 0:881ff0b71102 170 * \remarks The special values -1 and -2 signify the preset background and foreground colors, respectively.
ttodorov 0:881ff0b71102 171 * The backround color is the default.
ttodorov 0:881ff0b71102 172 */
ttodorov 0:881ff0b71102 173 virtual void FillScreen( int color = -1 );
ttodorov 0:881ff0b71102 174
ttodorov 0:881ff0b71102 175 /** Clears the screen.
ttodorov 0:881ff0b71102 176 *
ttodorov 0:881ff0b71102 177 * This is the same as calling #FillScreen() or #FillScreen( -1 ) to use the background color.
ttodorov 0:881ff0b71102 178 */
ttodorov 0:881ff0b71102 179 virtual void ClearScreen( void );
ttodorov 0:881ff0b71102 180
ttodorov 0:881ff0b71102 181 /** Draws a pixel at the specified location.
ttodorov 0:881ff0b71102 182 *
ttodorov 0:881ff0b71102 183 * By default the function will use the preset foreground color, but the background
ttodorov 0:881ff0b71102 184 * or a custom color could be used as well.
ttodorov 0:881ff0b71102 185 *
ttodorov 0:881ff0b71102 186 * \param x The horizontal offset of the pixel from the upper left corner of the screen.
ttodorov 0:881ff0b71102 187 * \param y The vertical offset of the pixel from the upper left corner of the screen.
ttodorov 0:881ff0b71102 188 * \param color The color to be used. Must be in RGB-565 format, or -1 for background and -2 for foreground color.
ttodorov 0:881ff0b71102 189 */
ttodorov 0:881ff0b71102 190 virtual void DrawPixel( unsigned short x, unsigned short y, int color = -2 );
ttodorov 0:881ff0b71102 191
ttodorov 0:881ff0b71102 192 /** Draws a line.
ttodorov 0:881ff0b71102 193 *
ttodorov 0:881ff0b71102 194 * \param x1 Horizontal offset of the beginning point of the line.
ttodorov 0:881ff0b71102 195 * \param y1 Vertical offset of the beginning point of the line.
ttodorov 0:881ff0b71102 196 * \param x2 Horizontal offset of the end point of the line.
ttodorov 0:881ff0b71102 197 * \param y2 Verical offset of the end point of the line.
ttodorov 0:881ff0b71102 198 * \param color The color to use for painting, in RGB-565 format, or -1 for background, or -2 for foreground.
ttodorov 0:881ff0b71102 199 */
ttodorov 0:881ff0b71102 200 virtual void DrawLine( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 201
ttodorov 0:881ff0b71102 202 /** Paints a rectangle.
ttodorov 0:881ff0b71102 203 *
ttodorov 0:881ff0b71102 204 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 205 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 206 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 207 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 208 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 209 */
ttodorov 0:881ff0b71102 210 virtual void DrawRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 211
ttodorov 0:881ff0b71102 212 /** Paints a rectangle and fills it with the paint color.
ttodorov 0:881ff0b71102 213 *
ttodorov 0:881ff0b71102 214 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 215 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 216 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 217 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 218 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 219 */
ttodorov 0:881ff0b71102 220 virtual void DrawRoundRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 221
ttodorov 0:881ff0b71102 222 /** Paints a rectangle with rounded corners.
ttodorov 0:881ff0b71102 223 *
ttodorov 0:881ff0b71102 224 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 225 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 226 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 227 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 228 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 229 */
ttodorov 0:881ff0b71102 230 virtual void FillRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 231
ttodorov 0:881ff0b71102 232 /** Paints a rectangle with rounded corners and fills it with the paint color.
ttodorov 0:881ff0b71102 233 *
ttodorov 0:881ff0b71102 234 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 235 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 236 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 237 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 238 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 239 */
ttodorov 0:881ff0b71102 240 virtual void FillRoundRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 241
ttodorov 0:881ff0b71102 242 /** Paints a circle.
ttodorov 0:881ff0b71102 243 *
ttodorov 0:881ff0b71102 244 * \param x The offset of the circle's center from the left edge of the screen.
ttodorov 0:881ff0b71102 245 * \param y The offset of the circle's center from the top edge of the screen.
ttodorov 0:881ff0b71102 246 * \param radius The circle's radius.
ttodorov 0:881ff0b71102 247 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 248 */
ttodorov 0:881ff0b71102 249 virtual void DrawCircle( unsigned short x, unsigned short y, unsigned short radius, int color = -2 );
ttodorov 0:881ff0b71102 250
ttodorov 0:881ff0b71102 251 /** Paints a circle and fills it with the paint color.
ttodorov 0:881ff0b71102 252 *
ttodorov 0:881ff0b71102 253 * \param x The offset of the circle's center from the left edge of the screen.
ttodorov 0:881ff0b71102 254 * \param y The offset of the circle's center from the top edge of the screen.
ttodorov 0:881ff0b71102 255 * \param radius The circle's radius.
ttodorov 0:881ff0b71102 256 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 257 */
ttodorov 0:881ff0b71102 258 virtual void FillCircle( unsigned short x, unsigned short y, unsigned short radius, int color = -2 );
ttodorov 0:881ff0b71102 259
ttodorov 0:881ff0b71102 260 /** Print a text on the screen.
ttodorov 0:881ff0b71102 261 *
ttodorov 0:881ff0b71102 262 * \param str The text.
ttodorov 0:881ff0b71102 263 * \param x The horizontal offset form the left edge of the screen. The special values LEFT, CENTER,
ttodorov 0:881ff0b71102 264 * or RIGHT can be used instead of pixel offset to indicate the text's horizontal alignment.
ttodorov 0:881ff0b71102 265 * \param y The vertical offset of the text from the top of the screen.
ttodorov 0:881ff0b71102 266 * \param fgColor The foreground to use for painting the text; -1 indicates background color, -2 the foreground setting, or custom color.
ttodorov 0:881ff0b71102 267 * \param bgColor The color to use for painting the empty pixels; -1 indicates the background color, -2 the foreground setting, or custom color.
ttodorov 0:881ff0b71102 268 * \param deg If different than 0, the text will be rotated at an angle this many degrees around its starting point. Default is not to ratate.
ttodorov 0:881ff0b71102 269 */
ttodorov 0:881ff0b71102 270 virtual void Print( const char *str, unsigned short x, unsigned short y, int fgColor = -2, int bgColor = -1, unsigned short deg = 0 );
ttodorov 0:881ff0b71102 271
ttodorov 0:881ff0b71102 272 /** Draw an image on the screen.
ttodorov 0:881ff0b71102 273 *
ttodorov 0:881ff0b71102 274 * The pixels of the picture must be in the RGB-565 format. The data can be provided
ttodorov 0:881ff0b71102 275 * as an array in a source or a header file. To convert an image file to the appropriate
ttodorov 0:881ff0b71102 276 * format, a special utility must be utilized. One such tool is provided by Henning Karlsen,
ttodorov 0:881ff0b71102 277 * the author of the UTFT display liberary and can be downloaded for free from his web site:
ttodorov 0:881ff0b71102 278 * http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 279 *
ttodorov 0:881ff0b71102 280 * \param x Horizontal offset of the first pixel of the image.
ttodorov 0:881ff0b71102 281 * \param y Vertical offset of the first pixel of the image
ttodorov 0:881ff0b71102 282 * \param sx Width of the image.
ttodorov 0:881ff0b71102 283 * \param sy Height of the image.
ttodorov 0:881ff0b71102 284 * \param data Image pixel array.
ttodorov 0:881ff0b71102 285 * \param scale A value of 1 will produce an image with its original size, while a different value will scale the image.
ttodorov 0:881ff0b71102 286 */
ttodorov 0:881ff0b71102 287 virtual void DrawBitmap( unsigned short x, unsigned short y, unsigned short sx, unsigned short sy, bitmap_t data, unsigned char scale = 1 );
ttodorov 0:881ff0b71102 288
ttodorov 0:881ff0b71102 289 /** Draw an image on the screen.
ttodorov 0:881ff0b71102 290 *
ttodorov 0:881ff0b71102 291 * The pixels of the picture must be in the RGB-565 format. The data can be provided
ttodorov 0:881ff0b71102 292 * as an array in a source or a header file. To convert an image file to the appropriate
ttodorov 0:881ff0b71102 293 * format, a special utility must be utilized. One such tool is provided by Henning Karlsen,
ttodorov 0:881ff0b71102 294 * the author of the UTFT display liberary and can be downloaded for free from his web site:
ttodorov 0:881ff0b71102 295 * http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 296 *
ttodorov 0:881ff0b71102 297 * \param x Horizontal offset of the first pixel of the image.
ttodorov 0:881ff0b71102 298 * \param y Vertical offset of the first pixel of the image
ttodorov 0:881ff0b71102 299 * \param sx Width of the image.
ttodorov 0:881ff0b71102 300 * \param sy Height of the image.
ttodorov 0:881ff0b71102 301 * \param data Image pixel array.
ttodorov 0:881ff0b71102 302 * \param deg Angle to rotate the image before painting on screen, in degrees.
ttodorov 0:881ff0b71102 303 * \param rox
ttodorov 0:881ff0b71102 304 * \param roy
ttodorov 0:881ff0b71102 305 */
ttodorov 0:881ff0b71102 306 virtual void DrawBitmap( unsigned short x, unsigned short y, unsigned short sx, unsigned short sy, bitmap_t data, unsigned short deg, unsigned short rox, unsigned short roy );
ttodorov 0:881ff0b71102 307
ttodorov 0:881ff0b71102 308 protected:
ttodorov 0:881ff0b71102 309 /** Creates an instance of the class.
ttodorov 0:881ff0b71102 310 *
ttodorov 0:881ff0b71102 311 * \param width Width of the display in pixels.
ttodorov 0:881ff0b71102 312 * \param height Height of the display in pixels.
ttodorov 0:881ff0b71102 313 * \param CS Pin connected to the CS input of the display.
ttodorov 0:881ff0b71102 314 * \param RS Pin connected to the RS input of the display.
ttodorov 0:881ff0b71102 315 */
ttodorov 0:881ff0b71102 316 LCD( unsigned short width, unsigned short height ,PinName CS, PinName RS );
ttodorov 0:881ff0b71102 317
ttodorov 0:881ff0b71102 318 /** Sends a command to the display.
ttodorov 0:881ff0b71102 319 *
ttodorov 0:881ff0b71102 320 * \param cmd The display command.
ttodorov 0:881ff0b71102 321 * \remarks Commands are controller-specific and this function needs to
ttodorov 0:881ff0b71102 322 * be implemented separately for each available controller.
ttodorov 0:881ff0b71102 323 */
ttodorov 2:81ed304b7e9b 324 virtual void WriteCmd( unsigned short cmd ) = 0;
ttodorov 0:881ff0b71102 325
ttodorov 0:881ff0b71102 326 /** Sends pixel data to the display.
ttodorov 0:881ff0b71102 327 *
ttodorov 0:881ff0b71102 328 * \param data The display data.
ttodorov 0:881ff0b71102 329 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 0:881ff0b71102 330 * be implemented separately for each available controller.
ttodorov 0:881ff0b71102 331 */
ttodorov 2:81ed304b7e9b 332 virtual void WriteData( unsigned short data ) = 0;
ttodorov 0:881ff0b71102 333
ttodorov 0:881ff0b71102 334 /** Sends both command and data to the display controller.
ttodorov 0:881ff0b71102 335 *
ttodorov 0:881ff0b71102 336 * This is a helper utility function which combines the 2 functions above
ttodorov 0:881ff0b71102 337 * into one single convenience step.
ttodorov 0:881ff0b71102 338 *
ttodorov 0:881ff0b71102 339 * \param cmd The display command.
ttodorov 0:881ff0b71102 340 * \param data The display pixel data.
ttodorov 0:881ff0b71102 341 */
ttodorov 2:81ed304b7e9b 342 virtual void WriteCmdData( unsigned short cmd, unsigned short data );
ttodorov 0:881ff0b71102 343
ttodorov 0:881ff0b71102 344 /** Assigns a chunk of the display memory to receive data.
ttodorov 0:881ff0b71102 345 *
ttodorov 0:881ff0b71102 346 * When data is sent to the display after this function completes, the opertion will
ttodorov 0:881ff0b71102 347 * start from the begining of the assigned address (pixel position) and the pointer
ttodorov 0:881ff0b71102 348 * will be automatically incremented so that the next data write operation will continue
ttodorov 0:881ff0b71102 349 * with the next pixel from the memory block. If more data is written than available
ttodorov 0:881ff0b71102 350 * pixels, at the end of the block the pointer will jump back to its beginning and
ttodorov 0:881ff0b71102 351 * commence again, until the next address change command is sent to the display.
ttodorov 0:881ff0b71102 352 *
ttodorov 0:881ff0b71102 353 * \param x1 The X coordinate of the pixel at the beginning of the block.
ttodorov 0:881ff0b71102 354 * \param y1 The Y coordinate of the pixel at the beginning of the block.
ttodorov 0:881ff0b71102 355 * \param x2 The X coordinate of the pixel at the end of the block.
ttodorov 0:881ff0b71102 356 * \param y2 The Y coordinate of the pixel at the end of the block.
ttodorov 0:881ff0b71102 357 * \remarks Addressing commands are controller-specific and this function needs to be
ttodorov 0:881ff0b71102 358 * implemented separately for each available controller.
ttodorov 0:881ff0b71102 359 */
ttodorov 2:81ed304b7e9b 360 virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 ) = 0;
ttodorov 0:881ff0b71102 361
ttodorov 0:881ff0b71102 362 /** Resets the memory address for the next display write operation to the screen origins (0,0).
ttodorov 0:881ff0b71102 363 */
ttodorov 2:81ed304b7e9b 364 virtual void ClearXY( void );
ttodorov 2:81ed304b7e9b 365
ttodorov 2:81ed304b7e9b 366 /** Draws a horizontal line.
ttodorov 2:81ed304b7e9b 367 *
ttodorov 2:81ed304b7e9b 368 * This is a utility function to draw horizontal-only lines
ttodorov 2:81ed304b7e9b 369 * for reduced code complexity and faster execution.
ttodorov 2:81ed304b7e9b 370 *
ttodorov 2:81ed304b7e9b 371 * \param x X coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 372 * \param y Y coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 373 * \param len Length of the line.
ttodorov 2:81ed304b7e9b 374 * \param color The color to use to draw the line. By default the global foreground color is used ( -2 ),
ttodorov 2:81ed304b7e9b 375 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 376 */
ttodorov 2:81ed304b7e9b 377 virtual void DrawHLine( unsigned short x, unsigned short y, unsigned short len, int color = -2 );
ttodorov 0:881ff0b71102 378
ttodorov 2:81ed304b7e9b 379 /** Draws a vertical line.
ttodorov 2:81ed304b7e9b 380 *
ttodorov 2:81ed304b7e9b 381 * This is a utility function to draw vertical-only lines
ttodorov 2:81ed304b7e9b 382 * for reduced code complexity and faster execution.
ttodorov 2:81ed304b7e9b 383 *
ttodorov 2:81ed304b7e9b 384 * \param x X coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 385 * \param y Y coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 386 * \param len Height of the line.
ttodorov 2:81ed304b7e9b 387 * \param color The color to use to draw the line. By default the global foreground color is used ( -2 ),
ttodorov 2:81ed304b7e9b 388 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 389 */
ttodorov 2:81ed304b7e9b 390 virtual void DrawVLine( unsigned short x, unsigned short y, unsigned short len, int color = -2 );
ttodorov 2:81ed304b7e9b 391
ttodorov 2:81ed304b7e9b 392 /** Prints a character at the given position and using the given color.
ttodorov 2:81ed304b7e9b 393 *
ttodorov 2:81ed304b7e9b 394 * \param c The character.
ttodorov 2:81ed304b7e9b 395 * \param x X coordinate of the character position.
ttodorov 2:81ed304b7e9b 396 * \param y Y coordinate of the character position.
ttodorov 2:81ed304b7e9b 397 * \param fgColor Foreground color for drawing. By default the global foreground color is used ( -2 ),
ttodorov 2:81ed304b7e9b 398 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 399 * \param bgColor Background color for drawing. By default the global background color is used ( -1 ),
ttodorov 2:81ed304b7e9b 400 * -2 switches to the default foreground color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 401 */
ttodorov 2:81ed304b7e9b 402 virtual void PrintChar( char c, unsigned short x, unsigned short y, int fgColor = -2, int bgColor = -1 );
ttodorov 2:81ed304b7e9b 403
ttodorov 2:81ed304b7e9b 404 /** Prints a character at the given position and using the given color and with the given rotation.
ttodorov 2:81ed304b7e9b 405 *
ttodorov 2:81ed304b7e9b 406 * \param c The character.
ttodorov 2:81ed304b7e9b 407 * \param x X coordinate of the character position.
ttodorov 2:81ed304b7e9b 408 * \param y Y coordinate of the character position.
ttodorov 2:81ed304b7e9b 409 * \param pos Position of the character in the string from which it originates (used to rotate a whole string).
ttodorov 2:81ed304b7e9b 410 * \param fgColor Foreground color for drawing. By default the global foreground color is used ( -2 ),
ttodorov 2:81ed304b7e9b 411 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 412 * \param bgColor Background color for drawing. By default the global background color is used ( -1 ),
ttodorov 2:81ed304b7e9b 413 * -2 switches to the default foreground color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 414 * \param deg The angle at which to rotate.
ttodorov 2:81ed304b7e9b 415 */
ttodorov 2:81ed304b7e9b 416 virtual void RotateChar( char c, unsigned short x, unsigned short y, int pos, int fgColor = -2, int bgColor = -1, unsigned short deg = 0 );
ttodorov 0:881ff0b71102 417
ttodorov 0:881ff0b71102 418 protected:
ttodorov 0:881ff0b71102 419 unsigned short _disp_width, _disp_height;
ttodorov 0:881ff0b71102 420 DigitalOut _lcd_pin_cs, _lcd_pin_rs;
ttodorov 0:881ff0b71102 421 orientation_t _orientation;
ttodorov 0:881ff0b71102 422 unsigned short _foreground, _background;
ttodorov 0:881ff0b71102 423 font_metrics_t _font;
ttodorov 0:881ff0b71102 424 };
ttodorov 0:881ff0b71102 425
ttodorov 3:64a5b67d5b51 426 #endif /* TFTLCD_BASE_H */