mcufriend 2.4 TFT LCD Shield Lib

Dependents:   Nucleo_LCD_mcufriend_test

Fork of 24_TFT_STMNUCLEO by Carlos Silva

mcufriend 2.4" TFT LCD Shield

front back

Import program

00001 #include "mbed.h"
00002 #include "ili9328.h"
00003 
00004 // prepare the data bus for writing commands and pixel data
00005 BusOut dataBus( D8, D9, D2, D3, D4, D5, D6, D7 ); // 8 pins
00006 // create the lcd instance
00007 ILI9328_LCD lcd( A3,  A4, A2,A1, &dataBus, NC, A0); // control pins and data bus
00008 //ILI9328_LCD(  CS,  RESET,  RS, WR, BusOut* DATA_PORT, PinName BL = NC,  RD );
00009    
00010 int main()
00011 {
00012     int ii,height,width;
00013     
00014     height = lcd.GetHeight();
00015     width =  lcd.GetWidth();
00016     // initialize display - place it in standard portrait mode and set background to black and
00017     //                      foreground to white color.
00018     lcd.Initialize();
00019 
00020     // print something on the screen
00021     lcd.Print( "Hello, World!", CENTER, 50); // align text to center horizontally and use starndard colors
00022  
00023     wait(2);
00024    
00025     lcd.ClearScreen();
00026  
00027     for(ii=0;ii<width;ii++)
00028     {
00029         lcd.DrawLine(0, 0, height, ii,COLOR_GREEN);
00030         ii = ii+10;    
00031     }
00032     wait(2);
00033  
00034     lcd.DrawCircle(height/4, width/4, 20, COLOR_GREEN);
00035     wait(2);
00036  
00037     lcd.FillCircle(height/2, width/2, 50, COLOR_GREEN);
00038     wait(2);
00039  
00040     lcd.FillTriangle(height/4, width/4,(height/4)+20, (width/4)+40,(height/4)-20, (width/4)+40, COLOR_RED);
00041  
00042     while ( 1 ) { }
00043 }

HW information about the mcufriend LCD Shield

Committer:
ttodorov
Date:
Sat Jan 26 02:55:46 2013 +0000
Revision:
21:e5c1e8ffada1
Parent:
20:4bdca8d8dadc
Child:
22:4c169297f374
- replaced old fonts with the better Terminus font in 8x12 and 16x28 sizes

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