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)

RA8875.h@40:04aa280dfa39, 2014-02-04 (annotated)

Committer:
WiredHome
Date:
Tue Feb 04 02:58:06 2014 +0000
Revision:
40:04aa280dfa39
Parent:
38:38d503b4fad6
Child:
41:2956a0a221e5
Revise SetTextFontSize( ) to require only 1 parameter, and change the type from unsigned to signed to permit easier default detection.

Who changed what in which revision?

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