Forked para SNOCC
Fork of RA8875 by
RA8875.h@24:8ca861acf12d, 2014-01-17 (annotated)
- Committer:
- WiredHome
- Date:
- Fri Jan 17 02:10:18 2014 +0000
- Revision:
- 24:8ca861acf12d
- Parent:
- 23:a50ded45dbaf
- Child:
- 25:9556a3a9b7cc
Cursor control is working - none, i-beam, underscore, block.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
WiredHome | 19:3f82c1161fd2 | 1 | #ifndef RA8875_H |
WiredHome | 19:3f82c1161fd2 | 2 | #define RA8875_H |
WiredHome | 19:3f82c1161fd2 | 3 | #include <mbed.h> |
WiredHome | 19:3f82c1161fd2 | 4 | |
WiredHome | 19:3f82c1161fd2 | 5 | #include "GraphicsDisplay.h" |
WiredHome | 19:3f82c1161fd2 | 6 | |
WiredHome | 19:3f82c1161fd2 | 7 | #define RA8875_DEFAULT_SPI_FREQ 1000000 |
WiredHome | 19:3f82c1161fd2 | 8 | |
WiredHome | 19:3f82c1161fd2 | 9 | // Define this to enable code that monitors the performance of various |
WiredHome | 19:3f82c1161fd2 | 10 | // graphics commands. |
WiredHome | 19:3f82c1161fd2 | 11 | //#define PERF_METRICS |
WiredHome | 19:3f82c1161fd2 | 12 | |
WiredHome | 23:a50ded45dbaf | 13 | // What better place for some test code than in here and the companion |
WiredHome | 23:a50ded45dbaf | 14 | // .cpp file. See also the bottom of this file. |
WiredHome | 19:3f82c1161fd2 | 15 | #define TESTENABLE |
WiredHome | 19:3f82c1161fd2 | 16 | |
WiredHome | 19:3f82c1161fd2 | 17 | #define RGB(r,g,b) ( ((r<<8)&0xF800) | ((g<<3)&0x07E0) | (b>>3) ) |
WiredHome | 19:3f82c1161fd2 | 18 | |
WiredHome | 19:3f82c1161fd2 | 19 | /// DOS colors - slightly color enhanced |
WiredHome | 20:6e2e4a8372eb | 20 | #define Black (color_t)(RGB(0,0,0)) |
WiredHome | 20:6e2e4a8372eb | 21 | #define Blue (color_t)(RGB(0,0,187)) |
WiredHome | 20:6e2e4a8372eb | 22 | #define Green (color_t)(RGB(0,187,0)) |
WiredHome | 20:6e2e4a8372eb | 23 | #define Cyan (color_t)(RGB(0,187,187)) |
WiredHome | 20:6e2e4a8372eb | 24 | #define Red (color_t)(RGB(187,0,0)) |
WiredHome | 20:6e2e4a8372eb | 25 | #define Magenta (color_t)(RGB(187,0,187)) |
WiredHome | 20:6e2e4a8372eb | 26 | #define Brown (color_t)(RGB(187,187,0)) |
WiredHome | 20:6e2e4a8372eb | 27 | #define Gray (color_t)(RGB(187,187,187)) |
WiredHome | 20:6e2e4a8372eb | 28 | #define Charcoal (color_t)(RGB(85,85,85)) |
WiredHome | 20:6e2e4a8372eb | 29 | #define BrightBlue (color_t)(RGB(85,85,255)) |
WiredHome | 20:6e2e4a8372eb | 30 | #define BrightGreen (color_t)(RGB(85,255,85)) |
WiredHome | 20:6e2e4a8372eb | 31 | #define BrightCyan (color_t)(RGB(85,255,255)) |
WiredHome | 20:6e2e4a8372eb | 32 | #define Orange (color_t)(RGB(255,85,85)) |
WiredHome | 20:6e2e4a8372eb | 33 | #define Pink (color_t)(RGB(255,85,255)) |
WiredHome | 20:6e2e4a8372eb | 34 | #define Yellow (color_t)(RGB(255,255,85)) |
WiredHome | 20:6e2e4a8372eb | 35 | #define White (color_t)(RGB(255,255,255)) |
WiredHome | 20:6e2e4a8372eb | 36 | |
WiredHome | 20:6e2e4a8372eb | 37 | #define BrightRed (color_t)(RGB(255,0,0)) |
WiredHome | 19:3f82c1161fd2 | 38 | |
WiredHome | 19:3f82c1161fd2 | 39 | //namespace SW_graphics |
WiredHome | 19:3f82c1161fd2 | 40 | //{ |
WiredHome | 19:3f82c1161fd2 | 41 | |
WiredHome | 19:3f82c1161fd2 | 42 | /// color type definition to let the compiler help keep us honest. |
WiredHome | 19:3f82c1161fd2 | 43 | /// |
WiredHome | 19:3f82c1161fd2 | 44 | /// colors can be defined with the RGB(r,g,b) macro, and there |
WiredHome | 19:3f82c1161fd2 | 45 | /// are a number of predefined colors: |
WiredHome | 19:3f82c1161fd2 | 46 | /// - Black, Blue, Green, Cyan, |
WiredHome | 19:3f82c1161fd2 | 47 | /// - Red, Magenta, Brown, Gray, |
WiredHome | 19:3f82c1161fd2 | 48 | /// - Charcoal, BrightBlue, BrightGreen, BrightCyan, |
WiredHome | 19:3f82c1161fd2 | 49 | /// - Orange, Pink, Yellow, White |
WiredHome | 19:3f82c1161fd2 | 50 | /// |
WiredHome | 19:3f82c1161fd2 | 51 | typedef uint16_t color_t; |
WiredHome | 19:3f82c1161fd2 | 52 | |
WiredHome | 19:3f82c1161fd2 | 53 | /// background fill info for drawing Text, Rectangles, RoundedRectanges, Circles, Ellipses and Triangles. |
WiredHome | 19:3f82c1161fd2 | 54 | typedef enum |
WiredHome | 19:3f82c1161fd2 | 55 | { |
WiredHome | 19:3f82c1161fd2 | 56 | NOFILL, ///< do not fill the object with the background color |
WiredHome | 19:3f82c1161fd2 | 57 | FILL ///< fill the object space with the background color |
WiredHome | 19:3f82c1161fd2 | 58 | } fill_t; |
WiredHome | 19:3f82c1161fd2 | 59 | |
WiredHome | 24:8ca861acf12d | 60 | /// cursor type to be shown as the text cursor. |
WiredHome | 24:8ca861acf12d | 61 | typedef enum |
WiredHome | 24:8ca861acf12d | 62 | { |
WiredHome | 24:8ca861acf12d | 63 | NOCURSOR, ///< cursor is hidden |
WiredHome | 24:8ca861acf12d | 64 | IBEAM, ///< | cursor |
WiredHome | 24:8ca861acf12d | 65 | UNDER, ///< _ cursor |
WiredHome | 24:8ca861acf12d | 66 | BLOCK ///< Block cursor |
WiredHome | 24:8ca861acf12d | 67 | } cursor_t; |
WiredHome | 24:8ca861acf12d | 68 | |
WiredHome | 19:3f82c1161fd2 | 69 | /// return values from functions |
WiredHome | 19:3f82c1161fd2 | 70 | //typedef enum |
WiredHome | 19:3f82c1161fd2 | 71 | //{ |
WiredHome | 19:3f82c1161fd2 | 72 | // noerror, |
WiredHome | 19:3f82c1161fd2 | 73 | // bad_parameter |
WiredHome | 19:3f82c1161fd2 | 74 | //} RetCode_t; |
WiredHome | 19:3f82c1161fd2 | 75 | |
WiredHome | 21:3c1efb192927 | 76 | /// This is a graphics library for the Raio RA8875 Display Controller chip |
WiredHome | 21:3c1efb192927 | 77 | /// attached to a 4-wire SPI interface. |
WiredHome | 21:3c1efb192927 | 78 | /// |
WiredHome | 21:3c1efb192927 | 79 | /// It offers both primitive and high level APIs. |
WiredHome | 21:3c1efb192927 | 80 | /// Central to this API is a coordinate system, where the origin (0,0) is in |
WiredHome | 21:3c1efb192927 | 81 | /// the top-left corner of the display, and the width extends positive to the |
WiredHome | 21:3c1efb192927 | 82 | /// right and the height extends positive toward the bottom. |
WiredHome | 21:3c1efb192927 | 83 | /// |
WiredHome | 21:3c1efb192927 | 84 | /// As there are both graphics and text commands, one must take care to use |
WiredHome | 21:3c1efb192927 | 85 | /// the proper coordinate system for each. Some of the text APIs are in units |
WiredHome | 21:3c1efb192927 | 86 | /// of column and row, which is measured in character positions (so dependent |
WiredHome | 21:3c1efb192927 | 87 | /// on the font size). |
WiredHome | 21:3c1efb192927 | 88 | /// |
WiredHome | 19:3f82c1161fd2 | 89 | class RA8875 : public GraphicsDisplay |
WiredHome | 19:3f82c1161fd2 | 90 | { |
WiredHome | 19:3f82c1161fd2 | 91 | public: |
WiredHome | 19:3f82c1161fd2 | 92 | /// font type selection. |
WiredHome | 19:3f82c1161fd2 | 93 | typedef enum |
WiredHome | 19:3f82c1161fd2 | 94 | { |
WiredHome | 19:3f82c1161fd2 | 95 | ISO8859_1, |
WiredHome | 19:3f82c1161fd2 | 96 | ISO8859_2, |
WiredHome | 19:3f82c1161fd2 | 97 | ISO8859_3, |
WiredHome | 19:3f82c1161fd2 | 98 | ISO8859_4 |
WiredHome | 19:3f82c1161fd2 | 99 | } font_t; |
WiredHome | 19:3f82c1161fd2 | 100 | |
WiredHome | 19:3f82c1161fd2 | 101 | /// font rotation selection |
WiredHome | 19:3f82c1161fd2 | 102 | typedef enum |
WiredHome | 19:3f82c1161fd2 | 103 | { |
WiredHome | 19:3f82c1161fd2 | 104 | normal, |
WiredHome | 19:3f82c1161fd2 | 105 | rotated |
WiredHome | 19:3f82c1161fd2 | 106 | } font_angle_t; |
WiredHome | 19:3f82c1161fd2 | 107 | |
WiredHome | 19:3f82c1161fd2 | 108 | /// alignment |
WiredHome | 19:3f82c1161fd2 | 109 | typedef enum |
WiredHome | 19:3f82c1161fd2 | 110 | { |
WiredHome | 19:3f82c1161fd2 | 111 | align_none, |
WiredHome | 19:3f82c1161fd2 | 112 | align_full |
WiredHome | 19:3f82c1161fd2 | 113 | } alignment_t; |
WiredHome | 19:3f82c1161fd2 | 114 | |
WiredHome | 19:3f82c1161fd2 | 115 | /// Scale factor - 1, 2, 3 4 |
WiredHome | 19:3f82c1161fd2 | 116 | typedef unsigned int HorizontalScale; |
WiredHome | 19:3f82c1161fd2 | 117 | |
WiredHome | 19:3f82c1161fd2 | 118 | /// Scale factor - 1, 2, 3, 4 |
WiredHome | 19:3f82c1161fd2 | 119 | typedef unsigned int VerticalScale; |
WiredHome | 19:3f82c1161fd2 | 120 | |
WiredHome | 19:3f82c1161fd2 | 121 | /// Clear screen region |
WiredHome | 19:3f82c1161fd2 | 122 | typedef enum |
WiredHome | 19:3f82c1161fd2 | 123 | { |
WiredHome | 19:3f82c1161fd2 | 124 | FULLWINDOW, |
WiredHome | 19:3f82c1161fd2 | 125 | ACTIVEWINDOW |
WiredHome | 19:3f82c1161fd2 | 126 | } Region_t; |
WiredHome | 19:3f82c1161fd2 | 127 | |
WiredHome | 19:3f82c1161fd2 | 128 | /// Constructor for a display based on the RAiO RA8875 |
WiredHome | 19:3f82c1161fd2 | 129 | /// display controller. |
WiredHome | 19:3f82c1161fd2 | 130 | /// |
WiredHome | 19:3f82c1161fd2 | 131 | /// @param mosi is the SPI master out slave in pin on the mbed. |
WiredHome | 19:3f82c1161fd2 | 132 | /// @param miso is the SPI master in slave out pin on the mbed. |
WiredHome | 19:3f82c1161fd2 | 133 | /// @param sclk is the SPI shift clock pin on the mbed. |
WiredHome | 19:3f82c1161fd2 | 134 | /// @param csel is the DigitalOut pin on the mbed to use as the |
WiredHome | 19:3f82c1161fd2 | 135 | /// active low chip select for the display controller. |
WiredHome | 19:3f82c1161fd2 | 136 | /// @param reset is the DigitalOut pin on the mbed to use as the |
WiredHome | 19:3f82c1161fd2 | 137 | /// active low reset input on the display controller - |
WiredHome | 19:3f82c1161fd2 | 138 | /// but this is not currently used. |
WiredHome | 19:3f82c1161fd2 | 139 | /// @param name is a text name for this object, which will permit |
WiredHome | 19:3f82c1161fd2 | 140 | /// capturing stdout and printf() directly to it. |
WiredHome | 19:3f82c1161fd2 | 141 | /// |
WiredHome | 19:3f82c1161fd2 | 142 | RA8875(PinName mosi, PinName miso, PinName sclk, PinName csel, PinName reset, const char * name = "lcd"); |
WiredHome | 19:3f82c1161fd2 | 143 | |
WiredHome | 23:a50ded45dbaf | 144 | /// Destructor doesn't have much to do as this would typically be created |
WiredHome | 23:a50ded45dbaf | 145 | /// at startup, and not at runtime. |
WiredHome | 19:3f82c1161fd2 | 146 | //~RA8875(); |
WiredHome | 19:3f82c1161fd2 | 147 | |
WiredHome | 19:3f82c1161fd2 | 148 | /// Write a command to the display |
WiredHome | 19:3f82c1161fd2 | 149 | /// |
WiredHome | 19:3f82c1161fd2 | 150 | /// This is a high level command, and may invoke several primitives. |
WiredHome | 19:3f82c1161fd2 | 151 | /// |
WiredHome | 19:3f82c1161fd2 | 152 | /// @param command is the command to write. |
WiredHome | 19:3f82c1161fd2 | 153 | /// @data is optional data to be written to the command register |
WiredHome | 19:3f82c1161fd2 | 154 | /// and only occurs if the data is in the range [0 - 0xFF]. |
WiredHome | 19:3f82c1161fd2 | 155 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 156 | /// |
WiredHome | 19:3f82c1161fd2 | 157 | RetCode_t WriteCommand(unsigned char command, unsigned int data = 0xFFFF); |
WiredHome | 19:3f82c1161fd2 | 158 | |
WiredHome | 19:3f82c1161fd2 | 159 | /// Write a data byte to the display |
WiredHome | 19:3f82c1161fd2 | 160 | /// |
WiredHome | 19:3f82c1161fd2 | 161 | /// This is a high level command, and may invoke several primitives. |
WiredHome | 19:3f82c1161fd2 | 162 | /// |
WiredHome | 19:3f82c1161fd2 | 163 | /// @param data is the data to write. |
WiredHome | 19:3f82c1161fd2 | 164 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 165 | /// |
WiredHome | 19:3f82c1161fd2 | 166 | RetCode_t WriteData(unsigned char data); |
WiredHome | 19:3f82c1161fd2 | 167 | |
WiredHome | 19:3f82c1161fd2 | 168 | /// Read a command register |
WiredHome | 19:3f82c1161fd2 | 169 | /// |
WiredHome | 19:3f82c1161fd2 | 170 | /// @param command is the command register to read. |
WiredHome | 19:3f82c1161fd2 | 171 | /// @returns the value read from the register. |
WiredHome | 19:3f82c1161fd2 | 172 | /// |
WiredHome | 19:3f82c1161fd2 | 173 | unsigned char ReadCommand(unsigned char command); |
WiredHome | 19:3f82c1161fd2 | 174 | |
WiredHome | 19:3f82c1161fd2 | 175 | /// Read a data byte to the display |
WiredHome | 19:3f82c1161fd2 | 176 | /// |
WiredHome | 19:3f82c1161fd2 | 177 | /// This is a high level command, and may invoke several primitives. |
WiredHome | 19:3f82c1161fd2 | 178 | /// |
WiredHome | 19:3f82c1161fd2 | 179 | /// @returns data that was read. |
WiredHome | 19:3f82c1161fd2 | 180 | /// |
WiredHome | 19:3f82c1161fd2 | 181 | unsigned char ReadData(void); |
WiredHome | 19:3f82c1161fd2 | 182 | |
WiredHome | 19:3f82c1161fd2 | 183 | /// Read the display status |
WiredHome | 19:3f82c1161fd2 | 184 | /// |
WiredHome | 19:3f82c1161fd2 | 185 | /// This is a high level command, and may invoke several primitives. |
WiredHome | 19:3f82c1161fd2 | 186 | /// |
WiredHome | 19:3f82c1161fd2 | 187 | /// @returns data that was read. |
WiredHome | 19:3f82c1161fd2 | 188 | /// |
WiredHome | 19:3f82c1161fd2 | 189 | unsigned char ReadStatus(void); |
WiredHome | 19:3f82c1161fd2 | 190 | |
WiredHome | 19:3f82c1161fd2 | 191 | /// get the width in pixels of the currently active font |
WiredHome | 19:3f82c1161fd2 | 192 | /// |
WiredHome | 19:3f82c1161fd2 | 193 | /// @returns font width in pixels. |
WiredHome | 19:3f82c1161fd2 | 194 | /// |
WiredHome | 19:3f82c1161fd2 | 195 | unsigned int fontwidth(void); |
WiredHome | 19:3f82c1161fd2 | 196 | |
WiredHome | 19:3f82c1161fd2 | 197 | /// get the height in pixels of the currently active font |
WiredHome | 19:3f82c1161fd2 | 198 | /// |
WiredHome | 19:3f82c1161fd2 | 199 | /// @returns font height in pixels. |
WiredHome | 19:3f82c1161fd2 | 200 | /// |
WiredHome | 19:3f82c1161fd2 | 201 | unsigned int fontheight(void); |
WiredHome | 19:3f82c1161fd2 | 202 | |
WiredHome | 19:3f82c1161fd2 | 203 | /// get the number of colums based on the currently active font |
WiredHome | 19:3f82c1161fd2 | 204 | /// |
WiredHome | 19:3f82c1161fd2 | 205 | /// @returns number of columns. |
WiredHome | 19:3f82c1161fd2 | 206 | /// |
WiredHome | 19:3f82c1161fd2 | 207 | virtual int columns(void); |
WiredHome | 19:3f82c1161fd2 | 208 | |
WiredHome | 19:3f82c1161fd2 | 209 | /// get the number of rows based on the currently active font |
WiredHome | 19:3f82c1161fd2 | 210 | /// |
WiredHome | 19:3f82c1161fd2 | 211 | /// @returns number of rows. |
WiredHome | 19:3f82c1161fd2 | 212 | /// |
WiredHome | 19:3f82c1161fd2 | 213 | virtual int rows(void); |
WiredHome | 19:3f82c1161fd2 | 214 | |
WiredHome | 19:3f82c1161fd2 | 215 | /// get the screen width in pixels |
WiredHome | 19:3f82c1161fd2 | 216 | /// |
WiredHome | 19:3f82c1161fd2 | 217 | /// @returns screen width in pixels. |
WiredHome | 19:3f82c1161fd2 | 218 | /// |
WiredHome | 19:3f82c1161fd2 | 219 | virtual int width(void); |
WiredHome | 19:3f82c1161fd2 | 220 | |
WiredHome | 19:3f82c1161fd2 | 221 | /// get the screen height in pixels |
WiredHome | 19:3f82c1161fd2 | 222 | /// |
WiredHome | 19:3f82c1161fd2 | 223 | /// @returns screen height in pixels. |
WiredHome | 19:3f82c1161fd2 | 224 | /// |
WiredHome | 19:3f82c1161fd2 | 225 | virtual int height(void); |
WiredHome | 19:3f82c1161fd2 | 226 | |
WiredHome | 19:3f82c1161fd2 | 227 | /// Set cursor position based on the current font size. |
WiredHome | 19:3f82c1161fd2 | 228 | /// |
WiredHome | 19:3f82c1161fd2 | 229 | /// @param x is the horizontal position in character positions |
WiredHome | 19:3f82c1161fd2 | 230 | /// @param y is the vertical position in character positions |
WiredHome | 19:3f82c1161fd2 | 231 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 232 | /// |
WiredHome | 19:3f82c1161fd2 | 233 | virtual RetCode_t locate(unsigned int x, unsigned int y); |
WiredHome | 19:3f82c1161fd2 | 234 | |
WiredHome | 19:3f82c1161fd2 | 235 | /// Prepare the controller to write text to the screen by positioning |
WiredHome | 19:3f82c1161fd2 | 236 | /// the cursor. |
WiredHome | 19:3f82c1161fd2 | 237 | /// |
WiredHome | 19:3f82c1161fd2 | 238 | /// @param x is the horizontal position in pixels (from the left edge) |
WiredHome | 19:3f82c1161fd2 | 239 | /// @param y is the vertical position in pixels (from the top edge) |
WiredHome | 19:3f82c1161fd2 | 240 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 241 | /// |
WiredHome | 19:3f82c1161fd2 | 242 | RetCode_t SetTextCursor(unsigned int x, unsigned int y); |
WiredHome | 19:3f82c1161fd2 | 243 | |
WiredHome | 23:a50ded45dbaf | 244 | /// Configure additional Cursor Control settings. |
WiredHome | 23:a50ded45dbaf | 245 | /// |
WiredHome | 23:a50ded45dbaf | 246 | /// This API lets you modify other cursor control settings; |
WiredHome | 23:a50ded45dbaf | 247 | /// Cursor visible/hidden, Cursor blink/normal, |
WiredHome | 23:a50ded45dbaf | 248 | /// Cursor I-Beam/underscore/box. |
WiredHome | 23:a50ded45dbaf | 249 | /// |
WiredHome | 24:8ca861acf12d | 250 | /// @param cursor can be set to NOCURSOR (default), IBEAM, |
WiredHome | 24:8ca861acf12d | 251 | /// UNDER, or BLOCK. |
WiredHome | 23:a50ded45dbaf | 252 | /// @param blink can be set to true or false (default false) |
WiredHome | 23:a50ded45dbaf | 253 | /// @returns success/failure code. @see RetCode_t |
WiredHome | 23:a50ded45dbaf | 254 | /// |
WiredHome | 24:8ca861acf12d | 255 | RetCode_t SetTextCursorControl(cursor_t cursor = NOCURSOR, bool blink = false); |
WiredHome | 23:a50ded45dbaf | 256 | |
WiredHome | 19:3f82c1161fd2 | 257 | /// Select the ISO 8859-X font to use next. |
WiredHome | 19:3f82c1161fd2 | 258 | /// |
WiredHome | 19:3f82c1161fd2 | 259 | /// Supported fonts: ISO 8859-1, -2, -3, -4 |
WiredHome | 19:3f82c1161fd2 | 260 | /// |
WiredHome | 19:3f82c1161fd2 | 261 | /// @param font selects the font for the subsequent text rendering. |
WiredHome | 19:3f82c1161fd2 | 262 | /// |
WiredHome | 19:3f82c1161fd2 | 263 | /// @note if either hScale or vScale is outside of its permitted range, |
WiredHome | 19:3f82c1161fd2 | 264 | /// the command is not executed. |
WiredHome | 19:3f82c1161fd2 | 265 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 266 | /// |
WiredHome | 19:3f82c1161fd2 | 267 | RetCode_t SetTextFont(font_t font = ISO8859_1); |
WiredHome | 19:3f82c1161fd2 | 268 | |
WiredHome | 19:3f82c1161fd2 | 269 | /// Control the font behavior. |
WiredHome | 19:3f82c1161fd2 | 270 | /// |
WiredHome | 19:3f82c1161fd2 | 271 | /// This command lets you make several modifications to any text that |
WiredHome | 19:3f82c1161fd2 | 272 | /// is written. |
WiredHome | 19:3f82c1161fd2 | 273 | /// |
WiredHome | 19:3f82c1161fd2 | 274 | /// Options can be combined: |
WiredHome | 19:3f82c1161fd2 | 275 | /// Default: |
WiredHome | 19:3f82c1161fd2 | 276 | /// @li Full alignment disabled, |
WiredHome | 19:3f82c1161fd2 | 277 | /// @li Font with Background color, |
WiredHome | 19:3f82c1161fd2 | 278 | /// @li Font in normal orientiation, |
WiredHome | 19:3f82c1161fd2 | 279 | /// @li Horizontal scale x 1 |
WiredHome | 19:3f82c1161fd2 | 280 | /// @li Vertical scale x 1 |
WiredHome | 19:3f82c1161fd2 | 281 | /// @li alignment |
WiredHome | 19:3f82c1161fd2 | 282 | /// |
WiredHome | 19:3f82c1161fd2 | 283 | /// @param fillit defaults to FILL, but can be NOFILL |
WiredHome | 19:3f82c1161fd2 | 284 | /// @param angle defaults to normal, but can be rotated |
WiredHome | 19:3f82c1161fd2 | 285 | /// @param hScale defaults to 1, but can be 1, 2, 3, or 4, |
WiredHome | 19:3f82c1161fd2 | 286 | /// and scales the font size by this amount. |
WiredHome | 19:3f82c1161fd2 | 287 | /// @param vScale defaults to 1, but can be 1, 2, 3, or 4, |
WiredHome | 19:3f82c1161fd2 | 288 | /// and scales the font size by this amount. |
WiredHome | 19:3f82c1161fd2 | 289 | /// @param alignment defaults to align_none, but can be |
WiredHome | 19:3f82c1161fd2 | 290 | /// align_full. |
WiredHome | 19:3f82c1161fd2 | 291 | /// |
WiredHome | 19:3f82c1161fd2 | 292 | /// @note if either hScale or vScale is outside of its permitted range, |
WiredHome | 19:3f82c1161fd2 | 293 | /// the command is not executed. |
WiredHome | 19:3f82c1161fd2 | 294 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 295 | /// |
WiredHome | 19:3f82c1161fd2 | 296 | RetCode_t SetTextFontControl(fill_t fillit = FILL, |
WiredHome | 19:3f82c1161fd2 | 297 | font_angle_t angle = normal, |
WiredHome | 19:3f82c1161fd2 | 298 | HorizontalScale hScale = 1, |
WiredHome | 19:3f82c1161fd2 | 299 | VerticalScale vScale = 1, |
WiredHome | 19:3f82c1161fd2 | 300 | alignment_t alignment = align_none); |
WiredHome | 19:3f82c1161fd2 | 301 | |
WiredHome | 19:3f82c1161fd2 | 302 | /// Control the font size |
WiredHome | 19:3f82c1161fd2 | 303 | /// |
WiredHome | 19:3f82c1161fd2 | 304 | /// This command lets you set the font enlargement for both horizontal |
WiredHome | 19:3f82c1161fd2 | 305 | /// and vertical, independent of the rotation, background, and |
WiredHome | 19:3f82c1161fd2 | 306 | /// alignment. @see SetTextFontControl. |
WiredHome | 19:3f82c1161fd2 | 307 | /// |
WiredHome | 19:3f82c1161fd2 | 308 | /// @param hScale defaults to 1, but can be 1, 2, 3, or 4, |
WiredHome | 19:3f82c1161fd2 | 309 | /// and scales the font size by this amount. |
WiredHome | 19:3f82c1161fd2 | 310 | /// @param vScale defaults to 1, but can be 1, 2, 3, or 4, |
WiredHome | 19:3f82c1161fd2 | 311 | /// and scales the font size by this amount. |
WiredHome | 19:3f82c1161fd2 | 312 | /// |
WiredHome | 19:3f82c1161fd2 | 313 | /// @note if either hScale or vScale is outside of its permitted range, |
WiredHome | 19:3f82c1161fd2 | 314 | /// the command is not executed. |
WiredHome | 19:3f82c1161fd2 | 315 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 316 | /// |
WiredHome | 19:3f82c1161fd2 | 317 | RetCode_t SetTextFontSize(HorizontalScale hScale = 1, VerticalScale vScale = 1); |
WiredHome | 19:3f82c1161fd2 | 318 | |
WiredHome | 19:3f82c1161fd2 | 319 | /// put a character on the screen. |
WiredHome | 19:3f82c1161fd2 | 320 | /// |
WiredHome | 19:3f82c1161fd2 | 321 | /// @param c is the character. |
WiredHome | 19:3f82c1161fd2 | 322 | /// @returns the character, or EOF if there is an error. |
WiredHome | 19:3f82c1161fd2 | 323 | /// |
WiredHome | 19:3f82c1161fd2 | 324 | virtual int _putc(int c); |
WiredHome | 19:3f82c1161fd2 | 325 | |
WiredHome | 19:3f82c1161fd2 | 326 | /// Write string of text to the display |
WiredHome | 19:3f82c1161fd2 | 327 | /// |
WiredHome | 19:3f82c1161fd2 | 328 | /// @param string is the null terminated string to send to the display. |
WiredHome | 19:3f82c1161fd2 | 329 | /// |
WiredHome | 19:3f82c1161fd2 | 330 | void puts(const char * string); |
WiredHome | 19:3f82c1161fd2 | 331 | |
WiredHome | 19:3f82c1161fd2 | 332 | /// Write string of text to the display at the specified location. |
WiredHome | 19:3f82c1161fd2 | 333 | /// |
WiredHome | 19:3f82c1161fd2 | 334 | /// @param x is the horizontal position in pixels (from the left edge) |
WiredHome | 19:3f82c1161fd2 | 335 | /// @param y is the vertical position in pixels (from the top edge) |
WiredHome | 19:3f82c1161fd2 | 336 | /// @param string is the null terminated string to send to the display. |
WiredHome | 19:3f82c1161fd2 | 337 | /// |
WiredHome | 19:3f82c1161fd2 | 338 | void puts(unsigned int x, unsigned int y, const char * string); |
WiredHome | 19:3f82c1161fd2 | 339 | |
WiredHome | 19:3f82c1161fd2 | 340 | /// Prepare the controller to write binary data to the screen by positioning |
WiredHome | 19:3f82c1161fd2 | 341 | /// the memory cursor. |
WiredHome | 19:3f82c1161fd2 | 342 | /// |
WiredHome | 19:3f82c1161fd2 | 343 | /// @param x is the horizontal position in pixels (from the left edge) |
WiredHome | 19:3f82c1161fd2 | 344 | /// @param y is the vertical position in pixels (from the top edge) |
WiredHome | 19:3f82c1161fd2 | 345 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 346 | /// |
WiredHome | 19:3f82c1161fd2 | 347 | RetCode_t SetMemoryCursor(unsigned int x, unsigned int y); |
WiredHome | 19:3f82c1161fd2 | 348 | |
WiredHome | 19:3f82c1161fd2 | 349 | /// Set the window, which controls where items are written to the screen. |
WiredHome | 19:3f82c1161fd2 | 350 | /// |
WiredHome | 19:3f82c1161fd2 | 351 | /// When something hits the window width, it wraps back to the left side |
WiredHome | 19:3f82c1161fd2 | 352 | /// and down a row. If the initial write is outside the window, it will |
WiredHome | 19:3f82c1161fd2 | 353 | /// be captured into the window when it crosses a boundary. |
WiredHome | 19:3f82c1161fd2 | 354 | /// |
WiredHome | 19:3f82c1161fd2 | 355 | /// @param x is the left edge in pixels. |
WiredHome | 19:3f82c1161fd2 | 356 | /// @param y is the top edge in pixels. |
WiredHome | 19:3f82c1161fd2 | 357 | /// @param width is the window width in pixels. |
WiredHome | 19:3f82c1161fd2 | 358 | /// @param height is the window height in pixels. |
WiredHome | 19:3f82c1161fd2 | 359 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 360 | /// |
WiredHome | 19:3f82c1161fd2 | 361 | RetCode_t SetWindow(unsigned int x, unsigned int y, unsigned int width, unsigned int height); |
WiredHome | 19:3f82c1161fd2 | 362 | |
WiredHome | 19:3f82c1161fd2 | 363 | /// Clear the screen. |
WiredHome | 19:3f82c1161fd2 | 364 | /// |
WiredHome | 19:3f82c1161fd2 | 365 | /// The behavior is to clear the whole screen. @see clsw(). |
WiredHome | 19:3f82c1161fd2 | 366 | /// |
WiredHome | 19:3f82c1161fd2 | 367 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 368 | /// |
WiredHome | 19:3f82c1161fd2 | 369 | virtual RetCode_t cls(void); |
WiredHome | 19:3f82c1161fd2 | 370 | |
WiredHome | 19:3f82c1161fd2 | 371 | /// Clear the screen, or clear only the active window. |
WiredHome | 19:3f82c1161fd2 | 372 | /// |
WiredHome | 19:3f82c1161fd2 | 373 | /// The default behavior is to clear the whole screen. With the optional |
WiredHome | 19:3f82c1161fd2 | 374 | /// parameter, the action can be restricted to the active window, which |
WiredHome | 19:3f82c1161fd2 | 375 | /// can be set with the @see SetWindow method. |
WiredHome | 19:3f82c1161fd2 | 376 | /// |
WiredHome | 19:3f82c1161fd2 | 377 | /// @param region is an optional parameter that defaults to FULLWINDOW |
WiredHome | 19:3f82c1161fd2 | 378 | /// or may be set to ACTIVEWINDOW. |
WiredHome | 19:3f82c1161fd2 | 379 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 380 | /// |
WiredHome | 19:3f82c1161fd2 | 381 | RetCode_t clsw(RA8875::Region_t region = FULLWINDOW); |
WiredHome | 19:3f82c1161fd2 | 382 | |
WiredHome | 19:3f82c1161fd2 | 383 | /// Set the background color. |
WiredHome | 19:3f82c1161fd2 | 384 | /// |
WiredHome | 19:3f82c1161fd2 | 385 | /// @param color is expressed in 16-bit format. |
WiredHome | 19:3f82c1161fd2 | 386 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 387 | /// |
WiredHome | 19:3f82c1161fd2 | 388 | virtual RetCode_t background(color_t color); |
WiredHome | 19:3f82c1161fd2 | 389 | |
WiredHome | 19:3f82c1161fd2 | 390 | /// Set the background color. |
WiredHome | 19:3f82c1161fd2 | 391 | /// |
WiredHome | 19:3f82c1161fd2 | 392 | /// @param r is the red element of the color. |
WiredHome | 19:3f82c1161fd2 | 393 | /// @param g is the green element of the color. |
WiredHome | 19:3f82c1161fd2 | 394 | /// @param b is the blue element of the color. |
WiredHome | 19:3f82c1161fd2 | 395 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 396 | /// |
WiredHome | 19:3f82c1161fd2 | 397 | virtual RetCode_t background(unsigned char r, unsigned char g, unsigned char b); |
WiredHome | 19:3f82c1161fd2 | 398 | |
WiredHome | 19:3f82c1161fd2 | 399 | /// Set the foreground color. |
WiredHome | 19:3f82c1161fd2 | 400 | /// |
WiredHome | 19:3f82c1161fd2 | 401 | /// @param color is expressed in 16-bit format. |
WiredHome | 19:3f82c1161fd2 | 402 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 403 | /// |
WiredHome | 19:3f82c1161fd2 | 404 | virtual RetCode_t foreground(color_t color); |
WiredHome | 19:3f82c1161fd2 | 405 | |
WiredHome | 19:3f82c1161fd2 | 406 | /// Set the foreground color. |
WiredHome | 19:3f82c1161fd2 | 407 | /// |
WiredHome | 19:3f82c1161fd2 | 408 | /// @param R is the red element of the color. |
WiredHome | 19:3f82c1161fd2 | 409 | /// @param G is the green element of the color. |
WiredHome | 19:3f82c1161fd2 | 410 | /// @param B is the blue element of the color. |
WiredHome | 19:3f82c1161fd2 | 411 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 412 | /// |
WiredHome | 19:3f82c1161fd2 | 413 | virtual RetCode_t foreground(unsigned char R, unsigned char G, unsigned char B); |
WiredHome | 19:3f82c1161fd2 | 414 | |
WiredHome | 19:3f82c1161fd2 | 415 | /// Get the current foreground color value. |
WiredHome | 19:3f82c1161fd2 | 416 | /// |
WiredHome | 19:3f82c1161fd2 | 417 | /// @returns the current foreground color. |
WiredHome | 19:3f82c1161fd2 | 418 | /// |
WiredHome | 19:3f82c1161fd2 | 419 | unsigned int GetForeColor(void); |
WiredHome | 19:3f82c1161fd2 | 420 | |
WiredHome | 19:3f82c1161fd2 | 421 | /// Draw a pixel in the specified color. |
WiredHome | 19:3f82c1161fd2 | 422 | /// |
WiredHome | 19:3f82c1161fd2 | 423 | /// @note As a side effect, this also sets the foreground color |
WiredHome | 19:3f82c1161fd2 | 424 | /// affecting all subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 425 | /// |
WiredHome | 19:3f82c1161fd2 | 426 | /// @param x is the horizontal offset to this pixel. |
WiredHome | 19:3f82c1161fd2 | 427 | /// @param y is the vertical offset to this pixel. |
WiredHome | 19:3f82c1161fd2 | 428 | /// @param color defines the color for the pixel. |
WiredHome | 19:3f82c1161fd2 | 429 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 430 | /// |
WiredHome | 19:3f82c1161fd2 | 431 | virtual RetCode_t pixel(unsigned int x, unsigned int y, color_t color); |
WiredHome | 19:3f82c1161fd2 | 432 | |
WiredHome | 19:3f82c1161fd2 | 433 | /// Draw a pixel in the current foreground color. |
WiredHome | 19:3f82c1161fd2 | 434 | /// |
WiredHome | 19:3f82c1161fd2 | 435 | /// @param x is the horizontal offset to this pixel. |
WiredHome | 19:3f82c1161fd2 | 436 | /// @param y is the veritical offset to this pixel. |
WiredHome | 19:3f82c1161fd2 | 437 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 438 | /// |
WiredHome | 19:3f82c1161fd2 | 439 | virtual RetCode_t pixel(unsigned int x, unsigned int y); |
WiredHome | 19:3f82c1161fd2 | 440 | |
WiredHome | 19:3f82c1161fd2 | 441 | /// Draw a line in the specified color |
WiredHome | 19:3f82c1161fd2 | 442 | /// |
WiredHome | 19:3f82c1161fd2 | 443 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 444 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 445 | /// |
WiredHome | 19:3f82c1161fd2 | 446 | /// @param x1 is the horizontal start of the line. |
WiredHome | 19:3f82c1161fd2 | 447 | /// @param y1 is the vertical start of the line. |
WiredHome | 19:3f82c1161fd2 | 448 | /// @param x2 is the horizontal end of the line. |
WiredHome | 19:3f82c1161fd2 | 449 | /// @param y2 is the vertical end of the line. |
WiredHome | 19:3f82c1161fd2 | 450 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 451 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 452 | /// |
WiredHome | 19:3f82c1161fd2 | 453 | RetCode_t line(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 454 | color_t color); |
WiredHome | 19:3f82c1161fd2 | 455 | |
WiredHome | 19:3f82c1161fd2 | 456 | /// Draw a line |
WiredHome | 19:3f82c1161fd2 | 457 | /// |
WiredHome | 19:3f82c1161fd2 | 458 | /// Draws a line using the foreground color setting. |
WiredHome | 19:3f82c1161fd2 | 459 | /// |
WiredHome | 19:3f82c1161fd2 | 460 | /// @param x1 is the horizontal start of the line. |
WiredHome | 19:3f82c1161fd2 | 461 | /// @param y1 is the vertical start of the line. |
WiredHome | 19:3f82c1161fd2 | 462 | /// @param x2 is the horizontal end of the line. |
WiredHome | 19:3f82c1161fd2 | 463 | /// @param y2 is the vertical end of the line. |
WiredHome | 19:3f82c1161fd2 | 464 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 465 | /// |
WiredHome | 19:3f82c1161fd2 | 466 | RetCode_t line(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2); |
WiredHome | 19:3f82c1161fd2 | 467 | |
WiredHome | 19:3f82c1161fd2 | 468 | /// Draw a rectangle in the specified color |
WiredHome | 19:3f82c1161fd2 | 469 | /// |
WiredHome | 19:3f82c1161fd2 | 470 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 471 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 472 | /// |
WiredHome | 19:3f82c1161fd2 | 473 | /// @param x1 is the horizontal start of the line. |
WiredHome | 19:3f82c1161fd2 | 474 | /// @param y1 is the vertical start of the line. |
WiredHome | 19:3f82c1161fd2 | 475 | /// @param x2 is the horizontal end of the line. |
WiredHome | 19:3f82c1161fd2 | 476 | /// @param y2 is the vertical end of the line. |
WiredHome | 19:3f82c1161fd2 | 477 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 478 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 479 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 480 | /// |
WiredHome | 19:3f82c1161fd2 | 481 | RetCode_t rect(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 482 | color_t color, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 483 | |
WiredHome | 19:3f82c1161fd2 | 484 | /// Draw a filled rectangle in the specified color |
WiredHome | 19:3f82c1161fd2 | 485 | /// |
WiredHome | 19:3f82c1161fd2 | 486 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 487 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 488 | /// |
WiredHome | 19:3f82c1161fd2 | 489 | /// @param x1 is the horizontal start of the line. |
WiredHome | 19:3f82c1161fd2 | 490 | /// @param y1 is the vertical start of the line. |
WiredHome | 19:3f82c1161fd2 | 491 | /// @param x2 is the horizontal end of the line. |
WiredHome | 19:3f82c1161fd2 | 492 | /// @param y2 is the vertical end of the line. |
WiredHome | 19:3f82c1161fd2 | 493 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 494 | /// @param fillit is optional to NOFILL the rectangle. default is FILL. |
WiredHome | 19:3f82c1161fd2 | 495 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 496 | /// |
WiredHome | 19:3f82c1161fd2 | 497 | RetCode_t fillrect(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 498 | color_t color, fill_t fillit = FILL); |
WiredHome | 19:3f82c1161fd2 | 499 | |
WiredHome | 19:3f82c1161fd2 | 500 | /// Draw a rectangle |
WiredHome | 19:3f82c1161fd2 | 501 | /// |
WiredHome | 19:3f82c1161fd2 | 502 | /// Draws a rectangle using the foreground color setting. |
WiredHome | 19:3f82c1161fd2 | 503 | /// |
WiredHome | 19:3f82c1161fd2 | 504 | /// @param x1 is the horizontal start of the line. |
WiredHome | 19:3f82c1161fd2 | 505 | /// @param y1 is the vertical start of the line. |
WiredHome | 19:3f82c1161fd2 | 506 | /// @param x2 is the horizontal end of the line. |
WiredHome | 19:3f82c1161fd2 | 507 | /// @param y2 is the vertical end of the line. |
WiredHome | 19:3f82c1161fd2 | 508 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 509 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 510 | /// |
WiredHome | 19:3f82c1161fd2 | 511 | RetCode_t rect(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 512 | fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 513 | |
WiredHome | 19:3f82c1161fd2 | 514 | /// Draw a filled rectangle with rounded corners using the specified color. |
WiredHome | 19:3f82c1161fd2 | 515 | /// |
WiredHome | 21:3c1efb192927 | 516 | /// This draws a rounded rectangle. A numbers of checks are made on the values, |
WiredHome | 21:3c1efb192927 | 517 | /// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2), |
WiredHome | 21:3c1efb192927 | 518 | /// or a single point (x1 == x2 && y1 == y2). If the radius parameters are |
WiredHome | 21:3c1efb192927 | 519 | /// > 1/2 the length of that side (width or height), an error value is returned. |
WiredHome | 21:3c1efb192927 | 520 | /// |
WiredHome | 19:3f82c1161fd2 | 521 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 522 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 523 | /// |
WiredHome | 21:3c1efb192927 | 524 | /// @param x1 is the horizontal start of the line and must be <= x2. |
WiredHome | 21:3c1efb192927 | 525 | /// @param y1 is the vertical start of the line and must be <= y2. |
WiredHome | 21:3c1efb192927 | 526 | /// @param x2 is the horizontal end of the line and must be >= x1. |
WiredHome | 21:3c1efb192927 | 527 | /// @param y2 is the vertical end of the line and must be >= y1. |
WiredHome | 22:f6ea795eb541 | 528 | /// @param radius1 defines the horizontal radius of the curved corner. Take care |
WiredHome | 21:3c1efb192927 | 529 | /// that this value < 1/2 the width of the rectangle, or bad_parameter |
WiredHome | 21:3c1efb192927 | 530 | /// is returned. |
WiredHome | 22:f6ea795eb541 | 531 | /// @param radius2 defines the vertical radius of the curved corner. Take care |
WiredHome | 21:3c1efb192927 | 532 | /// that this value < 1/2 the height of the rectangle, or bad_parameter |
WiredHome | 21:3c1efb192927 | 533 | /// is returned. |
WiredHome | 19:3f82c1161fd2 | 534 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 535 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 536 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 537 | /// |
WiredHome | 19:3f82c1161fd2 | 538 | RetCode_t fillroundrect(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 539 | unsigned int radius1, unsigned int radius2, color_t color, fill_t fillit = FILL); |
WiredHome | 19:3f82c1161fd2 | 540 | |
WiredHome | 19:3f82c1161fd2 | 541 | /// Draw a rectangle with rounded corners using the specified color. |
WiredHome | 19:3f82c1161fd2 | 542 | /// |
WiredHome | 21:3c1efb192927 | 543 | /// This draws a rounded rectangle. A numbers of checks are made on the values, |
WiredHome | 21:3c1efb192927 | 544 | /// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2), |
WiredHome | 21:3c1efb192927 | 545 | /// or a single point (x1 == x2 && y1 == y2). If the radius parameters are |
WiredHome | 21:3c1efb192927 | 546 | /// > 1/2 the length of that side (width or height), an error value is returned. |
WiredHome | 21:3c1efb192927 | 547 | /// |
WiredHome | 19:3f82c1161fd2 | 548 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 549 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 550 | /// |
WiredHome | 21:3c1efb192927 | 551 | /// @param x1 is the horizontal start of the line and must be <= x2. |
WiredHome | 21:3c1efb192927 | 552 | /// @param y1 is the vertical start of the line and must be <= y2. |
WiredHome | 21:3c1efb192927 | 553 | /// @param x2 is the horizontal end of the line and must be >= x1. |
WiredHome | 21:3c1efb192927 | 554 | /// @param y2 is the vertical end of the line and must be >= y1. |
WiredHome | 22:f6ea795eb541 | 555 | /// @param radius1 defines the horizontal radius of the curved corner. Take care |
WiredHome | 21:3c1efb192927 | 556 | /// that this value < 1/2 the width of the rectangle, or bad_parameter |
WiredHome | 21:3c1efb192927 | 557 | /// is returned. |
WiredHome | 22:f6ea795eb541 | 558 | /// @param radius2 defines the vertical radius of the curved corner. Take care |
WiredHome | 21:3c1efb192927 | 559 | /// that this value < 1/2 the height of the rectangle, or bad_parameter |
WiredHome | 21:3c1efb192927 | 560 | /// is returned. |
WiredHome | 19:3f82c1161fd2 | 561 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 562 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 563 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 564 | /// |
WiredHome | 19:3f82c1161fd2 | 565 | RetCode_t roundrect(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 566 | unsigned int radius1, unsigned int radius2, color_t color, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 567 | |
WiredHome | 19:3f82c1161fd2 | 568 | /// Draw a rectangle with rounded corners. |
WiredHome | 19:3f82c1161fd2 | 569 | /// |
WiredHome | 21:3c1efb192927 | 570 | /// This draws a rounded rectangle. A numbers of checks are made on the values, |
WiredHome | 21:3c1efb192927 | 571 | /// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2), |
WiredHome | 21:3c1efb192927 | 572 | /// or a single point (x1 == x2 && y1 == y2). If the radius parameters are |
WiredHome | 21:3c1efb192927 | 573 | /// > 1/2 the length of that side (width or height), an error value is returned. |
WiredHome | 19:3f82c1161fd2 | 574 | /// |
WiredHome | 21:3c1efb192927 | 575 | /// @param x1 is the horizontal start of the line and must be <= x2. |
WiredHome | 21:3c1efb192927 | 576 | /// @param y1 is the vertical start of the line and must be <= y2. |
WiredHome | 21:3c1efb192927 | 577 | /// @param x2 is the horizontal end of the line and must be >= x1. |
WiredHome | 21:3c1efb192927 | 578 | /// @param y2 is the vertical end of the line and must be >= y1. |
WiredHome | 22:f6ea795eb541 | 579 | /// @param radius1 defines the horizontal radius of the curved corner. Take care |
WiredHome | 21:3c1efb192927 | 580 | /// that this value < 1/2 the width of the rectangle, or bad_parameter |
WiredHome | 21:3c1efb192927 | 581 | /// is returned. |
WiredHome | 22:f6ea795eb541 | 582 | /// @param radius2 defines the vertical radius of the curved corner. Take care |
WiredHome | 21:3c1efb192927 | 583 | /// that this value < 1/2 the height of the rectangle, or bad_parameter |
WiredHome | 21:3c1efb192927 | 584 | /// is returned. |
WiredHome | 19:3f82c1161fd2 | 585 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 586 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 587 | /// |
WiredHome | 19:3f82c1161fd2 | 588 | RetCode_t roundrect(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 589 | unsigned int radius1, unsigned int radius2, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 590 | |
WiredHome | 19:3f82c1161fd2 | 591 | /// Draw a triangle in the specified color. |
WiredHome | 19:3f82c1161fd2 | 592 | /// |
WiredHome | 19:3f82c1161fd2 | 593 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 594 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 595 | /// |
WiredHome | 19:3f82c1161fd2 | 596 | /// @param x1 is the horizontal for point 1. |
WiredHome | 21:3c1efb192927 | 597 | /// @param y1 is the vertical for point 1. |
WiredHome | 19:3f82c1161fd2 | 598 | /// @param x2 is the horizontal for point 2. |
WiredHome | 19:3f82c1161fd2 | 599 | /// @param y2 is the vertical for point 2. |
WiredHome | 19:3f82c1161fd2 | 600 | /// @param x3 is the horizontal for point 3. |
WiredHome | 19:3f82c1161fd2 | 601 | /// @param y3 is the vertical for point 3. |
WiredHome | 19:3f82c1161fd2 | 602 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 603 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 604 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 605 | /// |
WiredHome | 19:3f82c1161fd2 | 606 | RetCode_t triangle(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 607 | unsigned int x3, unsigned int y3, color_t color, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 608 | |
WiredHome | 19:3f82c1161fd2 | 609 | /// Draw a filled triangle in the specified color. |
WiredHome | 19:3f82c1161fd2 | 610 | /// |
WiredHome | 19:3f82c1161fd2 | 611 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 612 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 613 | /// |
WiredHome | 19:3f82c1161fd2 | 614 | /// @param x1 is the horizontal for point 1. |
WiredHome | 19:3f82c1161fd2 | 615 | /// @param y1 is the vertical for point 1. |
WiredHome | 19:3f82c1161fd2 | 616 | /// @param x2 is the horizontal for point 2. |
WiredHome | 19:3f82c1161fd2 | 617 | /// @param y2 is the vertical for point 2. |
WiredHome | 19:3f82c1161fd2 | 618 | /// @param x3 is the horizontal for point 3. |
WiredHome | 19:3f82c1161fd2 | 619 | /// @param y3 is the vertical for point 3. |
WiredHome | 19:3f82c1161fd2 | 620 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 621 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 622 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 623 | /// |
WiredHome | 19:3f82c1161fd2 | 624 | RetCode_t filltriangle(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 625 | unsigned int x3, unsigned int y3, color_t color, fill_t fillit = FILL); |
WiredHome | 19:3f82c1161fd2 | 626 | |
WiredHome | 19:3f82c1161fd2 | 627 | /// Draw a triangle |
WiredHome | 19:3f82c1161fd2 | 628 | /// |
WiredHome | 19:3f82c1161fd2 | 629 | /// Draws a triangle using the foreground color setting. |
WiredHome | 19:3f82c1161fd2 | 630 | /// |
WiredHome | 19:3f82c1161fd2 | 631 | /// @param x1 is the horizontal for point 1. |
WiredHome | 19:3f82c1161fd2 | 632 | /// @param y1 is the vertical for point 1. |
WiredHome | 19:3f82c1161fd2 | 633 | /// @param x2 is the horizontal for point 2. |
WiredHome | 19:3f82c1161fd2 | 634 | /// @param y2 is the vertical for point 2. |
WiredHome | 19:3f82c1161fd2 | 635 | /// @param x3 is the horizontal for point 3. |
WiredHome | 19:3f82c1161fd2 | 636 | /// @param y3 is the vertical for point 3. |
WiredHome | 19:3f82c1161fd2 | 637 | /// @param fillit is optional to FILL the rectangle. default is NOFILL. |
WiredHome | 19:3f82c1161fd2 | 638 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 639 | /// |
WiredHome | 19:3f82c1161fd2 | 640 | RetCode_t triangle(unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, |
WiredHome | 19:3f82c1161fd2 | 641 | unsigned int x3, unsigned int y3, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 642 | |
WiredHome | 19:3f82c1161fd2 | 643 | /// Draw a circle using the specified color. |
WiredHome | 19:3f82c1161fd2 | 644 | /// |
WiredHome | 19:3f82c1161fd2 | 645 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 646 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 647 | /// |
WiredHome | 19:3f82c1161fd2 | 648 | /// @param x is the horizontal center of the circle. |
WiredHome | 19:3f82c1161fd2 | 649 | /// @param y is the vertical center of the circle. |
WiredHome | 19:3f82c1161fd2 | 650 | /// @param radius defines the size of the circle. |
WiredHome | 19:3f82c1161fd2 | 651 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 652 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 653 | /// |
WiredHome | 19:3f82c1161fd2 | 654 | RetCode_t circle(unsigned int x, unsigned int y, unsigned int radius, color_t color, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 655 | |
WiredHome | 19:3f82c1161fd2 | 656 | /// Draw a filled circle using the specified color. |
WiredHome | 19:3f82c1161fd2 | 657 | /// |
WiredHome | 19:3f82c1161fd2 | 658 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 659 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 660 | /// |
WiredHome | 19:3f82c1161fd2 | 661 | /// @param x is the horizontal center of the circle. |
WiredHome | 19:3f82c1161fd2 | 662 | /// @param y is the vertical center of the circle. |
WiredHome | 19:3f82c1161fd2 | 663 | /// @param radius defines the size of the circle. |
WiredHome | 19:3f82c1161fd2 | 664 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 665 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 666 | /// |
WiredHome | 19:3f82c1161fd2 | 667 | RetCode_t fillcircle(unsigned int x, unsigned int y, unsigned int radius, color_t color, fill_t fillit = FILL); |
WiredHome | 19:3f82c1161fd2 | 668 | |
WiredHome | 19:3f82c1161fd2 | 669 | /// Draw a circle. |
WiredHome | 19:3f82c1161fd2 | 670 | /// |
WiredHome | 19:3f82c1161fd2 | 671 | /// Draws a circle using the foreground color setting. |
WiredHome | 19:3f82c1161fd2 | 672 | /// |
WiredHome | 19:3f82c1161fd2 | 673 | /// @param x is the horizontal center of the circle. |
WiredHome | 19:3f82c1161fd2 | 674 | /// @param y is the vertical center of the circle. |
WiredHome | 19:3f82c1161fd2 | 675 | /// @param radius defines the size of the circle. |
WiredHome | 19:3f82c1161fd2 | 676 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 677 | /// |
WiredHome | 19:3f82c1161fd2 | 678 | RetCode_t circle(unsigned int x, unsigned int y, unsigned int radius, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 679 | |
WiredHome | 19:3f82c1161fd2 | 680 | /// Draw an Ellipse using the specified color |
WiredHome | 19:3f82c1161fd2 | 681 | /// |
WiredHome | 19:3f82c1161fd2 | 682 | /// @note As a side effect, this changes the current |
WiredHome | 19:3f82c1161fd2 | 683 | /// foreground color for subsequent operations. |
WiredHome | 19:3f82c1161fd2 | 684 | /// |
WiredHome | 19:3f82c1161fd2 | 685 | /// @param x is the horizontal center of the ellipse. |
WiredHome | 19:3f82c1161fd2 | 686 | /// @param y is the vertical center of the ellipse. |
WiredHome | 22:f6ea795eb541 | 687 | /// @param radius1 defines the horizontal radius of the ellipse. |
WiredHome | 22:f6ea795eb541 | 688 | /// @param radius2 defines the vertical radius of the ellipse. |
WiredHome | 19:3f82c1161fd2 | 689 | /// @param color defines the foreground color. |
WiredHome | 19:3f82c1161fd2 | 690 | /// @param fillit defines whether the circle is filled or not. |
WiredHome | 19:3f82c1161fd2 | 691 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 692 | /// |
WiredHome | 19:3f82c1161fd2 | 693 | RetCode_t ellipse(unsigned int x, unsigned int y, unsigned int radius1, unsigned int radius1, |
WiredHome | 19:3f82c1161fd2 | 694 | color_t color, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 695 | |
WiredHome | 19:3f82c1161fd2 | 696 | /// Draw an Ellipse |
WiredHome | 19:3f82c1161fd2 | 697 | /// |
WiredHome | 19:3f82c1161fd2 | 698 | /// Draws it using the foreground color setting. |
WiredHome | 19:3f82c1161fd2 | 699 | /// |
WiredHome | 19:3f82c1161fd2 | 700 | /// @param x is the horizontal center of the ellipse. |
WiredHome | 19:3f82c1161fd2 | 701 | /// @param y is the vertical center of the ellipse. |
WiredHome | 22:f6ea795eb541 | 702 | /// @param radius1 defines the horizontal radius of the ellipse. |
WiredHome | 22:f6ea795eb541 | 703 | /// @param radius2 defines the vertical radius of the ellipse. |
WiredHome | 19:3f82c1161fd2 | 704 | /// @param fillit defines whether the circle is filled or not. |
WiredHome | 19:3f82c1161fd2 | 705 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 706 | /// |
WiredHome | 19:3f82c1161fd2 | 707 | RetCode_t ellipse(unsigned int x, unsigned int y, unsigned int radius1, unsigned int radius1, fill_t fillit = NOFILL); |
WiredHome | 19:3f82c1161fd2 | 708 | |
WiredHome | 19:3f82c1161fd2 | 709 | /// Control display power |
WiredHome | 19:3f82c1161fd2 | 710 | /// |
WiredHome | 19:3f82c1161fd2 | 711 | /// @param on when set to true will turn on the display, when false it is turned off. |
WiredHome | 19:3f82c1161fd2 | 712 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 713 | /// |
WiredHome | 19:3f82c1161fd2 | 714 | RetCode_t Power(bool on); |
WiredHome | 19:3f82c1161fd2 | 715 | |
WiredHome | 19:3f82c1161fd2 | 716 | /// Reset the display controller via the Software Reset interface. |
WiredHome | 19:3f82c1161fd2 | 717 | /// |
WiredHome | 19:3f82c1161fd2 | 718 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 719 | /// |
WiredHome | 19:3f82c1161fd2 | 720 | RetCode_t Reset(void); |
WiredHome | 19:3f82c1161fd2 | 721 | |
WiredHome | 19:3f82c1161fd2 | 722 | /// Set backlight brightness. |
WiredHome | 19:3f82c1161fd2 | 723 | /// |
WiredHome | 19:3f82c1161fd2 | 724 | /// When the built-in PWM is used to control the backlight, this |
WiredHome | 19:3f82c1161fd2 | 725 | /// API can be used to set the brightness. |
WiredHome | 19:3f82c1161fd2 | 726 | /// |
WiredHome | 19:3f82c1161fd2 | 727 | /// @param brightness ranges from 0 (off) to 255 (full on) |
WiredHome | 19:3f82c1161fd2 | 728 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 729 | /// |
WiredHome | 19:3f82c1161fd2 | 730 | RetCode_t Backlight_u8(unsigned char brightness); |
WiredHome | 19:3f82c1161fd2 | 731 | |
WiredHome | 19:3f82c1161fd2 | 732 | /// Set backlight brightness. |
WiredHome | 19:3f82c1161fd2 | 733 | /// |
WiredHome | 19:3f82c1161fd2 | 734 | /// When the built-in PWM is used to control the backlight, this |
WiredHome | 19:3f82c1161fd2 | 735 | /// API can be used to set the brightness. |
WiredHome | 19:3f82c1161fd2 | 736 | /// |
WiredHome | 19:3f82c1161fd2 | 737 | /// @param brightness ranges from 0.0 (off) to 1.0 (full on) |
WiredHome | 19:3f82c1161fd2 | 738 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 739 | /// |
WiredHome | 19:3f82c1161fd2 | 740 | RetCode_t Backlight(float brightness); |
WiredHome | 19:3f82c1161fd2 | 741 | |
WiredHome | 19:3f82c1161fd2 | 742 | /// Set a reference to a bitmap font, provided by the user. |
WiredHome | 19:3f82c1161fd2 | 743 | /// |
WiredHome | 19:3f82c1161fd2 | 744 | /// @note Tool to create the fonts is accessible from its creator |
WiredHome | 19:3f82c1161fd2 | 745 | /// available at http://www.mikroe.com. |
WiredHome | 19:3f82c1161fd2 | 746 | /// Change the data to an array of type char[]. |
WiredHome | 19:3f82c1161fd2 | 747 | /// |
WiredHome | 19:3f82c1161fd2 | 748 | /// @param font is a pointer to a specially formed font array. |
WiredHome | 19:3f82c1161fd2 | 749 | /// This special font array has a 4-byte header, followed by |
WiredHome | 19:3f82c1161fd2 | 750 | /// the data: |
WiredHome | 19:3f82c1161fd2 | 751 | /// - the number of bytes per char |
WiredHome | 19:3f82c1161fd2 | 752 | /// - the vertical size in pixels for each character |
WiredHome | 19:3f82c1161fd2 | 753 | /// - the horizontal size in pixels for each character |
WiredHome | 19:3f82c1161fd2 | 754 | /// - the number of bytes per vertical line (width of the array) |
WiredHome | 19:3f82c1161fd2 | 755 | /// @returns error code. |
WiredHome | 19:3f82c1161fd2 | 756 | /// |
WiredHome | 19:3f82c1161fd2 | 757 | RetCode_t set_font(const unsigned char * font); |
WiredHome | 19:3f82c1161fd2 | 758 | |
WiredHome | 19:3f82c1161fd2 | 759 | /// Get the RGB value for a DOS color. |
WiredHome | 19:3f82c1161fd2 | 760 | /// |
WiredHome | 19:3f82c1161fd2 | 761 | /// @param i is the color, in the range 0 to 15; |
WiredHome | 19:3f82c1161fd2 | 762 | /// @returns the RGB color of the selected index, or 0 |
WiredHome | 19:3f82c1161fd2 | 763 | /// if the index is out of bounds. |
WiredHome | 19:3f82c1161fd2 | 764 | /// |
WiredHome | 19:3f82c1161fd2 | 765 | color_t DOSColor(int i); |
WiredHome | 19:3f82c1161fd2 | 766 | |
WiredHome | 19:3f82c1161fd2 | 767 | /// Get the color name (string) for a DOS color. |
WiredHome | 19:3f82c1161fd2 | 768 | /// |
WiredHome | 19:3f82c1161fd2 | 769 | /// @param i is the color, in the range 0 to 15; |
WiredHome | 19:3f82c1161fd2 | 770 | /// @returns a pointer to a string with the color name, |
WiredHome | 19:3f82c1161fd2 | 771 | /// or NULL if the index is out of bounds. |
WiredHome | 19:3f82c1161fd2 | 772 | /// |
WiredHome | 19:3f82c1161fd2 | 773 | const char * DOSColorNames(int i); |
WiredHome | 19:3f82c1161fd2 | 774 | |
WiredHome | 19:3f82c1161fd2 | 775 | |
WiredHome | 19:3f82c1161fd2 | 776 | #ifdef PERF_METRICS |
WiredHome | 19:3f82c1161fd2 | 777 | /// Clear the performance metrics to zero. |
WiredHome | 19:3f82c1161fd2 | 778 | void ClearPerformance(); |
WiredHome | 19:3f82c1161fd2 | 779 | |
WiredHome | 19:3f82c1161fd2 | 780 | /// Report the performance metrics for drawing functions using |
WiredHome | 19:3f82c1161fd2 | 781 | /// printf() |
WiredHome | 19:3f82c1161fd2 | 782 | void ReportPerformance(); |
WiredHome | 19:3f82c1161fd2 | 783 | #endif |
WiredHome | 19:3f82c1161fd2 | 784 | |
WiredHome | 19:3f82c1161fd2 | 785 | private: |
WiredHome | 19:3f82c1161fd2 | 786 | /// Set the SPI port frequency (in Hz). |
WiredHome | 19:3f82c1161fd2 | 787 | /// |
WiredHome | 19:3f82c1161fd2 | 788 | /// @note attempts to call this API at runtime, with the display |
WiredHome | 19:3f82c1161fd2 | 789 | /// already online, cause the system to lockup. |
WiredHome | 19:3f82c1161fd2 | 790 | /// Not sure why, so moving this to private to run once. |
WiredHome | 19:3f82c1161fd2 | 791 | /// |
WiredHome | 19:3f82c1161fd2 | 792 | /// This uses the mbed SPI driver, and is therefore dependent on |
WiredHome | 19:3f82c1161fd2 | 793 | /// its capabilities. Limited tests were performed for the display |
WiredHome | 19:3f82c1161fd2 | 794 | /// in the range of 1,000,000 to 50,000,000 Hz. The display was |
WiredHome | 19:3f82c1161fd2 | 795 | /// a bit erratic above 20,000,000 Hz, so this became the default, |
WiredHome | 19:3f82c1161fd2 | 796 | /// even though it might have been the bench-level wiring that posed |
WiredHome | 19:3f82c1161fd2 | 797 | /// the limit. |
WiredHome | 19:3f82c1161fd2 | 798 | /// |
WiredHome | 19:3f82c1161fd2 | 799 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 800 | /// |
WiredHome | 19:3f82c1161fd2 | 801 | RetCode_t frequency(unsigned long Hz = RA8875_DEFAULT_SPI_FREQ); |
WiredHome | 19:3f82c1161fd2 | 802 | |
WiredHome | 19:3f82c1161fd2 | 803 | |
WiredHome | 19:3f82c1161fd2 | 804 | /// Initialize the chip, which is normally done as part of the |
WiredHome | 19:3f82c1161fd2 | 805 | /// constructor, so not called by the user. |
WiredHome | 19:3f82c1161fd2 | 806 | /// |
WiredHome | 19:3f82c1161fd2 | 807 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 808 | /// |
WiredHome | 19:3f82c1161fd2 | 809 | RetCode_t init(void); |
WiredHome | 19:3f82c1161fd2 | 810 | |
WiredHome | 19:3f82c1161fd2 | 811 | /// Select the peripheral to use it. |
WiredHome | 19:3f82c1161fd2 | 812 | /// |
WiredHome | 19:3f82c1161fd2 | 813 | /// @param chipsel when true will select the peripheral, and when false |
WiredHome | 19:3f82c1161fd2 | 814 | /// will deselect the chip. This is the logical selection, and |
WiredHome | 19:3f82c1161fd2 | 815 | /// the pin selection is the invert of this. |
WiredHome | 19:3f82c1161fd2 | 816 | /// @returns success/failure code. @see RetCode_t. |
WiredHome | 19:3f82c1161fd2 | 817 | /// |
WiredHome | 19:3f82c1161fd2 | 818 | RetCode_t select(bool chipsel); |
WiredHome | 19:3f82c1161fd2 | 819 | |
WiredHome | 19:3f82c1161fd2 | 820 | /// The most primitive - to write a data value to the SPI interface. |
WiredHome | 19:3f82c1161fd2 | 821 | /// |
WiredHome | 19:3f82c1161fd2 | 822 | /// @param data is the value to write. |
WiredHome | 19:3f82c1161fd2 | 823 | /// @returns a value read from the port, since SPI is often shift |
WiredHome | 19:3f82c1161fd2 | 824 | /// in while shifting out. |
WiredHome | 19:3f82c1161fd2 | 825 | /// |
WiredHome | 19:3f82c1161fd2 | 826 | unsigned char spiwrite(unsigned char data); |
WiredHome | 19:3f82c1161fd2 | 827 | |
WiredHome | 19:3f82c1161fd2 | 828 | /// The most primitive - to read a data value to the SPI interface. |
WiredHome | 19:3f82c1161fd2 | 829 | /// |
WiredHome | 19:3f82c1161fd2 | 830 | /// This is really just a specialcase of the write command, where |
WiredHome | 19:3f82c1161fd2 | 831 | /// the value zero is written in order to read. |
WiredHome | 19:3f82c1161fd2 | 832 | /// |
WiredHome | 19:3f82c1161fd2 | 833 | /// @returns a value read from the port, since SPI is often shift |
WiredHome | 19:3f82c1161fd2 | 834 | /// in while shifting out. |
WiredHome | 19:3f82c1161fd2 | 835 | /// |
WiredHome | 19:3f82c1161fd2 | 836 | unsigned char spiread(); |
WiredHome | 19:3f82c1161fd2 | 837 | |
WiredHome | 19:3f82c1161fd2 | 838 | SPI spi; ///< spi port |
WiredHome | 19:3f82c1161fd2 | 839 | DigitalOut cs; ///< chip select pin, assumed active low |
WiredHome | 19:3f82c1161fd2 | 840 | DigitalOut res; ///< reset pin, assumed active low |
WiredHome | 19:3f82c1161fd2 | 841 | const unsigned char * font; ///< reference to an external font somewhere in memory |
WiredHome | 19:3f82c1161fd2 | 842 | |
WiredHome | 19:3f82c1161fd2 | 843 | #ifdef PERF_METRICS |
WiredHome | 19:3f82c1161fd2 | 844 | typedef enum |
WiredHome | 19:3f82c1161fd2 | 845 | { |
WiredHome | 19:3f82c1161fd2 | 846 | PRF_CLS, |
WiredHome | 19:3f82c1161fd2 | 847 | PRF_DRAWPOINT, |
WiredHome | 19:3f82c1161fd2 | 848 | PRF_DRAWLINE, |
WiredHome | 19:3f82c1161fd2 | 849 | PRF_DRAWRECTANGLE, |
WiredHome | 19:3f82c1161fd2 | 850 | PRF_DRAWROUNDEDRECTANGLE, |
WiredHome | 19:3f82c1161fd2 | 851 | PRF_DRAWTRIANGLE, |
WiredHome | 19:3f82c1161fd2 | 852 | PRF_DRAWCIRCLE, |
WiredHome | 19:3f82c1161fd2 | 853 | PRF_DRAWELLIPSE, |
WiredHome | 19:3f82c1161fd2 | 854 | METRICCOUNT |
WiredHome | 19:3f82c1161fd2 | 855 | } method_e; |
WiredHome | 19:3f82c1161fd2 | 856 | unsigned long metrics[METRICCOUNT]; |
WiredHome | 19:3f82c1161fd2 | 857 | void RegisterPerformance(method_e method); |
WiredHome | 19:3f82c1161fd2 | 858 | Timer performance; |
WiredHome | 19:3f82c1161fd2 | 859 | #endif |
WiredHome | 19:3f82c1161fd2 | 860 | }; |
WiredHome | 19:3f82c1161fd2 | 861 | |
WiredHome | 19:3f82c1161fd2 | 862 | //} // namespace |
WiredHome | 19:3f82c1161fd2 | 863 | |
WiredHome | 19:3f82c1161fd2 | 864 | //using namespace SW_graphics; |
WiredHome | 19:3f82c1161fd2 | 865 | |
WiredHome | 23:a50ded45dbaf | 866 | |
WiredHome | 23:a50ded45dbaf | 867 | #ifdef TESTENABLE |
WiredHome | 23:a50ded45dbaf | 868 | // ______________ ______________ ______________ _______________ |
WiredHome | 23:a50ded45dbaf | 869 | // /_____ _____/ / ___________/ / ___________/ /_____ ______/ |
WiredHome | 23:a50ded45dbaf | 870 | // / / / / / / / / |
WiredHome | 23:a50ded45dbaf | 871 | // / / / /___ / /__________ / / |
WiredHome | 23:a50ded45dbaf | 872 | // / / / ____/ /__________ / / / |
WiredHome | 23:a50ded45dbaf | 873 | // / / / / / / / / |
WiredHome | 23:a50ded45dbaf | 874 | // / / / /__________ ___________/ / / / |
WiredHome | 23:a50ded45dbaf | 875 | // /__/ /_____________/ /_____________/ /__/ |
WiredHome | 23:a50ded45dbaf | 876 | |
WiredHome | 23:a50ded45dbaf | 877 | #include "WebColors.h" |
WiredHome | 23:a50ded45dbaf | 878 | #include "Arial12x12.h" |
WiredHome | 23:a50ded45dbaf | 879 | #include <algorithm> |
WiredHome | 23:a50ded45dbaf | 880 | |
WiredHome | 23:a50ded45dbaf | 881 | extern "C" void mbed_reset(); |
WiredHome | 23:a50ded45dbaf | 882 | |
WiredHome | 23:a50ded45dbaf | 883 | /// This activates a small set of tests for the graphics library. |
WiredHome | 23:a50ded45dbaf | 884 | /// |
WiredHome | 23:a50ded45dbaf | 885 | /// Call this API and pass it the reference to the display class. |
WiredHome | 23:a50ded45dbaf | 886 | /// It will then run a series of tests. It accepts interaction via |
WiredHome | 23:a50ded45dbaf | 887 | /// stdin to switch from automatic test mode to manual, run a specific |
WiredHome | 23:a50ded45dbaf | 888 | /// test, or to exit the test mode. |
WiredHome | 23:a50ded45dbaf | 889 | /// |
WiredHome | 23:a50ded45dbaf | 890 | /// @param lcd is a reference to the display class. |
WiredHome | 23:a50ded45dbaf | 891 | /// @param pc is a reference to a serial interface, typically the USB to PC. |
WiredHome | 23:a50ded45dbaf | 892 | /// |
WiredHome | 23:a50ded45dbaf | 893 | void RunTestSet(RA8875 & lcd, Serial & pc); |
WiredHome | 23:a50ded45dbaf | 894 | |
WiredHome | 23:a50ded45dbaf | 895 | |
WiredHome | 23:a50ded45dbaf | 896 | // To enable the test code, uncomment this section, or copy the |
WiredHome | 23:a50ded45dbaf | 897 | // necessary pieces to your "main()". |
WiredHome | 23:a50ded45dbaf | 898 | // |
WiredHome | 23:a50ded45dbaf | 899 | // #include "mbed.h" |
WiredHome | 23:a50ded45dbaf | 900 | // #include "RA8875.h" |
WiredHome | 23:a50ded45dbaf | 901 | // RA8875 lcd(p5, p6, p7, p12, NC, "tft"); // MOSI, MISO, SCK, /ChipSelect, /reset, name |
WiredHome | 23:a50ded45dbaf | 902 | // Serial pc(USBTX, USBRX); |
WiredHome | 23:a50ded45dbaf | 903 | // extern "C" void mbed_reset(); |
WiredHome | 23:a50ded45dbaf | 904 | // int main() |
WiredHome | 23:a50ded45dbaf | 905 | // { |
WiredHome | 23:a50ded45dbaf | 906 | // pc.baud(460800); // I like a snappy terminal, so crank it up! |
WiredHome | 23:a50ded45dbaf | 907 | // pc.printf("\r\nRA8875 Test - Build " __DATE__ " " __TIME__ "\r\n"); |
WiredHome | 23:a50ded45dbaf | 908 | // |
WiredHome | 23:a50ded45dbaf | 909 | // pc.printf("Turning on display\r\n"); |
WiredHome | 23:a50ded45dbaf | 910 | // lcd.Reset(); |
WiredHome | 23:a50ded45dbaf | 911 | // lcd.Power(true); // display power is on, but the backlight is independent |
WiredHome | 23:a50ded45dbaf | 912 | // lcd.Backlight(0.5); |
WiredHome | 23:a50ded45dbaf | 913 | // RunTestSet(lcd, pc); |
WiredHome | 23:a50ded45dbaf | 914 | // } |
WiredHome | 23:a50ded45dbaf | 915 | |
WiredHome | 23:a50ded45dbaf | 916 | #endif // TESTENABLE |
WiredHome | 23:a50ded45dbaf | 917 | |
WiredHome | 19:3f82c1161fd2 | 918 | #endif |