David Smart / RA8875 Featured

Library to control a Graphics TFT connected to 4-wire SPI - revised for the Raio RA8875 Display Controller.

Dependents:   FRDM_RA8875_mPaint RA8875_Demo RA8875_KeyPadDemo SignalGenerator ... more

Fork of SPI_TFT by Peter Drescher

See Components - RA8875 Based Display

Enhanced touch-screen support - where it previous supported both the Resistive Touch and Capacitive Touch based on the FT5206 Touch Controller, now it also has support for the GSL1680 Touch Controller.

Offline Help Manual (Windows chm)

/media/uploads/WiredHome/ra8875.zip.bin (download, rename to .zip and unzip)

GraphicsDisplay.h@136:224e03d5c31f, 2016-11-16 (annotated)

Committer:
WiredHome
Date:
Wed Nov 16 02:48:45 2016 +0000
Revision:
136:224e03d5c31f
Parent:
126:c91bd2e500b9
Child:
142:6e9bff59878a
JPG Rendering can now write to display in 8-bit color format, not just 16-bit color format.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dreschpe 0:de9d1462a835 1 /* mbed GraphicsDisplay Display Library Base Class
dreschpe 0:de9d1462a835 2 * Copyright (c) 2007-2009 sford
dreschpe 0:de9d1462a835 3 * Released under the MIT License: http://mbed.org/license/mit
dreschpe 0:de9d1462a835 4 *
dreschpe 0:de9d1462a835 5 * A library for providing a common base class for Graphics displays
dreschpe 0:de9d1462a835 6 * To port a new display, derive from this class and implement
dreschpe 0:de9d1462a835 7 * the constructor (setup the display), pixel (put a pixel
dreschpe 0:de9d1462a835 8 * at a location), width and height functions. Everything else
dreschpe 0:de9d1462a835 9 * (locate, printf, putc, cls, window, putp, fill, blit, blitbit)
dreschpe 0:de9d1462a835 10 * will come for free. You can also provide a specialised implementation
dreschpe 0:de9d1462a835 11 * of window and putp to speed up the results
dreschpe 0:de9d1462a835 12 */
dreschpe 0:de9d1462a835 13
dreschpe 0:de9d1462a835 14 #ifndef MBED_GRAPHICSDISPLAY_H
dreschpe 0:de9d1462a835 15 #define MBED_GRAPHICSDISPLAY_H
WiredHome 32:0e4f2ae512e2 16 #include "Bitmap.h"
dreschpe 0:de9d1462a835 17 #include "TextDisplay.h"
WiredHome 115:c9862fd0c689 18 #include "GraphicsDisplayJPEG.h"
dreschpe 0:de9d1462a835 19
WiredHome 32:0e4f2ae512e2 20 /// The GraphicsDisplay class
WiredHome 32:0e4f2ae512e2 21 ///
WiredHome 32:0e4f2ae512e2 22 /// This graphics display class supports both graphics and text operations.
WiredHome 32:0e4f2ae512e2 23 /// Typically, a subclass is derived from this which has localizations to
WiredHome 32:0e4f2ae512e2 24 /// adapt to a specific hardware platform (e.g. a display controller chip),
WiredHome 32:0e4f2ae512e2 25 /// that overrides methods in here to either add more capability or perhaps
WiredHome 32:0e4f2ae512e2 26 /// to improve performance, by leveraging specific hardware capabilities.
WiredHome 32:0e4f2ae512e2 27 ///
WiredHome 32:0e4f2ae512e2 28 class GraphicsDisplay : public TextDisplay
WiredHome 32:0e4f2ae512e2 29 {
WiredHome 32:0e4f2ae512e2 30 public:
WiredHome 32:0e4f2ae512e2 31 /// The constructor
dreschpe 0:de9d1462a835 32 GraphicsDisplay(const char* name);
WiredHome 32:0e4f2ae512e2 33
WiredHome 104:8d1d3832a215 34 //~GraphicsDisplay();
WiredHome 104:8d1d3832a215 35
WiredHome 32:0e4f2ae512e2 36 /// Draw a pixel in the specified color.
WiredHome 32:0e4f2ae512e2 37 ///
WiredHome 32:0e4f2ae512e2 38 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 39 ///
WiredHome 76:c981284eb513 40 /// @param[in] x is the horizontal offset to this pixel.
WiredHome 76:c981284eb513 41 /// @param[in] y is the vertical offset to this pixel.
WiredHome 76:c981284eb513 42 /// @param[in] color defines the color for the pixel.
WiredHome 32:0e4f2ae512e2 43 /// @returns success/failure code. @see RetCode_t.
WiredHome 32:0e4f2ae512e2 44 ///
WiredHome 37:f19b7e7449dc 45 virtual RetCode_t pixel(loc_t x, loc_t y, color_t color) = 0;
WiredHome 32:0e4f2ae512e2 46
WiredHome 41:2956a0a221e5 47 /// Write a stream of pixels to the display.
WiredHome 41:2956a0a221e5 48 ///
WiredHome 41:2956a0a221e5 49 /// @note this method must be supported in the derived class.
WiredHome 41:2956a0a221e5 50 ///
WiredHome 76:c981284eb513 51 /// @param[in] p is a pointer to a color_t array to write.
WiredHome 76:c981284eb513 52 /// @param[in] count is the number of pixels to write.
WiredHome 76:c981284eb513 53 /// @param[in] x is the horizontal position on the display.
WiredHome 76:c981284eb513 54 /// @param[in] y is the vertical position on the display.
WiredHome 41:2956a0a221e5 55 /// @returns success/failure code. @see RetCode_t.
WiredHome 41:2956a0a221e5 56 ///
WiredHome 41:2956a0a221e5 57 virtual RetCode_t pixelStream(color_t * p, uint32_t count, loc_t x, loc_t y) = 0;
WiredHome 41:2956a0a221e5 58
WiredHome 41:2956a0a221e5 59 /// Get a pixel from the display.
WiredHome 41:2956a0a221e5 60 ///
WiredHome 41:2956a0a221e5 61 /// @note this method must be supported in the derived class.
WiredHome 41:2956a0a221e5 62 ///
WiredHome 76:c981284eb513 63 /// @param[in] x is the horizontal offset to this pixel.
WiredHome 76:c981284eb513 64 /// @param[in] y is the vertical offset to this pixel.
WiredHome 125:7a0b70f56550 65 /// @returns the pixel. @see color_t
WiredHome 41:2956a0a221e5 66 ///
WiredHome 41:2956a0a221e5 67 virtual color_t getPixel(loc_t x, loc_t y) = 0;
WiredHome 41:2956a0a221e5 68
WiredHome 41:2956a0a221e5 69 /// Get a stream of pixels from the display.
WiredHome 41:2956a0a221e5 70 ///
WiredHome 41:2956a0a221e5 71 /// @note this method must be supported in the derived class.
WiredHome 41:2956a0a221e5 72 ///
WiredHome 76:c981284eb513 73 /// @param[out] p is a pointer to a color_t array to accept the stream.
WiredHome 76:c981284eb513 74 /// @param[in] count is the number of pixels to read.
WiredHome 76:c981284eb513 75 /// @param[in] x is the horizontal offset to this pixel.
WiredHome 76:c981284eb513 76 /// @param[in] y is the vertical offset to this pixel.
WiredHome 41:2956a0a221e5 77 /// @returns success/failure code. @see RetCode_t.
WiredHome 41:2956a0a221e5 78 ///
WiredHome 41:2956a0a221e5 79 virtual RetCode_t getPixelStream(color_t * p, uint32_t count, loc_t x, loc_t y) = 0;
WiredHome 41:2956a0a221e5 80
WiredHome 32:0e4f2ae512e2 81 /// get the screen width in pixels
WiredHome 32:0e4f2ae512e2 82 ///
WiredHome 32:0e4f2ae512e2 83 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 84 ///
WiredHome 32:0e4f2ae512e2 85 /// @returns screen width in pixels.
WiredHome 32:0e4f2ae512e2 86 ///
WiredHome 32:0e4f2ae512e2 87 virtual uint16_t width() = 0;
WiredHome 32:0e4f2ae512e2 88
WiredHome 32:0e4f2ae512e2 89 /// get the screen height in pixels
WiredHome 32:0e4f2ae512e2 90 ///
WiredHome 32:0e4f2ae512e2 91 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 92 ///
WiredHome 32:0e4f2ae512e2 93 /// @returns screen height in pixels.
WiredHome 32:0e4f2ae512e2 94 ///
WiredHome 32:0e4f2ae512e2 95 virtual uint16_t height() = 0;
WiredHome 32:0e4f2ae512e2 96
WiredHome 32:0e4f2ae512e2 97 /// Prepare the controller to write binary data to the screen by positioning
WiredHome 32:0e4f2ae512e2 98 /// the memory cursor.
WiredHome 32:0e4f2ae512e2 99 ///
WiredHome 32:0e4f2ae512e2 100 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 101 ///
WiredHome 76:c981284eb513 102 /// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome 76:c981284eb513 103 /// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome 32:0e4f2ae512e2 104 /// @returns success/failure code. @see RetCode_t.
WiredHome 32:0e4f2ae512e2 105 ///
WiredHome 37:f19b7e7449dc 106 virtual RetCode_t SetGraphicsCursor(loc_t x, loc_t y) = 0;
WiredHome 32:0e4f2ae512e2 107
WiredHome 136:224e03d5c31f 108
WiredHome 136:224e03d5c31f 109 /// Prepare the controller to write binary data to the screen by positioning
WiredHome 136:224e03d5c31f 110 /// the memory cursor.
WiredHome 136:224e03d5c31f 111 ///
WiredHome 136:224e03d5c31f 112 /// @param[in] p is the point representing the cursor position to set
WiredHome 136:224e03d5c31f 113 /// @returns success/failure code. See @ref RetCode_t.
WiredHome 136:224e03d5c31f 114 ///
WiredHome 136:224e03d5c31f 115 virtual RetCode_t SetGraphicsCursor(point_t p) = 0;
WiredHome 136:224e03d5c31f 116
WiredHome 136:224e03d5c31f 117 /// Read the current graphics cursor position as a point.
WiredHome 136:224e03d5c31f 118 ///
WiredHome 136:224e03d5c31f 119 /// @returns the graphics cursor as a point.
WiredHome 136:224e03d5c31f 120 ///
WiredHome 136:224e03d5c31f 121 virtual point_t GetGraphicsCursor(void) = 0;
WiredHome 136:224e03d5c31f 122
WiredHome 41:2956a0a221e5 123 /// Prepare the controller to read binary data from the screen by positioning
WiredHome 41:2956a0a221e5 124 /// the memory read cursor.
WiredHome 41:2956a0a221e5 125 ///
WiredHome 76:c981284eb513 126 /// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome 76:c981284eb513 127 /// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome 41:2956a0a221e5 128 /// @returns success/failure code. @see RetCode_t.
WiredHome 41:2956a0a221e5 129 ///
WiredHome 41:2956a0a221e5 130 virtual RetCode_t SetGraphicsCursorRead(loc_t x, loc_t y) = 0;
WiredHome 41:2956a0a221e5 131
WiredHome 32:0e4f2ae512e2 132 /// Draw a filled rectangle in the specified color
WiredHome 32:0e4f2ae512e2 133 ///
WiredHome 32:0e4f2ae512e2 134 /// @note As a side effect, this changes the current
WiredHome 32:0e4f2ae512e2 135 /// foreground color for subsequent operations.
WiredHome 32:0e4f2ae512e2 136 ///
WiredHome 32:0e4f2ae512e2 137 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 138 ///
WiredHome 76:c981284eb513 139 /// @param[in] x1 is the horizontal start of the line.
WiredHome 76:c981284eb513 140 /// @param[in] y1 is the vertical start of the line.
WiredHome 76:c981284eb513 141 /// @param[in] x2 is the horizontal end of the line.
WiredHome 76:c981284eb513 142 /// @param[in] y2 is the vertical end of the line.
WiredHome 76:c981284eb513 143 /// @param[in] color defines the foreground color.
WiredHome 76:c981284eb513 144 /// @param[in] fillit is optional to NOFILL the rectangle. default is FILL.
WiredHome 32:0e4f2ae512e2 145 /// @returns success/failure code. @see RetCode_t.
WiredHome 32:0e4f2ae512e2 146 ///
WiredHome 37:f19b7e7449dc 147 virtual RetCode_t fillrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome 32:0e4f2ae512e2 148 color_t color, fill_t fillit = FILL) = 0;
WiredHome 32:0e4f2ae512e2 149
WiredHome 125:7a0b70f56550 150 /// a function to write the command and data to the RA8875 chip.
WiredHome 125:7a0b70f56550 151 ///
WiredHome 125:7a0b70f56550 152 /// @param command is the RA8875 instruction to perform
WiredHome 125:7a0b70f56550 153 /// @param data is the optional data to the instruction.
WiredHome 125:7a0b70f56550 154 /// @returns success/failure code. @see RetCode_t.
WiredHome 125:7a0b70f56550 155 ///
WiredHome 32:0e4f2ae512e2 156 virtual RetCode_t WriteCommand(unsigned char command, unsigned int data = 0xFFFF) = 0;
WiredHome 125:7a0b70f56550 157
WiredHome 125:7a0b70f56550 158
WiredHome 125:7a0b70f56550 159 /// a function to write the data to the RA8875 chip.
WiredHome 125:7a0b70f56550 160 ///
WiredHome 125:7a0b70f56550 161 /// This is typically used after a command has been initiated, and where
WiredHome 125:7a0b70f56550 162 /// there may be a data stream to follow.
WiredHome 125:7a0b70f56550 163 ///
WiredHome 125:7a0b70f56550 164 /// @param data is the optional data to the instruction.
WiredHome 125:7a0b70f56550 165 /// @returns success/failure code. @see RetCode_t.
WiredHome 125:7a0b70f56550 166 ///
WiredHome 32:0e4f2ae512e2 167 virtual RetCode_t WriteData(unsigned char data) = 0;
WiredHome 32:0e4f2ae512e2 168
WiredHome 32:0e4f2ae512e2 169 /// Set the window, which controls where items are written to the screen.
WiredHome 32:0e4f2ae512e2 170 ///
WiredHome 32:0e4f2ae512e2 171 /// When something hits the window width, it wraps back to the left side
WiredHome 126:c91bd2e500b9 172 /// and down a row.
WiredHome 126:c91bd2e500b9 173 ///
WiredHome 126:c91bd2e500b9 174 /// @note If the initial write is outside the window, it will
WiredHome 126:c91bd2e500b9 175 /// be captured into the window when it crosses a boundary. It may
WiredHome 126:c91bd2e500b9 176 /// be appropriate to SetGraphicsCursor() to a point in the window.
WiredHome 32:0e4f2ae512e2 177 ///
WiredHome 111:efe436c43aba 178 /// @param[in] r is the rect_t rect to define the window.
WiredHome 111:efe436c43aba 179 /// @returns success/failure code. @see RetCode_t.
WiredHome 111:efe436c43aba 180 ///
WiredHome 111:efe436c43aba 181 virtual RetCode_t window(rect_t r);
WiredHome 111:efe436c43aba 182
WiredHome 111:efe436c43aba 183 /// Set the window, which controls where items are written to the screen.
WiredHome 111:efe436c43aba 184 ///
WiredHome 111:efe436c43aba 185 /// When something hits the window width, it wraps back to the left side
WiredHome 126:c91bd2e500b9 186 /// and down a row.
WiredHome 126:c91bd2e500b9 187 ///
WiredHome 126:c91bd2e500b9 188 /// @note If the initial write is outside the window, it will
WiredHome 126:c91bd2e500b9 189 /// be captured into the window when it crosses a boundary. It may
WiredHome 126:c91bd2e500b9 190 /// be appropriate to SetGraphicsCursor() to a point in the window.
WiredHome 111:efe436c43aba 191 ///
WiredHome 114:dbfb996bfbf3 192 /// @note if no parameters are provided, it restores the window to full screen.
WiredHome 114:dbfb996bfbf3 193 ///
WiredHome 76:c981284eb513 194 /// @param[in] x is the left edge in pixels.
WiredHome 76:c981284eb513 195 /// @param[in] y is the top edge in pixels.
WiredHome 76:c981284eb513 196 /// @param[in] w is the window width in pixels.
WiredHome 76:c981284eb513 197 /// @param[in] h is the window height in pixels.
WiredHome 32:0e4f2ae512e2 198 /// @returns success/failure code. @see RetCode_t.
WiredHome 32:0e4f2ae512e2 199 ///
WiredHome 114:dbfb996bfbf3 200 virtual RetCode_t window(loc_t x = 0, loc_t y = 0, dim_t w = (dim_t)-1, dim_t h = (dim_t)-1);
WiredHome 32:0e4f2ae512e2 201
WiredHome 111:efe436c43aba 202 /// method to set the window region to the full screen.
WiredHome 111:efe436c43aba 203 ///
WiredHome 111:efe436c43aba 204 /// This restores the 'window' to the full screen, so that
WiredHome 111:efe436c43aba 205 /// other operations (@see cls) would clear the whole screen.
WiredHome 111:efe436c43aba 206 ///
WiredHome 111:efe436c43aba 207 /// @returns success/failure code. @see RetCode_t.
WiredHome 111:efe436c43aba 208 ///
WiredHome 111:efe436c43aba 209 virtual RetCode_t WindowMax(void);
WiredHome 111:efe436c43aba 210
WiredHome 32:0e4f2ae512e2 211 /// Clear the screen.
WiredHome 32:0e4f2ae512e2 212 ///
WiredHome 32:0e4f2ae512e2 213 /// The behavior is to clear the whole screen.
WiredHome 32:0e4f2ae512e2 214 ///
WiredHome 76:c981284eb513 215 /// @param[in] layers is ignored, but supports maintaining the same
WiredHome 61:8f3153bf0baa 216 /// API for the graphics layer.
WiredHome 32:0e4f2ae512e2 217 /// @returns success/failure code. @see RetCode_t.
WiredHome 32:0e4f2ae512e2 218 ///
WiredHome 61:8f3153bf0baa 219 virtual RetCode_t cls(uint16_t layers = 0);
WiredHome 32:0e4f2ae512e2 220
WiredHome 32:0e4f2ae512e2 221 /// method to put a single color pixel to the screen.
WiredHome 32:0e4f2ae512e2 222 ///
WiredHome 32:0e4f2ae512e2 223 /// This method may be called as many times as necessary after
WiredHome 32:0e4f2ae512e2 224 /// @see _StartGraphicsStream() is called, and it should be followed
WiredHome 32:0e4f2ae512e2 225 /// by _EndGraphicsStream.
WiredHome 32:0e4f2ae512e2 226 ///
WiredHome 76:c981284eb513 227 /// @param[in] pixel is a color value to be put on the screen.
WiredHome 79:544eb4964795 228 /// @returns success/failure code. @see RetCode_t.
WiredHome 32:0e4f2ae512e2 229 ///
WiredHome 55:dfbabef7003e 230 virtual RetCode_t _putp(color_t pixel);
WiredHome 32:0e4f2ae512e2 231
WiredHome 79:544eb4964795 232 /// method to fill a region.
WiredHome 79:544eb4964795 233 ///
WiredHome 125:7a0b70f56550 234 /// This method fills a region with the specified color. It essentially
WiredHome 125:7a0b70f56550 235 /// is an alias for fillrect, however this uses width and height rather
WiredHome 125:7a0b70f56550 236 /// than a second x,y pair.
WiredHome 79:544eb4964795 237 ///
WiredHome 79:544eb4964795 238 /// @param[in] x is the left-edge of the region.
WiredHome 79:544eb4964795 239 /// @param[in] y is the top-edge of the region.
WiredHome 79:544eb4964795 240 /// @param[in] w specifies the width of the region.
WiredHome 79:544eb4964795 241 /// @param[in] h specifies the height of the region.
WiredHome 125:7a0b70f56550 242 /// @param[in] color is the color value to use to fill the region
WiredHome 79:544eb4964795 243 /// @returns success/failure code. @see RetCode_t.
WiredHome 79:544eb4964795 244 ///
WiredHome 109:7b94f06f085b 245 virtual RetCode_t fill(loc_t x, loc_t y, dim_t w, dim_t h, color_t color);
WiredHome 76:c981284eb513 246
WiredHome 125:7a0b70f56550 247 /// method to stream bitmap data to the display
WiredHome 125:7a0b70f56550 248 ///
WiredHome 125:7a0b70f56550 249 /// This method fills a region from a stream of color data.
WiredHome 125:7a0b70f56550 250 ///
WiredHome 125:7a0b70f56550 251 /// @param[in] x is the left-edge of the region.
WiredHome 125:7a0b70f56550 252 /// @param[in] y is the top-edge of the region.
WiredHome 125:7a0b70f56550 253 /// @param[in] w specifies the width of the region.
WiredHome 125:7a0b70f56550 254 /// @param[in] h specifies the height of the region.
WiredHome 125:7a0b70f56550 255 /// @param[in] color is a pointer to a color stream with w x h values.
WiredHome 125:7a0b70f56550 256 /// @returns success/failure code. @see RetCode_t.
WiredHome 125:7a0b70f56550 257 ///
WiredHome 109:7b94f06f085b 258 virtual RetCode_t blit(loc_t x, loc_t y, dim_t w, dim_t h, const int * color);
WiredHome 29:422616aa04bd 259
WiredHome 101:e0aad446094a 260 /// This method returns the width in pixels of the chosen character
WiredHome 101:e0aad446094a 261 /// from the previously selected external font.
WiredHome 101:e0aad446094a 262 ///
WiredHome 101:e0aad446094a 263 /// @param[in] c is the character of interest.
WiredHome 106:c80828f5dea4 264 /// @param[in, out] width is a pointer to where the width will be stored.
WiredHome 101:e0aad446094a 265 /// This parameter is NULL tested and will only be written if not null
WiredHome 101:e0aad446094a 266 /// which is convenient if you only want the height.
WiredHome 106:c80828f5dea4 267 /// @param[in, out] height is a pointer to where the height will be stored.
WiredHome 101:e0aad446094a 268 /// This parameter is NULL tested and will only be written if not null
WiredHome 101:e0aad446094a 269 /// which is convenient if you only want the width.
WiredHome 101:e0aad446094a 270 /// @returns a pointer to the raw character data or NULL if not found.
WiredHome 101:e0aad446094a 271 ///
WiredHome 109:7b94f06f085b 272 virtual const uint8_t * getCharMetrics(const unsigned char c, dim_t * width, dim_t * height);
WiredHome 101:e0aad446094a 273
WiredHome 29:422616aa04bd 274 /// This method transfers one character from the external font data
WiredHome 29:422616aa04bd 275 /// to the screen.
WiredHome 29:422616aa04bd 276 ///
WiredHome 101:e0aad446094a 277 /// The font being used has already been set with the SelectUserFont
WiredHome 101:e0aad446094a 278 /// API.
WiredHome 101:e0aad446094a 279 ///
WiredHome 29:422616aa04bd 280 /// @note the font data is in a special format as generate by
WiredHome 95:ef538bd687c0 281 /// the mikroe font creator.
WiredHome 29:422616aa04bd 282 /// See http://www.mikroe.com/glcd-font-creator/
WiredHome 29:422616aa04bd 283 ///
WiredHome 76:c981284eb513 284 /// @param[in] x is the horizontal pixel coordinate
WiredHome 76:c981284eb513 285 /// @param[in] y is the vertical pixel coordinate
WiredHome 98:ecebed9b80b2 286 /// @param[in] c is the character to render
WiredHome 98:ecebed9b80b2 287 /// @returns how far the cursor should advance to the right in pixels.
WiredHome 98:ecebed9b80b2 288 /// @returns zero if the character could not be rendered.
WiredHome 29:422616aa04bd 289 ///
WiredHome 109:7b94f06f085b 290 virtual int fontblit(loc_t x, loc_t y, const unsigned char c);
WiredHome 29:422616aa04bd 291
WiredHome 32:0e4f2ae512e2 292 /// This method returns the color value from a palette.
WiredHome 32:0e4f2ae512e2 293 ///
WiredHome 32:0e4f2ae512e2 294 /// This method accepts a pointer to a Bitmap color palette, which
WiredHome 32:0e4f2ae512e2 295 /// is a table in memory composed of RGB Quad values (r, g, b, 0),
WiredHome 32:0e4f2ae512e2 296 /// and an index into that table. It then extracts the color information
WiredHome 32:0e4f2ae512e2 297 /// and downsamples it to a color_t value which it returns.
WiredHome 32:0e4f2ae512e2 298 ///
WiredHome 32:0e4f2ae512e2 299 /// @note This method probably has very little value outside of
WiredHome 32:0e4f2ae512e2 300 /// the internal methods for reading BMP files.
WiredHome 32:0e4f2ae512e2 301 ///
WiredHome 76:c981284eb513 302 /// @param[in] colorPaletteArray is the handle to the color palette array to use.
WiredHome 76:c981284eb513 303 /// @param[in] index is the index into the color palette.
WiredHome 32:0e4f2ae512e2 304 /// @returns the color in color_t format.
WiredHome 32:0e4f2ae512e2 305 ///
WiredHome 73:f22a18707b5e 306 color_t RGBQuadToRGB16(RGBQUAD * colorPaletteArray, uint16_t index);
WiredHome 32:0e4f2ae512e2 307
WiredHome 41:2956a0a221e5 308 /// This method converts a 16-bit color value into a 24-bit RGB Quad.
WiredHome 41:2956a0a221e5 309 ///
WiredHome 76:c981284eb513 310 /// @param[in] c is the 16-bit color. @see color_t.
WiredHome 41:2956a0a221e5 311 /// @returns an RGBQUAD value. @see RGBQUAD
WiredHome 41:2956a0a221e5 312 ///
WiredHome 41:2956a0a221e5 313 RGBQUAD RGB16ToRGBQuad(color_t c);
WiredHome 41:2956a0a221e5 314
WiredHome 42:7cbdfd2bbfc5 315 /// This method attempts to render a specified graphics image file at
WiredHome 42:7cbdfd2bbfc5 316 /// the specified screen location.
WiredHome 42:7cbdfd2bbfc5 317 ///
WiredHome 42:7cbdfd2bbfc5 318 /// This supports several variants of the following file types:
WiredHome 42:7cbdfd2bbfc5 319 /// \li Bitmap file format,
WiredHome 42:7cbdfd2bbfc5 320 /// \li Icon file format.
WiredHome 42:7cbdfd2bbfc5 321 ///
WiredHome 42:7cbdfd2bbfc5 322 /// @note The specified image width and height, when adjusted for the
WiredHome 42:7cbdfd2bbfc5 323 /// x and y origin, must fit on the screen, or the image will not
WiredHome 42:7cbdfd2bbfc5 324 /// be shown (it does not clip the image).
WiredHome 42:7cbdfd2bbfc5 325 ///
WiredHome 42:7cbdfd2bbfc5 326 /// @note The file extension is tested, and if it ends in a supported
WiredHome 42:7cbdfd2bbfc5 327 /// format, the appropriate handler is called to render that image.
WiredHome 42:7cbdfd2bbfc5 328 ///
WiredHome 76:c981284eb513 329 /// @param[in] x is the horizontal pixel coordinate
WiredHome 76:c981284eb513 330 /// @param[in] y is the vertical pixel coordinate
WiredHome 76:c981284eb513 331 /// @param[in] FileName refers to the fully qualified path and file on
WiredHome 42:7cbdfd2bbfc5 332 /// a mounted file system.
WiredHome 42:7cbdfd2bbfc5 333 /// @returns success or error code.
WiredHome 42:7cbdfd2bbfc5 334 ///
WiredHome 42:7cbdfd2bbfc5 335 RetCode_t RenderImageFile(loc_t x, loc_t y, const char *FileName);
WiredHome 42:7cbdfd2bbfc5 336
WiredHome 115:c9862fd0c689 337 /// This method reads a disk file that is in jpeg format and
WiredHome 115:c9862fd0c689 338 /// puts it on the screen.
WiredHome 115:c9862fd0c689 339 ///
WiredHome 115:c9862fd0c689 340 /// @param[in] x is the horizontal pixel coordinate
WiredHome 115:c9862fd0c689 341 /// @param[in] y is the vertical pixel coordinate
WiredHome 115:c9862fd0c689 342 /// @param[in] Name_JPG is the filename on the mounted file system.
WiredHome 115:c9862fd0c689 343 /// @returns success or error code.
WiredHome 115:c9862fd0c689 344 ///
WiredHome 115:c9862fd0c689 345 RetCode_t RenderJpegFile(loc_t x, loc_t y, const char *Name_JPG);
WiredHome 115:c9862fd0c689 346
WiredHome 31:c72e12cd5c67 347 /// This method reads a disk file that is in bitmap format and
WiredHome 31:c72e12cd5c67 348 /// puts it on the screen.
WiredHome 31:c72e12cd5c67 349 ///
WiredHome 36:300f6ee0b2cf 350 /// Supported formats:
WiredHome 112:325ca91bc03d 351 /// \li 1-bit color format (2 colors)
WiredHome 112:325ca91bc03d 352 /// \li 4-bit color format (16 colors)
WiredHome 112:325ca91bc03d 353 /// \li 8-bit color format (256 colors)
WiredHome 36:300f6ee0b2cf 354 /// \li 16-bit color format (65k colors)
WiredHome 112:325ca91bc03d 355 /// \li 24-bit color format (16M colors)
WiredHome 36:300f6ee0b2cf 356 /// \li compression: no.
WiredHome 36:300f6ee0b2cf 357 ///
WiredHome 36:300f6ee0b2cf 358 /// @note This is a slow operation, typically due to the use of
WiredHome 36:300f6ee0b2cf 359 /// the file system, and partially because bmp files
WiredHome 31:c72e12cd5c67 360 /// are stored from the bottom up, and the memory is written
WiredHome 32:0e4f2ae512e2 361 /// from the top down; as a result, it constantly 'seeks'
WiredHome 32:0e4f2ae512e2 362 /// on the file system for the next row of information.
WiredHome 31:c72e12cd5c67 363 ///
WiredHome 34:c99ec28fac66 364 /// As a performance test, a sample picture was timed. A family picture
WiredHome 34:c99ec28fac66 365 /// was converted to Bitmap format; shrunk to 352 x 272 pixels and save
WiredHome 34:c99ec28fac66 366 /// in 8-bit color format. The resulting file size was 94.5 KByte.
WiredHome 34:c99ec28fac66 367 /// The SPI port interface was set to 20 MHz.
WiredHome 34:c99ec28fac66 368 /// The original bitmap rendering software was purely in software,
WiredHome 34:c99ec28fac66 369 /// pushing 1 pixel at a time to the write function, which did use SPI
WiredHome 34:c99ec28fac66 370 /// hardware (not pin wiggling) to transfer commands and data to the
WiredHome 34:c99ec28fac66 371 /// display. Then, the driver was improved to leverage the capability
WiredHome 34:c99ec28fac66 372 /// of the derived display driver. As a final check, instead of the
WiredHome 34:c99ec28fac66 373 /// [known slow] local file system, a randomly chosen USB stick was
WiredHome 34:c99ec28fac66 374 /// used. The performance results are impressive (but depend on the
WiredHome 34:c99ec28fac66 375 /// listed factors).
WiredHome 34:c99ec28fac66 376 ///
WiredHome 35:7dcab9e3ab25 377 /// \li 34 seconds, LocalFileSystem, Software Rendering
WiredHome 35:7dcab9e3ab25 378 /// \li 9 seconds, LocalFileSystem, Hardware Rending for RA8875
WiredHome 35:7dcab9e3ab25 379 /// \li 3 seconds, MSCFileSystem, Hardware Rendering for RA8875
WiredHome 34:c99ec28fac66 380 ///
WiredHome 76:c981284eb513 381 /// @param[in] x is the horizontal pixel coordinate
WiredHome 76:c981284eb513 382 /// @param[in] y is the vertical pixel coordinate
WiredHome 76:c981284eb513 383 /// @param[in] Name_BMP is the filename on the mounted file system.
WiredHome 31:c72e12cd5c67 384 /// @returns success or error code.
WiredHome 31:c72e12cd5c67 385 ///
WiredHome 37:f19b7e7449dc 386 RetCode_t RenderBitmapFile(loc_t x, loc_t y, const char *Name_BMP);
WiredHome 31:c72e12cd5c67 387
WiredHome 42:7cbdfd2bbfc5 388
WiredHome 42:7cbdfd2bbfc5 389 /// This method reads a disk file that is in ico format and
WiredHome 42:7cbdfd2bbfc5 390 /// puts it on the screen.
WiredHome 42:7cbdfd2bbfc5 391 ///
WiredHome 42:7cbdfd2bbfc5 392 /// Reading the disk is slow, but a typical icon file is small
WiredHome 42:7cbdfd2bbfc5 393 /// so it should be ok.
WiredHome 42:7cbdfd2bbfc5 394 ///
WiredHome 42:7cbdfd2bbfc5 395 /// @note An Icon file can have more than one icon in it. This
WiredHome 42:7cbdfd2bbfc5 396 /// implementation only processes the first image in the file.
WiredHome 42:7cbdfd2bbfc5 397 ///
WiredHome 76:c981284eb513 398 /// @param[in] x is the horizontal pixel coordinate
WiredHome 76:c981284eb513 399 /// @param[in] y is the vertical pixel coordinate
WiredHome 76:c981284eb513 400 /// @param[in] Name_ICO is the filename on the mounted file system.
WiredHome 42:7cbdfd2bbfc5 401 /// @returns success or error code.
WiredHome 42:7cbdfd2bbfc5 402 ///
WiredHome 42:7cbdfd2bbfc5 403 RetCode_t RenderIconFile(loc_t x, loc_t y, const char *Name_ICO);
WiredHome 42:7cbdfd2bbfc5 404
WiredHome 42:7cbdfd2bbfc5 405
WiredHome 29:422616aa04bd 406 /// prints one character at the specified coordinates.
WiredHome 29:422616aa04bd 407 ///
WiredHome 29:422616aa04bd 408 /// This will print the character at the specified pixel coordinates.
WiredHome 29:422616aa04bd 409 ///
WiredHome 76:c981284eb513 410 /// @param[in] x is the horizontal offset in pixels.
WiredHome 76:c981284eb513 411 /// @param[in] y is the vertical offset in pixels.
WiredHome 76:c981284eb513 412 /// @param[in] value is the character to print.
WiredHome 29:422616aa04bd 413 /// @returns number of pixels to index to the right if a character was printed, 0 otherwise.
WiredHome 29:422616aa04bd 414 ///
WiredHome 29:422616aa04bd 415 virtual int character(int x, int y, int value);
WiredHome 29:422616aa04bd 416
WiredHome 32:0e4f2ae512e2 417 /// get the number of colums based on the currently active font
WiredHome 32:0e4f2ae512e2 418 ///
WiredHome 32:0e4f2ae512e2 419 /// @returns number of columns.
WiredHome 32:0e4f2ae512e2 420 ///
WiredHome 32:0e4f2ae512e2 421 virtual int columns(void);
WiredHome 32:0e4f2ae512e2 422
WiredHome 32:0e4f2ae512e2 423 /// get the number of rows based on the currently active font
WiredHome 32:0e4f2ae512e2 424 ///
WiredHome 32:0e4f2ae512e2 425 /// @returns number of rows.
WiredHome 32:0e4f2ae512e2 426 ///
WiredHome 32:0e4f2ae512e2 427 virtual int rows(void);
WiredHome 32:0e4f2ae512e2 428
WiredHome 98:ecebed9b80b2 429 /// Select a User Font for all subsequent text.
WiredHome 98:ecebed9b80b2 430 ///
WiredHome 98:ecebed9b80b2 431 /// @note Tool to create the fonts is accessible from its creator
WiredHome 98:ecebed9b80b2 432 /// available at http://www.mikroe.com.
WiredHome 98:ecebed9b80b2 433 /// For version 1.2.0.0, choose the "Export for TFT and new GLCD"
WiredHome 98:ecebed9b80b2 434 /// format.
WiredHome 98:ecebed9b80b2 435 ///
WiredHome 98:ecebed9b80b2 436 /// @param[in] font is a pointer to a specially formed font resource.
WiredHome 98:ecebed9b80b2 437 /// @returns error code.
WiredHome 98:ecebed9b80b2 438 ///
WiredHome 98:ecebed9b80b2 439 virtual RetCode_t SelectUserFont(const uint8_t * font = NULL);
WiredHome 98:ecebed9b80b2 440
WiredHome 32:0e4f2ae512e2 441
WiredHome 32:0e4f2ae512e2 442 protected:
WiredHome 32:0e4f2ae512e2 443
WiredHome 32:0e4f2ae512e2 444 /// Pure virtual method indicating the start of a graphics stream.
WiredHome 32:0e4f2ae512e2 445 ///
WiredHome 32:0e4f2ae512e2 446 /// This is called prior to a stream of pixel data being sent.
WiredHome 32:0e4f2ae512e2 447 /// This may cause register configuration changes in the derived
WiredHome 32:0e4f2ae512e2 448 /// class in order to prepare the hardware to accept the streaming
WiredHome 32:0e4f2ae512e2 449 /// data.
WiredHome 32:0e4f2ae512e2 450 ///
WiredHome 32:0e4f2ae512e2 451 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 452 ///
WiredHome 32:0e4f2ae512e2 453 /// @returns error code.
WiredHome 32:0e4f2ae512e2 454 ///
WiredHome 32:0e4f2ae512e2 455 virtual RetCode_t _StartGraphicsStream(void) = 0;
dreschpe 0:de9d1462a835 456
WiredHome 32:0e4f2ae512e2 457 /// Pure virtual method indicating the end of a graphics stream.
WiredHome 32:0e4f2ae512e2 458 ///
WiredHome 32:0e4f2ae512e2 459 /// This is called to conclude a stream of pixel data that was sent.
WiredHome 32:0e4f2ae512e2 460 /// This may cause register configuration changes in the derived
WiredHome 32:0e4f2ae512e2 461 /// class in order to stop the hardware from accept the streaming
WiredHome 32:0e4f2ae512e2 462 /// data.
WiredHome 32:0e4f2ae512e2 463 ///
WiredHome 32:0e4f2ae512e2 464 /// @note this method must be supported in the derived class.
WiredHome 32:0e4f2ae512e2 465 ///
WiredHome 32:0e4f2ae512e2 466 /// @returns error code.
WiredHome 32:0e4f2ae512e2 467 ///
WiredHome 32:0e4f2ae512e2 468 virtual RetCode_t _EndGraphicsStream(void) = 0;
WiredHome 32:0e4f2ae512e2 469
WiredHome 42:7cbdfd2bbfc5 470 /// Protected method to render an image given a file handle and
WiredHome 42:7cbdfd2bbfc5 471 /// coordinates.
WiredHome 42:7cbdfd2bbfc5 472 ///
WiredHome 76:c981284eb513 473 /// @param[in] x is the horizontal pixel coordinate
WiredHome 76:c981284eb513 474 /// @param[in] y is the vertical pixel coordinate
WiredHome 76:c981284eb513 475 /// @param[in] fileOffset is the offset into the file where the image data starts
WiredHome 76:c981284eb513 476 /// @param[in] Image is the filename stream already opened for the data.
WiredHome 42:7cbdfd2bbfc5 477 /// @returns success or error code.
WiredHome 42:7cbdfd2bbfc5 478 ///
WiredHome 42:7cbdfd2bbfc5 479 RetCode_t _RenderBitmap(loc_t x, loc_t y, uint32_t fileOffset, FILE * Image);
WiredHome 42:7cbdfd2bbfc5 480
WiredHome 115:c9862fd0c689 481 private:
WiredHome 122:79e431f98fa9 482
WiredHome 136:224e03d5c31f 483 loc_t img_x; /// x position of a rendered jpg
WiredHome 136:224e03d5c31f 484 loc_t img_y; /// y position of a rendered jpg
WiredHome 136:224e03d5c31f 485
WiredHome 122:79e431f98fa9 486 /// Analyze the jpeg data in preparation for decompression.
WiredHome 122:79e431f98fa9 487 ///
WiredHome 115:c9862fd0c689 488 JRESULT jd_prepare(JDEC * jd, uint16_t(* infunc)(JDEC * jd, uint8_t * buffer, uint16_t bufsize), void * pool, uint16_t poolsize, void * filehandle);
WiredHome 115:c9862fd0c689 489
WiredHome 122:79e431f98fa9 490 /// Decompress the jpeg and render it.
WiredHome 122:79e431f98fa9 491 ///
WiredHome 115:c9862fd0c689 492 JRESULT jd_decomp(JDEC * jd, uint16_t(* outfunct)(JDEC * jd, void * stream, JRECT * rect), uint8_t scale);
WiredHome 115:c9862fd0c689 493
WiredHome 122:79e431f98fa9 494 /// helper function to read data from the file system
WiredHome 122:79e431f98fa9 495 ///
WiredHome 115:c9862fd0c689 496 uint16_t privInFunc(JDEC * jd, uint8_t * buff, uint16_t ndata);
WiredHome 115:c9862fd0c689 497
WiredHome 122:79e431f98fa9 498 /// helper function to read data from the file system
WiredHome 122:79e431f98fa9 499 ///
WiredHome 115:c9862fd0c689 500 uint16_t getJpegData(JDEC * jd, uint8_t *buff, uint16_t ndata);
WiredHome 115:c9862fd0c689 501
WiredHome 122:79e431f98fa9 502 /// helper function to write data to the display
WiredHome 122:79e431f98fa9 503 ///
WiredHome 115:c9862fd0c689 504 uint16_t privOutFunc(JDEC * jd, void * bitmap, JRECT * rect);
WiredHome 115:c9862fd0c689 505
WiredHome 115:c9862fd0c689 506 JRESULT mcu_output (
WiredHome 115:c9862fd0c689 507 JDEC * jd, /* Pointer to the decompressor object */
WiredHome 115:c9862fd0c689 508 uint16_t (* outfunc)(JDEC * jd, void * stream, JRECT * rect), /* RGB output function */
WiredHome 115:c9862fd0c689 509 uint16_t x, /* MCU position in the image (left of the MCU) */
WiredHome 115:c9862fd0c689 510 uint16_t y /* MCU position in the image (top of the MCU) */
WiredHome 115:c9862fd0c689 511 );
WiredHome 115:c9862fd0c689 512
WiredHome 115:c9862fd0c689 513 int16_t bitext ( /* >=0: extracted data, <0: error code */
WiredHome 115:c9862fd0c689 514 JDEC * jd, /* Pointer to the decompressor object */
WiredHome 115:c9862fd0c689 515 uint16_t nbit /* Number of bits to extract (1 to 11) */
WiredHome 115:c9862fd0c689 516 );
WiredHome 115:c9862fd0c689 517
WiredHome 115:c9862fd0c689 518 int16_t huffext ( /* >=0: decoded data, <0: error code */
WiredHome 115:c9862fd0c689 519 JDEC * jd, /* Pointer to the decompressor object */
WiredHome 115:c9862fd0c689 520 const uint8_t * hbits, /* Pointer to the bit distribution table */
WiredHome 115:c9862fd0c689 521 const uint16_t * hcode, /* Pointer to the code word table */
WiredHome 115:c9862fd0c689 522 const uint8_t * hdata /* Pointer to the data table */
WiredHome 115:c9862fd0c689 523 );
WiredHome 115:c9862fd0c689 524
WiredHome 115:c9862fd0c689 525 JRESULT restart (
WiredHome 115:c9862fd0c689 526 JDEC * jd, /* Pointer to the decompressor object */
WiredHome 115:c9862fd0c689 527 uint16_t rstn /* Expected restert sequense number */
WiredHome 115:c9862fd0c689 528 );
WiredHome 115:c9862fd0c689 529
WiredHome 115:c9862fd0c689 530 JRESULT mcu_load (
WiredHome 115:c9862fd0c689 531 JDEC * jd /* Pointer to the decompressor object */
WiredHome 115:c9862fd0c689 532 );
WiredHome 115:c9862fd0c689 533
WiredHome 122:79e431f98fa9 534
WiredHome 115:c9862fd0c689 535 protected:
WiredHome 109:7b94f06f085b 536 /// Pure virtual method to write a boolean stream to the display.
WiredHome 109:7b94f06f085b 537 ///
WiredHome 109:7b94f06f085b 538 /// This takes a bit stream in memory and using the current color settings
WiredHome 109:7b94f06f085b 539 /// it will stream it to the display. Along the way, each bit is translated
WiredHome 109:7b94f06f085b 540 /// to either the foreground or background color value and then that pixel
WiredHome 109:7b94f06f085b 541 /// is pushed onward.
WiredHome 109:7b94f06f085b 542 ///
WiredHome 109:7b94f06f085b 543 /// This is similar, but different, to the @ref pixelStream API, which is
WiredHome 109:7b94f06f085b 544 /// given a stream of color values.
WiredHome 109:7b94f06f085b 545 ///
WiredHome 109:7b94f06f085b 546 /// @param[in] x is the horizontal position on the display.
WiredHome 109:7b94f06f085b 547 /// @param[in] y is the vertical position on the display.
WiredHome 109:7b94f06f085b 548 /// @param[in] w is the width of the rectangular region to fill.
WiredHome 109:7b94f06f085b 549 /// @param[in] h is the height of the rectangular region to fill.
WiredHome 109:7b94f06f085b 550 /// @param[in] boolStream is the inline memory image from which to extract
WiredHome 109:7b94f06f085b 551 /// the bitstream.
WiredHome 109:7b94f06f085b 552 /// @returns success/failure code. See @ref RetCode_t.
WiredHome 109:7b94f06f085b 553 ///
WiredHome 109:7b94f06f085b 554 virtual RetCode_t booleanStream(loc_t x, loc_t y, dim_t w, dim_t h, const uint8_t * boolStream) = 0;
WiredHome 109:7b94f06f085b 555
WiredHome 109:7b94f06f085b 556
WiredHome 29:422616aa04bd 557 const unsigned char * font; ///< reference to an external font somewhere in memory
WiredHome 29:422616aa04bd 558
dreschpe 0:de9d1462a835 559 // pixel location
WiredHome 125:7a0b70f56550 560 short _x; ///< keeps track of current X location
WiredHome 125:7a0b70f56550 561 short _y; ///< keeps track of current Y location
dreschpe 0:de9d1462a835 562
WiredHome 111:efe436c43aba 563 rect_t windowrect; ///< window commands are held here for speed of access
dreschpe 0:de9d1462a835 564 };
dreschpe 0:de9d1462a835 565
dreschpe 0:de9d1462a835 566 #endif
WiredHome 33:b6b710758ab3 567