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@63:ed787f5fcdc4, 2014-03-23 (annotated)

Committer:
WiredHome
Date:
Sun Mar 23 16:27:55 2014 +0000
Revision:
63:ed787f5fcdc4
Parent:
53:86d24b9480b9 
Adding PNG support - which works for tiny png files but memory requirements may exclude it for larger images.

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