madhu sudhana / Mbed OS newTFTLCD_

1.44 tft lcd display

Dependencies:   TFT_fonts mbed-os

Fork of newTFTLCD by madhu sudhana

lcd_base.h@12:d0978272a340, 2012-12-11 (annotated)

Committer:
ttodorov
Date:
Tue Dec 11 18:11:14 2012 +0000
Revision:
12:d0978272a340
Parent:
11:aeceefc5f9f2
Child:
19:eb27effb8c07
- integrated RGB16 and RGB18 color depth configuration/selection; - integrated HW rotation for the HX8340-B driver; - changed the bitmap drawing API; - TODO: no drawing of rotated or scaled bitmaps yet

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 5:09b6d228ceea 11 *
ttodorov 0:881ff0b71102 12 * Copyright (C)2012 Todor Todorov.
ttodorov 0:881ff0b71102 13 *
ttodorov 0:881ff0b71102 14 * This library is free software; you can redistribute it and/or
ttodorov 0:881ff0b71102 15 * modify it under the terms of the GNU Lesser General Public
ttodorov 0:881ff0b71102 16 * License as published by the Free Software Foundation; either
ttodorov 0:881ff0b71102 17 * version 2.1 of the License, or (at your option) any later version.
ttodorov 0:881ff0b71102 18 *
ttodorov 0:881ff0b71102 19 * This library is distributed in the hope that it will be useful,
ttodorov 0:881ff0b71102 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 0:881ff0b71102 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 0:881ff0b71102 22 * Lesser General Public License for more details.
ttodorov 0:881ff0b71102 23 *
ttodorov 0:881ff0b71102 24 * You should have received a copy of the GNU Lesser General Public
ttodorov 0:881ff0b71102 25 * License along with this library; if not, write to:
ttodorov 0:881ff0b71102 26 *
ttodorov 0:881ff0b71102 27 * Free Software Foundation, Inc.
ttodorov 0:881ff0b71102 28 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 0:881ff0b71102 29 *
ttodorov 0:881ff0b71102 30 *********************************************************************/
ttodorov 3:64a5b67d5b51 31 #ifndef TFTLCD_BASE_H
ttodorov 3:64a5b67d5b51 32 #define TFTLCD_BASE_H
ttodorov 0:881ff0b71102 33
ttodorov 0:881ff0b71102 34 #include "mbed.h"
ttodorov 0:881ff0b71102 35 #include "fonts.h"
ttodorov 0:881ff0b71102 36
ttodorov 6:059ca1648211 37 #ifdef __cplusplus
ttodorov 6:059ca1648211 38 extern "C" {
ttodorov 6:059ca1648211 39 #endif
ttodorov 6:059ca1648211 40
ttodorov 0:881ff0b71102 41 /** \def RGB(r,g,b)
ttodorov 12:d0978272a340 42 * \brief Creates a RGB color from distinct bytes for the red, green and blue components.
ttodorov 0:881ff0b71102 43 *
ttodorov 0:881ff0b71102 44 * Displays which use 16 bits to assign colors to a specific pixel, use
ttodorov 0:881ff0b71102 45 * 5 bits for the red component, 6 bits for the green component and 5
ttodorov 12:d0978272a340 46 * bits for the blue component. Displays which have 18-bit color depth
ttodorov 12:d0978272a340 47 * use 6 bits for red, 6 bits for green and 6 bits for blue component.
ttodorov 12:d0978272a340 48 * This macro preserves the full 24-bit color depth, but it is the responsibility
ttodorov 12:d0978272a340 49 * of the respective driver to convert the color value to the correct format.
ttodorov 0:881ff0b71102 50 */
ttodorov 12:d0978272a340 51 #define RGB( r, g, b ) ( ( r ) << 16 ) | ( ( g ) << 8 ) | ( b )
ttodorov 0:881ff0b71102 52 /** \def COLOR_BLACK
ttodorov 0:881ff0b71102 53 * \brief Shorthand for RGB( 0, 0, 0 ).
ttodorov 0:881ff0b71102 54 */
ttodorov 0:881ff0b71102 55 #define COLOR_BLACK RGB( 0x00, 0x00, 0x00 )
ttodorov 0:881ff0b71102 56 /** \def COLOR_WHITE
ttodorov 0:881ff0b71102 57 * \brief Shorthand for RGB( 255, 255, 255 ).
ttodorov 0:881ff0b71102 58 */
ttodorov 0:881ff0b71102 59 #define COLOR_WHITE RGB( 0xFF, 0xFF, 0xFF )
ttodorov 0:881ff0b71102 60 /** \def COLOR_RED
ttodorov 0:881ff0b71102 61 * \brief Shorthand for RGB( 255, 0, 0 ).
ttodorov 0:881ff0b71102 62 */
ttodorov 0:881ff0b71102 63 #define COLOR_RED RGB( 0xFF, 0x00, 0x00 )
ttodorov 0:881ff0b71102 64 /** \def COLOR_GREEN
ttodorov 0:881ff0b71102 65 * \brief Shorthand for RGB( 0, 255, 0 ).
ttodorov 0:881ff0b71102 66 */
ttodorov 0:881ff0b71102 67 #define COLOR_GREEN RGB( 0x00, 0xFF, 0x00 )
ttodorov 0:881ff0b71102 68 /** \def COLOR_BLUE
ttodorov 0:881ff0b71102 69 * \brief Shorthand for RGB( 0, 0, 255 ).
ttodorov 0:881ff0b71102 70 */
ttodorov 0:881ff0b71102 71 #define COLOR_BLUE RGB( 0x00, 0x00, 0xFF )
ttodorov 0:881ff0b71102 72
ttodorov 10:69571adcfad5 73 /** \enum Orientation_enum
ttodorov 0:881ff0b71102 74 * \brief Display orientation.
ttodorov 0:881ff0b71102 75 */
ttodorov 10:69571adcfad5 76 enum Orientation_enum
ttodorov 0:881ff0b71102 77 {
ttodorov 12:d0978272a340 78 PORTRAIT = 0, /**< Display height is bigger than its width. View at 12 o'clock. */
ttodorov 12:d0978272a340 79 LANDSCAPE = 1, /**< Display width is bigger than its height. View at 9 o'clock. */
ttodorov 12:d0978272a340 80 PORTRAIT_REV = 2, /**< Display height is bigger than its width. View at 6 o'clock. */
ttodorov 12:d0978272a340 81 LANDSCAPE_REV = 3, /**< Display width is bigger than its height. View at 3 o'clock. */
ttodorov 10:69571adcfad5 82 };
ttodorov 10:69571adcfad5 83 /** \typedef orientation_t
ttodorov 10:69571adcfad5 84 * \brief Convenience shortcut for display orientation.
ttodorov 10:69571adcfad5 85 */
ttodorov 10:69571adcfad5 86 typedef enum Orientation_enum orientation_t;
ttodorov 0:881ff0b71102 87
ttodorov 10:69571adcfad5 88 /** \enum ColorDepth_enum
ttodorov 10:69571adcfad5 89 * \brief Color depth
ttodorov 10:69571adcfad5 90 */
ttodorov 10:69571adcfad5 91 enum ColorDepth_enum
ttodorov 10:69571adcfad5 92 {
ttodorov 10:69571adcfad5 93 RGB16, /**< 16-bit colors, pixels can have 65K distinct color values */
ttodorov 10:69571adcfad5 94 RGB18, /**< 18-bit colors, pixels can have 262K distinct color values */
ttodorov 10:69571adcfad5 95 };
ttodorov 10:69571adcfad5 96 /** \typedef colordepth_t
ttodorov 10:69571adcfad5 97 * \brief Convenience shortcut for display color depth.
ttodorov 10:69571adcfad5 98 */
ttodorov 10:69571adcfad5 99 typedef enum ColorDepth_enum colordepth_t;
ttodorov 10:69571adcfad5 100
ttodorov 10:69571adcfad5 101 /** \enum Alignment_enum
ttodorov 0:881ff0b71102 102 * \brief Horizontal text alignment on the line.
ttodorov 0:881ff0b71102 103 */
ttodorov 10:69571adcfad5 104 enum Alignment_enum
ttodorov 0:881ff0b71102 105 {
ttodorov 0:881ff0b71102 106 LEFT = 0, /**< Left-oriented, naturally gravitate closer to the left edge of the screen. */
ttodorov 0:881ff0b71102 107 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 108 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 10:69571adcfad5 109 };
ttodorov 10:69571adcfad5 110 /** \typedef align_t
ttodorov 10:69571adcfad5 111 * \brief Convenience shortcut for text alignment.
ttodorov 10:69571adcfad5 112 */
ttodorov 10:69571adcfad5 113 typedef enum Alignment_enum align_t;
ttodorov 0:881ff0b71102 114
ttodorov 10:69571adcfad5 115 /** \struct Font_struct
ttodorov 0:881ff0b71102 116 * \brief Describes fonts and their properties.
ttodorov 0:881ff0b71102 117 * \sa Comments in fonts.h
ttodorov 0:881ff0b71102 118 */
ttodorov 10:69571adcfad5 119 struct Font_struct
ttodorov 0:881ff0b71102 120 {
ttodorov 0:881ff0b71102 121 const char* font; /**< A pointer to the first byte in the font. */
ttodorov 0:881ff0b71102 122 unsigned char width; /**< The width of each character, in pixels. */
ttodorov 0:881ff0b71102 123 unsigned char height; /**< Height of each character, in pixels. */
ttodorov 0:881ff0b71102 124 unsigned char offset; /**< Offset of the first character in the font. */
ttodorov 0:881ff0b71102 125 unsigned char numchars; /**< Count of the available characters in the font. */
ttodorov 10:69571adcfad5 126 };
ttodorov 10:69571adcfad5 127 /** \typedef font_metrics_t
ttodorov 10:69571adcfad5 128 * \brief Convenience shortcut for fonts properties.
ttodorov 10:69571adcfad5 129 */
ttodorov 10:69571adcfad5 130 typedef struct Font_struct font_metrics_t;
ttodorov 0:881ff0b71102 131
ttodorov 12:d0978272a340 132 /** \struct Bitmap_struct
ttodorov 12:d0978272a340 133 * \brief Describes an image.
ttodorov 12:d0978272a340 134 */
ttodorov 12:d0978272a340 135 struct Bitmap_struct
ttodorov 12:d0978272a340 136 {
ttodorov 12:d0978272a340 137 colordepth_t Format; /**< Color depth of the image. */
ttodorov 12:d0978272a340 138 unsigned short Width; /**< Width of the image in pixels. */
ttodorov 12:d0978272a340 139 unsigned short Height; /**< Height of the image in pixels. */
ttodorov 12:d0978272a340 140 const void* PixelData; /**< Image pixel data. */
ttodorov 12:d0978272a340 141 };
ttodorov 12:d0978272a340 142 /** \typedef bitmap_t
ttodorov 12:d0978272a340 143 * \brief Convenience shortcut bitmap type.
ttodorov 12:d0978272a340 144 */
ttodorov 12:d0978272a340 145 typedef struct Bitmap_struct bitmap_t;
ttodorov 12:d0978272a340 146
ttodorov 11:aeceefc5f9f2 147
ttodorov 0:881ff0b71102 148 /** Base class for LCD implementations.
ttodorov 0:881ff0b71102 149 *
ttodorov 0:881ff0b71102 150 * All separate LCD controller implementations have to subclass this one.
ttodorov 0:881ff0b71102 151 *
ttodorov 0:881ff0b71102 152 * \version 0.1
ttodorov 0:881ff0b71102 153 * \author Todor Todorov
ttodorov 0:881ff0b71102 154 */
ttodorov 0:881ff0b71102 155 class LCD
ttodorov 0:881ff0b71102 156 {
ttodorov 0:881ff0b71102 157 public:
ttodorov 0:881ff0b71102 158
ttodorov 0:881ff0b71102 159 /** Initialize display.
ttodorov 0:881ff0b71102 160 *
ttodorov 0:881ff0b71102 161 * Wakes up the display from sleep, initializes power parameters.
ttodorov 0:881ff0b71102 162 * This function must be called first, befor any painting on the
ttodorov 0:881ff0b71102 163 * display is done, otherwise the positioning of graphical elements
ttodorov 0:881ff0b71102 164 * will not work properly and any paynt operation will not be visible
ttodorov 0:881ff0b71102 165 * or produce garbage.
ttodorov 0:881ff0b71102 166 *
ttodorov 0:881ff0b71102 167 * This function is controller-specific and needs to be implemented
ttodorov 4:3ac4239f6c9c 168 * separately for each available display.
ttodorov 0:881ff0b71102 169 * \param oritentation The display orientation, landscape is default.
ttodorov 12:d0978272a340 170 * \param colors The correct color depth to use for the pixel data.
ttodorov 0:881ff0b71102 171 */
ttodorov 12:d0978272a340 172 virtual void Initialize( orientation_t orientation, colordepth_t colors ) = 0;
ttodorov 0:881ff0b71102 173
ttodorov 4:3ac4239f6c9c 174 /** Puts the display to sleep.
ttodorov 4:3ac4239f6c9c 175 *
ttodorov 4:3ac4239f6c9c 176 * When the display is in sleep mode, its power consumption is
ttodorov 4:3ac4239f6c9c 177 * minimized. Before new pixel data can be written to the display
ttodorov 4:3ac4239f6c9c 178 * memory, the controller needs to be brought out of sleep mode.
ttodorov 4:3ac4239f6c9c 179 * \sa #WakeUp( void );
ttodorov 4:3ac4239f6c9c 180 * \remarks The result of this operation might not be exactly as
ttodorov 4:3ac4239f6c9c 181 * expected. Putting the display to sleep will cause the
ttodorov 4:3ac4239f6c9c 182 * controller to switch to the standard color of the LCD,
ttodorov 4:3ac4239f6c9c 183 * so depending on whether the display is normally white,
ttodorov 4:3ac4239f6c9c 184 * or normally dark, the screen might or might not go
ttodorov 4:3ac4239f6c9c 185 * dark. Additional power saving can be achieved, if
ttodorov 4:3ac4239f6c9c 186 * the backlight of the used display is not hardwired on
ttodorov 4:3ac4239f6c9c 187 * the PCB and can be controlled via the BL pin.
ttodorov 4:3ac4239f6c9c 188 * \remarks This function is controller-specific and needs to be
ttodorov 4:3ac4239f6c9c 189 * implemented separately for each available display.
ttodorov 4:3ac4239f6c9c 190 */
ttodorov 4:3ac4239f6c9c 191 virtual void Sleep( void ) = 0;
ttodorov 4:3ac4239f6c9c 192
ttodorov 4:3ac4239f6c9c 193 /** Wakes up the display from sleep mode.
ttodorov 4:3ac4239f6c9c 194 *
ttodorov 4:3ac4239f6c9c 195 * This function needs to be called before any other, when the
ttodorov 4:3ac4239f6c9c 196 * display has been put into sleep mode by a previois call to
ttodorov 4:3ac4239f6c9c 197 * #Sleep( void ).
ttodorov 4:3ac4239f6c9c 198 * \remarks This function is controller-specific and needs to be
ttodorov 4:3ac4239f6c9c 199 * implemented separately for each available display.
ttodorov 4:3ac4239f6c9c 200 */
ttodorov 4:3ac4239f6c9c 201 virtual void WakeUp( void ) = 0;
ttodorov 4:3ac4239f6c9c 202
ttodorov 0:881ff0b71102 203 /** Set the foreground color for painting.
ttodorov 0:881ff0b71102 204 *
ttodorov 0:881ff0b71102 205 * This is the default foreground color to be used in painting operations.
ttodorov 0:881ff0b71102 206 * If a specific output function allows for a different color to be specified
ttodorov 0:881ff0b71102 207 * in place, the new setting will be used for that single operation only and
ttodorov 0:881ff0b71102 208 * will not change this value.
ttodorov 0:881ff0b71102 209 *
ttodorov 12:d0978272a340 210 * \param color The color to be used (24-bit color depth).
ttodorov 0:881ff0b71102 211 * \sa #RGB(r,g,b)
ttodorov 0:881ff0b71102 212 */
ttodorov 12:d0978272a340 213 virtual void SetForeground( unsigned int color = COLOR_WHITE );
ttodorov 0:881ff0b71102 214
ttodorov 0:881ff0b71102 215 /** Set the background color for painting.
ttodorov 0:881ff0b71102 216 *
ttodorov 0:881ff0b71102 217 * This is the default color to be used for "empty" pixels while painting.
ttodorov 0:881ff0b71102 218 * If a particular function allows for a different value to be specified
ttodorov 0:881ff0b71102 219 * when the function is called, the new value will be used only for this
ttodorov 0:881ff0b71102 220 * single call and will not change this setting.
ttodorov 0:881ff0b71102 221 *
ttodorov 12:d0978272a340 222 * \param color The background color (24-bit color depth).
ttodorov 0:881ff0b71102 223 * \sa #RGB(r,g,b)
ttodorov 0:881ff0b71102 224 */
ttodorov 12:d0978272a340 225 virtual void SetBackground( unsigned int color = COLOR_BLACK );
ttodorov 0:881ff0b71102 226
ttodorov 0:881ff0b71102 227 /** Sets the font to be used for painting of text on the screen.
ttodorov 0:881ff0b71102 228 * \param font A pointer to the font data.
ttodorov 0:881ff0b71102 229 * \sa Comments in file fonts.h
ttodorov 0:881ff0b71102 230 */
ttodorov 0:881ff0b71102 231 virtual void SetFont( const char* font );
ttodorov 0:881ff0b71102 232
ttodorov 0:881ff0b71102 233 /** Gets the display width.
ttodorov 0:881ff0b71102 234 * \return Display width in pixels.
ttodorov 0:881ff0b71102 235 */
ttodorov 0:881ff0b71102 236 unsigned short GetWidth( void );
ttodorov 0:881ff0b71102 237
ttodorov 0:881ff0b71102 238 /** Gets the display height.
ttodorov 0:881ff0b71102 239 * \return Display height in pixels.
ttodorov 0:881ff0b71102 240 */
ttodorov 0:881ff0b71102 241 unsigned short GetHeight( void );
ttodorov 0:881ff0b71102 242
ttodorov 0:881ff0b71102 243 /** Fills the whole screen with a single color.
ttodorov 9:58b328831d0a 244 * \param color The color to be used. The value must be in RGB-565 format.
ttodorov 9:58b328831d0a 245 * \remarks The special values -1 and -2 signify the preset background and foreground colors, respectively.
ttodorov 9:58b328831d0a 246 * The backround color is the default.
ttodorov 0:881ff0b71102 247 */
ttodorov 0:881ff0b71102 248 virtual void FillScreen( int color = -1 );
ttodorov 0:881ff0b71102 249
ttodorov 0:881ff0b71102 250 /** Clears the screen.
ttodorov 0:881ff0b71102 251 *
ttodorov 0:881ff0b71102 252 * This is the same as calling #FillScreen() or #FillScreen( -1 ) to use the background color.
ttodorov 0:881ff0b71102 253 */
ttodorov 0:881ff0b71102 254 virtual void ClearScreen( void );
ttodorov 0:881ff0b71102 255
ttodorov 0:881ff0b71102 256 /** Draws a pixel at the specified location.
ttodorov 0:881ff0b71102 257 *
ttodorov 0:881ff0b71102 258 * By default the function will use the preset foreground color, but the background
ttodorov 0:881ff0b71102 259 * or a custom color could be used as well.
ttodorov 0:881ff0b71102 260 *
ttodorov 0:881ff0b71102 261 * \param x The horizontal offset of the pixel from the upper left corner of the screen.
ttodorov 0:881ff0b71102 262 * \param y The vertical offset of the pixel from the upper left corner of the screen.
ttodorov 12:d0978272a340 263 * \param color The color to be used. Use a custom color, or -1 for background and -2 for foreground color.
ttodorov 0:881ff0b71102 264 */
ttodorov 0:881ff0b71102 265 virtual void DrawPixel( unsigned short x, unsigned short y, int color = -2 );
ttodorov 0:881ff0b71102 266
ttodorov 0:881ff0b71102 267 /** Draws a line.
ttodorov 0:881ff0b71102 268 *
ttodorov 0:881ff0b71102 269 * \param x1 Horizontal offset of the beginning point of the line.
ttodorov 0:881ff0b71102 270 * \param y1 Vertical offset of the beginning point of the line.
ttodorov 0:881ff0b71102 271 * \param x2 Horizontal offset of the end point of the line.
ttodorov 0:881ff0b71102 272 * \param y2 Verical offset of the end point of the line.
ttodorov 12:d0978272a340 273 * \param color The color to use for painting, or -1 for background, or -2 for foreground.
ttodorov 0:881ff0b71102 274 */
ttodorov 0:881ff0b71102 275 virtual void DrawLine( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 276
ttodorov 0:881ff0b71102 277 /** Paints a rectangle.
ttodorov 0:881ff0b71102 278 *
ttodorov 0:881ff0b71102 279 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 280 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 281 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 282 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 12:d0978272a340 283 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color.
ttodorov 0:881ff0b71102 284 */
ttodorov 0:881ff0b71102 285 virtual void DrawRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 286
ttodorov 0:881ff0b71102 287 /** Paints a rectangle and fills it with the paint color.
ttodorov 0:881ff0b71102 288 *
ttodorov 0:881ff0b71102 289 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 290 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 291 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 292 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 12:d0978272a340 293 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color.
ttodorov 0:881ff0b71102 294 */
ttodorov 0:881ff0b71102 295 virtual void DrawRoundRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 296
ttodorov 0:881ff0b71102 297 /** Paints a rectangle with rounded corners.
ttodorov 0:881ff0b71102 298 *
ttodorov 0:881ff0b71102 299 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 300 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 301 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 302 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 12:d0978272a340 303 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color.
ttodorov 0:881ff0b71102 304 */
ttodorov 0:881ff0b71102 305 virtual void FillRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 306
ttodorov 0:881ff0b71102 307 /** Paints a rectangle with rounded corners and fills it with the paint color.
ttodorov 0:881ff0b71102 308 *
ttodorov 0:881ff0b71102 309 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 310 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 311 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 312 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 12:d0978272a340 313 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color.
ttodorov 0:881ff0b71102 314 */
ttodorov 0:881ff0b71102 315 virtual void FillRoundRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 316
ttodorov 0:881ff0b71102 317 /** Paints a circle.
ttodorov 0:881ff0b71102 318 *
ttodorov 0:881ff0b71102 319 * \param x The offset of the circle's center from the left edge of the screen.
ttodorov 0:881ff0b71102 320 * \param y The offset of the circle's center from the top edge of the screen.
ttodorov 0:881ff0b71102 321 * \param radius The circle's radius.
ttodorov 12:d0978272a340 322 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color.
ttodorov 0:881ff0b71102 323 */
ttodorov 0:881ff0b71102 324 virtual void DrawCircle( unsigned short x, unsigned short y, unsigned short radius, int color = -2 );
ttodorov 0:881ff0b71102 325
ttodorov 0:881ff0b71102 326 /** Paints a circle and fills it with the paint color.
ttodorov 0:881ff0b71102 327 *
ttodorov 0:881ff0b71102 328 * \param x The offset of the circle's center from the left edge of the screen.
ttodorov 0:881ff0b71102 329 * \param y The offset of the circle's center from the top edge of the screen.
ttodorov 0:881ff0b71102 330 * \param radius The circle's radius.
ttodorov 12:d0978272a340 331 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color.
ttodorov 0:881ff0b71102 332 */
ttodorov 0:881ff0b71102 333 virtual void FillCircle( unsigned short x, unsigned short y, unsigned short radius, int color = -2 );
ttodorov 0:881ff0b71102 334
ttodorov 0:881ff0b71102 335 /** Print a text on the screen.
ttodorov 0:881ff0b71102 336 *
ttodorov 0:881ff0b71102 337 * \param str The text.
ttodorov 0:881ff0b71102 338 * \param x The horizontal offset form the left edge of the screen. The special values LEFT, CENTER,
ttodorov 0:881ff0b71102 339 * or RIGHT can be used instead of pixel offset to indicate the text's horizontal alignment.
ttodorov 0:881ff0b71102 340 * \param y The vertical offset of the text from the top of the screen.
ttodorov 0:881ff0b71102 341 * \param fgColor The foreground to use for painting the text; -1 indicates background color, -2 the foreground setting, or custom color.
ttodorov 0:881ff0b71102 342 * \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 343 * \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 344 */
ttodorov 0:881ff0b71102 345 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 346
ttodorov 0:881ff0b71102 347 /** Draw an image on the screen.
ttodorov 0:881ff0b71102 348 *
ttodorov 0:881ff0b71102 349 * The pixels of the picture must be in the RGB-565 format. The data can be provided
ttodorov 0:881ff0b71102 350 * as an array in a source or a header file. To convert an image file to the appropriate
ttodorov 0:881ff0b71102 351 * format, a special utility must be utilized. One such tool is provided by Henning Karlsen,
ttodorov 0:881ff0b71102 352 * the author of the UTFT display liberary and can be downloaded for free from his web site:
ttodorov 0:881ff0b71102 353 * http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 354 *
ttodorov 0:881ff0b71102 355 * \param x Horizontal offset of the first pixel of the image.
ttodorov 12:d0978272a340 356 * \param y Vertical offset of the first pixel of the image.
ttodorov 12:d0978272a340 357 * \param img Image data pointer.
ttodorov 0:881ff0b71102 358 * \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 359 */
ttodorov 12:d0978272a340 360 virtual void DrawBitmap( unsigned short x, unsigned short y, const bitmap_t* img, unsigned char scale = 1 );
ttodorov 0:881ff0b71102 361
ttodorov 0:881ff0b71102 362 /** Draw an image on the screen.
ttodorov 0:881ff0b71102 363 *
ttodorov 0:881ff0b71102 364 * The pixels of the picture must be in the RGB-565 format. The data can be provided
ttodorov 0:881ff0b71102 365 * as an array in a source or a header file. To convert an image file to the appropriate
ttodorov 0:881ff0b71102 366 * format, a special utility must be utilized. One such tool is provided by Henning Karlsen,
ttodorov 0:881ff0b71102 367 * the author of the UTFT display liberary and can be downloaded for free from his web site:
ttodorov 0:881ff0b71102 368 * http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 369 *
ttodorov 0:881ff0b71102 370 * \param x Horizontal offset of the first pixel of the image.
ttodorov 12:d0978272a340 371 * \param y Vertical offset of the first pixel of the image.
ttodorov 12:d0978272a340 372 * \param img Image data pointer.
ttodorov 0:881ff0b71102 373 * \param deg Angle to rotate the image before painting on screen, in degrees.
ttodorov 0:881ff0b71102 374 * \param rox
ttodorov 0:881ff0b71102 375 * \param roy
ttodorov 0:881ff0b71102 376 */
ttodorov 12:d0978272a340 377 virtual void DrawBitmap( unsigned short x, unsigned short y, const bitmap_t* img, unsigned short deg, unsigned short rox, unsigned short roy );
ttodorov 0:881ff0b71102 378
ttodorov 0:881ff0b71102 379 protected:
ttodorov 0:881ff0b71102 380 /** Creates an instance of the class.
ttodorov 0:881ff0b71102 381 *
ttodorov 0:881ff0b71102 382 * \param width Width of the display in pixels.
ttodorov 0:881ff0b71102 383 * \param height Height of the display in pixels.
ttodorov 0:881ff0b71102 384 * \param CS Pin connected to the CS input of the display.
ttodorov 0:881ff0b71102 385 * \param RS Pin connected to the RS input of the display.
ttodorov 4:3ac4239f6c9c 386 * \param RESET Pin connected to the RESET input of the display.
ttodorov 0:881ff0b71102 387 */
ttodorov 4:3ac4239f6c9c 388 LCD( unsigned short width, unsigned short height ,PinName CS, PinName RS, PinName RESET );
ttodorov 4:3ac4239f6c9c 389
ttodorov 4:3ac4239f6c9c 390 /** Activates the display for command/data transfer.
ttodorov 4:3ac4239f6c9c 391 *
ttodorov 4:3ac4239f6c9c 392 * Usually achieved by pulling the CS pin of the display low.
ttodorov 4:3ac4239f6c9c 393 */
ttodorov 4:3ac4239f6c9c 394 virtual void Activate( void );
ttodorov 4:3ac4239f6c9c 395
ttodorov 4:3ac4239f6c9c 396 /** Deactivates the display after data has been transmitted.
ttodorov 4:3ac4239f6c9c 397 *
ttodorov 4:3ac4239f6c9c 398 * Usually achieved by pulling the CS pin of the display high.
ttodorov 4:3ac4239f6c9c 399 */
ttodorov 4:3ac4239f6c9c 400 virtual void Deactivate( void );
ttodorov 0:881ff0b71102 401
ttodorov 0:881ff0b71102 402 /** Sends a command to the display.
ttodorov 0:881ff0b71102 403 *
ttodorov 0:881ff0b71102 404 * \param cmd The display command.
ttodorov 0:881ff0b71102 405 * \remarks Commands are controller-specific and this function needs to
ttodorov 0:881ff0b71102 406 * be implemented separately for each available controller.
ttodorov 0:881ff0b71102 407 */
ttodorov 2:81ed304b7e9b 408 virtual void WriteCmd( unsigned short cmd ) = 0;
ttodorov 0:881ff0b71102 409
ttodorov 0:881ff0b71102 410 /** Sends pixel data to the display.
ttodorov 0:881ff0b71102 411 *
ttodorov 0:881ff0b71102 412 * \param data The display data.
ttodorov 0:881ff0b71102 413 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 0:881ff0b71102 414 * be implemented separately for each available controller.
ttodorov 0:881ff0b71102 415 */
ttodorov 2:81ed304b7e9b 416 virtual void WriteData( unsigned short data ) = 0;
ttodorov 0:881ff0b71102 417
ttodorov 0:881ff0b71102 418 /** Sends both command and data to the display controller.
ttodorov 0:881ff0b71102 419 *
ttodorov 0:881ff0b71102 420 * This is a helper utility function which combines the 2 functions above
ttodorov 0:881ff0b71102 421 * into one single convenience step.
ttodorov 0:881ff0b71102 422 *
ttodorov 0:881ff0b71102 423 * \param cmd The display command.
ttodorov 0:881ff0b71102 424 * \param data The display pixel data.
ttodorov 0:881ff0b71102 425 */
ttodorov 2:81ed304b7e9b 426 virtual void WriteCmdData( unsigned short cmd, unsigned short data );
ttodorov 0:881ff0b71102 427
ttodorov 0:881ff0b71102 428 /** Assigns a chunk of the display memory to receive data.
ttodorov 0:881ff0b71102 429 *
ttodorov 0:881ff0b71102 430 * When data is sent to the display after this function completes, the opertion will
ttodorov 0:881ff0b71102 431 * start from the begining of the assigned address (pixel position) and the pointer
ttodorov 0:881ff0b71102 432 * will be automatically incremented so that the next data write operation will continue
ttodorov 0:881ff0b71102 433 * with the next pixel from the memory block. If more data is written than available
ttodorov 0:881ff0b71102 434 * pixels, at the end of the block the pointer will jump back to its beginning and
ttodorov 0:881ff0b71102 435 * commence again, until the next address change command is sent to the display.
ttodorov 0:881ff0b71102 436 *
ttodorov 0:881ff0b71102 437 * \param x1 The X coordinate of the pixel at the beginning of the block.
ttodorov 0:881ff0b71102 438 * \param y1 The Y coordinate of the pixel at the beginning of the block.
ttodorov 0:881ff0b71102 439 * \param x2 The X coordinate of the pixel at the end of the block.
ttodorov 0:881ff0b71102 440 * \param y2 The Y coordinate of the pixel at the end of the block.
ttodorov 0:881ff0b71102 441 * \remarks Addressing commands are controller-specific and this function needs to be
ttodorov 0:881ff0b71102 442 * implemented separately for each available controller.
ttodorov 0:881ff0b71102 443 */
ttodorov 2:81ed304b7e9b 444 virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 ) = 0;
ttodorov 0:881ff0b71102 445
ttodorov 0:881ff0b71102 446 /** Resets the memory address for the next display write operation to the screen origins (0,0).
ttodorov 0:881ff0b71102 447 */
ttodorov 2:81ed304b7e9b 448 virtual void ClearXY( void );
ttodorov 2:81ed304b7e9b 449
ttodorov 10:69571adcfad5 450 /** Sets the color of the pixel at the address pointer of the controller.
ttodorov 10:69571adcfad5 451 *
ttodorov 10:69571adcfad5 452 * This function is to be provided by each implementation separately in
ttodorov 12:d0978272a340 453 * order to account for different color depths used by the controller.
ttodorov 10:69571adcfad5 454 * \param color The color of the pixel.
ttodorov 10:69571adcfad5 455 */
ttodorov 12:d0978272a340 456 virtual void SetPixelColor( unsigned int color ) = 0;
ttodorov 10:69571adcfad5 457
ttodorov 2:81ed304b7e9b 458 /** Draws a horizontal line.
ttodorov 2:81ed304b7e9b 459 *
ttodorov 2:81ed304b7e9b 460 * This is a utility function to draw horizontal-only lines
ttodorov 2:81ed304b7e9b 461 * for reduced code complexity and faster execution.
ttodorov 2:81ed304b7e9b 462 *
ttodorov 2:81ed304b7e9b 463 * \param x X coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 464 * \param y Y coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 465 * \param len Length of the line.
ttodorov 2:81ed304b7e9b 466 * \param color The color to use to draw the line. By default the global foreground color is used ( -2 ),
ttodorov 12:d0978272a340 467 * -1 switches to the default background color, or any custom color can be used.
ttodorov 2:81ed304b7e9b 468 */
ttodorov 2:81ed304b7e9b 469 virtual void DrawHLine( unsigned short x, unsigned short y, unsigned short len, int color = -2 );
ttodorov 0:881ff0b71102 470
ttodorov 2:81ed304b7e9b 471 /** Draws a vertical line.
ttodorov 2:81ed304b7e9b 472 *
ttodorov 2:81ed304b7e9b 473 * This is a utility function to draw vertical-only lines
ttodorov 2:81ed304b7e9b 474 * for reduced code complexity and faster execution.
ttodorov 2:81ed304b7e9b 475 *
ttodorov 2:81ed304b7e9b 476 * \param x X coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 477 * \param y Y coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 478 * \param len Height of the line.
ttodorov 2:81ed304b7e9b 479 * \param color The color to use to draw the line. By default the global foreground color is used ( -2 ),
ttodorov 12:d0978272a340 480 * -1 switches to the default background color, or any custom color can be used.
ttodorov 2:81ed304b7e9b 481 */
ttodorov 2:81ed304b7e9b 482 virtual void DrawVLine( unsigned short x, unsigned short y, unsigned short len, int color = -2 );
ttodorov 2:81ed304b7e9b 483
ttodorov 2:81ed304b7e9b 484 /** Prints a character at the given position and using the given color.
ttodorov 2:81ed304b7e9b 485 *
ttodorov 2:81ed304b7e9b 486 * \param c The character.
ttodorov 2:81ed304b7e9b 487 * \param x X coordinate of the character position.
ttodorov 2:81ed304b7e9b 488 * \param y Y coordinate of the character position.
ttodorov 2:81ed304b7e9b 489 * \param fgColor Foreground color for drawing. By default the global foreground color is used ( -2 ),
ttodorov 12:d0978272a340 490 * -1 switches to the default background color, or any custom color can be used.
ttodorov 2:81ed304b7e9b 491 * \param bgColor Background color for drawing. By default the global background color is used ( -1 ),
ttodorov 12:d0978272a340 492 * -2 switches to the default foreground color, or any custom color can be used.
ttodorov 2:81ed304b7e9b 493 */
ttodorov 2:81ed304b7e9b 494 virtual void PrintChar( char c, unsigned short x, unsigned short y, int fgColor = -2, int bgColor = -1 );
ttodorov 2:81ed304b7e9b 495
ttodorov 2:81ed304b7e9b 496 /** Prints a character at the given position and using the given color and with the given rotation.
ttodorov 2:81ed304b7e9b 497 *
ttodorov 2:81ed304b7e9b 498 * \param c The character.
ttodorov 2:81ed304b7e9b 499 * \param x X coordinate of the character position.
ttodorov 2:81ed304b7e9b 500 * \param y Y coordinate of the character position.
ttodorov 2:81ed304b7e9b 501 * \param pos Position of the character in the string from which it originates (used to rotate a whole string).
ttodorov 2:81ed304b7e9b 502 * \param fgColor Foreground color for drawing. By default the global foreground color is used ( -2 ),
ttodorov 12:d0978272a340 503 * -1 switches to the default background color, or any custom color can be used.
ttodorov 2:81ed304b7e9b 504 * \param bgColor Background color for drawing. By default the global background color is used ( -1 ),
ttodorov 12:d0978272a340 505 * -2 switches to the default foreground color, or any custom color can be used.
ttodorov 2:81ed304b7e9b 506 * \param deg The angle at which to rotate.
ttodorov 2:81ed304b7e9b 507 */
ttodorov 2:81ed304b7e9b 508 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 509
ttodorov 0:881ff0b71102 510 protected:
ttodorov 4:3ac4239f6c9c 511 unsigned short _disp_width, _disp_height;
ttodorov 4:3ac4239f6c9c 512 DigitalOut _lcd_pin_cs, _lcd_pin_rs, _lcd_pin_reset;
ttodorov 4:3ac4239f6c9c 513 orientation_t _orientation;
ttodorov 12:d0978272a340 514 colordepth_t _colorDepth;
ttodorov 12:d0978272a340 515 unsigned int _foreground, _background;
ttodorov 4:3ac4239f6c9c 516 font_metrics_t _font;
ttodorov 0:881ff0b71102 517 };
ttodorov 0:881ff0b71102 518
ttodorov 6:059ca1648211 519 #ifdef __cplusplus
ttodorov 6:059ca1648211 520 }
ttodorov 6:059ca1648211 521 #endif
ttodorov 6:059ca1648211 522
ttodorov 3:64a5b67d5b51 523 #endif /* TFTLCD_BASE_H */