RA8875 - Library to control a Graphics TFT connected to 4-…

Users » WiredHome » Code » RA8875

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

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@137:9e09f6081ef1, 2016-12-08 (annotated)

Committer:: WiredHome
Date:: Thu Dec 08 12:29:54 2016 +0000
Revision:: 137:9e09f6081ef1
Parent:: 136:224e03d5c31f
Child:: 140:33ca352755a2

Correct a defect in BlockMove

Who changed what in which revision?

User	Revision	Line number	New contents of line
WiredHome	78:faf49c381591	1	///
WiredHome	78:faf49c381591	2	/// @mainpage RA8875 Display Controller Driver library
WiredHome	78:faf49c381591	3	///
WiredHome	78:faf49c381591	4	/// The RA8875 Display controller is a powerful interface for low cost displays. It
WiredHome	78:faf49c381591	5	/// can support displays up to 800 x 600 pixels x 16-bit color. Another common
WiredHome	78:faf49c381591	6	/// implementation is 480 x 272 x 16 with two layers. The two layers can be
WiredHome	78:faf49c381591	7	/// exchanged, or blended in various ways (transparency, OR, AND, and more).
WiredHome	78:faf49c381591	8	/// It includes graphics acceleration capabilities for drawing primitives,
WiredHome	78:faf49c381591	9	/// such as line, rectangle, circles, and more.
WiredHome	78:faf49c381591	10	///
WiredHome	101:e0aad446094a	11	/// It is not a display for super-fast animations, video, picture frames and so forth,
WiredHome	101:e0aad446094a	12	/// at least when using the SPI ports. Performance has not been evaluated with one
WiredHome	101:e0aad446094a	13	/// of the parallel port options.
WiredHome	101:e0aad446094a	14	///
WiredHome	78:faf49c381591	15	/// The controller additionally supports backlight control (via PWM), keypad scanning
WiredHome	125:7a0b70f56550	16	/// (for a 4 x 5 matrix) and resistive touch-panel support. Recently support for a
WiredHome	125:7a0b70f56550	17	/// capacitive touch screen was integrated, in a manner that makes the resistive and
WiredHome	125:7a0b70f56550	18	/// capactive interfaces nearly identical.
WiredHome	78:faf49c381591	19	///
WiredHome	78:faf49c381591	20	/// @section Display_Config Display Configuration
WiredHome	78:faf49c381591	21	///
WiredHome	78:faf49c381591	22	/// This section details basics for bringing the display online. At a minimum,
WiredHome	78:faf49c381591	23	/// the display is instantiated. After that any of the available commands
WiredHome	78:faf49c381591	24	/// may be issued.
WiredHome	78:faf49c381591	25	///
WiredHome	78:faf49c381591	26	/// During the instantiation, the display is powered on, cleared, and the backlight
WiredHome	78:faf49c381591	27	/// is energized. Additionally, the keypad and touchscreen features are activated.
WiredHome	78:faf49c381591	28	/// It is important to keep in mind that the keypad had the default mapping, and
WiredHome	78:faf49c381591	29	/// the touchscreen does not have the calibration matrix configured, so additional
WiredHome	78:faf49c381591	30	/// steps may be necessary.
WiredHome	78:faf49c381591	31	///
WiredHome	78:faf49c381591	32	/// @code
WiredHome	78:faf49c381591	33	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	81:01da2e34283d	34	/// lcd.init();
WiredHome	78:faf49c381591	35	/// lcd.foreground(Blue);
WiredHome	78:faf49c381591	36	/// lcd.line(0,0, 479,271);
WiredHome	78:faf49c381591	37	/// ...
WiredHome	78:faf49c381591	38	/// @endcode
WiredHome	78:faf49c381591	39	///
WiredHome	78:faf49c381591	40	/// @section Touch_Panel Touch Panel
WiredHome	78:faf49c381591	41	///
WiredHome	78:faf49c381591	42	/// The supported touch panel interface is for a resistive panel, and is natively
WiredHome	78:faf49c381591	43	/// supported by the RA8875 controller. There are a few steps to enable this interface.
WiredHome	78:faf49c381591	44	///
WiredHome	78:faf49c381591	45	/// @subsection Touch_Panel_Enable Touch Panel Enable
WiredHome	78:faf49c381591	46	///
WiredHome	106:c80828f5dea4	47	/// See @ref TouchPanelInit has two forms - fully automatic, and controlled. See the APIs for
WiredHome	78:faf49c381591	48	/// details.
WiredHome	78:faf49c381591	49	///
WiredHome	78:faf49c381591	50	/// @subsection Touch_Panel_Calibration
WiredHome	78:faf49c381591	51	///
WiredHome	78:faf49c381591	52	/// The touch panel is not initially calibrated on startup. The application should
WiredHome	78:faf49c381591	53	/// provide a means to activate the calibration process, and that should not require
WiredHome	78:faf49c381591	54	/// the touchscreen as it may not yet be usable. Alternately, a calibration matrix
WiredHome	78:faf49c381591	55	/// can be loaded from non-volatile and installed.
WiredHome	78:faf49c381591	56	///
WiredHome	78:faf49c381591	57	/// @section Keypad Keypad
WiredHome	78:faf49c381591	58	///
WiredHome	78:faf49c381591	59	/// The keypad has a default keypad mapping, but there is an API that permits
WiredHome	78:faf49c381591	60	/// installing a custom keymap.
WiredHome	78:faf49c381591	61	///
WiredHome	101:e0aad446094a	62	/// @todo Add APIs for the 2nd PWM channel, which might be quite useful as a simple
WiredHome	101:e0aad446094a	63	/// beeper.
WiredHome	101:e0aad446094a	64	/// @todo Figure out how to "init()" in the constructor. I ran into some issues if
WiredHome	101:e0aad446094a	65	/// the display was instantiated before main(), and the code would not run,
WiredHome	101:e0aad446094a	66	/// thus the exposure and activation of the init() function. If the constructor
WiredHome	101:e0aad446094a	67	/// was within main(), then it seemed to work as expected.
WiredHome	101:e0aad446094a	68	///
WiredHome	19:3f82c1161fd2	69	#ifndef RA8875_H
WiredHome	19:3f82c1161fd2	70	#define RA8875_H
WiredHome	19:3f82c1161fd2	71	#include <mbed.h>
WiredHome	19:3f82c1161fd2	72
WiredHome	77:9206c13aa527	73	#include "RA8875_Regs.h"
WiredHome	19:3f82c1161fd2	74	#include "GraphicsDisplay.h"
WiredHome	19:3f82c1161fd2	75
WiredHome	41:2956a0a221e5	76	#define RA8875_DEFAULT_SPI_FREQ 5000000
WiredHome	19:3f82c1161fd2	77
WiredHome	19:3f82c1161fd2	78	// Define this to enable code that monitors the performance of various
WiredHome	19:3f82c1161fd2	79	// graphics commands.
WiredHome	78:faf49c381591	80	//#define PERF_METRICS
WiredHome	19:3f82c1161fd2	81
WiredHome	23:a50ded45dbaf	82	// What better place for some test code than in here and the companion
WiredHome	23:a50ded45dbaf	83	// .cpp file. See also the bottom of this file.
WiredHome	99:66edf771373a	84	//#define TESTENABLE
WiredHome	19:3f82c1161fd2	85
WiredHome	19:3f82c1161fd2	86	/// DOS colors - slightly color enhanced
WiredHome	20:6e2e4a8372eb	87	#define Black (color_t)(RGB(0,0,0))
WiredHome	20:6e2e4a8372eb	88	#define Blue (color_t)(RGB(0,0,187))
WiredHome	20:6e2e4a8372eb	89	#define Green (color_t)(RGB(0,187,0))
WiredHome	20:6e2e4a8372eb	90	#define Cyan (color_t)(RGB(0,187,187))
WiredHome	20:6e2e4a8372eb	91	#define Red (color_t)(RGB(187,0,0))
WiredHome	20:6e2e4a8372eb	92	#define Magenta (color_t)(RGB(187,0,187))
WiredHome	81:01da2e34283d	93	#define Brown (color_t)(RGB(63,63,0))
WiredHome	20:6e2e4a8372eb	94	#define Gray (color_t)(RGB(187,187,187))
WiredHome	20:6e2e4a8372eb	95	#define Charcoal (color_t)(RGB(85,85,85))
WiredHome	62:ba5d33438fda	96	#define BrightBlue (color_t)(RGB(0,0,255))
WiredHome	62:ba5d33438fda	97	#define BrightGreen (color_t)(RGB(0,255,0))
WiredHome	62:ba5d33438fda	98	#define BrightCyan (color_t)(RGB(0,255,255))
WiredHome	62:ba5d33438fda	99	#define BrightRed (color_t)(RGB(255,0,0))
WiredHome	20:6e2e4a8372eb	100	#define Orange (color_t)(RGB(255,85,85))
WiredHome	20:6e2e4a8372eb	101	#define Pink (color_t)(RGB(255,85,255))
WiredHome	81:01da2e34283d	102	#define Yellow (color_t)(RGB(187,187,0))
WiredHome	20:6e2e4a8372eb	103	#define White (color_t)(RGB(255,255,255))
WiredHome	20:6e2e4a8372eb	104
WiredHome	62:ba5d33438fda	105	#define DarkBlue (color_t)(RGB(0,0,63))
WiredHome	62:ba5d33438fda	106	#define DarkGreen (color_t)(RGB(0,63,0))
WiredHome	62:ba5d33438fda	107	#define DarkCyan (color_t)(RGB(0,63,63))
WiredHome	62:ba5d33438fda	108	#define DarkRed (color_t)(RGB(63,0,0))
WiredHome	62:ba5d33438fda	109	#define DarkMagenta (color_t)(RGB(63,0,63))
WiredHome	62:ba5d33438fda	110	#define DarkBrown (color_t)(RGB(63,63,0))
WiredHome	62:ba5d33438fda	111	#define DarkGray (color_t)(RGB(63,63,63))
WiredHome	61:8f3153bf0baa	112
WiredHome	82:f7d300f26540	113	#define min(a,b) ((a<b)?a:b)
WiredHome	82:f7d300f26540	114	#define max(a,b) ((a>b)?a:b)
WiredHome	82:f7d300f26540	115
WiredHome	19:3f82c1161fd2	116
WiredHome	124:1690a7ae871c	117	/// FT5206 definitions follow
WiredHome	124:1690a7ae871c	118	#define FT5206_I2C_FREQUENCY 400000
WiredHome	124:1690a7ae871c	119
WiredHome	124:1690a7ae871c	120	#define FT5206_I2C_ADDRESS 0x38
WiredHome	124:1690a7ae871c	121	#define FT5206_NUMBER_OF_REGISTERS 31 // there are more registers, but this
WiredHome	124:1690a7ae871c	122	// is enough to get all 5 touch coordinates.
WiredHome	124:1690a7ae871c	123
WiredHome	124:1690a7ae871c	124	#define FT5206_NUMBER_OF_TOTAL_REGISTERS 0xFE
WiredHome	124:1690a7ae871c	125
WiredHome	124:1690a7ae871c	126	#define FT5206_DEVICE_MODE 0x00 // Normal, test, etc.
WiredHome	124:1690a7ae871c	127	#define FT5206_GEST_ID 0x01 // Gesture detected
WiredHome	124:1690a7ae871c	128	#define FT5206_TD_STATUS 0x02 // How many points detected (3:0). 1-5 is valid.
WiredHome	124:1690a7ae871c	129
WiredHome	124:1690a7ae871c	130	#define FT5206_TOUCH1_XH 0x03 // Event Flag, Touch X Position
WiredHome	124:1690a7ae871c	131	#define FT5206_TOUCH1_XL 0x04
WiredHome	124:1690a7ae871c	132	#define FT5206_TOUCH1_YH 0x05 // Touch ID, Touch Y Position
WiredHome	124:1690a7ae871c	133	#define FT5206_TOUCH1_YL 0x06
WiredHome	124:1690a7ae871c	134
WiredHome	124:1690a7ae871c	135	#define FT5206_TOUCH2_XH 0x09 // Event Flag, Touch X Position
WiredHome	124:1690a7ae871c	136	#define FT5206_TOUCH2_XL 0x0a
WiredHome	124:1690a7ae871c	137	#define FT5206_TOUCH2_YH 0x0b // Touch ID, Touch Y Position
WiredHome	124:1690a7ae871c	138	#define FT5206_TOUCH2_YL 0x0c
WiredHome	124:1690a7ae871c	139
WiredHome	124:1690a7ae871c	140	#define FT5206_TOUCH3_XH 0x0f // Event Flag, Touch X Position
WiredHome	124:1690a7ae871c	141	#define FT5206_TOUCH3_XL 0x10
WiredHome	124:1690a7ae871c	142	#define FT5206_TOUCH3_YH 0x11 // Touch ID, Touch Y Position
WiredHome	124:1690a7ae871c	143	#define FT5206_TOUCH3_YL 0x12
WiredHome	124:1690a7ae871c	144
WiredHome	124:1690a7ae871c	145	#define FT5206_TOUCH4_XH 0x15 // Event Flag, Touch X Position
WiredHome	124:1690a7ae871c	146	#define FT5206_TOUCH4_XL 0x16
WiredHome	124:1690a7ae871c	147	#define FT5206_TOUCH4_YH 0x17 // Touch ID, Touch Y Position
WiredHome	124:1690a7ae871c	148	#define FT5206_TOUCH4_YL 0x18
WiredHome	124:1690a7ae871c	149
WiredHome	124:1690a7ae871c	150	#define FT5206_TOUCH5_XH 0x1b // Event Flag, Touch X Position
WiredHome	124:1690a7ae871c	151	#define FT5206_TOUCH5_XL 0x1c
WiredHome	124:1690a7ae871c	152	#define FT5206_TOUCH5_YH 0x1d // Touch ID, Touch Y Position
WiredHome	124:1690a7ae871c	153	#define FT5206_TOUCH5_YL 0x1e
WiredHome	124:1690a7ae871c	154
WiredHome	124:1690a7ae871c	155	// For typical usage, the registers listed below are not used.
WiredHome	124:1690a7ae871c	156	#define FT5206_ID_G_THGROUP 0x80 // Valid touching detect threshold
WiredHome	124:1690a7ae871c	157	#define FT5206_ID_G_THPEAK 0x81 // Valid touching peak detect threshold
WiredHome	124:1690a7ae871c	158	#define FT5206_ID_G_THCAL 0x82 // The threshold when calculating the focus of touching
WiredHome	124:1690a7ae871c	159	#define FT5206_ID_G_THWATER 0x83 // The threshold when there is surface water
WiredHome	124:1690a7ae871c	160	#define FT5206_ID_G_THTEMP 0x84 // The threshold of temperature compensation
WiredHome	124:1690a7ae871c	161	#define FT5206_ID_G_CTRL 0x86 // Power control mode
WiredHome	124:1690a7ae871c	162	#define FT5206_ID_G_TIME_ENTER_MONITOR 0x87 // The timer of entering monitor status
WiredHome	124:1690a7ae871c	163	#define FT5206_ID_G_PERIODACTIVE 0x88 // Period Active
WiredHome	124:1690a7ae871c	164	#define FT5206_ID_G_PERIODMONITOR 0x89 // The timer of entering idle while in monitor status
WiredHome	124:1690a7ae871c	165	#define FT5206_ID_G_AUTO_CLB_MODE 0xA0 // Auto calibration mode
WiredHome	124:1690a7ae871c	166
WiredHome	124:1690a7ae871c	167	#define FT5206_TOUCH_LIB_VERSION_H 0xA1 // Firmware Library Version H byte
WiredHome	124:1690a7ae871c	168	#define FT5206_TOUCH_LIB_VERSION_L 0xA2 // Firmware Library Version L byte
WiredHome	124:1690a7ae871c	169	#define FT5206_ID_G_CIPHER 0xA3 // Chip vendor ID
WiredHome	124:1690a7ae871c	170	#define FT5206_G_MODE 0xA4 // The interrupt status to host
WiredHome	124:1690a7ae871c	171	#define FT5206_ID_G_PMODE 0xA5 // Power Consume Mode
WiredHome	124:1690a7ae871c	172	#define FT5206_FIRMID 0xA6 // Firmware ID
WiredHome	124:1690a7ae871c	173	#define FT5206_ID_G_STATE 0xA7 // Running State
WiredHome	124:1690a7ae871c	174	#define FT5206_ID_G_FT5201ID 0xA8 // CTPM Vendor ID
WiredHome	124:1690a7ae871c	175	#define FT5206_ID_G_ERR 0xA9 // Error Code
WiredHome	124:1690a7ae871c	176	#define FT5206_ID_G_CLB 0xAA // Configure TP module during calibration in Test Mode
WiredHome	124:1690a7ae871c	177	#define FT5206_ID_G_B_AREA_TH 0xAE // The threshold of big area
WiredHome	124:1690a7ae871c	178	#define FT5206_LOG_MSG_CNT 0xFE // The log MSG count
WiredHome	124:1690a7ae871c	179	#define FT5206_LOG_CUR_CHA 0xFF // Current character of log message, will point to the next
WiredHome	124:1690a7ae871c	180	// character when one character is read.
WiredHome	124:1690a7ae871c	181	#define FT5206_GEST_ID_MOVE_UP 0x10
WiredHome	124:1690a7ae871c	182	#define FT5206_GEST_ID_MOVE_LEFT 0x14
WiredHome	124:1690a7ae871c	183	#define FT5206_GEST_ID_MOVE_DOWN 0x18
WiredHome	124:1690a7ae871c	184	#define FT5206_GEST_ID_MOVE_RIGHT 0x1c
WiredHome	124:1690a7ae871c	185	#define FT5206_GEST_ID_ZOOM_IN 0x48
WiredHome	124:1690a7ae871c	186	#define FT5206_GEST_ID_ZOOM_OUT 0x49
WiredHome	124:1690a7ae871c	187	#define FT5206_GEST_ID_NO_GESTURE 0x00
WiredHome	124:1690a7ae871c	188
WiredHome	124:1690a7ae871c	189	#define FT5206_EVENT_FLAG_PUT_DOWN 0x00
WiredHome	124:1690a7ae871c	190	#define FT5206_EVENT_FLAG_PUT_UP 0x01
WiredHome	124:1690a7ae871c	191	#define FT5206_EVENT_FLAG_CONTACT 0x02
WiredHome	124:1690a7ae871c	192	#define FT5206_EVENT_FLAG_RESERVED 0x03
WiredHome	124:1690a7ae871c	193
WiredHome	124:1690a7ae871c	194	#define FT5206_ID_G_POLLING_MODE 0x00
WiredHome	124:1690a7ae871c	195	#define FT5206_ID_G_TRIGGER_MODE 0x01
WiredHome	124:1690a7ae871c	196
WiredHome	124:1690a7ae871c	197	#define FT5206_ID_G_PMODE_ACTIVE 0x00
WiredHome	124:1690a7ae871c	198	#define FT5206_ID_G_PMODE_MONITOR 0x01
WiredHome	124:1690a7ae871c	199	#define FT5206_ID_G_PMODE_HIBERNATE 0x03
WiredHome	124:1690a7ae871c	200
WiredHome	124:1690a7ae871c	201	#define FT5206_ID_G_STATE_CONFIGURE 0x00
WiredHome	124:1690a7ae871c	202	#define FT5206_ID_G_STATE_WORK 0x01
WiredHome	124:1690a7ae871c	203	#define FT5206_ID_G_STATE_CALIBRATION 0x02
WiredHome	124:1690a7ae871c	204	#define FT5206_ID_G_STATE_FACTORY 0x03
WiredHome	124:1690a7ae871c	205	#define FT5206_ID_G_STATE_AUTO_CALIBRATION 0x04
WiredHome	124:1690a7ae871c	206	/// end of FT5206 definitions
WiredHome	124:1690a7ae871c	207
WiredHome	124:1690a7ae871c	208
WiredHome	19:3f82c1161fd2	209	//namespace SW_graphics
WiredHome	19:3f82c1161fd2	210	//{
WiredHome	19:3f82c1161fd2	211
WiredHome	96:40b74dd3695b	212	class FPointerDummy; // used by the callback methods.
WiredHome	24:8ca861acf12d	213
WiredHome	21:3c1efb192927	214	/// This is a graphics library for the Raio RA8875 Display Controller chip
WiredHome	21:3c1efb192927	215	/// attached to a 4-wire SPI interface.
WiredHome	21:3c1efb192927	216	///
WiredHome	56:7a85d226ad0d	217	/// It offers both primitive and high level APIs.
WiredHome	56:7a85d226ad0d	218	///
WiredHome	21:3c1efb192927	219	/// Central to this API is a coordinate system, where the origin (0,0) is in
WiredHome	56:7a85d226ad0d	220	/// the top-left corner of the display, and the width (x) extends positive to the
WiredHome	56:7a85d226ad0d	221	/// right and the height (y) extends positive toward the bottom.
WiredHome	21:3c1efb192927	222	///
WiredHome	125:7a0b70f56550	223	/// @note As there are both graphics and text commands, one must take care to use
WiredHome	21:3c1efb192927	224	/// the proper coordinate system for each. Some of the text APIs are in units
WiredHome	29:422616aa04bd	225	/// of column and row, which is measured in character positions (and dependent
WiredHome	56:7a85d226ad0d	226	/// on the font size), where other text APIs permit pixel level positioning.
WiredHome	56:7a85d226ad0d	227	///
WiredHome	56:7a85d226ad0d	228	/// @code
WiredHome	56:7a85d226ad0d	229	/// #include "RA8875.h"
WiredHome	56:7a85d226ad0d	230	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	56:7a85d226ad0d	231	///
WiredHome	56:7a85d226ad0d	232	/// int main()
WiredHome	56:7a85d226ad0d	233	/// {
WiredHome	81:01da2e34283d	234	/// lcd.init();
WiredHome	56:7a85d226ad0d	235	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	56:7a85d226ad0d	236	/// lcd.circle( 400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	237	/// lcd.fillcircle( 400,25, 15, RGB(128,255,128));
WiredHome	56:7a85d226ad0d	238	/// lcd.ellipse( 440,75, 35,20, BrightBlue);
WiredHome	56:7a85d226ad0d	239	/// lcd.fillellipse( 440,75, 25,10, Blue);
WiredHome	56:7a85d226ad0d	240	/// lcd.triangle( 440,100, 475,110, 450,125, Magenta);
WiredHome	56:7a85d226ad0d	241	/// lcd.filltriangle( 445,105, 467,111, 452,120, Cyan);
WiredHome	56:7a85d226ad0d	242	/// lcd.rect( 400,130, 475,155, Brown);
WiredHome	56:7a85d226ad0d	243	/// lcd.fillrect( 405,135, 470,150, Pink);
WiredHome	56:7a85d226ad0d	244	/// lcd.roundrect( 410,160, 475,190, 10,8, Yellow);
WiredHome	56:7a85d226ad0d	245	/// lcd.fillroundrect(415,165, 470,185, 5,3, Orange);
WiredHome	56:7a85d226ad0d	246	/// lcd.line( 430,200, 460,230, RGB(0,255,0));
WiredHome	56:7a85d226ad0d	247	/// for (int i=0; i<=30; i+=5)
WiredHome	56:7a85d226ad0d	248	/// lcd.pixel(435+i,200+i, White);
WiredHome	56:7a85d226ad0d	249	/// }
WiredHome	56:7a85d226ad0d	250	/// @endcode
WiredHome	29:422616aa04bd	251	///
WiredHome	31:c72e12cd5c67	252	/// @todo Add Scroll support for text.
WiredHome	75:ca78388cfd77	253	/// @todo Add Hardware reset signal - but testing to date indicates it is not needed.
WiredHome	44:207594dece70	254	/// @todo Add high level objects - x-y graph, meter, others... but these will
WiredHome	44:207594dece70	255	/// probably be best served in another class, since they may not
WiredHome	44:207594dece70	256	/// be needed for many uses.
WiredHome	21:3c1efb192927	257	///
WiredHome	19:3f82c1161fd2	258	class RA8875 : public GraphicsDisplay
WiredHome	19:3f82c1161fd2	259	{
WiredHome	19:3f82c1161fd2	260	public:
WiredHome	53:86d24b9480b9	261	/// cursor type to be shown as the text cursor.
WiredHome	53:86d24b9480b9	262	typedef enum
WiredHome	53:86d24b9480b9	263	{
WiredHome	53:86d24b9480b9	264	NOCURSOR, ///< cursor is hidden
WiredHome	53:86d24b9480b9	265	IBEAM, ///< \| cursor
WiredHome	53:86d24b9480b9	266	UNDER, ///< _ cursor
WiredHome	53:86d24b9480b9	267	BLOCK ///< Block cursor
WiredHome	53:86d24b9480b9	268	} cursor_t;
WiredHome	53:86d24b9480b9	269
WiredHome	19:3f82c1161fd2	270	/// font type selection.
WiredHome	19:3f82c1161fd2	271	typedef enum
WiredHome	19:3f82c1161fd2	272	{
WiredHome	31:c72e12cd5c67	273	ISO8859_1, ///< ISO8859-1 font
WiredHome	31:c72e12cd5c67	274	ISO8859_2, ///< ISO8859-2 font
WiredHome	31:c72e12cd5c67	275	ISO8859_3, ///< ISO8859-3 font
WiredHome	31:c72e12cd5c67	276	ISO8859_4 ///< ISO8859-4 font
WiredHome	19:3f82c1161fd2	277	} font_t;
WiredHome	19:3f82c1161fd2	278
WiredHome	84:e102021864b5	279	/// display orientation
WiredHome	19:3f82c1161fd2	280	typedef enum
WiredHome	19:3f82c1161fd2	281	{
WiredHome	84:e102021864b5	282	normal, ///< normal (landscape) orientation
WiredHome	84:e102021864b5	283	rotate_0 = normal, ///< alternate to 'normal'
WiredHome	84:e102021864b5	284	rotate_90, ///< rotated clockwise 90 degree
WiredHome	84:e102021864b5	285	rotate_180, ///< rotated (clockwise) 180 degree
WiredHome	84:e102021864b5	286	rotate_270, ///< rotated clockwise 270 degree
WiredHome	84:e102021864b5	287	} orientation_t;
WiredHome	19:3f82c1161fd2	288
WiredHome	19:3f82c1161fd2	289	/// alignment
WiredHome	19:3f82c1161fd2	290	typedef enum
WiredHome	19:3f82c1161fd2	291	{
WiredHome	31:c72e12cd5c67	292	align_none, ///< align - none
WiredHome	31:c72e12cd5c67	293	align_full ///< align - full
WiredHome	19:3f82c1161fd2	294	} alignment_t;
WiredHome	19:3f82c1161fd2	295
WiredHome	127:db7f2c704693	296	/// Font Horizontal Scale factor - 1, 2, 3 4
WiredHome	40:04aa280dfa39	297	typedef int HorizontalScale;
WiredHome	19:3f82c1161fd2	298
WiredHome	127:db7f2c704693	299	/// Font Vertical Scale factor - 1, 2, 3, 4
WiredHome	40:04aa280dfa39	300	typedef int VerticalScale;
WiredHome	19:3f82c1161fd2	301
WiredHome	19:3f82c1161fd2	302	/// Clear screen region
WiredHome	19:3f82c1161fd2	303	typedef enum
WiredHome	19:3f82c1161fd2	304	{
WiredHome	31:c72e12cd5c67	305	FULLWINDOW, ///< Full screen
WiredHome	31:c72e12cd5c67	306	ACTIVEWINDOW ///< active window/region
WiredHome	19:3f82c1161fd2	307	} Region_t;
WiredHome	19:3f82c1161fd2	308
WiredHome	61:8f3153bf0baa	309	/// Set the Layer Display Mode. @ref SetLayerMode
WiredHome	53:86d24b9480b9	310	typedef enum
WiredHome	53:86d24b9480b9	311	{
WiredHome	61:8f3153bf0baa	312	ShowLayer0, ///< Only layer 0 is visible, layer 1 is hidden (default)
WiredHome	56:7a85d226ad0d	313	ShowLayer1, ///< Only layer 1 is visible, layer 0 is hidden
WiredHome	53:86d24b9480b9	314	LightenOverlay, ///< Lighten-overlay mode
WiredHome	53:86d24b9480b9	315	TransparentMode, ///< Transparent mode
WiredHome	53:86d24b9480b9	316	BooleanOR, ///< Boolean OR mode
WiredHome	53:86d24b9480b9	317	BooleanAND, ///< Boolean AND mode
WiredHome	53:86d24b9480b9	318	FloatingWindow ///< Floating Window mode
WiredHome	53:86d24b9480b9	319	} LayerMode_T;
WiredHome	53:86d24b9480b9	320
hexley	54:e117ad10fba6	321	/// Touch Panel modes
hexley	54:e117ad10fba6	322	typedef enum
hexley	54:e117ad10fba6	323	{
hexley	54:e117ad10fba6	324	TP_Auto, ///< Auto touch detection mode
hexley	54:e117ad10fba6	325	TP_Manual, ///< Manual touch detection mode
hexley	54:e117ad10fba6	326	} tpmode_t;
WiredHome	96:40b74dd3695b	327
WiredHome	96:40b74dd3695b	328	/// printscreen callback commands
WiredHome	96:40b74dd3695b	329	typedef enum
WiredHome	96:40b74dd3695b	330	{
WiredHome	96:40b74dd3695b	331	OPEN, ///< command to open the file. cast uint32_t * to the buffer to get the total size to be written.
WiredHome	96:40b74dd3695b	332	WRITE, ///< command to write some data, buffer points to the data and the size is in bytes.
WiredHome	96:40b74dd3695b	333	CLOSE, ///< command to close the file
WiredHome	96:40b74dd3695b	334	} filecmd_t;
WiredHome	96:40b74dd3695b	335
WiredHome	96:40b74dd3695b	336	/// print screen callback
WiredHome	96:40b74dd3695b	337	///
WiredHome	96:40b74dd3695b	338	/// The special form of the print screen will pass one blob at a time
WiredHome	96:40b74dd3695b	339	/// to the callback. There are basic command declaring that the stream
WiredHome	96:40b74dd3695b	340	/// can be opened, a block written, and the stream closed. There is
WiredHome	96:40b74dd3695b	341	/// also a command to communicate the total size being delivered.
WiredHome	96:40b74dd3695b	342	///
WiredHome	96:40b74dd3695b	343	/// @code
WiredHome	96:40b74dd3695b	344	/// lcd.PrintScreen(x,y,w,h,callback);
WiredHome	96:40b74dd3695b	345	/// ...
WiredHome	96:40b74dd3695b	346	/// void callback(filecmd_t cmd, uint8_t * buffer, uint16_t size) {
WiredHome	96:40b74dd3695b	347	/// switch(cmd) {
WiredHome	96:40b74dd3695b	348	/// case OPEN:
WiredHome	96:40b74dd3695b	349	/// pc.printf("About to write %u bytes\r\n", (uint32_t )buffer);
WiredHome	96:40b74dd3695b	350	/// fh = fopen("file.bmp", "w+b");
WiredHome	96:40b74dd3695b	351	/// break;
WiredHome	96:40b74dd3695b	352	/// case WRITE:
WiredHome	96:40b74dd3695b	353	/// fwrite(buffer, size, fh);
WiredHome	96:40b74dd3695b	354	/// break;
WiredHome	96:40b74dd3695b	355	/// case CLOSE:
WiredHome	96:40b74dd3695b	356	/// fclose(fh);
WiredHome	96:40b74dd3695b	357	/// break;
WiredHome	96:40b74dd3695b	358	/// default:
WiredHome	96:40b74dd3695b	359	/// pc.printf("Unexpected callback %d\r\n", cmd);
WiredHome	96:40b74dd3695b	360	/// break;
WiredHome	96:40b74dd3695b	361	/// }
WiredHome	96:40b74dd3695b	362	/// }
WiredHome	96:40b74dd3695b	363	/// @endcode
WiredHome	96:40b74dd3695b	364	///
WiredHome	106:c80828f5dea4	365	/// @param cmd is the command to execute. See @ref filecmd_t.
WiredHome	96:40b74dd3695b	366	/// @param buffer is a pointer to the buffer being passed.
WiredHome	96:40b74dd3695b	367	/// @param size is the number of bytes in the buffer.
WiredHome	123:2f45e80fec5f	368	/// @returns the noerror signal.
WiredHome	96:40b74dd3695b	369	///
WiredHome	96:40b74dd3695b	370	typedef RetCode_t (* PrintCallback_T)(filecmd_t cmd, uint8_t * buffer, uint16_t size);
hexley	54:e117ad10fba6	371
WiredHome	125:7a0b70f56550	372	/// Idle reason provided in the Idle Callback
WiredHome	123:2f45e80fec5f	373	typedef enum {
WiredHome	123:2f45e80fec5f	374	unknown, ///< reason has not been assigned (this should not happen)
WiredHome	123:2f45e80fec5f	375	status_wait, ///< driver is polling the status register while busy
WiredHome	123:2f45e80fec5f	376	command_wait, ///< driver is polling the command register while busy
WiredHome	123:2f45e80fec5f	377	getc_wait, ///< user has called the getc function
WiredHome	123:2f45e80fec5f	378	touch_wait, ///< user has called the touch function
WiredHome	123:2f45e80fec5f	379	touchcal_wait ///< driver is performing a touch calibration
WiredHome	123:2f45e80fec5f	380	} IdleReason_T;
WiredHome	123:2f45e80fec5f	381
WiredHome	123:2f45e80fec5f	382	/// Idle Callback
WiredHome	123:2f45e80fec5f	383	///
WiredHome	123:2f45e80fec5f	384	/// This defines the interface for an idle callback. That is, when the
WiredHome	125:7a0b70f56550	385	/// driver is held up, pending some event, it can call a previously registered
WiredHome	123:2f45e80fec5f	386	/// idle function. This could be most useful for servicing a watchdog.
WiredHome	123:2f45e80fec5f	387	///
WiredHome	123:2f45e80fec5f	388	/// The user code, which is notified via this API, can force the idle
WiredHome	123:2f45e80fec5f	389	/// to abort, by returning the external_abort value back to the driver.
WiredHome	125:7a0b70f56550	390	/// It is important to note that the abort could leave the driver in
WiredHome	125:7a0b70f56550	391	/// an undesireable state, so this should be used with care.
WiredHome	125:7a0b70f56550	392	///
WiredHome	125:7a0b70f56550	393	/// @note Should it be called the BusyCallback? It is true, that it will
WiredHome	125:7a0b70f56550	394	/// call this function when the RA8875 is busy, but this is also
WiredHome	125:7a0b70f56550	395	/// when the CPU is largely idle.
WiredHome	125:7a0b70f56550	396	///
WiredHome	125:7a0b70f56550	397	/// @code
WiredHome	125:7a0b70f56550	398	/// RetCode_t myIdle_handler(RA8875::IdleReason_T reason)
WiredHome	125:7a0b70f56550	399	/// {
WiredHome	125:7a0b70f56550	400	/// idleFlasher = !idleFlasher;
WiredHome	125:7a0b70f56550	401	/// if (it_has_been_too_long())
WiredHome	125:7a0b70f56550	402	/// return external_abort;
WiredHome	125:7a0b70f56550	403	/// else
WiredHome	125:7a0b70f56550	404	/// return noerror;
WiredHome	125:7a0b70f56550	405	/// }
WiredHome	125:7a0b70f56550	406	/// @endcode
WiredHome	125:7a0b70f56550	407	///
WiredHome	125:7a0b70f56550	408	/// @param reason informs the callback why it is idle.
WiredHome	123:2f45e80fec5f	409	/// @returns noerror to allow the driver continue waiting.
WiredHome	123:2f45e80fec5f	410	/// @returns external_abort if the pending action should be aborted.
WiredHome	123:2f45e80fec5f	411	///
WiredHome	125:7a0b70f56550	412	typedef RetCode_t (* IdleCallback_T)(IdleReason_T reason);
WiredHome	123:2f45e80fec5f	413
WiredHome	125:7a0b70f56550	414	/// Basic constructor for a display based on the RAiO RA8875
WiredHome	125:7a0b70f56550	415	/// display controller, which can be used with no touchscreen,
WiredHome	125:7a0b70f56550	416	/// or the RA8875 managed resistive touchscreen.
WiredHome	124:1690a7ae871c	417	///
WiredHome	124:1690a7ae871c	418	/// This constructor differs from the alternate by supportting
WiredHome	124:1690a7ae871c	419	/// either No Touch Screen, or the RA8875 built-in resistive
WiredHome	125:7a0b70f56550	420	/// touch screen. If the application requires the use of the
WiredHome	125:7a0b70f56550	421	/// capacitive touchscreen, the alternate constructor should
WiredHome	125:7a0b70f56550	422	/// be used.
WiredHome	19:3f82c1161fd2	423	///
WiredHome	61:8f3153bf0baa	424	/// This configures the registers and calls the @ref init method.
WiredHome	61:8f3153bf0baa	425	///
WiredHome	56:7a85d226ad0d	426	/// @code
WiredHome	56:7a85d226ad0d	427	/// #include "RA8875.h"
WiredHome	56:7a85d226ad0d	428	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	56:7a85d226ad0d	429	///
WiredHome	56:7a85d226ad0d	430	/// int main()
WiredHome	56:7a85d226ad0d	431	/// {
WiredHome	81:01da2e34283d	432	/// lcd.init();
WiredHome	56:7a85d226ad0d	433	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	56:7a85d226ad0d	434	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	435	/// }
WiredHome	56:7a85d226ad0d	436	/// @endcode
WiredHome	56:7a85d226ad0d	437	///
WiredHome	72:ecffe56af969	438	/// @param[in] mosi is the SPI master out slave in pin on the mbed.
WiredHome	72:ecffe56af969	439	/// @param[in] miso is the SPI master in slave out pin on the mbed.
WiredHome	72:ecffe56af969	440	/// @param[in] sclk is the SPI shift clock pin on the mbed.
WiredHome	72:ecffe56af969	441	/// @param[in] csel is the DigitalOut pin on the mbed to use as the
WiredHome	19:3f82c1161fd2	442	/// active low chip select for the display controller.
WiredHome	72:ecffe56af969	443	/// @param[in] reset is the DigitalOut pin on the mbed to use as the
WiredHome	19:3f82c1161fd2	444	/// active low reset input on the display controller -
WiredHome	19:3f82c1161fd2	445	/// but this is not currently used.
WiredHome	72:ecffe56af969	446	/// @param[in] name is a text name for this object, which will permit
WiredHome	72:ecffe56af969	447	/// capturing stdout to puts() and printf() directly to it.
WiredHome	19:3f82c1161fd2	448	///
WiredHome	124:1690a7ae871c	449	RA8875(PinName mosi, PinName miso, PinName sclk, PinName csel, PinName reset,
WiredHome	124:1690a7ae871c	450	const char * name = "lcd");
WiredHome	124:1690a7ae871c	451
WiredHome	124:1690a7ae871c	452
WiredHome	124:1690a7ae871c	453	/// Constructor for a display based on the RAiO RA8875
WiredHome	124:1690a7ae871c	454	/// display controller (use for TouchScreen: Capacitive only)
WiredHome	124:1690a7ae871c	455	///
WiredHome	124:1690a7ae871c	456	/// This constructor differs from the alternate by including support
WiredHome	124:1690a7ae871c	457	/// for the Capactive Touch screen.
WiredHome	124:1690a7ae871c	458	///
WiredHome	125:7a0b70f56550	459	/// @code
WiredHome	125:7a0b70f56550	460	/// #include "RA8875.h"
WiredHome	125:7a0b70f56550	461	/// RA8875 lcd(p5, p6, p7, p12, NC, p9,p10,p13, "tft");
WiredHome	125:7a0b70f56550	462	///
WiredHome	125:7a0b70f56550	463	/// int main()
WiredHome	125:7a0b70f56550	464	/// {
WiredHome	125:7a0b70f56550	465	/// lcd.init();
WiredHome	125:7a0b70f56550	466	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	125:7a0b70f56550	467	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	125:7a0b70f56550	468	/// TouchCode_t tp = lcd.TouchPanelReadable();
WiredHome	125:7a0b70f56550	469	/// if (tp == touch)
WiredHome	125:7a0b70f56550	470	/// ...
WiredHome	125:7a0b70f56550	471	/// }
WiredHome	125:7a0b70f56550	472	/// @endcode
WiredHome	125:7a0b70f56550	473	///
WiredHome	124:1690a7ae871c	474	/// @param[in] mosi is the SPI master out slave in pin on the mbed.
WiredHome	124:1690a7ae871c	475	/// @param[in] miso is the SPI master in slave out pin on the mbed.
WiredHome	124:1690a7ae871c	476	/// @param[in] sclk is the SPI shift clock pin on the mbed.
WiredHome	124:1690a7ae871c	477	/// @param[in] csel is the DigitalOut pin on the mbed to use as the
WiredHome	124:1690a7ae871c	478	/// active low chip select for the display controller.
WiredHome	124:1690a7ae871c	479	/// @param[in] reset is the DigitalOut pin on the mbed to use as the
WiredHome	124:1690a7ae871c	480	/// active low reset input on the display controller -
WiredHome	124:1690a7ae871c	481	/// but this is not currently used.
WiredHome	124:1690a7ae871c	482	/// @param[in] sda is the I2C Serial Data pin you are wiring to the FT5206.
WiredHome	124:1690a7ae871c	483	/// @param[in] scl is the I2C Serial Clock pin you are wiring to the FT5206.
WiredHome	124:1690a7ae871c	484	/// @param[in] irq is the Interrupt Request pin you are wiring to the FT5206.
WiredHome	124:1690a7ae871c	485	/// @param[in] name is a text name for this object, which will permit
WiredHome	124:1690a7ae871c	486	/// capturing stdout to puts() and printf() directly to it.
WiredHome	124:1690a7ae871c	487	///
WiredHome	124:1690a7ae871c	488	RA8875(PinName mosi, PinName miso, PinName sclk, PinName csel, PinName reset,
WiredHome	124:1690a7ae871c	489	PinName sda, PinName scl, PinName irq, const char * name = "lcd");
WiredHome	124:1690a7ae871c	490
WiredHome	19:3f82c1161fd2	491
WiredHome	45:679c2fb8480c	492	// Destructor doesn't have much to do as this would typically be created
WiredHome	45:679c2fb8480c	493	// at startup, and not at runtime.
WiredHome	19:3f82c1161fd2	494	//~RA8875();
WiredHome	19:3f82c1161fd2	495
WiredHome	79:544eb4964795	496	/// Initialize the driver.
WiredHome	79:544eb4964795	497	///
WiredHome	132:a5d7a8541683	498	/// The RA8875 can control typical displays from the 480x272 to 800x480, and it supports 8 or 16-bit color.
WiredHome	132:a5d7a8541683	499	/// It also supports 2 graphics layers, but it cannot support 2 layers at the maximum color depth and
WiredHome	132:a5d7a8541683	500	/// screen size. When configured under 480x400, it will support both 16-bit color depth and 2 drawing layers.
WiredHome	132:a5d7a8541683	501	/// Above 480x400 it support either 16-bit color, or 2 layers, but not both.
WiredHome	132:a5d7a8541683	502	///
WiredHome	132:a5d7a8541683	503	/// Typical of the displays that are readily purchased, you will find 480x272 and 800x480 resolutions.
WiredHome	106:c80828f5dea4	504	///
WiredHome	81:01da2e34283d	505	/// @param[in] width in pixels to configure the display for. This parameter is optional
WiredHome	81:01da2e34283d	506	/// and the default is 480.
WiredHome	81:01da2e34283d	507	/// @param[in] height in pixels to configure the display for. This parameter is optional
WiredHome	81:01da2e34283d	508	/// and the default is 272.
WiredHome	81:01da2e34283d	509	/// @param[in] color_bpp can be either 8 or 16, but must be consistent
WiredHome	81:01da2e34283d	510	/// with the width and height parameters. This parameter is optional
WiredHome	81:01da2e34283d	511	/// and the default is 16.
WiredHome	131:5bd6ba2ee4a1	512	/// @param[in] poweron defines if the display should be initialized into the power-on or off state.
WiredHome	132:a5d7a8541683	513	/// If power is non-zero(on), the backlight is set to this value. This parameter is optional
WiredHome	131:5bd6ba2ee4a1	514	/// and the default is 255 (on and full brightness). See @ref Power.
WiredHome	81:01da2e34283d	515	/// @param[in] keypadon defines if the keypad support should be enabled. This parameter is optional
WiredHome	106:c80828f5dea4	516	/// and the default is true (enabled). See @ref KeypadInit.
WiredHome	124:1690a7ae871c	517	/// @param[in] touchscreeenon defines if the touchscreen support should be enabled.
WiredHome	132:a5d7a8541683	518	/// This parameter is optional and the default is true (enabled). See @ref TouchPanelInit.
WiredHome	124:1690a7ae871c	519	/// - If the constructor was called with support for the capacitive driver, this
WiredHome	124:1690a7ae871c	520	/// parameter causes the driver to initialize.
WiredHome	124:1690a7ae871c	521	/// - If the constructor was called without support for the capacitive driver, this
WiredHome	124:1690a7ae871c	522	/// parameter is used to enable and initialize the resistive touchscreen driver.
WiredHome	106:c80828f5dea4	523	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	79:544eb4964795	524	///
WiredHome	81:01da2e34283d	525	RetCode_t init(int width = 480, int height = 272, int color_bpp = 16,
WiredHome	131:5bd6ba2ee4a1	526	uint8_t poweron = 255, bool keypadon = true, bool touchscreeenon = true);
WiredHome	124:1690a7ae871c	527
WiredHome	125:7a0b70f56550	528
WiredHome	79:544eb4964795	529	/// Get a pointer to the error code.
WiredHome	79:544eb4964795	530	///
WiredHome	79:544eb4964795	531	/// This method returns a pointer to a text string that matches the
WiredHome	106:c80828f5dea4	532	/// code. See @ref RetCode_t.
WiredHome	79:544eb4964795	533	///
WiredHome	79:544eb4964795	534	/// @param[in] code is the return value from RetCode_t to look up.
WiredHome	79:544eb4964795	535	/// @returns a pointer to the text message representing code. If code
WiredHome	79:544eb4964795	536	/// is not a valid value, then it returns the text for bad_parameter;
WiredHome	125:7a0b70f56550	537	///
WiredHome	79:544eb4964795	538	const char * GetErrorMessage(RetCode_t code);
WiredHome	79:544eb4964795	539
WiredHome	79:544eb4964795	540
WiredHome	50:2c4f474a2453	541	/// Select the drawing layer for subsequent commands.
WiredHome	43:3becae133285	542	///
WiredHome	43:3becae133285	543	/// If the screen configuration is 480 x 272, or if it is 800 x 480
WiredHome	43:3becae133285	544	/// and 8-bit color, the the display supports two layers, which can
WiredHome	43:3becae133285	545	/// be independently drawn on and shown. Additionally, complex
WiredHome	43:3becae133285	546	/// operations involving both layers are permitted.
WiredHome	43:3becae133285	547	///
WiredHome	56:7a85d226ad0d	548	/// @code
WiredHome	56:7a85d226ad0d	549	/// //lcd.SetLayerMode(OnlyLayer0); // default is layer 0
WiredHome	56:7a85d226ad0d	550	/// lcd.rect(400,130, 475,155,Brown);
WiredHome	56:7a85d226ad0d	551	/// lcd.SelectDrawingLayer(1);
WiredHome	56:7a85d226ad0d	552	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	553	/// wait(1);
WiredHome	56:7a85d226ad0d	554	/// lcd.SetLayerMode(ShowLayer1);
WiredHome	56:7a85d226ad0d	555	/// @endcode
WiredHome	56:7a85d226ad0d	556	///
WiredHome	61:8f3153bf0baa	557	/// @attention The user manual refers to Layer 1 and Layer 2, however the
WiredHome	61:8f3153bf0baa	558	/// actual register values are value 0 and 1. This API as well as
WiredHome	61:8f3153bf0baa	559	/// others that reference the layers use the values 0 and 1 for
WiredHome	61:8f3153bf0baa	560	/// cleaner iteration in the code.
WiredHome	43:3becae133285	561	///
WiredHome	72:ecffe56af969	562	/// @param[in] layer is 0 or 1 to select the layer for subsequent
WiredHome	61:8f3153bf0baa	563	/// commands.
WiredHome	106:c80828f5dea4	564	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	43:3becae133285	565	///
WiredHome	50:2c4f474a2453	566	RetCode_t SelectDrawingLayer(uint16_t layer);
WiredHome	125:7a0b70f56550	567
WiredHome	43:3becae133285	568
WiredHome	61:8f3153bf0baa	569	/// Get the currently active drawing layer.
WiredHome	61:8f3153bf0baa	570	///
WiredHome	61:8f3153bf0baa	571	/// This returns a value, 0 or 1, based on the screen configuration
WiredHome	61:8f3153bf0baa	572	/// and the currently active drawing layer.
WiredHome	61:8f3153bf0baa	573	///
WiredHome	61:8f3153bf0baa	574	/// @code
WiredHome	61:8f3153bf0baa	575	/// uint16_t prevLayer = lcd.GetDrawingLayer();
WiredHome	61:8f3153bf0baa	576	/// lcd.SelectDrawingLayer(x);
WiredHome	61:8f3153bf0baa	577	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	61:8f3153bf0baa	578	/// lcd.SelectDrawingLayer(prevLayer);
WiredHome	61:8f3153bf0baa	579	/// @endcode
WiredHome	61:8f3153bf0baa	580	///
WiredHome	61:8f3153bf0baa	581	/// @attention The user manual refers to Layer 1 and Layer 2, however the
WiredHome	61:8f3153bf0baa	582	/// actual register values are value 0 and 1. This API as well as
WiredHome	61:8f3153bf0baa	583	/// others that reference the layers use the values 0 and 1 for
WiredHome	61:8f3153bf0baa	584	/// cleaner iteration in the code.
WiredHome	61:8f3153bf0baa	585	///
WiredHome	61:8f3153bf0baa	586	/// @returns the current drawing layer; 0 or 1.
WiredHome	61:8f3153bf0baa	587	///
WiredHome	61:8f3153bf0baa	588	uint16_t GetDrawingLayer(void);
WiredHome	125:7a0b70f56550	589
WiredHome	61:8f3153bf0baa	590
WiredHome	44:207594dece70	591	/// Set the Layer presentation mode.
WiredHome	44:207594dece70	592	///
WiredHome	44:207594dece70	593	/// This sets the presentation mode for layers, and permits showing
WiredHome	44:207594dece70	594	/// a single layer, or applying a mode where the two layers
WiredHome	44:207594dece70	595	/// are combined using one of the hardware methods.
WiredHome	44:207594dece70	596	///
WiredHome	61:8f3153bf0baa	597	/// Refer to the RA8875 data sheet for full details.
WiredHome	61:8f3153bf0baa	598	///
WiredHome	56:7a85d226ad0d	599	/// @code
WiredHome	56:7a85d226ad0d	600	/// //lcd.SetLayerMode(OnlyLayer0); // default is layer 0
WiredHome	56:7a85d226ad0d	601	/// lcd.rect(400,130, 475,155,Brown);
WiredHome	56:7a85d226ad0d	602	/// lcd.SelectDrawingLayer(1);
WiredHome	56:7a85d226ad0d	603	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	604	/// wait(1);
WiredHome	56:7a85d226ad0d	605	/// lcd.SetLayerMode(ShowLayer1);
WiredHome	56:7a85d226ad0d	606	/// @endcode
WiredHome	56:7a85d226ad0d	607	///
WiredHome	72:ecffe56af969	608	/// @param[in] mode sets the mode in the Layer Transparency Register.
WiredHome	106:c80828f5dea4	609	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	44:207594dece70	610	///
WiredHome	53:86d24b9480b9	611	RetCode_t SetLayerMode(LayerMode_T mode);
WiredHome	125:7a0b70f56550	612
WiredHome	44:207594dece70	613
WiredHome	82:f7d300f26540	614	/// Get the Layer presentation mode.
WiredHome	82:f7d300f26540	615	///
WiredHome	106:c80828f5dea4	616	/// This gets the current layer mode. See @ref LayerMode_T.
WiredHome	82:f7d300f26540	617	///
WiredHome	82:f7d300f26540	618	/// @returns layer mode.
WiredHome	82:f7d300f26540	619	///
WiredHome	82:f7d300f26540	620	LayerMode_T GetLayerMode(void);
WiredHome	125:7a0b70f56550	621
WiredHome	82:f7d300f26540	622
WiredHome	44:207594dece70	623	/// Set the layer transparency for each layer.
WiredHome	44:207594dece70	624	///
WiredHome	44:207594dece70	625	/// Set the transparency, where the range of values is
WiredHome	44:207594dece70	626	/// from zero (fully visible) to eight (fully transparent).
WiredHome	44:207594dece70	627	/// The input value is automatically limited to this range.
WiredHome	44:207594dece70	628	///
WiredHome	56:7a85d226ad0d	629	/// @code
WiredHome	56:7a85d226ad0d	630	/// // draw something on each layer, then step-fade across
WiredHome	56:7a85d226ad0d	631	/// display.SetLayerMode(RA8875::TransparentMode);
WiredHome	56:7a85d226ad0d	632	/// for (i=0; i<=8; i++) {
WiredHome	56:7a85d226ad0d	633	/// display.SetLayerTransparency(i, 8-i);
WiredHome	56:7a85d226ad0d	634	/// wait_ms(200);
WiredHome	56:7a85d226ad0d	635	/// }
WiredHome	56:7a85d226ad0d	636	/// @endcode
WiredHome	56:7a85d226ad0d	637	///
WiredHome	72:ecffe56af969	638	/// @param[in] layer1 sets the layer 1 transparency.
WiredHome	72:ecffe56af969	639	/// @param[in] layer2 sets the layer 2 transparency.
WiredHome	106:c80828f5dea4	640	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	44:207594dece70	641	///
WiredHome	44:207594dece70	642	RetCode_t SetLayerTransparency(uint8_t layer1, uint8_t layer2);
WiredHome	125:7a0b70f56550	643
WiredHome	44:207594dece70	644
WiredHome	53:86d24b9480b9	645	/// Set the background color register used for transparency.
WiredHome	53:86d24b9480b9	646	///
WiredHome	53:86d24b9480b9	647	/// This command sets the background color registers that are used
WiredHome	53:86d24b9480b9	648	/// in the transparent color operations involving the layers.
WiredHome	53:86d24b9480b9	649	///
WiredHome	72:ecffe56af969	650	/// @param[in] color is optional and expressed in 16-bit format. If not
WiredHome	53:86d24b9480b9	651	/// supplied, a default of Black is used.
WiredHome	106:c80828f5dea4	652	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	53:86d24b9480b9	653	///
WiredHome	53:86d24b9480b9	654	RetCode_t SetBackgroundTransparencyColor(color_t color = RGB(0,0,0));
hexley	54:e117ad10fba6	655
WiredHome	73:f22a18707b5e	656
WiredHome	73:f22a18707b5e	657	/// Get the background color value used for transparency.
WiredHome	73:f22a18707b5e	658	///
WiredHome	73:f22a18707b5e	659	/// This command reads the background color registers that define
WiredHome	73:f22a18707b5e	660	/// the transparency color for operations involving layers.
WiredHome	73:f22a18707b5e	661	///
WiredHome	73:f22a18707b5e	662	/// @returns the color.
WiredHome	73:f22a18707b5e	663	///
WiredHome	73:f22a18707b5e	664	color_t GetBackgroundTransparencyColor(void);
WiredHome	73:f22a18707b5e	665
WiredHome	125:7a0b70f56550	666
hexley	54:e117ad10fba6	667	/// Initialize theTouch Panel controller with default values
hexley	54:e117ad10fba6	668	///
WiredHome	78:faf49c381591	669	/// This activates the simplified touch panel init, which may work for
WiredHome	78:faf49c381591	670	/// most uses. The alternate API is available if fine-grained control
WiredHome	124:1690a7ae871c	671	/// of the numerous settings of the resistive panel is needed.
WiredHome	78:faf49c381591	672	///
WiredHome	106:c80828f5dea4	673	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	56:7a85d226ad0d	674	///
hexley	54:e117ad10fba6	675	RetCode_t TouchPanelInit(void);
hexley	54:e117ad10fba6	676
WiredHome	125:7a0b70f56550	677
hexley	54:e117ad10fba6	678	/// Initialize the Touch Panel controller with detailed settings.
hexley	54:e117ad10fba6	679	///
WiredHome	78:faf49c381591	680	/// This is the detailed touch panel init, which provides the ability
WiredHome	124:1690a7ae871c	681	/// to set nearly every option.
WiredHome	124:1690a7ae871c	682	///
WiredHome	124:1690a7ae871c	683	/// @note If the capacitive touch panel was constructed, this behaves
WiredHome	124:1690a7ae871c	684	/// the same as the simplified version.
WiredHome	78:faf49c381591	685	///
hexley	54:e117ad10fba6	686	/// @param[in] bTpEnable Touch Panel enable/disable control:
hexley	54:e117ad10fba6	687	/// - TP_ENABLE: enable the touch panel
hexley	54:e117ad10fba6	688	/// - TP_DISABLE: disable the touch panel
WiredHome	56:7a85d226ad0d	689	/// @param[in] bTpAutoManual Touch Panel operating mode:
hexley	54:e117ad10fba6	690	/// - TP_MODE_AUTO: automatic capture
hexley	54:e117ad10fba6	691	/// - TP_MODE_MANUAL: manual capture
WiredHome	56:7a85d226ad0d	692	/// @param[in] bTpDebounce Debounce circuit enable for touch panel interrupt:
hexley	54:e117ad10fba6	693	/// - TP_DEBOUNCE_OFF: disable the debounce circuit
hexley	54:e117ad10fba6	694	/// - TP_DEBOUNCE_ON: enable the debounce circuit
WiredHome	56:7a85d226ad0d	695	/// @param[in] bTpManualMode When Manual Mode is selected, this sets the mode:
hexley	54:e117ad10fba6	696	/// - TP_MANUAL_IDLE: touch panel is idle
hexley	54:e117ad10fba6	697	/// - TP_MANUAL_WAIT: wait for touch panel event
hexley	54:e117ad10fba6	698	/// - TP_MANUAL_LATCH_X: latch X data
hexley	54:e117ad10fba6	699	/// - TP_MANUAL_LATCH_Y: latch Y data
WiredHome	56:7a85d226ad0d	700	/// @param[in] bTpAdcClkDiv Sets the ADC clock as a fraction of the System CLK:
hexley	54:e117ad10fba6	701	/// - TP_ADC_CLKDIV_1: Use CLK
hexley	54:e117ad10fba6	702	/// - TP_ADC_CLKDIV_2: Use CLK/2
hexley	54:e117ad10fba6	703	/// - TP_ADC_CLKDIV_4: Use CLK/4
hexley	54:e117ad10fba6	704	/// - TP_ADC_CLKDIV_8: Use CLK/8
hexley	54:e117ad10fba6	705	/// - TP_ADC_CLKDIV_16: Use CLK/16
hexley	54:e117ad10fba6	706	/// - TP_ADC_CLKDIV_32: Use CLK/32
hexley	54:e117ad10fba6	707	/// - TP_ADC_CLKDIV_64: Use CLK/64
hexley	54:e117ad10fba6	708	/// - TP_ADC_CLKDIV_128: Use CLK/128
WiredHome	56:7a85d226ad0d	709	/// @param[in] bTpAdcSampleTime Touch Panel sample time delay before ADC data is ready:
hexley	54:e117ad10fba6	710	/// - TP_ADC_SAMPLE_512_CLKS: Wait 512 system clocks
hexley	54:e117ad10fba6	711	/// - TP_ADC_SAMPLE_1024_CLKS: Wait 1024 system clocks
hexley	54:e117ad10fba6	712	/// - TP_ADC_SAMPLE_2048_CLKS: Wait 2048 system clocks
hexley	54:e117ad10fba6	713	/// - TP_ADC_SAMPLE_4096_CLKS: Wait 4096 system clocks
hexley	54:e117ad10fba6	714	/// - TP_ADC_SAMPLE_8192_CLKS: Wait 8192 system clocks
hexley	54:e117ad10fba6	715	/// - TP_ADC_SAMPLE_16384_CLKS: Wait 16384 system clocks
hexley	54:e117ad10fba6	716	/// - TP_ADC_SAMPLE_32768_CLKS: Wait 32768 system clocks
hexley	54:e117ad10fba6	717	/// - TP_ADC_SAMPLE_65536_CLKS: Wait 65536 system clocks
WiredHome	106:c80828f5dea4	718	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	56:7a85d226ad0d	719	///
WiredHome	78:faf49c381591	720	RetCode_t TouchPanelInit(uint8_t bTpEnable, uint8_t bTpAutoManual, uint8_t bTpDebounce,
WiredHome	78:faf49c381591	721	uint8_t bTpManualMode, uint8_t bTpAdcClkDiv, uint8_t bTpAdcSampleTime);
WiredHome	53:86d24b9480b9	722
WiredHome	123:2f45e80fec5f	723
WiredHome	123:2f45e80fec5f	724	/// Get the screen calibrated point of touch.
WiredHome	123:2f45e80fec5f	725	///
WiredHome	123:2f45e80fec5f	726	/// This method determines if there is a touch and if so it will provide
WiredHome	123:2f45e80fec5f	727	/// the screen-relative touch coordinates. This method can be used in
WiredHome	123:2f45e80fec5f	728	/// a manner similar to Serial.readable(), to determine if there was a
WiredHome	123:2f45e80fec5f	729	/// touch and indicate that - but not care about the coordinates. Alternately,
WiredHome	123:2f45e80fec5f	730	/// if a valid pointer to a point_t is provided, then if a touch is detected
WiredHome	123:2f45e80fec5f	731	/// the point_t will be populated with data.
WiredHome	123:2f45e80fec5f	732	///
WiredHome	123:2f45e80fec5f	733	/// @code
WiredHome	123:2f45e80fec5f	734	/// Timer t;
WiredHome	123:2f45e80fec5f	735	/// t.start();
WiredHome	123:2f45e80fec5f	736	/// do {
WiredHome	123:2f45e80fec5f	737	/// point_t point = {0, 0};
WiredHome	123:2f45e80fec5f	738	/// if (display.TouchPanelReadable(&point)) {
WiredHome	123:2f45e80fec5f	739	/// display.pixel(point, Red);
WiredHome	123:2f45e80fec5f	740	/// }
WiredHome	123:2f45e80fec5f	741	/// } while (t.read_ms() < 30000);
WiredHome	123:2f45e80fec5f	742	/// @endcode
WiredHome	123:2f45e80fec5f	743	///
WiredHome	123:2f45e80fec5f	744	/// @param[out] TouchPoint is a pointer to a point_t, which is set as the touch point, if a touch is registered.
WiredHome	123:2f45e80fec5f	745	/// @returns a value indicating the state of the touch,
WiredHome	123:2f45e80fec5f	746	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	123:2f45e80fec5f	747	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	123:2f45e80fec5f	748	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	123:2f45e80fec5f	749	/// - held: held after touch, touch coordinates are returned.
WiredHome	123:2f45e80fec5f	750	/// - release: indicates a release, touch coordinates are returned.
WiredHome	123:2f45e80fec5f	751	///
WiredHome	123:2f45e80fec5f	752	TouchCode_t TouchPanelReadable(point_t * TouchPoint = NULL);
WiredHome	123:2f45e80fec5f	753
WiredHome	125:7a0b70f56550	754
WiredHome	124:1690a7ae871c	755	/// Get the reported touch gesture, if any.
WiredHome	124:1690a7ae871c	756	///
WiredHome	124:1690a7ae871c	757	/// If it could detect a gesture, it will return a value based on
WiredHome	132:a5d7a8541683	758	/// the interpreted gesture.
WiredHome	124:1690a7ae871c	759	///
WiredHome	124:1690a7ae871c	760	/// Valid gesture values are:
WiredHome	124:1690a7ae871c	761	/// @li 0x00 No gesture
WiredHome	132:a5d7a8541683	762	/// @li 0x48 Zoom in
WiredHome	132:a5d7a8541683	763	/// @li 0x49 Zoom out
WiredHome	132:a5d7a8541683	764	///
WiredHome	132:a5d7a8541683	765	/// The following gestures are defined in the FT5206 specification, but
WiredHome	132:a5d7a8541683	766	/// do not appear to work.
WiredHome	124:1690a7ae871c	767	/// @li 0x10 Move up
WiredHome	124:1690a7ae871c	768	/// @li 0x14 Move left
WiredHome	124:1690a7ae871c	769	/// @li 0x18 Move down
WiredHome	124:1690a7ae871c	770	/// @li 0x1C Move right
WiredHome	124:1690a7ae871c	771	///
WiredHome	124:1690a7ae871c	772	/// @returns gesture information.
WiredHome	124:1690a7ae871c	773	///
WiredHome	124:1690a7ae871c	774	uint8_t TouchGesture(void) { return gesture; }
WiredHome	124:1690a7ae871c	775
WiredHome	123:2f45e80fec5f	776
WiredHome	124:1690a7ae871c	777	/// Get the count of registered touches.
WiredHome	124:1690a7ae871c	778	///
WiredHome	124:1690a7ae871c	779	/// @returns count of touch points to communicate; 0 to 5.
WiredHome	124:1690a7ae871c	780	///
WiredHome	124:1690a7ae871c	781	int TouchCount(void) { return numberOfTouchPoints; }
WiredHome	125:7a0b70f56550	782
WiredHome	124:1690a7ae871c	783
WiredHome	124:1690a7ae871c	784	/// Get the count of possible touch channels.
WiredHome	124:1690a7ae871c	785	///
WiredHome	124:1690a7ae871c	786	/// @returns count of touch channels supported by the hardware.
WiredHome	124:1690a7ae871c	787	///
WiredHome	124:1690a7ae871c	788	int TouchChannels(void);
WiredHome	125:7a0b70f56550	789
WiredHome	124:1690a7ae871c	790
WiredHome	124:1690a7ae871c	791	/// Get the Touch ID value for a specified touch channel.
WiredHome	124:1690a7ae871c	792	///
WiredHome	124:1690a7ae871c	793	/// Touch ID is a tracking number based on the order of the touch
WiredHome	124:1690a7ae871c	794	/// detections. The first touch is ID 0, the next is ID 1, and
WiredHome	124:1690a7ae871c	795	/// so on. If the first touch is lifted (no touch), the touch count
WiredHome	124:1690a7ae871c	796	/// decrements, and the remaining touch is communicated on
WiredHome	124:1690a7ae871c	797	/// touch channel zero, even as the Touch ID remains as originally
WiredHome	124:1690a7ae871c	798	/// reported (1 in this example). In this way, it is easy to track
WiredHome	132:a5d7a8541683	799	/// a specific touch.
WiredHome	124:1690a7ae871c	800	///
WiredHome	124:1690a7ae871c	801	/// It is possible to query the data for a channel that is not
WiredHome	124:1690a7ae871c	802	/// presently reported as touched.
WiredHome	124:1690a7ae871c	803	///
WiredHome	124:1690a7ae871c	804	/// @param[in] channel is the touch channel, from 0 to 4, or 0 to getTouchCount()-1
WiredHome	124:1690a7ae871c	805	/// It defaults to 0, in case the user is not interested in multi-touch.
WiredHome	124:1690a7ae871c	806	/// @returns the touch ID, or 15 if you get the ID for an untouched channel.
WiredHome	124:1690a7ae871c	807	/// @returns 0 if an invalid channel is queried.
WiredHome	124:1690a7ae871c	808	///
WiredHome	124:1690a7ae871c	809	uint8_t TouchID(uint8_t channel = 0) { return (channel < 5) ? touchInfo[channel].touchID : touchInfo[0].touchID; }
WiredHome	125:7a0b70f56550	810
WiredHome	124:1690a7ae871c	811
WiredHome	124:1690a7ae871c	812	/// Get the Touch Code for a touch channel.
WiredHome	124:1690a7ae871c	813	///
WiredHome	124:1690a7ae871c	814	/// It is possible to query the data for a channel that is not
WiredHome	124:1690a7ae871c	815	/// presently reported as touched.
WiredHome	124:1690a7ae871c	816	///
WiredHome	124:1690a7ae871c	817	/// @param[in] channel is the touch channel, from 0 to 4, or 0 to getTouchCount()-1
WiredHome	124:1690a7ae871c	818	/// It defaults to 0, in case the user is not interested in multi-touch.
WiredHome	124:1690a7ae871c	819	/// @returns the touch code (@ref TouchCode_t).
WiredHome	124:1690a7ae871c	820	/// @returns channel 0 information if an invalid channel is queried.
WiredHome	124:1690a7ae871c	821	///
WiredHome	124:1690a7ae871c	822	TouchCode_t TouchCode(uint8_t channel = 0) { return (channel < 5) ? touchInfo[channel].touchCode : touchInfo[0].touchCode; }
WiredHome	124:1690a7ae871c	823
WiredHome	125:7a0b70f56550	824
WiredHome	124:1690a7ae871c	825	/// Get the coordinates for a touch channel.
WiredHome	124:1690a7ae871c	826	///
WiredHome	124:1690a7ae871c	827	/// This returns the (X,Y) coordinates for a touch channel.
WiredHome	132:a5d7a8541683	828	///
WiredHome	124:1690a7ae871c	829	///
WiredHome	124:1690a7ae871c	830	/// It is possible to query the data for a channel that is not
WiredHome	124:1690a7ae871c	831	/// presently reported as touched.
WiredHome	124:1690a7ae871c	832	///
WiredHome	124:1690a7ae871c	833	/// @param[in] channel is an optional touch channel, from 0 to 4, or 0 to getTouchCount()-1.
WiredHome	124:1690a7ae871c	834	/// It defaults to 0, in case the user is not interested in multi-touch.
WiredHome	124:1690a7ae871c	835	/// @returns the coordinates as a point_t structure.
WiredHome	124:1690a7ae871c	836	/// @returns channel 0 information if an invalid channel is queried.
WiredHome	124:1690a7ae871c	837	///
WiredHome	124:1690a7ae871c	838	point_t TouchCoordinates(uint8_t channel = 0) { return (channel < 5) ? touchInfo[channel].coordinates : touchInfo[0].coordinates; }
WiredHome	125:7a0b70f56550	839
WiredHome	131:5bd6ba2ee4a1	840
WiredHome	79:544eb4964795	841	/// Poll the TouchPanel and on a touch event return the a to d filtered x, y coordinates.
hexley	54:e117ad10fba6	842	///
WiredHome	78:faf49c381591	843	/// This method reads the touch controller, which has a 10-bit range for each the
WiredHome	79:544eb4964795	844	/// x and the y axis.
WiredHome	79:544eb4964795	845	///
WiredHome	79:544eb4964795	846	/// @note The returned values are not in display (pixel) units but are in analog to
WiredHome	79:544eb4964795	847	/// digital converter units.
WiredHome	78:faf49c381591	848	///
WiredHome	131:5bd6ba2ee4a1	849	/// @note This API is usually not needed and is likely to be deprecated.
WiredHome	131:5bd6ba2ee4a1	850	/// See @ref TouchPanelComputeCalibration.
WiredHome	106:c80828f5dea4	851	/// See @ref TouchPanelReadable.
WiredHome	78:faf49c381591	852	///
WiredHome	79:544eb4964795	853	/// @param[out] x is the x scale a/d value.
WiredHome	79:544eb4964795	854	/// @param[out] y is the y scale a/d value.
WiredHome	83:7bad0068cca0	855	/// @returns a value indicating the state of the touch,
WiredHome	83:7bad0068cca0	856	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	857	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	858	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	83:7bad0068cca0	859	/// - held: held after touch, touch coordinates are returned.
WiredHome	83:7bad0068cca0	860	/// - release: indicates a release, touch coordinates are returned.
WiredHome	56:7a85d226ad0d	861	///
WiredHome	83:7bad0068cca0	862	TouchCode_t TouchPanelA2DFiltered(int x, int y);
hexley	54:e117ad10fba6	863
WiredHome	125:7a0b70f56550	864
WiredHome	79:544eb4964795	865	/// Poll the TouchPanel and on a touch event return the a to d raw x, y coordinates.
hexley	54:e117ad10fba6	866	///
WiredHome	78:faf49c381591	867	/// This method reads the touch controller, which has a 10-bit range for each the
WiredHome	78:faf49c381591	868	/// x and the y axis. A number of samples of the raw data are taken, filtered,
WiredHome	79:544eb4964795	869	/// and the results are returned.
WiredHome	78:faf49c381591	870	///
WiredHome	79:544eb4964795	871	/// @note The returned values are not in display (pixel) units but are in analog to
WiredHome	79:544eb4964795	872	/// digital converter units.
WiredHome	79:544eb4964795	873	///
WiredHome	131:5bd6ba2ee4a1	874	/// @note This API is usually not needed and is likely to be deprecated.
WiredHome	131:5bd6ba2ee4a1	875	/// See @ref TouchPanelComputeCalibration.
WiredHome	106:c80828f5dea4	876	/// See @ref TouchPanelReadable.
WiredHome	78:faf49c381591	877	///
WiredHome	79:544eb4964795	878	/// @param[out] x is the x scale a/d value.
WiredHome	79:544eb4964795	879	/// @param[out] y is the y scale a/d value.
WiredHome	83:7bad0068cca0	880	/// @returns a value indicating the state of the touch,
WiredHome	83:7bad0068cca0	881	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	882	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	883	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	83:7bad0068cca0	884	/// - held: held after touch, touch coordinates are returned.
WiredHome	83:7bad0068cca0	885	/// - release: indicates a release, touch coordinates are returned.
WiredHome	83:7bad0068cca0	886	///
WiredHome	83:7bad0068cca0	887	TouchCode_t TouchPanelA2DRaw(int x, int y);
WiredHome	125:7a0b70f56550	888
WiredHome	83:7bad0068cca0	889
WiredHome	85:022bba13c5c4	890	/// Wait for a touch panel touch and return it.
WiredHome	85:022bba13c5c4	891	///
WiredHome	85:022bba13c5c4	892	/// This method is similar to Serial.getc() in that it will wait for a touch
WiredHome	85:022bba13c5c4	893	/// and then return. In order to extract the coordinates of the touch, a
WiredHome	85:022bba13c5c4	894	/// valid pointer to a point_t must be provided.
WiredHome	85:022bba13c5c4	895	///
WiredHome	85:022bba13c5c4	896	/// @note There is no timeout on this function, so its use is not recommended.
WiredHome	85:022bba13c5c4	897	///
WiredHome	85:022bba13c5c4	898	/// @code
WiredHome	85:022bba13c5c4	899	/// Timer t;
WiredHome	85:022bba13c5c4	900	/// t.start();
WiredHome	85:022bba13c5c4	901	/// do {
WiredHome	85:022bba13c5c4	902	/// point_t point = {0, 0};
WiredHome	85:022bba13c5c4	903	/// display.TouchPanelGet(&point); // hangs here until touch
WiredHome	85:022bba13c5c4	904	/// display.pixel(point, Red);
WiredHome	85:022bba13c5c4	905	/// } while (t.read_ms() < 30000);
WiredHome	85:022bba13c5c4	906	/// @endcode
WiredHome	85:022bba13c5c4	907	///
WiredHome	85:022bba13c5c4	908	/// @param[out] TouchPoint is the touch point, if a touch is registered.
WiredHome	85:022bba13c5c4	909	/// @returns a value indicating the state of the touch,
WiredHome	85:022bba13c5c4	910	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	85:022bba13c5c4	911	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	85:022bba13c5c4	912	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	85:022bba13c5c4	913	/// - held: held after touch, touch coordinates are returned.
WiredHome	85:022bba13c5c4	914	/// - release: indicates a release, touch coordinates are returned.
WiredHome	85:022bba13c5c4	915	///
WiredHome	85:022bba13c5c4	916	TouchCode_t TouchPanelGet(point_t * TouchPoint);
WiredHome	85:022bba13c5c4	917
WiredHome	83:7bad0068cca0	918
WiredHome	77:9206c13aa527	919	/// Calibrate the touch panel.
WiredHome	77:9206c13aa527	920	///
WiredHome	77:9206c13aa527	921	/// This method accepts two lists - one list is target points in ,
WiredHome	77:9206c13aa527	922	/// display coordinates and the other is a lit of raw touch coordinate
WiredHome	77:9206c13aa527	923	/// values. It generates a calibration matrix for later use. This
WiredHome	77:9206c13aa527	924	/// matrix is also accessible to the calling API, which may store
WiredHome	77:9206c13aa527	925	/// the matrix in persistent memory and then install the calibration
WiredHome	77:9206c13aa527	926	/// matrix on the next power cycle. By doing so, it can avoid the
WiredHome	77:9206c13aa527	927	/// need to calibrate on every power cycle.
WiredHome	77:9206c13aa527	928	///
WiredHome	81:01da2e34283d	929	/// @note The methods "TouchPanelComputeCalibration", "TouchPanelReadable", and
WiredHome	77:9206c13aa527	930	/// indirectly the "TouchPanelSetMatrix" methods are all derived
WiredHome	77:9206c13aa527	931	/// from a program by Carlos E. Vidales. See the copyright note
WiredHome	77:9206c13aa527	932	/// for further details. See also the article
WiredHome	77:9206c13aa527	933	/// http://www.embedded.com/design/system-integration/4023968/How-To-Calibrate-Touch-Screens
WiredHome	77:9206c13aa527	934	///
WiredHome	77:9206c13aa527	935	/// @copyright Copyright (c) 2001, Carlos E. Vidales. All rights reserved.
WiredHome	78:faf49c381591	936	/// This sample program was written and put in the public domain
WiredHome	78:faf49c381591	937	/// by Carlos E. Vidales. The program is provided "as is"
WiredHome	78:faf49c381591	938	/// without warranty of any kind, either expressed or implied.
WiredHome	78:faf49c381591	939	/// If you choose to use the program within your own products
WiredHome	78:faf49c381591	940	/// you do so at your own risk, and assume the responsibility
WiredHome	78:faf49c381591	941	/// for servicing, repairing or correcting the program should
WiredHome	78:faf49c381591	942	/// it prove defective in any manner.
WiredHome	78:faf49c381591	943	/// You may copy and distribute the program's source code in any
WiredHome	78:faf49c381591	944	/// medium, provided that you also include in each copy an
WiredHome	78:faf49c381591	945	/// appropriate copyright notice and disclaimer of warranty.
WiredHome	78:faf49c381591	946	/// You may also modify this program and distribute copies of
WiredHome	78:faf49c381591	947	/// it provided that you include prominent notices stating
WiredHome	78:faf49c381591	948	/// that you changed the file(s) and the date of any change,
WiredHome	78:faf49c381591	949	/// and that you do not charge any royalties or licenses for
WiredHome	78:faf49c381591	950	/// its use.
WiredHome	77:9206c13aa527	951	///
WiredHome	77:9206c13aa527	952	/// @param[in] display is a pointer to a set of 3 points, which
WiredHome	77:9206c13aa527	953	/// are in display units of measure. These are the targets
WiredHome	77:9206c13aa527	954	/// the calibration was aiming for.
WiredHome	77:9206c13aa527	955	/// @param[in] screen is a pointer to a set of 3 points, which
WiredHome	77:9206c13aa527	956	/// are in touchscreen units of measure. These are the
WiredHome	77:9206c13aa527	957	/// registered touches.
WiredHome	77:9206c13aa527	958	/// @param[out] matrix is an optional parameter to hold the calibration matrix
WiredHome	77:9206c13aa527	959	/// as a result of the calibration. This can be saved in
WiredHome	77:9206c13aa527	960	/// non-volatile memory to recover the calibration after a power fail.
WiredHome	106:c80828f5dea4	961	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	77:9206c13aa527	962	///
WiredHome	81:01da2e34283d	963	RetCode_t TouchPanelComputeCalibration(point_t display[3], point_t screen[3], tpMatrix_t * matrix);
WiredHome	81:01da2e34283d	964
WiredHome	81:01da2e34283d	965
WiredHome	81:01da2e34283d	966	/// Perform the touch panel calibration process.
WiredHome	81:01da2e34283d	967	///
WiredHome	81:01da2e34283d	968	/// This method provides the easy "shortcut" to calibrating the touch panel.
WiredHome	81:01da2e34283d	969	/// The process will automatically generate the calibration points, present
WiredHome	81:01da2e34283d	970	/// the targets on-screen, detect the touches, compute the calibration
WiredHome	81:01da2e34283d	971	/// matrix, and optionally provide the calibration matrix to the calling code
WiredHome	81:01da2e34283d	972	/// for persistence in non-volatile memory.
WiredHome	81:01da2e34283d	973	///
WiredHome	81:01da2e34283d	974	/// @param[out] matrix is an optional parameter to hold the calibration matrix
WiredHome	81:01da2e34283d	975	/// as a result of the calibration. This can be saved in
WiredHome	81:01da2e34283d	976	/// non-volatile memory to recover the calibration after a power fail.
WiredHome	106:c80828f5dea4	977	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	81:01da2e34283d	978	///
WiredHome	85:022bba13c5c4	979	RetCode_t TouchPanelCalibrate(tpMatrix_t * matrix = NULL);
WiredHome	81:01da2e34283d	980
WiredHome	125:7a0b70f56550	981
WiredHome	81:01da2e34283d	982	/// Perform the touch panel calibration process.
WiredHome	81:01da2e34283d	983	///
WiredHome	81:01da2e34283d	984	/// This method provides the easy "shortcut" to calibrating the touch panel.
WiredHome	81:01da2e34283d	985	/// The process will automatically generate the calibration points, present
WiredHome	81:01da2e34283d	986	/// the targets on-screen, detect the touches, compute the calibration
WiredHome	81:01da2e34283d	987	/// matrix, and optionally provide the calibration matrix to the calling code
WiredHome	81:01da2e34283d	988	/// for persistence in non-volatile memory.
WiredHome	81:01da2e34283d	989	///
WiredHome	81:01da2e34283d	990	/// @param[in] msg is a text message to present on the screen during the
WiredHome	81:01da2e34283d	991	/// calibration process.
WiredHome	81:01da2e34283d	992	/// @param[out] matrix is an optional parameter to hold the calibration matrix
WiredHome	81:01da2e34283d	993	/// as a result of the calibration. This can be saved in
WiredHome	81:01da2e34283d	994	/// non-volatile memory to recover the calibration after a power fail.
WiredHome	88:bfddef6ec836	995	/// @param[in] maxwait_s is the maximum number of seconds to wait for a touch
WiredHome	88:bfddef6ec836	996	/// calibration. If no touch panel installed, it then reports
WiredHome	88:bfddef6ec836	997	/// touch_cal_timeout.
WiredHome	106:c80828f5dea4	998	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	81:01da2e34283d	999	///
WiredHome	88:bfddef6ec836	1000	RetCode_t TouchPanelCalibrate(const char * msg, tpMatrix_t * matrix = NULL, int maxwait_s = 15);
WiredHome	77:9206c13aa527	1001
WiredHome	125:7a0b70f56550	1002
WiredHome	77:9206c13aa527	1003	/// Set the calibration matrix for the touch panel.
WiredHome	77:9206c13aa527	1004	///
WiredHome	77:9206c13aa527	1005	/// This method is used to set the calibration matrix for the touch panel. After
WiredHome	106:c80828f5dea4	1006	/// performing the calibration (See @ref TouchPanelComputeCalibration), the matrix can be stored.
WiredHome	77:9206c13aa527	1007	/// On a subsequence power cycle, the matrix may be restored from non-volatile and
WiredHome	77:9206c13aa527	1008	/// passed in to this method. It will then be held to perform the corrections when
WiredHome	77:9206c13aa527	1009	/// reading the touch panel point.
WiredHome	77:9206c13aa527	1010	///
WiredHome	78:faf49c381591	1011	/// @code
WiredHome	78:faf49c381591	1012	/// FILE * fh = fopen("/local/tpmatrix.cfg", "r");
WiredHome	78:faf49c381591	1013	/// if (fh) {
WiredHome	78:faf49c381591	1014	/// tpMatrix_t matrix;
WiredHome	78:faf49c381591	1015	/// if (fread(fh, &matrix, sizeof(tpMatrix_t))) {
WiredHome	78:faf49c381591	1016	/// lcd.TouchPanelSetMatrix(&matrix);
WiredHome	78:faf49c381591	1017	/// }
WiredHome	78:faf49c381591	1018	/// fclose(fh);
WiredHome	78:faf49c381591	1019	/// }
WiredHome	78:faf49c381591	1020	/// @endcode
WiredHome	78:faf49c381591	1021	///
WiredHome	77:9206c13aa527	1022	/// @param[in] matrix is a pointer to the touch panel calibration matrix.
WiredHome	106:c80828f5dea4	1023	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	77:9206c13aa527	1024	///
WiredHome	77:9206c13aa527	1025	RetCode_t TouchPanelSetMatrix(tpMatrix_t * matrix);
WiredHome	78:faf49c381591	1026
WiredHome	125:7a0b70f56550	1027
WiredHome	75:ca78388cfd77	1028	#if 0
hexley	54:e117ad10fba6	1029	/// Append interrupt handler for specific RA8875 interrupt source
hexley	54:e117ad10fba6	1030	///
hexley	54:e117ad10fba6	1031	/// @param[in] bISRType Interrupt Source, should be:
hexley	54:e117ad10fba6	1032	/// - RA8875_INT_KEYSCAN: KEYCAN interrupt
hexley	54:e117ad10fba6	1033	/// - RA8875_INT_DMA: DMA interrupt
hexley	54:e117ad10fba6	1034	/// - RA8875_INT_TP: Touch panel interrupt
hexley	54:e117ad10fba6	1035	/// - RA8875_INT_BTE: BTE process complete interrupt
hexley	54:e117ad10fba6	1036	/// - RA8875_INT_BTEMCU_FONTWR: Multi-purpose interrupt (see spec sheet)
WiredHome	56:7a85d226ad0d	1037	/// @param[in] fptr is a callback function to handle the interrupt event.
WiredHome	56:7a85d226ad0d	1038	/// @returns none
hexley	54:e117ad10fba6	1039	///
hexley	54:e117ad10fba6	1040	void AppendISR(uint8_t bISRType, void(*fptr)(void));
hexley	54:e117ad10fba6	1041
hexley	54:e117ad10fba6	1042	/// Unappend interrupt handler for specific RA8875 interrupt source
hexley	54:e117ad10fba6	1043	///
hexley	54:e117ad10fba6	1044	/// @param[in] bISRType Interrupt Source, should be:
hexley	54:e117ad10fba6	1045	/// - RA8875_INT_KEYSCAN: KEYCAN interrupt
hexley	54:e117ad10fba6	1046	/// - RA8875_INT_DMA: DMA interrupt
hexley	54:e117ad10fba6	1047	/// - RA8875_INT_TP: Touch panel interrupt
hexley	54:e117ad10fba6	1048	/// - RA8875_INT_BTE: BTE process complete interrupt
hexley	54:e117ad10fba6	1049	/// - RA8875_INT_BTEMCU_FONTWR: Multi-purpose interrupt (see spec sheet)
hexley	54:e117ad10fba6	1050	/// @return none
hexley	54:e117ad10fba6	1051	///
hexley	54:e117ad10fba6	1052	void UnAppendISR(uint8_t bISRType);
WiredHome	75:ca78388cfd77	1053	#endif
WiredHome	77:9206c13aa527	1054
WiredHome	125:7a0b70f56550	1055
WiredHome	71:dcac8efd842d	1056	/// Initialize the keypad interface on the RA8875 controller.
WiredHome	71:dcac8efd842d	1057	///
WiredHome	71:dcac8efd842d	1058	/// Enables the keypad subsystem. It will scan the 4 x 5 matrix
WiredHome	131:5bd6ba2ee4a1	1059	/// and make available key presses.
WiredHome	71:dcac8efd842d	1060	///
WiredHome	71:dcac8efd842d	1061	/// @note See section 5-13 of RAIO RA8875 data sheet for more details.
WiredHome	125:7a0b70f56550	1062	/// @note When using the display from buy-display.com, be sure that
WiredHome	71:dcac8efd842d	1063	/// the option for the keypad is configured on the hardware.
WiredHome	71:dcac8efd842d	1064	///
WiredHome	71:dcac8efd842d	1065	/// All parameters are optional.
WiredHome	76:c981284eb513	1066	/// @param[in] scanEnable when true, enables the key scan function (default: true).
WiredHome	76:c981284eb513	1067	/// @param[in] longDetect when true, additionally enables the long key held detection (default: false).
WiredHome	71:dcac8efd842d	1068	/// @param[in] sampleTime setting (range: 0 - 3, default: 0).
WiredHome	71:dcac8efd842d	1069	/// @param[in] scanFrequency setting (range: 0 - 7, default: 0).
WiredHome	71:dcac8efd842d	1070	/// @param[in] longTimeAdjustment (range: 0 - 3, default: 0).
WiredHome	76:c981284eb513	1071	/// @param[in] interruptEnable when true, enables interrupts from keypress (default: false).
WiredHome	76:c981284eb513	1072	/// @param[in] wakeupEnable when true, activates the wakeup function (default: false).
WiredHome	71:dcac8efd842d	1073	///
WiredHome	106:c80828f5dea4	1074	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	71:dcac8efd842d	1075	///
WiredHome	71:dcac8efd842d	1076	RetCode_t KeypadInit(bool scanEnable = true, bool longDetect = false,
WiredHome	71:dcac8efd842d	1077	uint8_t sampleTime = 0, uint8_t scanFrequency = 0,
WiredHome	71:dcac8efd842d	1078	uint8_t longTimeAdjustment = 0,
WiredHome	71:dcac8efd842d	1079	bool interruptEnable = false, bool wakeupEnable = false);
WiredHome	71:dcac8efd842d	1080
WiredHome	125:7a0b70f56550	1081
WiredHome	75:ca78388cfd77	1082	/// Create Key Code definitions for the key matrix.
WiredHome	75:ca78388cfd77	1083	///
WiredHome	75:ca78388cfd77	1084	/// This API provides a table of 22 key-code assignments for the matrix of keys.
WiredHome	75:ca78388cfd77	1085	/// This can be used to translate the keys 1 - 20 into some other value, as
WiredHome	75:ca78388cfd77	1086	/// well as to communicate the "no key" (zero) and "error state" (21).
WiredHome	75:ca78388cfd77	1087	///
WiredHome	75:ca78388cfd77	1088	/// In this way, a keypad could easily emulate a piece of a keyboard, transforming
WiredHome	75:ca78388cfd77	1089	/// 0 - 20 into the values 0, '0', '1', '2', '3', '4', '5', '6', '7', '8',
WiredHome	125:7a0b70f56550	1090	/// '9', '+', '-', '*' , '/', '=', '(bs)', '(cr)', and so on...
WiredHome	75:ca78388cfd77	1091	///
WiredHome	75:ca78388cfd77	1092	/// @code
WiredHome	75:ca78388cfd77	1093	/// // Return Value by Row, Column Example reassignment
WiredHome	75:ca78388cfd77	1094	/// // Column 0 1 2 3 4
WiredHome	75:ca78388cfd77	1095	/// // +-------------------------+ +-------------------------+
WiredHome	76:c981284eb513	1096	/// // Row 0 \| 1 2 3 4 5 \| \| '7' '8' '9' ',' '<-' \|
WiredHome	75:ca78388cfd77	1097	/// // 1 \| 6 7 8 9 10 \| \| '4' '5' '6' '/' '-' \|
WiredHome	75:ca78388cfd77	1098	/// // 2 \| 11 12 13 14 15 \| \| '1' '2' '3' '*' '+' \|
WiredHome	76:c981284eb513	1099	/// // 3 \| 16 17 18 19 20 \| \| '0' '.' '(' ')' '\n' \|
WiredHome	75:ca78388cfd77	1100	/// // +-------------------------+ +-------------------------+
WiredHome	75:ca78388cfd77	1101	/// // Return value 0 = No Key pressed
WiredHome	75:ca78388cfd77	1102	/// // Return value 21 = Error
WiredHome	77:9206c13aa527	1103	/// const uint8_t CodeList[22] =
WiredHome	77:9206c13aa527	1104	/// {0, '7', '8', '9', ',', '\h',
WiredHome	77:9206c13aa527	1105	/// '4', '5', '6', '/', '-',
WiredHome	77:9206c13aa527	1106	/// '1', '2', '3', '*', '+',
WiredHome	77:9206c13aa527	1107	/// '0', '.', '(', ')', '\n',
WiredHome	77:9206c13aa527	1108	/// '\x1b'};
WiredHome	77:9206c13aa527	1109	/// lcd.SetKeyMap(CodeList);
WiredHome	75:ca78388cfd77	1110	/// @endcode
WiredHome	75:ca78388cfd77	1111	///
WiredHome	75:ca78388cfd77	1112	/// @param[in] CodeList is a pointer to an always available byte-array
WiredHome	75:ca78388cfd77	1113	/// where the first 22 bytes are used as the transformation
WiredHome	75:ca78388cfd77	1114	/// from raw code to your reassigned value.
WiredHome	75:ca78388cfd77	1115	/// If CodeList is NULL, the original raw value key map is
WiredHome	75:ca78388cfd77	1116	/// restored.
WiredHome	75:ca78388cfd77	1117	/// @returns noerror.
WiredHome	75:ca78388cfd77	1118	///
WiredHome	75:ca78388cfd77	1119	RetCode_t SetKeyMap(const uint8_t * CodeList = NULL);
WiredHome	75:ca78388cfd77	1120
WiredHome	125:7a0b70f56550	1121
WiredHome	71:dcac8efd842d	1122	/// Determine if a key has been hit
WiredHome	71:dcac8efd842d	1123	///
WiredHome	71:dcac8efd842d	1124	/// @returns true if a key has been hit
WiredHome	71:dcac8efd842d	1125	///
WiredHome	75:ca78388cfd77	1126	bool readable();
WiredHome	71:dcac8efd842d	1127
WiredHome	125:7a0b70f56550	1128
WiredHome	71:dcac8efd842d	1129	/// Blocking read of the keypad.
WiredHome	71:dcac8efd842d	1130	///
WiredHome	125:7a0b70f56550	1131	/// @note: This is a blocking read, so it is important to first call _kbhit()
WiredHome	71:dcac8efd842d	1132	/// to avoid hanging your processes.
WiredHome	71:dcac8efd842d	1133	///
WiredHome	71:dcac8efd842d	1134	/// A keypad connected to the RA8875 is connected in a matrix of 4 rows and 5 columns.
WiredHome	75:ca78388cfd77	1135	/// When pressed, this method will return a code in the range of 1 through 20, reserving
WiredHome	75:ca78388cfd77	1136	/// the value 0 to indicate that no key is pressed.
WiredHome	71:dcac8efd842d	1137	///
WiredHome	71:dcac8efd842d	1138	/// Additionally, if configured to detect a "long press", bit 7 will be set to indicate
WiredHome	71:dcac8efd842d	1139	/// this. In this situation, first a "normal press" would be detected and signaled and
WiredHome	71:dcac8efd842d	1140	/// soon after that a "long press" of the same key would be detected and communicated.
WiredHome	71:dcac8efd842d	1141	///
WiredHome	75:ca78388cfd77	1142	/// @return 8-bit where bit 7 indicates a long press. The remaining bits indicate the
WiredHome	75:ca78388cfd77	1143	/// keypress using 0 = no key pressed, 1 - 20 = the key pressed.
WiredHome	71:dcac8efd842d	1144	///
WiredHome	75:ca78388cfd77	1145	uint8_t getc();
WiredHome	75:ca78388cfd77	1146
WiredHome	82:f7d300f26540	1147
WiredHome	82:f7d300f26540	1148	/// Determine if a point is within a rectangle.
WiredHome	82:f7d300f26540	1149	///
WiredHome	82:f7d300f26540	1150	/// @param[in] rect is a rectangular region to use.
WiredHome	82:f7d300f26540	1151	/// @param[in] p is a point to analyze to see if it is within the rect.
WiredHome	82:f7d300f26540	1152	/// @returns true if p is within rect.
WiredHome	82:f7d300f26540	1153	///
WiredHome	82:f7d300f26540	1154	bool Intersect(rect_t rect, point_t p);
WiredHome	82:f7d300f26540	1155
WiredHome	131:5bd6ba2ee4a1	1156	/// Determine if a rectangle intersects another rectangle.
WiredHome	131:5bd6ba2ee4a1	1157	///
WiredHome	131:5bd6ba2ee4a1	1158	/// @param[in] rect1 is a rectangular region.
WiredHome	131:5bd6ba2ee4a1	1159	/// @param[in] rect2 is a second rectangular region.
WiredHome	131:5bd6ba2ee4a1	1160	/// @returns true if rect1 and rect2 intersect.
WiredHome	131:5bd6ba2ee4a1	1161	///
WiredHome	131:5bd6ba2ee4a1	1162	bool Intersect(rect_t rect1, rect_t rect2);
WiredHome	82:f7d300f26540	1163
WiredHome	38:38d503b4fad6	1164	/// Write a command to the display with a word of data.
WiredHome	38:38d503b4fad6	1165	///
WiredHome	38:38d503b4fad6	1166	/// This is a high level command, and may invoke several primitives.
WiredHome	38:38d503b4fad6	1167	///
WiredHome	72:ecffe56af969	1168	/// @param[in] command is the command to write.
WiredHome	72:ecffe56af969	1169	/// @param[in] data is data to be written to the command register.
WiredHome	106:c80828f5dea4	1170	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	38:38d503b4fad6	1171	///
WiredHome	38:38d503b4fad6	1172	RetCode_t WriteCommandW(uint8_t command, uint16_t data);
WiredHome	38:38d503b4fad6	1173
WiredHome	125:7a0b70f56550	1174
WiredHome	19:3f82c1161fd2	1175	/// Write a command to the display
WiredHome	19:3f82c1161fd2	1176	///
WiredHome	19:3f82c1161fd2	1177	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1178	///
WiredHome	72:ecffe56af969	1179	/// @param[in] command is the command to write.
WiredHome	72:ecffe56af969	1180	/// @param[in] data is optional data to be written to the command register
WiredHome	19:3f82c1161fd2	1181	/// and only occurs if the data is in the range [0 - 0xFF].
WiredHome	106:c80828f5dea4	1182	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1183	///
WiredHome	32:0e4f2ae512e2	1184	virtual RetCode_t WriteCommand(unsigned char command, unsigned int data = 0xFFFF);
WiredHome	125:7a0b70f56550	1185
WiredHome	19:3f82c1161fd2	1186
WiredHome	38:38d503b4fad6	1187	/// Write a data word to the display
WiredHome	38:38d503b4fad6	1188	///
WiredHome	38:38d503b4fad6	1189	/// This is a high level command, and may invoke several primitives.
WiredHome	38:38d503b4fad6	1190	///
WiredHome	72:ecffe56af969	1191	/// @param[in] data is the data to write.
WiredHome	106:c80828f5dea4	1192	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	38:38d503b4fad6	1193	///
WiredHome	38:38d503b4fad6	1194	RetCode_t WriteDataW(uint16_t data);
WiredHome	125:7a0b70f56550	1195
WiredHome	38:38d503b4fad6	1196
WiredHome	19:3f82c1161fd2	1197	/// Write a data byte to the display
WiredHome	19:3f82c1161fd2	1198	///
WiredHome	19:3f82c1161fd2	1199	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1200	///
WiredHome	72:ecffe56af969	1201	/// @param[in] data is the data to write.
WiredHome	106:c80828f5dea4	1202	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1203	///
WiredHome	32:0e4f2ae512e2	1204	virtual RetCode_t WriteData(unsigned char data);
WiredHome	125:7a0b70f56550	1205
WiredHome	19:3f82c1161fd2	1206
WiredHome	19:3f82c1161fd2	1207	/// Read a command register
WiredHome	19:3f82c1161fd2	1208	///
WiredHome	72:ecffe56af969	1209	/// @param[in] command is the command register to read.
WiredHome	19:3f82c1161fd2	1210	/// @returns the value read from the register.
WiredHome	19:3f82c1161fd2	1211	///
WiredHome	19:3f82c1161fd2	1212	unsigned char ReadCommand(unsigned char command);
WiredHome	136:224e03d5c31f	1213
WiredHome	136:224e03d5c31f	1214
WiredHome	136:224e03d5c31f	1215	/// Read a word from a command register
WiredHome	136:224e03d5c31f	1216	///
WiredHome	136:224e03d5c31f	1217	/// @param[in] command is the command register to read.
WiredHome	136:224e03d5c31f	1218	/// @returns the value read from the register.
WiredHome	136:224e03d5c31f	1219	///
WiredHome	136:224e03d5c31f	1220	uint16_t ReadCommandW(unsigned char command);
WiredHome	19:3f82c1161fd2	1221
WiredHome	136:224e03d5c31f	1222
WiredHome	41:2956a0a221e5	1223	/// Read a data byte from the display
WiredHome	19:3f82c1161fd2	1224	///
WiredHome	19:3f82c1161fd2	1225	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1226	///
WiredHome	19:3f82c1161fd2	1227	/// @returns data that was read.
WiredHome	19:3f82c1161fd2	1228	///
WiredHome	19:3f82c1161fd2	1229	unsigned char ReadData(void);
WiredHome	125:7a0b70f56550	1230
WiredHome	19:3f82c1161fd2	1231
WiredHome	41:2956a0a221e5	1232	/// Read a word from the display
WiredHome	41:2956a0a221e5	1233	///
WiredHome	41:2956a0a221e5	1234	/// This is a high level command, and may invoke several primitives.
WiredHome	41:2956a0a221e5	1235	///
WiredHome	41:2956a0a221e5	1236	/// @returns data that was read.
WiredHome	41:2956a0a221e5	1237	///
WiredHome	41:2956a0a221e5	1238	uint16_t ReadDataW(void);
WiredHome	41:2956a0a221e5	1239
WiredHome	125:7a0b70f56550	1240
WiredHome	19:3f82c1161fd2	1241	/// Read the display status
WiredHome	19:3f82c1161fd2	1242	///
WiredHome	19:3f82c1161fd2	1243	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1244	///
WiredHome	19:3f82c1161fd2	1245	/// @returns data that was read.
WiredHome	19:3f82c1161fd2	1246	///
WiredHome	19:3f82c1161fd2	1247	unsigned char ReadStatus(void);
WiredHome	19:3f82c1161fd2	1248
WiredHome	125:7a0b70f56550	1249
WiredHome	19:3f82c1161fd2	1250	/// get the width in pixels of the currently active font
WiredHome	19:3f82c1161fd2	1251	///
WiredHome	19:3f82c1161fd2	1252	/// @returns font width in pixels.
WiredHome	19:3f82c1161fd2	1253	///
WiredHome	37:f19b7e7449dc	1254	dim_t fontwidth(void);
WiredHome	19:3f82c1161fd2	1255
WiredHome	125:7a0b70f56550	1256
WiredHome	19:3f82c1161fd2	1257	/// get the height in pixels of the currently active font
WiredHome	19:3f82c1161fd2	1258	///
WiredHome	19:3f82c1161fd2	1259	/// @returns font height in pixels.
WiredHome	19:3f82c1161fd2	1260	///
WiredHome	37:f19b7e7449dc	1261	dim_t fontheight(void);
WiredHome	125:7a0b70f56550	1262
WiredHome	19:3f82c1161fd2	1263
WiredHome	19:3f82c1161fd2	1264	/// get the number of colums based on the currently active font
WiredHome	19:3f82c1161fd2	1265	///
WiredHome	19:3f82c1161fd2	1266	/// @returns number of columns.
WiredHome	19:3f82c1161fd2	1267	///
WiredHome	19:3f82c1161fd2	1268	virtual int columns(void);
WiredHome	19:3f82c1161fd2	1269
WiredHome	125:7a0b70f56550	1270
WiredHome	19:3f82c1161fd2	1271	/// get the number of rows based on the currently active font
WiredHome	19:3f82c1161fd2	1272	///
WiredHome	19:3f82c1161fd2	1273	/// @returns number of rows.
WiredHome	19:3f82c1161fd2	1274	///
WiredHome	19:3f82c1161fd2	1275	virtual int rows(void);
WiredHome	19:3f82c1161fd2	1276
WiredHome	125:7a0b70f56550	1277
WiredHome	19:3f82c1161fd2	1278	/// get the screen width in pixels
WiredHome	19:3f82c1161fd2	1279	///
WiredHome	19:3f82c1161fd2	1280	/// @returns screen width in pixels.
WiredHome	19:3f82c1161fd2	1281	///
WiredHome	38:38d503b4fad6	1282	virtual dim_t width(void);
WiredHome	19:3f82c1161fd2	1283
WiredHome	125:7a0b70f56550	1284
WiredHome	19:3f82c1161fd2	1285	/// get the screen height in pixels
WiredHome	19:3f82c1161fd2	1286	///
WiredHome	19:3f82c1161fd2	1287	/// @returns screen height in pixels.
WiredHome	19:3f82c1161fd2	1288	///
WiredHome	38:38d503b4fad6	1289	virtual dim_t height(void);
WiredHome	19:3f82c1161fd2	1290
WiredHome	125:7a0b70f56550	1291
WiredHome	43:3becae133285	1292	/// get the color depth in bits per pixel.
WiredHome	43:3becae133285	1293	///
WiredHome	43:3becae133285	1294	/// @returns 8 or 16 only.
WiredHome	43:3becae133285	1295	///
WiredHome	43:3becae133285	1296	virtual dim_t color_bpp(void);
WiredHome	43:3becae133285	1297
WiredHome	19:3f82c1161fd2	1298	/// Set cursor position based on the current font size.
WiredHome	19:3f82c1161fd2	1299	///
WiredHome	72:ecffe56af969	1300	/// @param[in] column is the horizontal position in character positions
WiredHome	72:ecffe56af969	1301	/// @param[in] row is the vertical position in character positions
WiredHome	106:c80828f5dea4	1302	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1303	///
WiredHome	37:f19b7e7449dc	1304	virtual RetCode_t locate(textloc_t column, textloc_t row);
WiredHome	19:3f82c1161fd2	1305
WiredHome	125:7a0b70f56550	1306
WiredHome	19:3f82c1161fd2	1307	/// Prepare the controller to write text to the screen by positioning
WiredHome	19:3f82c1161fd2	1308	/// the cursor.
WiredHome	19:3f82c1161fd2	1309	///
WiredHome	56:7a85d226ad0d	1310	/// @code
WiredHome	56:7a85d226ad0d	1311	/// lcd.SetTextCursor(100, 25);
WiredHome	56:7a85d226ad0d	1312	/// lcd.puts("Hello");
WiredHome	56:7a85d226ad0d	1313	/// @endcode
WiredHome	56:7a85d226ad0d	1314	///
WiredHome	72:ecffe56af969	1315	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	1316	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	106:c80828f5dea4	1317	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1318	///
WiredHome	37:f19b7e7449dc	1319	RetCode_t SetTextCursor(loc_t x, loc_t y);
WiredHome	29:422616aa04bd	1320
WiredHome	125:7a0b70f56550	1321
WiredHome	103:7e0464ca6c5c	1322	/// Prepare the controller to write text to the screen by positioning
WiredHome	103:7e0464ca6c5c	1323	/// the cursor.
WiredHome	103:7e0464ca6c5c	1324	///
WiredHome	103:7e0464ca6c5c	1325	/// @code
WiredHome	103:7e0464ca6c5c	1326	/// point_t point = {100, 25};
WiredHome	103:7e0464ca6c5c	1327	/// lcd.SetTextCursor(point);
WiredHome	103:7e0464ca6c5c	1328	/// lcd.puts("Hello");
WiredHome	103:7e0464ca6c5c	1329	/// @endcode
WiredHome	103:7e0464ca6c5c	1330	///
WiredHome	103:7e0464ca6c5c	1331	/// @param[in] p is the x:y point in pixels from the top-left.
WiredHome	106:c80828f5dea4	1332	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	103:7e0464ca6c5c	1333	///
WiredHome	103:7e0464ca6c5c	1334	RetCode_t SetTextCursor(point_t p);
WiredHome	103:7e0464ca6c5c	1335
WiredHome	125:7a0b70f56550	1336
WiredHome	37:f19b7e7449dc	1337	/// Get the current cursor position in pixels.
WiredHome	37:f19b7e7449dc	1338	///
WiredHome	56:7a85d226ad0d	1339	/// @code
WiredHome	56:7a85d226ad0d	1340	/// point_t point = GetTextCursor();
WiredHome	56:7a85d226ad0d	1341	/// if (point.x > 100 && point.y > 150)
WiredHome	56:7a85d226ad0d	1342	/// //...
WiredHome	56:7a85d226ad0d	1343	/// @endcode
WiredHome	56:7a85d226ad0d	1344	///
WiredHome	37:f19b7e7449dc	1345	/// @returns cursor position.
WiredHome	37:f19b7e7449dc	1346	///
WiredHome	37:f19b7e7449dc	1347	point_t GetTextCursor(void);
WiredHome	37:f19b7e7449dc	1348
WiredHome	125:7a0b70f56550	1349
WiredHome	29:422616aa04bd	1350	/// Get the current cursor horizontal position in pixels.
WiredHome	29:422616aa04bd	1351	///
WiredHome	29:422616aa04bd	1352	/// @returns cursor position horizontal offset.
WiredHome	29:422616aa04bd	1353	///
WiredHome	37:f19b7e7449dc	1354	loc_t GetTextCursor_X(void);
WiredHome	29:422616aa04bd	1355
WiredHome	125:7a0b70f56550	1356
WiredHome	29:422616aa04bd	1357	/// Get the current cursor vertical position in pixels.
WiredHome	29:422616aa04bd	1358	///
WiredHome	29:422616aa04bd	1359	/// @returns cursor position vertical offset.
WiredHome	29:422616aa04bd	1360	///
WiredHome	37:f19b7e7449dc	1361	loc_t GetTextCursor_Y(void);
WiredHome	29:422616aa04bd	1362
WiredHome	125:7a0b70f56550	1363
WiredHome	23:a50ded45dbaf	1364	/// Configure additional Cursor Control settings.
WiredHome	23:a50ded45dbaf	1365	///
WiredHome	23:a50ded45dbaf	1366	/// This API lets you modify other cursor control settings;
WiredHome	23:a50ded45dbaf	1367	/// Cursor visible/hidden, Cursor blink/normal,
WiredHome	23:a50ded45dbaf	1368	/// Cursor I-Beam/underscore/box.
WiredHome	23:a50ded45dbaf	1369	///
WiredHome	72:ecffe56af969	1370	/// @param[in] cursor can be set to NOCURSOR (default), IBEAM,
WiredHome	24:8ca861acf12d	1371	/// UNDER, or BLOCK.
WiredHome	72:ecffe56af969	1372	/// @param[in] blink can be set to true or false (default false)
WiredHome	106:c80828f5dea4	1373	/// @returns success/failure code. See @ref RetCode_t
WiredHome	23:a50ded45dbaf	1374	///
WiredHome	24:8ca861acf12d	1375	RetCode_t SetTextCursorControl(cursor_t cursor = NOCURSOR, bool blink = false);
WiredHome	125:7a0b70f56550	1376
WiredHome	23:a50ded45dbaf	1377
WiredHome	98:ecebed9b80b2	1378	/// Select the built-in ISO 8859-X font to use next.
WiredHome	19:3f82c1161fd2	1379	///
WiredHome	19:3f82c1161fd2	1380	/// Supported fonts: ISO 8859-1, -2, -3, -4
WiredHome	19:3f82c1161fd2	1381	///
WiredHome	125:7a0b70f56550	1382	/// @note This only modifies the choice of font from the RA8875 internal
WiredHome	98:ecebed9b80b2	1383	/// fonts.
WiredHome	98:ecebed9b80b2	1384	///
WiredHome	72:ecffe56af969	1385	/// @param[in] font selects the font for the subsequent text rendering.
WiredHome	19:3f82c1161fd2	1386	///
WiredHome	19:3f82c1161fd2	1387	/// @note if either hScale or vScale is outside of its permitted range,
WiredHome	19:3f82c1161fd2	1388	/// the command is not executed.
WiredHome	106:c80828f5dea4	1389	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1390	///
WiredHome	19:3f82c1161fd2	1391	RetCode_t SetTextFont(font_t font = ISO8859_1);
WiredHome	19:3f82c1161fd2	1392
WiredHome	125:7a0b70f56550	1393
WiredHome	84:e102021864b5	1394	/// Sets the display orientation.
WiredHome	84:e102021864b5	1395	///
WiredHome	84:e102021864b5	1396	/// @note This command does not let you "merge" text onto an existing
WiredHome	84:e102021864b5	1397	/// image, since it reuses the memory for the new orientation.
WiredHome	84:e102021864b5	1398	/// Therefore, it is recommended that you issue a cls() prior
WiredHome	84:e102021864b5	1399	/// to sending text to the screen, or you end with a blended
WiredHome	84:e102021864b5	1400	/// image that is probably not as intended.
WiredHome	84:e102021864b5	1401	///
WiredHome	125:7a0b70f56550	1402	/// @note This command only operates on the RA8875 internal fonts.
WiredHome	98:ecebed9b80b2	1403	///
WiredHome	84:e102021864b5	1404	/// @code
WiredHome	84:e102021864b5	1405	/// lcd.cls();
WiredHome	84:e102021864b5	1406	/// lcd.SetOrientation(RA8875::normal);
WiredHome	84:e102021864b5	1407	/// lcd.puts(30,30, "Normal Landscape");
WiredHome	84:e102021864b5	1408	/// wait_ms(2500);
WiredHome	84:e102021864b5	1409	///
WiredHome	84:e102021864b5	1410	/// lcd.cls();
WiredHome	84:e102021864b5	1411	/// lcd.SetOrientation(RA8875::rotate_90);
WiredHome	84:e102021864b5	1412	/// lcd.puts(30,30, "Rotated 90 Text\r\n");
WiredHome	84:e102021864b5	1413	/// wait_ms(2500);
WiredHome	84:e102021864b5	1414	///
WiredHome	84:e102021864b5	1415	/// lcd.cls();
WiredHome	84:e102021864b5	1416	/// lcd.SetOrientation(RA8875::rotate_180);
WiredHome	84:e102021864b5	1417	/// lcd.puts(30,30, "Rotated 180 Text\r\n");
WiredHome	84:e102021864b5	1418	/// wait_ms(2500);
WiredHome	84:e102021864b5	1419	///
WiredHome	84:e102021864b5	1420	/// lcd.cls();
WiredHome	84:e102021864b5	1421	/// lcd.SetOrientation(RA8875::rotate_270);
WiredHome	84:e102021864b5	1422	/// lcd.puts(30,30, "Rotated 270 Text\r\n");
WiredHome	84:e102021864b5	1423	/// wait_ms(2500);
WiredHome	84:e102021864b5	1424	/// @endcode
WiredHome	84:e102021864b5	1425	///
WiredHome	84:e102021864b5	1426	/// @param[in] angle defaults to normal, but can be rotated
WiredHome	84:e102021864b5	1427	/// - normal \| rotate_0
WiredHome	84:e102021864b5	1428	/// - rotate_90 (clockwise)
WiredHome	84:e102021864b5	1429	/// - rotate_180
WiredHome	84:e102021864b5	1430	/// - rotate_270 (clockwise)
WiredHome	106:c80828f5dea4	1431	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	84:e102021864b5	1432	///
WiredHome	84:e102021864b5	1433	RetCode_t SetOrientation(orientation_t angle = normal);
WiredHome	84:e102021864b5	1434
WiredHome	125:7a0b70f56550	1435
WiredHome	19:3f82c1161fd2	1436	/// Control the font behavior.
WiredHome	19:3f82c1161fd2	1437	///
WiredHome	19:3f82c1161fd2	1438	/// This command lets you make several modifications to any text that
WiredHome	56:7a85d226ad0d	1439	/// will be written to the screen.
WiredHome	19:3f82c1161fd2	1440	///
WiredHome	125:7a0b70f56550	1441	/// @note This command only operates on the RA8875 internal fonts.
WiredHome	98:ecebed9b80b2	1442	///
WiredHome	19:3f82c1161fd2	1443	/// Options can be combined:
WiredHome	19:3f82c1161fd2	1444	/// Default:
WiredHome	19:3f82c1161fd2	1445	/// @li Full alignment disabled,
WiredHome	19:3f82c1161fd2	1446	/// @li Font with Background color,
WiredHome	84:e102021864b5	1447	/// @li Font in normal orientiation, or rotated 90, 180, or 270 clockwise,
WiredHome	84:e102021864b5	1448	/// @li Horizontal scale x 1, 2, 3, or 4
WiredHome	84:e102021864b5	1449	/// @li Vertical scale x 1, 2, 3, or 4
WiredHome	84:e102021864b5	1450	///
WiredHome	84:e102021864b5	1451	/// @note alignment is a special mode for the fonts, when mixing half and
WiredHome	84:e102021864b5	1452	/// full fonts on one presentation. 'align_full' starts each full
WiredHome	84:e102021864b5	1453	/// character on an even alignment. See section 7-4-7 of the RA8875
WiredHome	84:e102021864b5	1454	/// specification.
WiredHome	19:3f82c1161fd2	1455	///
WiredHome	72:ecffe56af969	1456	/// @param[in] fillit defaults to FILL, but can be NOFILL
WiredHome	72:ecffe56af969	1457	/// @param[in] hScale defaults to 1, but can be 1, 2, 3, or 4,
WiredHome	19:3f82c1161fd2	1458	/// and scales the font size by this amount.
WiredHome	72:ecffe56af969	1459	/// @param[in] vScale defaults to 1, but can be 1, 2, 3, or 4,
WiredHome	19:3f82c1161fd2	1460	/// and scales the font size by this amount.
WiredHome	72:ecffe56af969	1461	/// @param[in] alignment defaults to align_none, but can be
WiredHome	19:3f82c1161fd2	1462	/// align_full.
WiredHome	19:3f82c1161fd2	1463	///
WiredHome	19:3f82c1161fd2	1464	/// @note if either hScale or vScale is outside of its permitted range,
WiredHome	19:3f82c1161fd2	1465	/// the command is not executed.
WiredHome	106:c80828f5dea4	1466	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1467	///
WiredHome	19:3f82c1161fd2	1468	RetCode_t SetTextFontControl(fill_t fillit = FILL,
WiredHome	19:3f82c1161fd2	1469	HorizontalScale hScale = 1,
WiredHome	19:3f82c1161fd2	1470	VerticalScale vScale = 1,
WiredHome	19:3f82c1161fd2	1471	alignment_t alignment = align_none);
WiredHome	19:3f82c1161fd2	1472
WiredHome	125:7a0b70f56550	1473
WiredHome	98:ecebed9b80b2	1474	/// Control the font size of the RA8875 internal fonts.
WiredHome	19:3f82c1161fd2	1475	///
WiredHome	19:3f82c1161fd2	1476	/// This command lets you set the font enlargement for both horizontal
WiredHome	19:3f82c1161fd2	1477	/// and vertical, independent of the rotation, background, and
WiredHome	106:c80828f5dea4	1478	/// alignment. See @ref SetTextFontControl.
WiredHome	19:3f82c1161fd2	1479	///
WiredHome	125:7a0b70f56550	1480	/// @note This command only operates on the RA8875 internal fonts.
WiredHome	98:ecebed9b80b2	1481	///
WiredHome	72:ecffe56af969	1482	/// @param[in] hScale defaults to 1, but can be 1, 2, 3, or 4,
WiredHome	19:3f82c1161fd2	1483	/// and scales the font size by this amount.
WiredHome	72:ecffe56af969	1484	/// @param[in] vScale is an optional parameter that defaults to the hScale value,
WiredHome	40:04aa280dfa39	1485	/// but can be 1, 2, 3, or 4, and scales the font size by this amount.
WiredHome	40:04aa280dfa39	1486	///
WiredHome	40:04aa280dfa39	1487	/// @code
WiredHome	40:04aa280dfa39	1488	/// lcd.SetTextFontSize(2); // Set the font to 2x normal size
WiredHome	56:7a85d226ad0d	1489	/// lcd.puts("Two times");
WiredHome	40:04aa280dfa39	1490	/// lcd.SetTextFontSize(2,3); // Set the font to 2x Width and 3x Height
WiredHome	56:7a85d226ad0d	1491	/// lcd.puts("22 3h");
WiredHome	40:04aa280dfa39	1492	/// lcd.SetTextFontSize(); // Restore to normal size in both dimensions
WiredHome	56:7a85d226ad0d	1493	/// lcd.puts("normal");
WiredHome	40:04aa280dfa39	1494	/// @endcode
WiredHome	19:3f82c1161fd2	1495	///
WiredHome	19:3f82c1161fd2	1496	/// @note if either hScale or vScale is outside of its permitted range,
WiredHome	19:3f82c1161fd2	1497	/// the command is not executed.
WiredHome	106:c80828f5dea4	1498	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1499	///
WiredHome	40:04aa280dfa39	1500	RetCode_t SetTextFontSize(HorizontalScale hScale = 1, VerticalScale vScale = -1);
WiredHome	127:db7f2c704693	1501
WiredHome	127:db7f2c704693	1502
WiredHome	127:db7f2c704693	1503	/// Get the text font size of the RA8875 internal fonts.
WiredHome	127:db7f2c704693	1504	///
WiredHome	127:db7f2c704693	1505	/// This command lets you retrieve the current settings for the font
WiredHome	127:db7f2c704693	1506	/// horizontal and vertical scale factors. The return value is
WiredHome	127:db7f2c704693	1507	/// one of the scale factors 1, 2, 3, or 4.
WiredHome	127:db7f2c704693	1508	///
WiredHome	127:db7f2c704693	1509	/// @param[out] hScale is a pointer to memory where the horizontal scale factor
WiredHome	127:db7f2c704693	1510	/// will be written. If the pointer is null, that item will be ignored.
WiredHome	127:db7f2c704693	1511	/// @param[out] vScale is a pointer to memory where the vertical scale factor
WiredHome	127:db7f2c704693	1512	/// will be written. If the pointer is null, that item will be ignored.
WiredHome	127:db7f2c704693	1513	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	127:db7f2c704693	1514	///
WiredHome	127:db7f2c704693	1515	RetCode_t GetTextFontSize(HorizontalScale * hScale, VerticalScale * vScale);
WiredHome	125:7a0b70f56550	1516
WiredHome	19:3f82c1161fd2	1517	/// put a character on the screen.
WiredHome	19:3f82c1161fd2	1518	///
WiredHome	72:ecffe56af969	1519	/// @param[in] c is the character.
WiredHome	19:3f82c1161fd2	1520	/// @returns the character, or EOF if there is an error.
WiredHome	19:3f82c1161fd2	1521	///
WiredHome	19:3f82c1161fd2	1522	virtual int _putc(int c);
WiredHome	19:3f82c1161fd2	1523
WiredHome	125:7a0b70f56550	1524
WiredHome	19:3f82c1161fd2	1525	/// Write string of text to the display
WiredHome	19:3f82c1161fd2	1526	///
WiredHome	56:7a85d226ad0d	1527	/// @code
WiredHome	56:7a85d226ad0d	1528	/// lcd.puts("Test STring");
WiredHome	56:7a85d226ad0d	1529	/// @endcode
WiredHome	56:7a85d226ad0d	1530	///
WiredHome	72:ecffe56af969	1531	/// @param[in] string is the null terminated string to send to the display.
WiredHome	19:3f82c1161fd2	1532	///
WiredHome	19:3f82c1161fd2	1533	void puts(const char * string);
WiredHome	125:7a0b70f56550	1534
WiredHome	19:3f82c1161fd2	1535
WiredHome	19:3f82c1161fd2	1536	/// Write string of text to the display at the specified location.
WiredHome	19:3f82c1161fd2	1537	///
WiredHome	56:7a85d226ad0d	1538	/// @code
WiredHome	56:7a85d226ad0d	1539	/// lcd.puts(10,25, "Test STring");
WiredHome	56:7a85d226ad0d	1540	/// @endcode
WiredHome	56:7a85d226ad0d	1541	///
WiredHome	72:ecffe56af969	1542	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	1543	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	72:ecffe56af969	1544	/// @param[in] string is the null terminated string to send to the display.
WiredHome	19:3f82c1161fd2	1545	///
WiredHome	37:f19b7e7449dc	1546	void puts(loc_t x, loc_t y, const char * string);
WiredHome	19:3f82c1161fd2	1547
WiredHome	125:7a0b70f56550	1548
WiredHome	19:3f82c1161fd2	1549	/// Prepare the controller to write binary data to the screen by positioning
WiredHome	19:3f82c1161fd2	1550	/// the memory cursor.
WiredHome	19:3f82c1161fd2	1551	///
WiredHome	72:ecffe56af969	1552	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	1553	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	106:c80828f5dea4	1554	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1555	///
WiredHome	37:f19b7e7449dc	1556	virtual RetCode_t SetGraphicsCursor(loc_t x, loc_t y);
WiredHome	125:7a0b70f56550	1557
WiredHome	136:224e03d5c31f	1558	/// Prepare the controller to write binary data to the screen by positioning
WiredHome	136:224e03d5c31f	1559	/// the memory cursor.
WiredHome	136:224e03d5c31f	1560	///
WiredHome	136:224e03d5c31f	1561	/// @param[in] p is the point representing the cursor position to set
WiredHome	136:224e03d5c31f	1562	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	136:224e03d5c31f	1563	///
WiredHome	136:224e03d5c31f	1564	virtual RetCode_t SetGraphicsCursor(point_t p);
WiredHome	136:224e03d5c31f	1565
WiredHome	136:224e03d5c31f	1566	/// Read the current graphics cursor position as a point.
WiredHome	136:224e03d5c31f	1567	///
WiredHome	136:224e03d5c31f	1568	/// @returns the graphics cursor as a point.
WiredHome	136:224e03d5c31f	1569	///
WiredHome	136:224e03d5c31f	1570	virtual point_t GetGraphicsCursor(void);
WiredHome	136:224e03d5c31f	1571
WiredHome	19:3f82c1161fd2	1572
WiredHome	41:2956a0a221e5	1573	/// Prepare the controller to read binary data from the screen by positioning
WiredHome	41:2956a0a221e5	1574	/// the memory read cursor.
WiredHome	41:2956a0a221e5	1575	///
WiredHome	72:ecffe56af969	1576	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	1577	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	106:c80828f5dea4	1578	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	41:2956a0a221e5	1579	///
WiredHome	41:2956a0a221e5	1580	virtual RetCode_t SetGraphicsCursorRead(loc_t x, loc_t y);
WiredHome	41:2956a0a221e5	1581
WiredHome	125:7a0b70f56550	1582
WiredHome	111:efe436c43aba	1583	/// Set the window, constraining where items are written to the screen.
WiredHome	111:efe436c43aba	1584	///
WiredHome	111:efe436c43aba	1585	/// After setting the window, text and graphics are constrained to this
WiredHome	111:efe436c43aba	1586	/// window. Text will wrap from the right edge back to the left and down
WiredHome	111:efe436c43aba	1587	/// one row and from the bottom to the top. Graphics drawing will be clipped
WiredHome	111:efe436c43aba	1588	/// at the edge of the window.
WiredHome	111:efe436c43aba	1589	///
WiredHome	111:efe436c43aba	1590	/// @note If the initial text write is outside the window, it will be shown
WiredHome	111:efe436c43aba	1591	/// where the cursor position it. Once the write hits the right edge of
WiredHome	111:efe436c43aba	1592	/// the defined window, it will then wrap back to the left edge. Once it
WiredHome	111:efe436c43aba	1593	/// hits the bottom, it wraps to the top of the window. For this reason,
WiredHome	111:efe436c43aba	1594	/// it is common to set the text cursor to the window.
WiredHome	19:3f82c1161fd2	1595	///
WiredHome	111:efe436c43aba	1596	/// @code
WiredHome	111:efe436c43aba	1597	/// rect_t r = {10,10, 90,90};
WiredHome	111:efe436c43aba	1598	/// lcd.window(r);
WiredHome	111:efe436c43aba	1599	/// lcd.SetTextCursor(r.p1.x, r.p1.y);
WiredHome	111:efe436c43aba	1600	/// lcd.puts("012345678901234567890123456789012345678901234567890");
WiredHome	111:efe436c43aba	1601	/// lcd.window(); restore to full screen
WiredHome	111:efe436c43aba	1602	/// @endcode
WiredHome	111:efe436c43aba	1603	///
WiredHome	111:efe436c43aba	1604	/// @param[in] r is the rect_t used to set the window.
WiredHome	111:efe436c43aba	1605	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	111:efe436c43aba	1606	///
WiredHome	111:efe436c43aba	1607	virtual RetCode_t window(rect_t r);
WiredHome	111:efe436c43aba	1608
WiredHome	125:7a0b70f56550	1609
WiredHome	111:efe436c43aba	1610	/// Set the window, constraining where items are written to the screen.
WiredHome	111:efe436c43aba	1611	///
WiredHome	111:efe436c43aba	1612	/// After setting the window, text and graphics are constrained to this
WiredHome	111:efe436c43aba	1613	/// window. Text will wrap from the right edge back to the left and down
WiredHome	111:efe436c43aba	1614	/// one row and from the bottom to the top. Graphics drawing will be clipped
WiredHome	111:efe436c43aba	1615	/// at the edge of the window.
WiredHome	111:efe436c43aba	1616	///
WiredHome	114:dbfb996bfbf3	1617	/// @note if no parameters are provided, it restores the window to full screen.
WiredHome	114:dbfb996bfbf3	1618	///
WiredHome	111:efe436c43aba	1619	/// @note If the initial text write is outside the window, it will be shown
WiredHome	111:efe436c43aba	1620	/// where the cursor position it. Once the write hits the right edge of
WiredHome	111:efe436c43aba	1621	/// the defined window, it will then wrap back to the left edge. Once it
WiredHome	111:efe436c43aba	1622	/// hits the bottom, it wraps to the top of the window. For this reason,
WiredHome	111:efe436c43aba	1623	/// it is common to set the text cursor to the window.
WiredHome	19:3f82c1161fd2	1624	///
WiredHome	56:7a85d226ad0d	1625	/// @code
WiredHome	56:7a85d226ad0d	1626	/// lcd.window(10,10, 80,80);
WiredHome	111:efe436c43aba	1627	/// lcd.SetTextCursor(10,10);
WiredHome	56:7a85d226ad0d	1628	/// lcd.puts("012345678901234567890123456789012345678901234567890");
WiredHome	111:efe436c43aba	1629	/// lcd.window(); restore to full screen
WiredHome	56:7a85d226ad0d	1630	/// @endcode
WiredHome	56:7a85d226ad0d	1631	///
WiredHome	72:ecffe56af969	1632	/// @param[in] x is the left edge in pixels.
WiredHome	72:ecffe56af969	1633	/// @param[in] y is the top edge in pixels.
WiredHome	72:ecffe56af969	1634	/// @param[in] width is the window width in pixels.
WiredHome	72:ecffe56af969	1635	/// @param[in] height is the window height in pixels.
WiredHome	106:c80828f5dea4	1636	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1637	///
WiredHome	111:efe436c43aba	1638	virtual RetCode_t window(loc_t x = 0, loc_t y = 0, dim_t width = (dim_t)-1, dim_t height = (dim_t)-1);
WiredHome	19:3f82c1161fd2	1639
WiredHome	125:7a0b70f56550	1640
WiredHome	61:8f3153bf0baa	1641	/// Clear either the specified layer, or the active layer.
WiredHome	19:3f82c1161fd2	1642	///
WiredHome	61:8f3153bf0baa	1643	/// The behavior is to clear the whole screen for the specified
WiredHome	61:8f3153bf0baa	1644	/// layer. When not specified, the active drawing layer is cleared.
WiredHome	61:8f3153bf0baa	1645	/// This command can also be used to specifically clear either,
WiredHome	106:c80828f5dea4	1646	/// or both layers. See @ref clsw().
WiredHome	19:3f82c1161fd2	1647	///
WiredHome	56:7a85d226ad0d	1648	/// @code
WiredHome	56:7a85d226ad0d	1649	/// lcd.cls();
WiredHome	56:7a85d226ad0d	1650	/// @endcode
WiredHome	56:7a85d226ad0d	1651	///
WiredHome	72:ecffe56af969	1652	/// @param[in] layers is optional. If not provided, the active layer
WiredHome	61:8f3153bf0baa	1653	/// is cleared. If bit 0 is set, layer 0 is cleared, if bit
WiredHome	61:8f3153bf0baa	1654	/// 1 is set, layer 1 is cleared. If both are set, both layers
WiredHome	61:8f3153bf0baa	1655	/// are cleared. Any other value does not cause an action.
WiredHome	61:8f3153bf0baa	1656	///
WiredHome	106:c80828f5dea4	1657	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1658	///
WiredHome	61:8f3153bf0baa	1659	virtual RetCode_t cls(uint16_t layers = 0);
WiredHome	125:7a0b70f56550	1660
WiredHome	19:3f82c1161fd2	1661
WiredHome	19:3f82c1161fd2	1662	/// Clear the screen, or clear only the active window.
WiredHome	19:3f82c1161fd2	1663	///
WiredHome	19:3f82c1161fd2	1664	/// The default behavior is to clear the whole screen. With the optional
WiredHome	19:3f82c1161fd2	1665	/// parameter, the action can be restricted to the active window, which
WiredHome	106:c80828f5dea4	1666	/// can be set with the See @ref window method.
WiredHome	19:3f82c1161fd2	1667	///
WiredHome	56:7a85d226ad0d	1668	/// @code
WiredHome	56:7a85d226ad0d	1669	/// lcd.window(20,20, 40,10);
WiredHome	56:7a85d226ad0d	1670	/// lcd.clsw();
WiredHome	56:7a85d226ad0d	1671	/// @endcode
WiredHome	56:7a85d226ad0d	1672	///
WiredHome	72:ecffe56af969	1673	/// @param[in] region is an optional parameter that defaults to FULLWINDOW
WiredHome	19:3f82c1161fd2	1674	/// or may be set to ACTIVEWINDOW.
WiredHome	106:c80828f5dea4	1675	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1676	///
WiredHome	19:3f82c1161fd2	1677	RetCode_t clsw(RA8875::Region_t region = FULLWINDOW);
WiredHome	19:3f82c1161fd2	1678
WiredHome	125:7a0b70f56550	1679
WiredHome	19:3f82c1161fd2	1680	/// Set the background color.
WiredHome	19:3f82c1161fd2	1681	///
WiredHome	72:ecffe56af969	1682	/// @param[in] color is expressed in 16-bit format.
WiredHome	106:c80828f5dea4	1683	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1684	///
WiredHome	19:3f82c1161fd2	1685	virtual RetCode_t background(color_t color);
WiredHome	125:7a0b70f56550	1686
WiredHome	19:3f82c1161fd2	1687
WiredHome	19:3f82c1161fd2	1688	/// Set the background color.
WiredHome	19:3f82c1161fd2	1689	///
WiredHome	72:ecffe56af969	1690	/// @param[in] r is the red element of the color.
WiredHome	72:ecffe56af969	1691	/// @param[in] g is the green element of the color.
WiredHome	72:ecffe56af969	1692	/// @param[in] b is the blue element of the color.
WiredHome	106:c80828f5dea4	1693	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1694	///
WiredHome	19:3f82c1161fd2	1695	virtual RetCode_t background(unsigned char r, unsigned char g, unsigned char b);
WiredHome	19:3f82c1161fd2	1696
WiredHome	125:7a0b70f56550	1697
WiredHome	19:3f82c1161fd2	1698	/// Set the foreground color.
WiredHome	19:3f82c1161fd2	1699	///
WiredHome	72:ecffe56af969	1700	/// @param[in] color is expressed in 16-bit format.
WiredHome	106:c80828f5dea4	1701	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1702	///
WiredHome	19:3f82c1161fd2	1703	virtual RetCode_t foreground(color_t color);
WiredHome	19:3f82c1161fd2	1704
WiredHome	125:7a0b70f56550	1705
WiredHome	19:3f82c1161fd2	1706	/// Set the foreground color.
WiredHome	19:3f82c1161fd2	1707	///
WiredHome	72:ecffe56af969	1708	/// @param[in] r is the red element of the color.
WiredHome	72:ecffe56af969	1709	/// @param[in] g is the green element of the color.
WiredHome	72:ecffe56af969	1710	/// @param[in] b is the blue element of the color.
WiredHome	106:c80828f5dea4	1711	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1712	///
WiredHome	37:f19b7e7449dc	1713	virtual RetCode_t foreground(unsigned char r, unsigned char g, unsigned char b);
WiredHome	19:3f82c1161fd2	1714
WiredHome	125:7a0b70f56550	1715
WiredHome	19:3f82c1161fd2	1716	/// Get the current foreground color value.
WiredHome	19:3f82c1161fd2	1717	///
WiredHome	19:3f82c1161fd2	1718	/// @returns the current foreground color.
WiredHome	19:3f82c1161fd2	1719	///
WiredHome	37:f19b7e7449dc	1720	color_t GetForeColor(void);
WiredHome	87:ee2240581aa7	1721
WiredHome	125:7a0b70f56550	1722
WiredHome	87:ee2240581aa7	1723	/// Draw a pixel in the specified color.
WiredHome	87:ee2240581aa7	1724	///
WiredHome	87:ee2240581aa7	1725	/// @note Unlike many other operations, this does not
WiredHome	87:ee2240581aa7	1726	/// set the forecolor!
WiredHome	87:ee2240581aa7	1727	///
WiredHome	87:ee2240581aa7	1728	/// @param[in] p is the point_t defining the location.
WiredHome	106:c80828f5dea4	1729	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	87:ee2240581aa7	1730	///
WiredHome	87:ee2240581aa7	1731	virtual RetCode_t pixel(point_t p, color_t color);
WiredHome	87:ee2240581aa7	1732
WiredHome	125:7a0b70f56550	1733
WiredHome	87:ee2240581aa7	1734	/// Draw a pixel in the current foreground color.
WiredHome	87:ee2240581aa7	1735	///
WiredHome	87:ee2240581aa7	1736	/// @param[in] p is the point_t defining the location.
WiredHome	106:c80828f5dea4	1737	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	87:ee2240581aa7	1738	///
WiredHome	87:ee2240581aa7	1739	virtual RetCode_t pixel(point_t p);
WiredHome	125:7a0b70f56550	1740
WiredHome	19:3f82c1161fd2	1741
WiredHome	19:3f82c1161fd2	1742	/// Draw a pixel in the specified color.
WiredHome	19:3f82c1161fd2	1743	///
WiredHome	41:2956a0a221e5	1744	/// @note Unlike many other operations, this does not
WiredHome	41:2956a0a221e5	1745	/// set the forecolor!
WiredHome	19:3f82c1161fd2	1746	///
WiredHome	72:ecffe56af969	1747	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	1748	/// @param[in] y is the vertical offset to this pixel.
WiredHome	72:ecffe56af969	1749	/// @param[in] color defines the color for the pixel.
WiredHome	106:c80828f5dea4	1750	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1751	///
WiredHome	37:f19b7e7449dc	1752	virtual RetCode_t pixel(loc_t x, loc_t y, color_t color);
WiredHome	19:3f82c1161fd2	1753
WiredHome	125:7a0b70f56550	1754
WiredHome	19:3f82c1161fd2	1755	/// Draw a pixel in the current foreground color.
WiredHome	19:3f82c1161fd2	1756	///
WiredHome	72:ecffe56af969	1757	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	1758	/// @param[in] y is the veritical offset to this pixel.
WiredHome	106:c80828f5dea4	1759	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1760	///
WiredHome	37:f19b7e7449dc	1761	virtual RetCode_t pixel(loc_t x, loc_t y);
WiredHome	19:3f82c1161fd2	1762
WiredHome	125:7a0b70f56550	1763
WiredHome	41:2956a0a221e5	1764	/// Get a pixel from the display.
WiredHome	41:2956a0a221e5	1765	///
WiredHome	72:ecffe56af969	1766	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	1767	/// @param[in] y is the vertical offset to this pixel.
WiredHome	41:2956a0a221e5	1768	/// @returns the pixel. see @color_t
WiredHome	41:2956a0a221e5	1769	///
WiredHome	41:2956a0a221e5	1770	virtual color_t getPixel(loc_t x, loc_t y);
WiredHome	41:2956a0a221e5	1771
WiredHome	125:7a0b70f56550	1772
WiredHome	136:224e03d5c31f	1773	/// Write an RGB565 stream of pixels to the display.
WiredHome	41:2956a0a221e5	1774	///
WiredHome	72:ecffe56af969	1775	/// @param[in] p is a pointer to a color_t array to write.
WiredHome	72:ecffe56af969	1776	/// @param[in] count is the number of pixels to write.
WiredHome	72:ecffe56af969	1777	/// @param[in] x is the horizontal position on the display.
WiredHome	72:ecffe56af969	1778	/// @param[in] y is the vertical position on the display.
WiredHome	106:c80828f5dea4	1779	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	41:2956a0a221e5	1780	///
WiredHome	41:2956a0a221e5	1781	virtual RetCode_t pixelStream(color_t * p, uint32_t count, loc_t x, loc_t y);
WiredHome	41:2956a0a221e5	1782
WiredHome	125:7a0b70f56550	1783
WiredHome	41:2956a0a221e5	1784	/// Get a stream of pixels from the display.
WiredHome	41:2956a0a221e5	1785	///
WiredHome	72:ecffe56af969	1786	/// @param[in] p is a pointer to a color_t array to accept the stream.
WiredHome	72:ecffe56af969	1787	/// @param[in] count is the number of pixels to read.
WiredHome	72:ecffe56af969	1788	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	1789	/// @param[in] y is the vertical offset to this pixel.
WiredHome	106:c80828f5dea4	1790	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	41:2956a0a221e5	1791	///
WiredHome	41:2956a0a221e5	1792	virtual RetCode_t getPixelStream(color_t * p, uint32_t count, loc_t x, loc_t y);
WiredHome	131:5bd6ba2ee4a1	1793
WiredHome	131:5bd6ba2ee4a1	1794
WiredHome	109:7b94f06f085b	1795	/// Write a boolean stream to the display.
WiredHome	109:7b94f06f085b	1796	///
WiredHome	109:7b94f06f085b	1797	/// This takes a bit stream in memory and using the current color settings
WiredHome	109:7b94f06f085b	1798	/// it will stream it to the display. Along the way, each bit is translated
WiredHome	109:7b94f06f085b	1799	/// to either the foreground or background color value and then that pixel
WiredHome	109:7b94f06f085b	1800	/// is pushed onward.
WiredHome	109:7b94f06f085b	1801	///
WiredHome	109:7b94f06f085b	1802	/// This is similar, but different, to the @ref pixelStream API, which is
WiredHome	109:7b94f06f085b	1803	/// given a stream of color values.
WiredHome	109:7b94f06f085b	1804	///
WiredHome	109:7b94f06f085b	1805	/// @param[in] x is the horizontal position on the display.
WiredHome	109:7b94f06f085b	1806	/// @param[in] y is the vertical position on the display.
WiredHome	109:7b94f06f085b	1807	/// @param[in] w is the width of the rectangular region to fill.
WiredHome	109:7b94f06f085b	1808	/// @param[in] h is the height of the rectangular region to fill.
WiredHome	109:7b94f06f085b	1809	/// @param[in] boolStream is the inline memory image from which to extract
WiredHome	109:7b94f06f085b	1810	/// the bitstream.
WiredHome	109:7b94f06f085b	1811	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	109:7b94f06f085b	1812	///
WiredHome	109:7b94f06f085b	1813	virtual RetCode_t booleanStream(loc_t x, loc_t y, dim_t w, dim_t h, const uint8_t * boolStream);
WiredHome	125:7a0b70f56550	1814
WiredHome	109:7b94f06f085b	1815
WiredHome	19:3f82c1161fd2	1816	/// Draw a line in the specified color
WiredHome	19:3f82c1161fd2	1817	///
WiredHome	19:3f82c1161fd2	1818	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	1819	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	1820	///
WiredHome	83:7bad0068cca0	1821	/// @param[in] p1 is the point to start the line.
WiredHome	83:7bad0068cca0	1822	/// @param[in] p2 is the point to end the line.
WiredHome	83:7bad0068cca0	1823	/// @param[in] color defines the foreground color.
WiredHome	106:c80828f5dea4	1824	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	83:7bad0068cca0	1825	///
WiredHome	83:7bad0068cca0	1826	RetCode_t line(point_t p1, point_t p2, color_t color);
WiredHome	83:7bad0068cca0	1827
WiredHome	125:7a0b70f56550	1828
WiredHome	83:7bad0068cca0	1829	/// Draw a line
WiredHome	83:7bad0068cca0	1830	///
WiredHome	83:7bad0068cca0	1831	/// Draws a line using the foreground color setting.
WiredHome	83:7bad0068cca0	1832	///
WiredHome	83:7bad0068cca0	1833	/// @param[in] p1 is the point to start the line.
WiredHome	83:7bad0068cca0	1834	/// @param[in] p2 is the point to end the line.
WiredHome	106:c80828f5dea4	1835	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	83:7bad0068cca0	1836	///
WiredHome	83:7bad0068cca0	1837	RetCode_t line(point_t p1, point_t p2);
WiredHome	125:7a0b70f56550	1838
WiredHome	83:7bad0068cca0	1839
WiredHome	83:7bad0068cca0	1840	/// Draw a line in the specified color
WiredHome	83:7bad0068cca0	1841	///
WiredHome	83:7bad0068cca0	1842	/// @note As a side effect, this changes the current
WiredHome	83:7bad0068cca0	1843	/// foreground color for subsequent operations.
WiredHome	83:7bad0068cca0	1844	///
WiredHome	72:ecffe56af969	1845	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	1846	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	1847	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	1848	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	1849	/// @param[in] color defines the foreground color.
WiredHome	106:c80828f5dea4	1850	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1851	///
WiredHome	56:7a85d226ad0d	1852	RetCode_t line(loc_t x1, loc_t y1, loc_t x2, loc_t y2, color_t color);
WiredHome	19:3f82c1161fd2	1853
WiredHome	125:7a0b70f56550	1854
WiredHome	19:3f82c1161fd2	1855	/// Draw a line
WiredHome	19:3f82c1161fd2	1856	///
WiredHome	19:3f82c1161fd2	1857	/// Draws a line using the foreground color setting.
WiredHome	19:3f82c1161fd2	1858	///
WiredHome	72:ecffe56af969	1859	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	1860	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	1861	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	1862	/// @param[in] y2 is the vertical end of the line.
WiredHome	106:c80828f5dea4	1863	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1864	///
WiredHome	37:f19b7e7449dc	1865	RetCode_t line(loc_t x1, loc_t y1, loc_t x2, loc_t y2);
WiredHome	19:3f82c1161fd2	1866
WiredHome	125:7a0b70f56550	1867
WiredHome	19:3f82c1161fd2	1868	/// Draw a rectangle in the specified color
WiredHome	19:3f82c1161fd2	1869	///
WiredHome	19:3f82c1161fd2	1870	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	1871	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	1872	///
WiredHome	81:01da2e34283d	1873	/// @param[in] rect defines the rectangle.
WiredHome	81:01da2e34283d	1874	/// @param[in] color defines the foreground color.
WiredHome	81:01da2e34283d	1875	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	1876	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	81:01da2e34283d	1877	///
WiredHome	82:f7d300f26540	1878	RetCode_t rect(rect_t rect, color_t color, fill_t fillit = NOFILL);
WiredHome	81:01da2e34283d	1879
WiredHome	125:7a0b70f56550	1880
WiredHome	125:7a0b70f56550	1881	/// Draw a filled rectangle in the specified color
WiredHome	81:01da2e34283d	1882	///
WiredHome	81:01da2e34283d	1883	/// @note As a side effect, this changes the current
WiredHome	81:01da2e34283d	1884	/// foreground color for subsequent operations.
WiredHome	81:01da2e34283d	1885	///
WiredHome	81:01da2e34283d	1886	/// @param[in] rect defines the rectangle.
WiredHome	81:01da2e34283d	1887	/// @param[in] color defines the foreground color.
WiredHome	81:01da2e34283d	1888	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	1889	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	81:01da2e34283d	1890	///
WiredHome	81:01da2e34283d	1891	RetCode_t fillrect(rect_t rect, color_t color, fill_t fillit = FILL);
WiredHome	81:01da2e34283d	1892
WiredHome	125:7a0b70f56550	1893
WiredHome	81:01da2e34283d	1894	/// Draw a rectangle in the specified color
WiredHome	81:01da2e34283d	1895	///
WiredHome	81:01da2e34283d	1896	/// @note As a side effect, this changes the current
WiredHome	81:01da2e34283d	1897	/// foreground color for subsequent operations.
WiredHome	81:01da2e34283d	1898	///
WiredHome	72:ecffe56af969	1899	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	1900	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	1901	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	1902	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	1903	/// @param[in] color defines the foreground color.
WiredHome	81:01da2e34283d	1904	/// @param[in] fillit is optional to FILL the rectangle. default is FILL.
WiredHome	106:c80828f5dea4	1905	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1906	///
WiredHome	37:f19b7e7449dc	1907	RetCode_t rect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	19:3f82c1161fd2	1908	color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	1909
WiredHome	125:7a0b70f56550	1910
WiredHome	19:3f82c1161fd2	1911	/// Draw a filled rectangle in the specified color
WiredHome	19:3f82c1161fd2	1912	///
WiredHome	19:3f82c1161fd2	1913	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	1914	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	1915	///
WiredHome	72:ecffe56af969	1916	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	1917	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	1918	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	1919	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	1920	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	1921	/// @param[in] fillit is optional to NOFILL the rectangle. default is FILL.
WiredHome	106:c80828f5dea4	1922	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1923	///
WiredHome	37:f19b7e7449dc	1924	virtual RetCode_t fillrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	19:3f82c1161fd2	1925	color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	1926
WiredHome	125:7a0b70f56550	1927
WiredHome	19:3f82c1161fd2	1928	/// Draw a rectangle
WiredHome	19:3f82c1161fd2	1929	///
WiredHome	19:3f82c1161fd2	1930	/// Draws a rectangle using the foreground color setting.
WiredHome	19:3f82c1161fd2	1931	///
WiredHome	72:ecffe56af969	1932	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	1933	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	1934	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	1935	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	1936	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	1937	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1938	///
WiredHome	37:f19b7e7449dc	1939	RetCode_t rect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	19:3f82c1161fd2	1940	fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	1941
WiredHome	125:7a0b70f56550	1942
WiredHome	19:3f82c1161fd2	1943	/// Draw a filled rectangle with rounded corners using the specified color.
WiredHome	19:3f82c1161fd2	1944	///
WiredHome	21:3c1efb192927	1945	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	21:3c1efb192927	1946	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	21:3c1efb192927	1947	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	21:3c1efb192927	1948	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	21:3c1efb192927	1949	///
WiredHome	19:3f82c1161fd2	1950	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	1951	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	1952	///
WiredHome	72:ecffe56af969	1953	/// @param[in] x1 is the horizontal start of the line and must be <= x2.
WiredHome	72:ecffe56af969	1954	/// @param[in] y1 is the vertical start of the line and must be <= y2.
WiredHome	72:ecffe56af969	1955	/// @param[in] x2 is the horizontal end of the line and must be >= x1.
WiredHome	72:ecffe56af969	1956	/// @param[in] y2 is the vertical end of the line and must be >= y1.
WiredHome	72:ecffe56af969	1957	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	21:3c1efb192927	1958	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	1959	/// is returned.
WiredHome	72:ecffe56af969	1960	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	21:3c1efb192927	1961	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	1962	/// is returned.
WiredHome	72:ecffe56af969	1963	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	1964	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	1965	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	1966	///
WiredHome	37:f19b7e7449dc	1967	RetCode_t fillroundrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	1968	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	1969
WiredHome	125:7a0b70f56550	1970
WiredHome	107:f9ccffcb84f1	1971	/// Draw a filled rectangle with rounded corners using the specified color.
WiredHome	107:f9ccffcb84f1	1972	///
WiredHome	107:f9ccffcb84f1	1973	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	107:f9ccffcb84f1	1974	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	107:f9ccffcb84f1	1975	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	107:f9ccffcb84f1	1976	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	107:f9ccffcb84f1	1977	///
WiredHome	107:f9ccffcb84f1	1978	/// @note As a side effect, this changes the current
WiredHome	107:f9ccffcb84f1	1979	/// foreground color for subsequent operations.
WiredHome	107:f9ccffcb84f1	1980	///
WiredHome	107:f9ccffcb84f1	1981	/// @param[in] r is the rectangle to draw.
WiredHome	107:f9ccffcb84f1	1982	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	107:f9ccffcb84f1	1983	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	1984	/// is returned.
WiredHome	107:f9ccffcb84f1	1985	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	107:f9ccffcb84f1	1986	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	1987	/// is returned.
WiredHome	107:f9ccffcb84f1	1988	/// @param[in] color defines the foreground color.
WiredHome	107:f9ccffcb84f1	1989	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	107:f9ccffcb84f1	1990	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	107:f9ccffcb84f1	1991	///
WiredHome	107:f9ccffcb84f1	1992	RetCode_t fillroundrect(rect_t r,
WiredHome	107:f9ccffcb84f1	1993	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = FILL);
WiredHome	107:f9ccffcb84f1	1994
WiredHome	125:7a0b70f56550	1995
WiredHome	107:f9ccffcb84f1	1996	/// Draw a rectangle with rounded corners using the specified color.
WiredHome	107:f9ccffcb84f1	1997	///
WiredHome	107:f9ccffcb84f1	1998	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	107:f9ccffcb84f1	1999	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	107:f9ccffcb84f1	2000	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	107:f9ccffcb84f1	2001	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	107:f9ccffcb84f1	2002	///
WiredHome	107:f9ccffcb84f1	2003	/// @note As a side effect, this changes the current
WiredHome	107:f9ccffcb84f1	2004	/// foreground color for subsequent operations.
WiredHome	107:f9ccffcb84f1	2005	///
WiredHome	107:f9ccffcb84f1	2006	/// @param[in] r is the rectangle to draw.
WiredHome	107:f9ccffcb84f1	2007	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	107:f9ccffcb84f1	2008	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	2009	/// is returned.
WiredHome	107:f9ccffcb84f1	2010	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	107:f9ccffcb84f1	2011	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	2012	/// is returned.
WiredHome	107:f9ccffcb84f1	2013	/// @param[in] color defines the foreground color.
WiredHome	107:f9ccffcb84f1	2014	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	107:f9ccffcb84f1	2015	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	107:f9ccffcb84f1	2016	///
WiredHome	107:f9ccffcb84f1	2017	RetCode_t roundrect(rect_t r,
WiredHome	107:f9ccffcb84f1	2018	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = NOFILL);
WiredHome	107:f9ccffcb84f1	2019
WiredHome	125:7a0b70f56550	2020
WiredHome	19:3f82c1161fd2	2021	/// Draw a rectangle with rounded corners using the specified color.
WiredHome	19:3f82c1161fd2	2022	///
WiredHome	21:3c1efb192927	2023	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	21:3c1efb192927	2024	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	21:3c1efb192927	2025	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	21:3c1efb192927	2026	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	21:3c1efb192927	2027	///
WiredHome	19:3f82c1161fd2	2028	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2029	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2030	///
WiredHome	72:ecffe56af969	2031	/// @param[in] x1 is the horizontal start of the line and must be <= x2.
WiredHome	72:ecffe56af969	2032	/// @param[in] y1 is the vertical start of the line and must be <= y2.
WiredHome	72:ecffe56af969	2033	/// @param[in] x2 is the horizontal end of the line and must be >= x1.
WiredHome	72:ecffe56af969	2034	/// @param[in] y2 is the vertical end of the line and must be >= y1.
WiredHome	72:ecffe56af969	2035	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	21:3c1efb192927	2036	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2037	/// is returned.
WiredHome	72:ecffe56af969	2038	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	21:3c1efb192927	2039	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2040	/// is returned.
WiredHome	72:ecffe56af969	2041	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2042	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	2043	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2044	///
WiredHome	37:f19b7e7449dc	2045	RetCode_t roundrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2046	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2047
WiredHome	125:7a0b70f56550	2048
WiredHome	19:3f82c1161fd2	2049	/// Draw a rectangle with rounded corners.
WiredHome	19:3f82c1161fd2	2050	///
WiredHome	21:3c1efb192927	2051	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	21:3c1efb192927	2052	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	21:3c1efb192927	2053	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	21:3c1efb192927	2054	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	19:3f82c1161fd2	2055	///
WiredHome	72:ecffe56af969	2056	/// @param[in] x1 is the horizontal start of the line and must be <= x2.
WiredHome	72:ecffe56af969	2057	/// @param[in] y1 is the vertical start of the line and must be <= y2.
WiredHome	72:ecffe56af969	2058	/// @param[in] x2 is the horizontal end of the line and must be >= x1.
WiredHome	72:ecffe56af969	2059	/// @param[in] y2 is the vertical end of the line and must be >= y1.
WiredHome	72:ecffe56af969	2060	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	21:3c1efb192927	2061	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2062	/// is returned.
WiredHome	72:ecffe56af969	2063	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	21:3c1efb192927	2064	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2065	/// is returned.
WiredHome	72:ecffe56af969	2066	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	2067	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2068	///
WiredHome	37:f19b7e7449dc	2069	RetCode_t roundrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2070	dim_t radius1, dim_t radius2, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2071
WiredHome	125:7a0b70f56550	2072
WiredHome	19:3f82c1161fd2	2073	/// Draw a triangle in the specified color.
WiredHome	19:3f82c1161fd2	2074	///
WiredHome	19:3f82c1161fd2	2075	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2076	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2077	///
WiredHome	72:ecffe56af969	2078	/// @param[in] x1 is the horizontal for point 1.
WiredHome	72:ecffe56af969	2079	/// @param[in] y1 is the vertical for point 1.
WiredHome	72:ecffe56af969	2080	/// @param[in] x2 is the horizontal for point 2.
WiredHome	72:ecffe56af969	2081	/// @param[in] y2 is the vertical for point 2.
WiredHome	72:ecffe56af969	2082	/// @param[in] x3 is the horizontal for point 3.
WiredHome	72:ecffe56af969	2083	/// @param[in] y3 is the vertical for point 3.
WiredHome	72:ecffe56af969	2084	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2085	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	2086	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2087	///
WiredHome	37:f19b7e7449dc	2088	RetCode_t triangle(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2089	loc_t x3, loc_t y3, color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2090
WiredHome	125:7a0b70f56550	2091
WiredHome	19:3f82c1161fd2	2092	/// Draw a filled triangle in the specified color.
WiredHome	19:3f82c1161fd2	2093	///
WiredHome	19:3f82c1161fd2	2094	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2095	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2096	///
WiredHome	72:ecffe56af969	2097	/// @param[in] x1 is the horizontal for point 1.
WiredHome	72:ecffe56af969	2098	/// @param[in] y1 is the vertical for point 1.
WiredHome	72:ecffe56af969	2099	/// @param[in] x2 is the horizontal for point 2.
WiredHome	72:ecffe56af969	2100	/// @param[in] y2 is the vertical for point 2.
WiredHome	72:ecffe56af969	2101	/// @param[in] x3 is the horizontal for point 3.
WiredHome	72:ecffe56af969	2102	/// @param[in] y3 is the vertical for point 3.
WiredHome	72:ecffe56af969	2103	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2104	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	2105	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2106	///
WiredHome	37:f19b7e7449dc	2107	RetCode_t filltriangle(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2108	loc_t x3, loc_t y3, color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	2109
WiredHome	125:7a0b70f56550	2110
WiredHome	19:3f82c1161fd2	2111	/// Draw a triangle
WiredHome	19:3f82c1161fd2	2112	///
WiredHome	19:3f82c1161fd2	2113	/// Draws a triangle using the foreground color setting.
WiredHome	19:3f82c1161fd2	2114	///
WiredHome	72:ecffe56af969	2115	/// @param[in] x1 is the horizontal for point 1.
WiredHome	72:ecffe56af969	2116	/// @param[in] y1 is the vertical for point 1.
WiredHome	72:ecffe56af969	2117	/// @param[in] x2 is the horizontal for point 2.
WiredHome	72:ecffe56af969	2118	/// @param[in] y2 is the vertical for point 2.
WiredHome	72:ecffe56af969	2119	/// @param[in] x3 is the horizontal for point 3.
WiredHome	72:ecffe56af969	2120	/// @param[in] y3 is the vertical for point 3.
WiredHome	72:ecffe56af969	2121	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	106:c80828f5dea4	2122	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2123	///
WiredHome	37:f19b7e7449dc	2124	RetCode_t triangle(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2125	loc_t x3, loc_t y3, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2126
WiredHome	83:7bad0068cca0	2127
WiredHome	83:7bad0068cca0	2128	/// Draw a circle using the specified color.
WiredHome	83:7bad0068cca0	2129	///
WiredHome	83:7bad0068cca0	2130	/// @note As a side effect, this changes the current
WiredHome	83:7bad0068cca0	2131	/// foreground color for subsequent operations.
WiredHome	83:7bad0068cca0	2132	///
WiredHome	83:7bad0068cca0	2133	/// @param[in] p defines the center of the circle.
WiredHome	83:7bad0068cca0	2134	/// @param[in] radius defines the size of the circle.
WiredHome	83:7bad0068cca0	2135	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2136	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	106:c80828f5dea4	2137	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	83:7bad0068cca0	2138	///
WiredHome	83:7bad0068cca0	2139	RetCode_t circle(point_t p, dim_t radius, color_t color, fill_t fillit = NOFILL);
WiredHome	83:7bad0068cca0	2140
WiredHome	125:7a0b70f56550	2141
WiredHome	83:7bad0068cca0	2142	/// Draw a filled circle using the specified color.
WiredHome	83:7bad0068cca0	2143	///
WiredHome	83:7bad0068cca0	2144	/// @note As a side effect, this changes the current
WiredHome	83:7bad0068cca0	2145	/// foreground color for subsequent operations.
WiredHome	83:7bad0068cca0	2146	///
WiredHome	83:7bad0068cca0	2147	/// @param[in] p defines the center of the circle.
WiredHome	83:7bad0068cca0	2148	/// @param[in] radius defines the size of the circle.
WiredHome	83:7bad0068cca0	2149	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2150	/// @param[in] fillit is optional to FILL the circle. default is FILL.
WiredHome	106:c80828f5dea4	2151	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	83:7bad0068cca0	2152	///
WiredHome	83:7bad0068cca0	2153	RetCode_t fillcircle(point_t p, dim_t radius, color_t color, fill_t fillit = FILL);
WiredHome	83:7bad0068cca0	2154
WiredHome	125:7a0b70f56550	2155
WiredHome	83:7bad0068cca0	2156	/// Draw a circle.
WiredHome	83:7bad0068cca0	2157	///
WiredHome	83:7bad0068cca0	2158	/// Draws a circle using the foreground color setting.
WiredHome	83:7bad0068cca0	2159	///
WiredHome	83:7bad0068cca0	2160	/// @param[in] p defines the center of the circle.
WiredHome	83:7bad0068cca0	2161	/// @param[in] radius defines the size of the circle.
WiredHome	125:7a0b70f56550	2162	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	106:c80828f5dea4	2163	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	83:7bad0068cca0	2164	///
WiredHome	83:7bad0068cca0	2165	RetCode_t circle(point_t p, dim_t radius, fill_t fillit = NOFILL);
WiredHome	83:7bad0068cca0	2166
WiredHome	125:7a0b70f56550	2167
WiredHome	19:3f82c1161fd2	2168	/// Draw a circle using the specified color.
WiredHome	19:3f82c1161fd2	2169	///
WiredHome	19:3f82c1161fd2	2170	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2171	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2172	///
WiredHome	72:ecffe56af969	2173	/// @param[in] x is the horizontal center of the circle.
WiredHome	72:ecffe56af969	2174	/// @param[in] y is the vertical center of the circle.
WiredHome	72:ecffe56af969	2175	/// @param[in] radius defines the size of the circle.
WiredHome	72:ecffe56af969	2176	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2177	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	106:c80828f5dea4	2178	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2179	///
WiredHome	37:f19b7e7449dc	2180	RetCode_t circle(loc_t x, loc_t y, dim_t radius, color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2181
WiredHome	125:7a0b70f56550	2182
WiredHome	19:3f82c1161fd2	2183	/// Draw a filled circle using the specified color.
WiredHome	19:3f82c1161fd2	2184	///
WiredHome	19:3f82c1161fd2	2185	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2186	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2187	///
WiredHome	72:ecffe56af969	2188	/// @param[in] x is the horizontal center of the circle.
WiredHome	72:ecffe56af969	2189	/// @param[in] y is the vertical center of the circle.
WiredHome	72:ecffe56af969	2190	/// @param[in] radius defines the size of the circle.
WiredHome	72:ecffe56af969	2191	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2192	/// @param[in] fillit is optional to FILL the circle. default is FILL.
WiredHome	106:c80828f5dea4	2193	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2194	///
WiredHome	37:f19b7e7449dc	2195	RetCode_t fillcircle(loc_t x, loc_t y, dim_t radius, color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	2196
WiredHome	125:7a0b70f56550	2197
WiredHome	19:3f82c1161fd2	2198	/// Draw a circle.
WiredHome	19:3f82c1161fd2	2199	///
WiredHome	19:3f82c1161fd2	2200	/// Draws a circle using the foreground color setting.
WiredHome	19:3f82c1161fd2	2201	///
WiredHome	72:ecffe56af969	2202	/// @param[in] x is the horizontal center of the circle.
WiredHome	72:ecffe56af969	2203	/// @param[in] y is the vertical center of the circle.
WiredHome	72:ecffe56af969	2204	/// @param[in] radius defines the size of the circle.
WiredHome	125:7a0b70f56550	2205	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	106:c80828f5dea4	2206	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2207	///
WiredHome	37:f19b7e7449dc	2208	RetCode_t circle(loc_t x, loc_t y, dim_t radius, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2209
WiredHome	19:3f82c1161fd2	2210	/// Draw an Ellipse using the specified color
WiredHome	19:3f82c1161fd2	2211	///
WiredHome	19:3f82c1161fd2	2212	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2213	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2214	///
WiredHome	72:ecffe56af969	2215	/// @param[in] x is the horizontal center of the ellipse.
WiredHome	72:ecffe56af969	2216	/// @param[in] y is the vertical center of the ellipse.
WiredHome	72:ecffe56af969	2217	/// @param[in] radius1 defines the horizontal radius of the ellipse.
WiredHome	72:ecffe56af969	2218	/// @param[in] radius2 defines the vertical radius of the ellipse.
WiredHome	72:ecffe56af969	2219	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2220	/// @param[in] fillit defines whether the circle is filled or not.
WiredHome	106:c80828f5dea4	2221	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2222	///
WiredHome	37:f19b7e7449dc	2223	RetCode_t ellipse(loc_t x, loc_t y, dim_t radius1, dim_t radius2,
WiredHome	19:3f82c1161fd2	2224	color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2225
WiredHome	125:7a0b70f56550	2226
WiredHome	25:9556a3a9b7cc	2227	/// Draw a filled Ellipse using the specified color
WiredHome	25:9556a3a9b7cc	2228	///
WiredHome	25:9556a3a9b7cc	2229	/// @note As a side effect, this changes the current
WiredHome	25:9556a3a9b7cc	2230	/// foreground color for subsequent operations.
WiredHome	25:9556a3a9b7cc	2231	///
WiredHome	72:ecffe56af969	2232	/// @param[in] x is the horizontal center of the ellipse.
WiredHome	72:ecffe56af969	2233	/// @param[in] y is the vertical center of the ellipse.
WiredHome	72:ecffe56af969	2234	/// @param[in] radius1 defines the horizontal radius of the ellipse.
WiredHome	72:ecffe56af969	2235	/// @param[in] radius2 defines the vertical radius of the ellipse.
WiredHome	72:ecffe56af969	2236	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2237	/// @param[in] fillit defines whether the circle is filled or not.
WiredHome	106:c80828f5dea4	2238	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	25:9556a3a9b7cc	2239	///
WiredHome	37:f19b7e7449dc	2240	RetCode_t fillellipse(loc_t x, loc_t y, dim_t radius1, dim_t radius2,
WiredHome	25:9556a3a9b7cc	2241	color_t color, fill_t fillit = FILL);
WiredHome	25:9556a3a9b7cc	2242
WiredHome	125:7a0b70f56550	2243
WiredHome	19:3f82c1161fd2	2244	/// Draw an Ellipse
WiredHome	19:3f82c1161fd2	2245	///
WiredHome	19:3f82c1161fd2	2246	/// Draws it using the foreground color setting.
WiredHome	19:3f82c1161fd2	2247	///
WiredHome	72:ecffe56af969	2248	/// @param[in] x is the horizontal center of the ellipse.
WiredHome	72:ecffe56af969	2249	/// @param[in] y is the vertical center of the ellipse.
WiredHome	72:ecffe56af969	2250	/// @param[in] radius1 defines the horizontal radius of the ellipse.
WiredHome	72:ecffe56af969	2251	/// @param[in] radius2 defines the vertical radius of the ellipse.
WiredHome	72:ecffe56af969	2252	/// @param[in] fillit defines whether the circle is filled or not.
WiredHome	106:c80828f5dea4	2253	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2254	///
WiredHome	37:f19b7e7449dc	2255	RetCode_t ellipse(loc_t x, loc_t y, dim_t radius1, dim_t radius2, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2256
WiredHome	125:7a0b70f56550	2257
WiredHome	131:5bd6ba2ee4a1	2258
WiredHome	131:5bd6ba2ee4a1	2259	/// Block Move
WiredHome	131:5bd6ba2ee4a1	2260	///
WiredHome	131:5bd6ba2ee4a1	2261	/// The Block Move API activates the RA8875 Block Transfer Engine. Due to the complex
WiredHome	131:5bd6ba2ee4a1	2262	/// set of possible operations, the user should read the related sections of the
WiredHome	131:5bd6ba2ee4a1	2263	/// RA8875 user manual.
WiredHome	131:5bd6ba2ee4a1	2264	///
WiredHome	131:5bd6ba2ee4a1	2265	/// Some operations may require that other registers are configured, such as the
WiredHome	131:5bd6ba2ee4a1	2266	/// foreground and background color registers, and others. Those must be set
WiredHome	131:5bd6ba2ee4a1	2267	/// outside of this API.
WiredHome	131:5bd6ba2ee4a1	2268	///
WiredHome	137:9e09f6081ef1	2269	/// @param[in] dstLayer layer [5B.7]. layer value is 0 or 1 representing layer 1 and 2.
WiredHome	131:5bd6ba2ee4a1	2270	/// @param[in] dstDataSelect [50.5] defines the destination data type 0: block, 1: linear.
WiredHome	131:5bd6ba2ee4a1	2271	/// @param[in] dstPoint [58-5B] is a point_t defining the destination coordinate.
WiredHome	137:9e09f6081ef1	2272	/// @param[in] srcLayer layer [57.7]. layer value is 0 or 1 representing layer 1 and 2.
WiredHome	131:5bd6ba2ee4a1	2273	/// @param[in] srcDataSelect [50.6] defines the source data type 0: block, 1: linear.
WiredHome	131:5bd6ba2ee4a1	2274	/// @param[in] srcPoint [54-57] is a point_t defining the source coordinate.
WiredHome	131:5bd6ba2ee4a1	2275	/// @param[in] bte_width [5C-5D]. operation width.
WiredHome	131:5bd6ba2ee4a1	2276	/// @param[in] bte_height [5E-5F]. operation height.
WiredHome	131:5bd6ba2ee4a1	2277	/// @param[in] bte_op_code [51.3-0] defines the raster operation function
WiredHome	131:5bd6ba2ee4a1	2278	/// (write/read/move/...)
WiredHome	131:5bd6ba2ee4a1	2279	/// @param[in] bte_rop_code [51.7-4] defines what type of BTE operation to perform
WiredHome	131:5bd6ba2ee4a1	2280	/// (what is placed at the destination)
WiredHome	131:5bd6ba2ee4a1	2281	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	131:5bd6ba2ee4a1	2282	///
WiredHome	131:5bd6ba2ee4a1	2283	RetCode_t BlockMove(uint8_t dstLayer, uint8_t dstDataSelect, point_t dstPoint,
WiredHome	131:5bd6ba2ee4a1	2284	uint8_t srcLayer, uint8_t srcDataSelect, point_t srcPoint,
WiredHome	137:9e09f6081ef1	2285	dim_t bte_width, dim_t bte_height,
WiredHome	131:5bd6ba2ee4a1	2286	uint8_t bte_op_code, uint8_t bte_rop_code);
WiredHome	131:5bd6ba2ee4a1	2287
WiredHome	131:5bd6ba2ee4a1	2288
WiredHome	19:3f82c1161fd2	2289	/// Control display power
WiredHome	19:3f82c1161fd2	2290	///
WiredHome	72:ecffe56af969	2291	/// @param[in] on when set to true will turn on the display, when false it is turned off.
WiredHome	106:c80828f5dea4	2292	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2293	///
WiredHome	19:3f82c1161fd2	2294	RetCode_t Power(bool on);
WiredHome	19:3f82c1161fd2	2295
WiredHome	125:7a0b70f56550	2296
WiredHome	19:3f82c1161fd2	2297	/// Reset the display controller via the Software Reset interface.
WiredHome	19:3f82c1161fd2	2298	///
WiredHome	106:c80828f5dea4	2299	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2300	///
WiredHome	19:3f82c1161fd2	2301	RetCode_t Reset(void);
WiredHome	19:3f82c1161fd2	2302
WiredHome	125:7a0b70f56550	2303
WiredHome	19:3f82c1161fd2	2304	/// Set backlight brightness.
WiredHome	19:3f82c1161fd2	2305	///
WiredHome	19:3f82c1161fd2	2306	/// When the built-in PWM is used to control the backlight, this
WiredHome	19:3f82c1161fd2	2307	/// API can be used to set the brightness.
WiredHome	19:3f82c1161fd2	2308	///
WiredHome	72:ecffe56af969	2309	/// @param[in] brightness ranges from 0 (off) to 255 (full on)
WiredHome	106:c80828f5dea4	2310	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2311	///
WiredHome	131:5bd6ba2ee4a1	2312	RetCode_t Backlight_u8(uint8_t brightness);
WiredHome	125:7a0b70f56550	2313
WiredHome	19:3f82c1161fd2	2314
WiredHome	86:e86b355940f4	2315	/// Get backlight brightness.
WiredHome	86:e86b355940f4	2316	///
WiredHome	86:e86b355940f4	2317	/// @returns backlight setting from 0 (off) to 255 (full on).
WiredHome	86:e86b355940f4	2318	///
WiredHome	86:e86b355940f4	2319	uint8_t GetBacklight_u8(void);
WiredHome	86:e86b355940f4	2320
WiredHome	19:3f82c1161fd2	2321	/// Set backlight brightness.
WiredHome	19:3f82c1161fd2	2322	///
WiredHome	19:3f82c1161fd2	2323	/// When the built-in PWM is used to control the backlight, this
WiredHome	19:3f82c1161fd2	2324	/// API can be used to set the brightness.
WiredHome	19:3f82c1161fd2	2325	///
WiredHome	72:ecffe56af969	2326	/// @param[in] brightness ranges from 0.0 (off) to 1.0 (full on)
WiredHome	106:c80828f5dea4	2327	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2328	///
WiredHome	19:3f82c1161fd2	2329	RetCode_t Backlight(float brightness);
WiredHome	19:3f82c1161fd2	2330
WiredHome	125:7a0b70f56550	2331
WiredHome	86:e86b355940f4	2332	/// Get backlight brightness.
WiredHome	86:e86b355940f4	2333	///
WiredHome	86:e86b355940f4	2334	/// @returns backlight setting from 0 (off) to 1.0 (full on).
WiredHome	86:e86b355940f4	2335	///
WiredHome	86:e86b355940f4	2336	float GetBacklight(void);
WiredHome	86:e86b355940f4	2337
WiredHome	125:7a0b70f56550	2338
WiredHome	98:ecebed9b80b2	2339	/// Select a User Font for all subsequent text.
WiredHome	98:ecebed9b80b2	2340	///
WiredHome	98:ecebed9b80b2	2341	/// @note Tool to create the fonts is accessible from its creator
WiredHome	98:ecebed9b80b2	2342	/// available at http://www.mikroe.com.
WiredHome	98:ecebed9b80b2	2343	/// For version 1.2.0.0, choose the "Export for TFT and new GLCD"
WiredHome	98:ecebed9b80b2	2344	/// format.
WiredHome	98:ecebed9b80b2	2345	///
WiredHome	98:ecebed9b80b2	2346	/// @param[in] font is a pointer to a specially formed font resource.
WiredHome	98:ecebed9b80b2	2347	/// @returns error code.
WiredHome	98:ecebed9b80b2	2348	///
WiredHome	98:ecebed9b80b2	2349	virtual RetCode_t SelectUserFont(const uint8_t * font = NULL);
WiredHome	98:ecebed9b80b2	2350
WiredHome	127:db7f2c704693	2351	/// Get the currently selected user font.
WiredHome	127:db7f2c704693	2352	///
WiredHome	127:db7f2c704693	2353	/// @returns a pointer to the font, or null, if no user font is selected.
WiredHome	127:db7f2c704693	2354	///
WiredHome	127:db7f2c704693	2355	virtual const uint8_t * GetUserFont(void) { return font; }
WiredHome	19:3f82c1161fd2	2356
WiredHome	19:3f82c1161fd2	2357	/// Get the RGB value for a DOS color.
WiredHome	19:3f82c1161fd2	2358	///
WiredHome	125:7a0b70f56550	2359	/// @code
WiredHome	125:7a0b70f56550	2360	/// color_t color = DOSColor(12);
WiredHome	125:7a0b70f56550	2361	/// @endcode
WiredHome	125:7a0b70f56550	2362	///
WiredHome	72:ecffe56af969	2363	/// @param[in] i is the color, in the range 0 to 15;
WiredHome	19:3f82c1161fd2	2364	/// @returns the RGB color of the selected index, or 0
WiredHome	19:3f82c1161fd2	2365	/// if the index is out of bounds.
WiredHome	19:3f82c1161fd2	2366	///
WiredHome	19:3f82c1161fd2	2367	color_t DOSColor(int i);
WiredHome	19:3f82c1161fd2	2368
WiredHome	125:7a0b70f56550	2369
WiredHome	19:3f82c1161fd2	2370	/// Get the color name (string) for a DOS color.
WiredHome	19:3f82c1161fd2	2371	///
WiredHome	125:7a0b70f56550	2372	/// @code
WiredHome	125:7a0b70f56550	2373	/// printf("color is %s\n", DOSColorNames(12));
WiredHome	125:7a0b70f56550	2374	/// @endcode
WiredHome	125:7a0b70f56550	2375	///
WiredHome	72:ecffe56af969	2376	/// @param[in] i is the color, in the range 0 to 15;
WiredHome	19:3f82c1161fd2	2377	/// @returns a pointer to a string with the color name,
WiredHome	19:3f82c1161fd2	2378	/// or NULL if the index is out of bounds.
WiredHome	19:3f82c1161fd2	2379	///
WiredHome	19:3f82c1161fd2	2380	const char * DOSColorNames(int i);
WiredHome	19:3f82c1161fd2	2381
WiredHome	125:7a0b70f56550	2382
WiredHome	55:dfbabef7003e	2383	/// Advanced method indicating the start of a graphics stream.
WiredHome	55:dfbabef7003e	2384	///
WiredHome	55:dfbabef7003e	2385	/// This is called prior to a stream of pixel data being sent.
WiredHome	55:dfbabef7003e	2386	/// This may cause register configuration changes in the derived
WiredHome	55:dfbabef7003e	2387	/// class in order to prepare the hardware to accept the streaming
WiredHome	55:dfbabef7003e	2388	/// data.
WiredHome	55:dfbabef7003e	2389	///
WiredHome	106:c80828f5dea4	2390	/// Following this command, a series of See @ref _putp() commands can
WiredHome	55:dfbabef7003e	2391	/// be used to send individual pixels to the screen.
WiredHome	55:dfbabef7003e	2392	///
WiredHome	106:c80828f5dea4	2393	/// To conclude the graphics stream, See @ref _EndGraphicsStream should
WiredHome	55:dfbabef7003e	2394	/// be callled.
WiredHome	55:dfbabef7003e	2395	///
WiredHome	55:dfbabef7003e	2396	/// @returns error code.
WiredHome	55:dfbabef7003e	2397	///
WiredHome	55:dfbabef7003e	2398	virtual RetCode_t _StartGraphicsStream(void);
WiredHome	125:7a0b70f56550	2399
WiredHome	55:dfbabef7003e	2400
WiredHome	55:dfbabef7003e	2401	/// Advanced method to put a single color pixel to the screen.
WiredHome	55:dfbabef7003e	2402	///
WiredHome	55:dfbabef7003e	2403	/// This method may be called as many times as necessary after
WiredHome	106:c80828f5dea4	2404	/// See @ref _StartGraphicsStream() is called, and it should be followed
WiredHome	55:dfbabef7003e	2405	/// by _EndGraphicsStream.
WiredHome	55:dfbabef7003e	2406	///
WiredHome	125:7a0b70f56550	2407	/// @code
WiredHome	125:7a0b70f56550	2408	/// _putp(DOSColor(12));
WiredHome	125:7a0b70f56550	2409	/// @endcode
WiredHome	125:7a0b70f56550	2410	///
WiredHome	72:ecffe56af969	2411	/// @param[in] pixel is a color value to be put on the screen.
WiredHome	55:dfbabef7003e	2412	/// @returns error code.
WiredHome	55:dfbabef7003e	2413	///
WiredHome	55:dfbabef7003e	2414	virtual RetCode_t _putp(color_t pixel);
WiredHome	125:7a0b70f56550	2415
WiredHome	55:dfbabef7003e	2416
WiredHome	55:dfbabef7003e	2417	/// Advanced method indicating the end of a graphics stream.
WiredHome	55:dfbabef7003e	2418	///
WiredHome	55:dfbabef7003e	2419	/// This is called to conclude a stream of pixel data that was sent.
WiredHome	55:dfbabef7003e	2420	/// This may cause register configuration changes in the derived
WiredHome	55:dfbabef7003e	2421	/// class in order to stop the hardware from accept the streaming
WiredHome	55:dfbabef7003e	2422	/// data.
WiredHome	55:dfbabef7003e	2423	///
WiredHome	55:dfbabef7003e	2424	/// @returns error code.
WiredHome	55:dfbabef7003e	2425	///
WiredHome	55:dfbabef7003e	2426	virtual RetCode_t _EndGraphicsStream(void);
WiredHome	19:3f82c1161fd2	2427
WiredHome	125:7a0b70f56550	2428
WiredHome	57:bd53a9e165a1	2429	/// Set the SPI port frequency (in Hz).
WiredHome	57:bd53a9e165a1	2430	///
WiredHome	66:468a11f05580	2431	/// This uses the mbed SPI driver, and is therefore dependent on
WiredHome	66:468a11f05580	2432	/// its capabilities. The RA8875 can accept writes via SPI faster
WiredHome	66:468a11f05580	2433	/// than a read can be performed. The frequency set by this API
WiredHome	66:468a11f05580	2434	/// is for the SPI writes. It will automatically reduce the SPI
WiredHome	66:468a11f05580	2435	/// clock rate when a read is performed, and restore it for the
WiredHome	68:ab08efabfc88	2436	/// next write. Alternately, the 2nd parameters permits setting
WiredHome	68:ab08efabfc88	2437	/// the read speed rather than letting it compute it automatically.
WiredHome	57:bd53a9e165a1	2438	///
WiredHome	66:468a11f05580	2439	/// @note The primary effect of this is to recover more CPU cycles
WiredHome	66:468a11f05580	2440	/// for your application code. Keep in mind that when more than
WiredHome	66:468a11f05580	2441	/// one command is sent to the display controller, that it
WiredHome	66:468a11f05580	2442	/// will wait for the controller to finish the prior command.
WiredHome	66:468a11f05580	2443	/// In this case, the performance is limited by the RA8875.
WiredHome	57:bd53a9e165a1	2444	///
WiredHome	72:ecffe56af969	2445	/// @param[in] Hz is the frequency in Hz, tested range includes the
WiredHome	66:468a11f05580	2446	/// range from 1,000,000 (1MHz) to 10,000,000 (10 MHz). Values
WiredHome	66:468a11f05580	2447	/// outside this range will be accepted, but operation may
WiredHome	76:c981284eb513	2448	/// be unreliable. This depends partially on your hardware design
WiredHome	76:c981284eb513	2449	/// and the wires connecting the display module.
WiredHome	76:c981284eb513	2450	/// The default value is 5,000,000, which should work for most
WiredHome	76:c981284eb513	2451	/// applications as a starting point.
WiredHome	72:ecffe56af969	2452	/// @param[in] Hz2 is an optional parameter and will set the read
WiredHome	68:ab08efabfc88	2453	/// speed independently of the write speed.
WiredHome	106:c80828f5dea4	2454	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	57:bd53a9e165a1	2455	///
WiredHome	68:ab08efabfc88	2456	RetCode_t frequency(unsigned long Hz = RA8875_DEFAULT_SPI_FREQ, unsigned long Hz2 = 0);
WiredHome	125:7a0b70f56550	2457
WiredHome	125:7a0b70f56550	2458
WiredHome	72:ecffe56af969	2459	/// This method captures the specified area as a 24-bit bitmap file.
WiredHome	72:ecffe56af969	2460	///
WiredHome	72:ecffe56af969	2461	/// Even though this is a 16-bit display, the stored image is in
WiredHome	72:ecffe56af969	2462	/// 24-bit format.
WiredHome	72:ecffe56af969	2463	///
WiredHome	73:f22a18707b5e	2464	/// This method will interrogate the current display setting and
WiredHome	73:f22a18707b5e	2465	/// create a bitmap based on those settings. For instance, if
WiredHome	73:f22a18707b5e	2466	/// only layer 1 is visible, then the bitmap is only layer 1. However,
WiredHome	73:f22a18707b5e	2467	/// if there is some other operation in effect (transparent mode).
WiredHome	73:f22a18707b5e	2468	///
WiredHome	72:ecffe56af969	2469	/// @param[in] x is the left edge of the region to capture
WiredHome	72:ecffe56af969	2470	/// @param[in] y is the top edge of the region to capture
WiredHome	72:ecffe56af969	2471	/// @param[in] w is the width of the region to capture
WiredHome	72:ecffe56af969	2472	/// @param[in] h is the height of the region to capture.
WiredHome	72:ecffe56af969	2473	/// @param[out] Name_BMP is the filename to write the image to.
WiredHome	72:ecffe56af969	2474	/// @return success or error code.
WiredHome	72:ecffe56af969	2475	///
WiredHome	72:ecffe56af969	2476	RetCode_t PrintScreen(loc_t x, loc_t y, dim_t w, dim_t h, const char *Name_BMP);
WiredHome	125:7a0b70f56550	2477
WiredHome	72:ecffe56af969	2478
WiredHome	96:40b74dd3695b	2479	/// This method captures the specified area as a 24-bit bitmap file
WiredHome	96:40b74dd3695b	2480	/// and delivers it to the previously attached callback.
WiredHome	96:40b74dd3695b	2481	///
WiredHome	96:40b74dd3695b	2482	/// Even though this is a 16-bit display, the stored image is in
WiredHome	96:40b74dd3695b	2483	/// 24-bit format.
WiredHome	96:40b74dd3695b	2484	///
WiredHome	96:40b74dd3695b	2485	/// This method will interrogate the current display setting and
WiredHome	96:40b74dd3695b	2486	/// create a bitmap based on those settings. For instance, if
WiredHome	96:40b74dd3695b	2487	/// only layer 1 is visible, then the bitmap is only layer 1. However,
WiredHome	96:40b74dd3695b	2488	/// if there is some other operation in effect (transparent mode), it
WiredHome	96:40b74dd3695b	2489	/// will return the blended image.
WiredHome	96:40b74dd3695b	2490	///
WiredHome	96:40b74dd3695b	2491	/// @param[in] x is the left edge of the region to capture
WiredHome	96:40b74dd3695b	2492	/// @param[in] y is the top edge of the region to capture
WiredHome	96:40b74dd3695b	2493	/// @param[in] w is the width of the region to capture
WiredHome	96:40b74dd3695b	2494	/// @param[in] h is the height of the region to capture.
WiredHome	96:40b74dd3695b	2495	/// @return success or error code.
WiredHome	96:40b74dd3695b	2496	///
WiredHome	96:40b74dd3695b	2497	RetCode_t PrintScreen(loc_t x, loc_t y, dim_t w, dim_t h);
WiredHome	125:7a0b70f56550	2498
WiredHome	96:40b74dd3695b	2499
WiredHome	96:40b74dd3695b	2500	/// PrintScreen callback registration.
WiredHome	96:40b74dd3695b	2501	///
WiredHome	96:40b74dd3695b	2502	/// This method attaches a simple c-compatible callback of type PrintCallback_T.
WiredHome	96:40b74dd3695b	2503	/// Then, the PrintScreen(x,y,w,h) method is called. Each chunk of data in the
WiredHome	96:40b74dd3695b	2504	/// BMP file to be created is passed to this callback.
WiredHome	96:40b74dd3695b	2505	///
WiredHome	123:2f45e80fec5f	2506	/// @param callback is the optional callback function. Without a callback function
WiredHome	123:2f45e80fec5f	2507	/// it will unregister the handler.
WiredHome	96:40b74dd3695b	2508	///
WiredHome	123:2f45e80fec5f	2509	void AttachPrintHandler(PrintCallback_T callback = NULL) { c_callback = callback; }
WiredHome	96:40b74dd3695b	2510
WiredHome	125:7a0b70f56550	2511
WiredHome	96:40b74dd3695b	2512	/// PrintScreen callback registration.
WiredHome	96:40b74dd3695b	2513	///
WiredHome	96:40b74dd3695b	2514	/// This method attaches a c++ class method as a callback of type PrintCallback_T.
WiredHome	96:40b74dd3695b	2515	/// Then, the PrintScreen(x,y,w,h) method is called. Each chunk of data in the
WiredHome	96:40b74dd3695b	2516	/// BMP file to be created is passed to this callback.
WiredHome	96:40b74dd3695b	2517	///
WiredHome	96:40b74dd3695b	2518	/// @param object is the class hosting the callback function.
WiredHome	102:fc60bfa0199f	2519	/// @param method is the callback method in the object to activate.
WiredHome	96:40b74dd3695b	2520	///
WiredHome	96:40b74dd3695b	2521	template <class T>
WiredHome	102:fc60bfa0199f	2522	void AttachPrintHandler(T object, RetCode_t (T::method)(void)) {
WiredHome	102:fc60bfa0199f	2523	obj_callback = (FPointerDummy *)object;
WiredHome	108:7415c405ee08	2524	method_callback = (uint32_t (FPointerDummy::)(uint32_t, uint8_t , uint16_t))method;
WiredHome	96:40b74dd3695b	2525	}
WiredHome	96:40b74dd3695b	2526
WiredHome	125:7a0b70f56550	2527
WiredHome	72:ecffe56af969	2528	/// This method captures the specified area as a 24-bit bitmap file,
WiredHome	72:ecffe56af969	2529	/// including the option of layer selection.
WiredHome	72:ecffe56af969	2530	///
WiredHome	125:7a0b70f56550	2531	/// @note This method is deprecated as the alternate PrintScreen API
WiredHome	74:686faa218914	2532	/// automatically examines the display layer configuration.
WiredHome	74:686faa218914	2533	/// Therefore, calls to this API will ignore the layer parameter
WiredHome	74:686faa218914	2534	/// and automatically execute the other method.
WiredHome	74:686faa218914	2535	///
WiredHome	72:ecffe56af969	2536	/// Even though this is a 16-bit display, the stored image is in
WiredHome	72:ecffe56af969	2537	/// 24-bit format.
WiredHome	72:ecffe56af969	2538	///
WiredHome	72:ecffe56af969	2539	/// @param[in] layer is 0 or 1 to select the layer to extract.
WiredHome	72:ecffe56af969	2540	/// @param[in] x is the left edge of the region to capture
WiredHome	72:ecffe56af969	2541	/// @param[in] y is the top edge of the region to capture
WiredHome	72:ecffe56af969	2542	/// @param[in] w is the width of the region to capture
WiredHome	72:ecffe56af969	2543	/// @param[in] h is the height of the region to capture.
WiredHome	72:ecffe56af969	2544	/// @param[out] Name_BMP is the filename to write the image to.
WiredHome	72:ecffe56af969	2545	/// @return success or error code.
WiredHome	72:ecffe56af969	2546	///
WiredHome	72:ecffe56af969	2547	RetCode_t PrintScreen(uint16_t layer, loc_t x, loc_t y, dim_t w, dim_t h, const char *Name_BMP);
WiredHome	125:7a0b70f56550	2548
WiredHome	72:ecffe56af969	2549
WiredHome	123:2f45e80fec5f	2550	/// idle callback registration.
WiredHome	123:2f45e80fec5f	2551	///
WiredHome	125:7a0b70f56550	2552	/// This method attaches a simple c-compatible callback of type IdleCallback_T.
WiredHome	123:2f45e80fec5f	2553	/// Then, at any time when the display driver is waiting, it will call the
WiredHome	123:2f45e80fec5f	2554	/// registered function. This is probably most useful if you want to service
WiredHome	123:2f45e80fec5f	2555	/// a watchdog, when you may have called an API that will "hang" waiting
WiredHome	123:2f45e80fec5f	2556	/// on the user.
WiredHome	123:2f45e80fec5f	2557	///
WiredHome	123:2f45e80fec5f	2558	/// @param callback is the idle callback function. Without a callback function
WiredHome	123:2f45e80fec5f	2559	/// it will unregister the handler.
WiredHome	123:2f45e80fec5f	2560	///
WiredHome	123:2f45e80fec5f	2561	void AttachIdleHandler(IdleCallback_T callback = NULL) { idle_callback = callback; }
WiredHome	57:bd53a9e165a1	2562
WiredHome	133:e36dcfc2d756	2563
WiredHome	19:3f82c1161fd2	2564	#ifdef PERF_METRICS
WiredHome	19:3f82c1161fd2	2565	/// Clear the performance metrics to zero.
WiredHome	19:3f82c1161fd2	2566	void ClearPerformance();
WiredHome	19:3f82c1161fd2	2567
WiredHome	66:468a11f05580	2568	/// Count idle time.
WiredHome	66:468a11f05580	2569	///
WiredHome	72:ecffe56af969	2570	/// @param[in] t is the amount of idle time to accumulate.
WiredHome	66:468a11f05580	2571	///
WiredHome	66:468a11f05580	2572	void CountIdleTime(uint32_t t);
WiredHome	66:468a11f05580	2573
WiredHome	19:3f82c1161fd2	2574	/// Report the performance metrics for drawing functions using
WiredHome	41:2956a0a221e5	2575	/// the available serial channel.
WiredHome	41:2956a0a221e5	2576	///
WiredHome	72:ecffe56af969	2577	/// @param[in,out] pc is the serial channel to write to.
WiredHome	41:2956a0a221e5	2578	///
WiredHome	41:2956a0a221e5	2579	void ReportPerformance(Serial & pc);
WiredHome	19:3f82c1161fd2	2580	#endif
WiredHome	19:3f82c1161fd2	2581
hexley	54:e117ad10fba6	2582
WiredHome	19:3f82c1161fd2	2583	private:
WiredHome	124:1690a7ae871c	2584	/// Touch panel parameters - common to both resistive and capacitive
WiredHome	124:1690a7ae871c	2585
WiredHome	124:1690a7ae871c	2586	/// Data type to indicate which TP, if any, is in use.
WiredHome	124:1690a7ae871c	2587	typedef enum {
WiredHome	124:1690a7ae871c	2588	TP_NONE, ///< no touch panel in use
WiredHome	124:1690a7ae871c	2589	TP_RES, ///< resistive touch panel using RA8875
WiredHome	124:1690a7ae871c	2590	TP_CAP, ///< capacitive touch panel using FT5206
WiredHome	124:1690a7ae871c	2591	} WhichTP_T;
WiredHome	124:1690a7ae871c	2592
WiredHome	124:1690a7ae871c	2593	/// boolean flag set true when using Capacitive touch panel, and false
WiredHome	124:1690a7ae871c	2594	/// for resistive.
WiredHome	124:1690a7ae871c	2595	WhichTP_T useTouchPanel; ///< Indicates which TP is selected for use.
WiredHome	124:1690a7ae871c	2596
WiredHome	124:1690a7ae871c	2597	/// Touch State used by TouchPanelReadable. See @ref TouchCode_t.
WiredHome	124:1690a7ae871c	2598	TouchCode_t touchState;
WiredHome	124:1690a7ae871c	2599
WiredHome	124:1690a7ae871c	2600	////////////////// Start of Capacitive Touch Panel parameters
WiredHome	124:1690a7ae871c	2601
WiredHome	124:1690a7ae871c	2602	uint8_t getTouchPositions(void);
WiredHome	124:1690a7ae871c	2603	void TouchPanelISR(void);
WiredHome	124:1690a7ae871c	2604	uint16_t numberOfTouchPoints;
WiredHome	124:1690a7ae871c	2605	uint8_t gesture; ///< Holds the reported gesture information.
WiredHome	124:1690a7ae871c	2606
WiredHome	124:1690a7ae871c	2607	/// Touch Information data structure
WiredHome	124:1690a7ae871c	2608	typedef struct {
WiredHome	124:1690a7ae871c	2609	uint8_t touchID; ///< Contains the touch ID, which is the "order" of touch, from 0 to n-1
WiredHome	124:1690a7ae871c	2610	TouchCode_t touchCode; ///< Contains the touch code; no_touch, touch, held, release
WiredHome	124:1690a7ae871c	2611	point_t coordinates; ///< Contains the X,Y coordinate of the touch
WiredHome	124:1690a7ae871c	2612	} touchInfo_T;
WiredHome	124:1690a7ae871c	2613
WiredHome	124:1690a7ae871c	2614	touchInfo_T touchInfo[5]; /// Contains the actual touch information in an array from 0 to n-1
WiredHome	124:1690a7ae871c	2615
WiredHome	124:1690a7ae871c	2616	InterruptIn * m_irq;
WiredHome	124:1690a7ae871c	2617	I2C * m_i2c;
WiredHome	124:1690a7ae871c	2618	int m_addr;
WiredHome	124:1690a7ae871c	2619	uint8_t data[2];
WiredHome	124:1690a7ae871c	2620
WiredHome	124:1690a7ae871c	2621	bool panelTouched;
WiredHome	124:1690a7ae871c	2622	void writeRegister8(uint8_t reg, uint8_t val);
WiredHome	124:1690a7ae871c	2623	uint8_t readRegister8(uint8_t reg);
WiredHome	124:1690a7ae871c	2624
WiredHome	124:1690a7ae871c	2625
WiredHome	124:1690a7ae871c	2626	////////////////// Start of Resistive Touch Panel parameters
WiredHome	124:1690a7ae871c	2627
WiredHome	124:1690a7ae871c	2628	/// Resistive Touch Panel register name definitions
WiredHome	77:9206c13aa527	2629	#define TPCR0 0x70
WiredHome	77:9206c13aa527	2630	#define TPCR1 0x71
WiredHome	77:9206c13aa527	2631	#define TPXH 0x72
WiredHome	77:9206c13aa527	2632	#define TPYH 0x73
WiredHome	77:9206c13aa527	2633	#define TPXYL 0x74
WiredHome	77:9206c13aa527	2634	#define INTC1 0xF0
WiredHome	77:9206c13aa527	2635	#define INTC2 0xF1
hexley	54:e117ad10fba6	2636
hexley	54:e117ad10fba6	2637	/// Specify the default settings for the Touch Panel, where different from the chip defaults
WiredHome	77:9206c13aa527	2638	#define TP_MODE_DEFAULT TP_MODE_AUTO
WiredHome	77:9206c13aa527	2639	#define TP_DEBOUNCE_DEFAULT TP_DEBOUNCE_ON
WiredHome	77:9206c13aa527	2640	#define TP_ADC_CLKDIV_DEFAULT TP_ADC_CLKDIV_8
hexley	54:e117ad10fba6	2641
WiredHome	77:9206c13aa527	2642	#define TP_ADC_SAMPLE_DEFAULT_CLKS TP_ADC_SAMPLE_8192_CLKS
hexley	54:e117ad10fba6	2643
hexley	54:e117ad10fba6	2644	/// Other Touch Panel params
WiredHome	77:9206c13aa527	2645	#define TPBUFSIZE 16 // Depth of the averaging buffers for x and y data
hexley	54:e117ad10fba6	2646
WiredHome	83:7bad0068cca0	2647	// Needs both a ticker and a timer. (could have created a timer from the ticker, but this is easier).
WiredHome	83:7bad0068cca0	2648	// on a touch, the timer is reset.
WiredHome	83:7bad0068cca0	2649	// the ticker monitors the timer to see if it has been a long time since
WiredHome	83:7bad0068cca0	2650	// a touch, and if so, it then clears the sample counter so it doesn't get partial old
WiredHome	83:7bad0068cca0	2651	// and partial new.
WiredHome	83:7bad0068cca0	2652
WiredHome	83:7bad0068cca0	2653	/// Touch Panel ticker
WiredHome	83:7bad0068cca0	2654	Ticker touchTicker;
WiredHome	83:7bad0068cca0	2655
WiredHome	83:7bad0068cca0	2656	/// Touch Panel timer
WiredHome	83:7bad0068cca0	2657	Timer touchTimer;
WiredHome	83:7bad0068cca0	2658
WiredHome	83:7bad0068cca0	2659	/// keeps track of which sample we're collecting to filter out the noise.
WiredHome	83:7bad0068cca0	2660	int touchSample;
WiredHome	83:7bad0068cca0	2661
WiredHome	83:7bad0068cca0	2662	/// Private function for touch ticker callback.
WiredHome	83:7bad0068cca0	2663	void _TouchTicker(void);
WiredHome	83:7bad0068cca0	2664
WiredHome	77:9206c13aa527	2665	/// Touch Panel calibration matrix.
WiredHome	77:9206c13aa527	2666	tpMatrix_t tpMatrix;
hexley	54:e117ad10fba6	2667
WiredHome	124:1690a7ae871c	2668	////////////////// End of Touch Panel parameters
WiredHome	124:1690a7ae871c	2669
WiredHome	124:1690a7ae871c	2670
WiredHome	29:422616aa04bd	2671	/// Internal function to put a character using the built-in (internal) font engine
WiredHome	29:422616aa04bd	2672	///
WiredHome	101:e0aad446094a	2673	/// @param[in] c is the character to put to the screen.
WiredHome	29:422616aa04bd	2674	/// @returns the character put.
WiredHome	29:422616aa04bd	2675	///
WiredHome	29:422616aa04bd	2676	int _internal_putc(int c);
WiredHome	29:422616aa04bd	2677
WiredHome	29:422616aa04bd	2678	/// Internal function to put a character using the external font engine
WiredHome	29:422616aa04bd	2679	///
WiredHome	101:e0aad446094a	2680	/// @param[in] c is the character to put to the screen.
WiredHome	29:422616aa04bd	2681	/// @returns the character put.
WiredHome	29:422616aa04bd	2682	///
WiredHome	29:422616aa04bd	2683	int _external_putc(int c);
WiredHome	29:422616aa04bd	2684
WiredHome	101:e0aad446094a	2685	/// Internal function to get the actual width of a character when using the external font engine
WiredHome	101:e0aad446094a	2686	///
WiredHome	101:e0aad446094a	2687	/// @param[in] c is the character to get the width.
WiredHome	101:e0aad446094a	2688	/// @returns the width in pixels of the character. zero if not found.
WiredHome	101:e0aad446094a	2689	///
WiredHome	101:e0aad446094a	2690	int _external_getCharWidth(int c);
WiredHome	101:e0aad446094a	2691
WiredHome	133:e36dcfc2d756	2692	/// Write color to an RGB register set
WiredHome	133:e36dcfc2d756	2693	///
WiredHome	133:e36dcfc2d756	2694	/// This API takes a color value, and writes it into the specified
WiredHome	133:e36dcfc2d756	2695	/// color registers, which are a trio of 3 registers. The actual
WiredHome	133:e36dcfc2d756	2696	/// trio write is performed based on whether the display is configured
WiredHome	133:e36dcfc2d756	2697	/// for 8 or 16 bits per pixel.
WiredHome	133:e36dcfc2d756	2698	///
WiredHome	133:e36dcfc2d756	2699	/// @param[in] regAddr is the register address starting the trio
WiredHome	133:e36dcfc2d756	2700	/// @param[in] color is the color to write
WiredHome	133:e36dcfc2d756	2701	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	133:e36dcfc2d756	2702	///
WiredHome	133:e36dcfc2d756	2703	RetCode_t _writeColorTrio(uint8_t regAddr, color_t color);
WiredHome	133:e36dcfc2d756	2704
WiredHome	133:e36dcfc2d756	2705	/// Read color from an RGB register set
WiredHome	133:e36dcfc2d756	2706	///
WiredHome	133:e36dcfc2d756	2707	/// This API reads a color value from a trio of registers. The actual
WiredHome	133:e36dcfc2d756	2708	/// trio write is performed based on whether the display is configured
WiredHome	133:e36dcfc2d756	2709	/// for 8 or 16 bits per pixel.
WiredHome	133:e36dcfc2d756	2710	///
WiredHome	133:e36dcfc2d756	2711	/// @param[in] regAddr is the register address starting the trio
WiredHome	133:e36dcfc2d756	2712	/// @returns color_t value
WiredHome	133:e36dcfc2d756	2713	///
WiredHome	133:e36dcfc2d756	2714	color_t _readColorTrio(uint8_t regAddr);
WiredHome	133:e36dcfc2d756	2715
WiredHome	133:e36dcfc2d756	2716
WiredHome	105:4f116006ba1f	2717	/// Convert a 16-bit color value to an 8-bit value
WiredHome	105:4f116006ba1f	2718	///
WiredHome	105:4f116006ba1f	2719	/// @param[in] c16 is the 16-bit color value to convert.
WiredHome	105:4f116006ba1f	2720	/// @returns 8-bit color value.
WiredHome	105:4f116006ba1f	2721	///
WiredHome	105:4f116006ba1f	2722	uint8_t _cvt16to8(color_t c16);
WiredHome	105:4f116006ba1f	2723
WiredHome	105:4f116006ba1f	2724	/// Convert an 8-bit color value to a 16-bit value
WiredHome	105:4f116006ba1f	2725	///
WiredHome	105:4f116006ba1f	2726	/// @param[in] c8 is the 8-bit color value to convert.
WiredHome	105:4f116006ba1f	2727	/// @returns 16-bit color value.
WiredHome	105:4f116006ba1f	2728	///
WiredHome	105:4f116006ba1f	2729	color_t _cvt8to16(uint8_t c8);
WiredHome	105:4f116006ba1f	2730
WiredHome	19:3f82c1161fd2	2731	/// Select the peripheral to use it.
WiredHome	19:3f82c1161fd2	2732	///
WiredHome	72:ecffe56af969	2733	/// @param[in] chipsel when true will select the peripheral, and when false
WiredHome	19:3f82c1161fd2	2734	/// will deselect the chip. This is the logical selection, and
WiredHome	19:3f82c1161fd2	2735	/// the pin selection is the invert of this.
WiredHome	106:c80828f5dea4	2736	/// @returns success/failure code. See @ref RetCode_t.
WiredHome	19:3f82c1161fd2	2737	///
WiredHome	79:544eb4964795	2738	RetCode_t _select(bool chipsel);
WiredHome	19:3f82c1161fd2	2739
WiredHome	66:468a11f05580	2740	/// Wait while the status register indicates the controller is busy.
WiredHome	66:468a11f05580	2741	///
WiredHome	72:ecffe56af969	2742	/// @param[in] mask is the mask of bits to monitor.
WiredHome	66:468a11f05580	2743	/// @returns true if a normal exit.
WiredHome	66:468a11f05580	2744	/// @returns false if a timeout exit.
WiredHome	66:468a11f05580	2745	///
WiredHome	66:468a11f05580	2746	bool _WaitWhileBusy(uint8_t mask);
WiredHome	66:468a11f05580	2747
WiredHome	66:468a11f05580	2748	/// Wait while the the register anded with the mask is true.
WiredHome	66:468a11f05580	2749	///
WiredHome	72:ecffe56af969	2750	/// @param[in] reg is the register to monitor
WiredHome	72:ecffe56af969	2751	/// @param[in] mask is the bit mask to monitor
WiredHome	66:468a11f05580	2752	/// @returns true if it was a normal exit
WiredHome	66:468a11f05580	2753	/// @returns false if it was a timeout that caused the exit.
WiredHome	66:468a11f05580	2754	///
WiredHome	66:468a11f05580	2755	bool _WaitWhileReg(uint8_t reg, uint8_t mask);
WiredHome	66:468a11f05580	2756
WiredHome	68:ab08efabfc88	2757	/// set the spi port to either the write or the read speed.
WiredHome	68:ab08efabfc88	2758	///
WiredHome	68:ab08efabfc88	2759	/// This is a private API used to toggle between the write
WiredHome	68:ab08efabfc88	2760	/// and the read speed for the SPI port to the RA8875, since
WiredHome	68:ab08efabfc88	2761	/// it can accept writes faster than reads.
WiredHome	68:ab08efabfc88	2762	///
WiredHome	72:ecffe56af969	2763	/// @param[in] writeSpeed when true selects the write frequency,
WiredHome	68:ab08efabfc88	2764	/// and when false it selects the read frequency.
WiredHome	68:ab08efabfc88	2765	///
WiredHome	68:ab08efabfc88	2766	void _setWriteSpeed(bool writeSpeed);
WiredHome	68:ab08efabfc88	2767
WiredHome	19:3f82c1161fd2	2768	/// The most primitive - to write a data value to the SPI interface.
WiredHome	19:3f82c1161fd2	2769	///
WiredHome	72:ecffe56af969	2770	/// @param[in] data is the value to write.
WiredHome	19:3f82c1161fd2	2771	/// @returns a value read from the port, since SPI is often shift
WiredHome	19:3f82c1161fd2	2772	/// in while shifting out.
WiredHome	19:3f82c1161fd2	2773	///
WiredHome	79:544eb4964795	2774	unsigned char _spiwrite(unsigned char data);
WiredHome	19:3f82c1161fd2	2775
WiredHome	19:3f82c1161fd2	2776	/// The most primitive - to read a data value to the SPI interface.
WiredHome	19:3f82c1161fd2	2777	///
WiredHome	19:3f82c1161fd2	2778	/// This is really just a specialcase of the write command, where
WiredHome	19:3f82c1161fd2	2779	/// the value zero is written in order to read.
WiredHome	19:3f82c1161fd2	2780	///
WiredHome	19:3f82c1161fd2	2781	/// @returns a value read from the port, since SPI is often shift
WiredHome	19:3f82c1161fd2	2782	/// in while shifting out.
WiredHome	19:3f82c1161fd2	2783	///
WiredHome	79:544eb4964795	2784	unsigned char _spiread();
WiredHome	19:3f82c1161fd2	2785
WiredHome	75:ca78388cfd77	2786	const uint8_t * pKeyMap;
WiredHome	75:ca78388cfd77	2787
WiredHome	19:3f82c1161fd2	2788	SPI spi; ///< spi port
WiredHome	68:ab08efabfc88	2789	bool spiWriteSpeed; ///< indicates if the current mode is write or read
WiredHome	68:ab08efabfc88	2790	unsigned long spiwritefreq; ///< saved write freq
WiredHome	66:468a11f05580	2791	unsigned long spireadfreq; ///< saved read freq
WiredHome	19:3f82c1161fd2	2792	DigitalOut cs; ///< chip select pin, assumed active low
WiredHome	19:3f82c1161fd2	2793	DigitalOut res; ///< reset pin, assumed active low
WiredHome	90:d113d71ae4f0	2794
WiredHome	105:4f116006ba1f	2795	// display metrics to avoid lengthy spi read queries
WiredHome	105:4f116006ba1f	2796	uint8_t screenbpp; ///< configured bits per pixel
WiredHome	90:d113d71ae4f0	2797	dim_t screenwidth; ///< configured screen width
WiredHome	90:d113d71ae4f0	2798	dim_t screenheight; ///< configured screen height
WiredHome	111:efe436c43aba	2799	rect_t windowrect; ///< window commands are held here for speed of access
WiredHome	90:d113d71ae4f0	2800	bool portraitmode; ///< set true when in portrait mode (w,h are reversed)
WiredHome	90:d113d71ae4f0	2801
WiredHome	19:3f82c1161fd2	2802	const unsigned char * font; ///< reference to an external font somewhere in memory
WiredHome	98:ecebed9b80b2	2803	uint8_t extFontHeight; ///< computed from the font table when the user sets the font
WiredHome	98:ecebed9b80b2	2804	uint8_t extFontWidth; ///< computed from the font table when the user sets the font
WiredHome	98:ecebed9b80b2	2805
WiredHome	90:d113d71ae4f0	2806	loc_t cursor_x, cursor_y; ///< used for external fonts only
WiredHome	19:3f82c1161fd2	2807
WiredHome	19:3f82c1161fd2	2808	#ifdef PERF_METRICS
WiredHome	19:3f82c1161fd2	2809	typedef enum
WiredHome	19:3f82c1161fd2	2810	{
WiredHome	19:3f82c1161fd2	2811	PRF_CLS,
WiredHome	41:2956a0a221e5	2812	PRF_DRAWPIXEL,
WiredHome	41:2956a0a221e5	2813	PRF_PIXELSTREAM,
WiredHome	109:7b94f06f085b	2814	PRF_BOOLSTREAM,
WiredHome	41:2956a0a221e5	2815	PRF_READPIXEL,
WiredHome	41:2956a0a221e5	2816	PRF_READPIXELSTREAM,
WiredHome	19:3f82c1161fd2	2817	PRF_DRAWLINE,
WiredHome	19:3f82c1161fd2	2818	PRF_DRAWRECTANGLE,
WiredHome	19:3f82c1161fd2	2819	PRF_DRAWROUNDEDRECTANGLE,
WiredHome	19:3f82c1161fd2	2820	PRF_DRAWTRIANGLE,
WiredHome	19:3f82c1161fd2	2821	PRF_DRAWCIRCLE,
WiredHome	19:3f82c1161fd2	2822	PRF_DRAWELLIPSE,
WiredHome	131:5bd6ba2ee4a1	2823	PRF_BLOCKMOVE,
WiredHome	19:3f82c1161fd2	2824	METRICCOUNT
WiredHome	19:3f82c1161fd2	2825	} method_e;
WiredHome	19:3f82c1161fd2	2826	unsigned long metrics[METRICCOUNT];
WiredHome	75:ca78388cfd77	2827	unsigned long idletime_usec;
WiredHome	19:3f82c1161fd2	2828	void RegisterPerformance(method_e method);
WiredHome	19:3f82c1161fd2	2829	Timer performance;
WiredHome	19:3f82c1161fd2	2830	#endif
WiredHome	96:40b74dd3695b	2831
WiredHome	96:40b74dd3695b	2832	RetCode_t _printCallback(RA8875::filecmd_t cmd, uint8_t * buffer, uint16_t size);
WiredHome	96:40b74dd3695b	2833
WiredHome	96:40b74dd3695b	2834	FILE * _printFH; ///< PrintScreen file handle
WiredHome	96:40b74dd3695b	2835
WiredHome	96:40b74dd3695b	2836	RetCode_t privateCallback(filecmd_t cmd, uint8_t * buffer, uint16_t size) {
WiredHome	96:40b74dd3695b	2837	if (c_callback != NULL) {
WiredHome	96:40b74dd3695b	2838	return (*c_callback)(cmd, buffer, size);
WiredHome	96:40b74dd3695b	2839	}
WiredHome	96:40b74dd3695b	2840	else {
WiredHome	96:40b74dd3695b	2841	if (obj_callback != NULL && method_callback != NULL) {
WiredHome	96:40b74dd3695b	2842	return (obj_callback->*method_callback)(cmd, buffer, size);
WiredHome	96:40b74dd3695b	2843	}
WiredHome	96:40b74dd3695b	2844	}
WiredHome	96:40b74dd3695b	2845	return noerror;
WiredHome	96:40b74dd3695b	2846	}
WiredHome	96:40b74dd3695b	2847
WiredHome	96:40b74dd3695b	2848	RetCode_t (* c_callback)(filecmd_t cmd, uint8_t * buffer, uint16_t size);
WiredHome	96:40b74dd3695b	2849	FPointerDummy *obj_callback;
WiredHome	96:40b74dd3695b	2850	RetCode_t (FPointerDummy::method_callback)(filecmd_t cmd, uint8_t buffer, uint16_t size);
WiredHome	123:2f45e80fec5f	2851	RetCode_t (* idle_callback)(IdleReason_T reason);
WiredHome	19:3f82c1161fd2	2852	};
WiredHome	19:3f82c1161fd2	2853
WiredHome	96:40b74dd3695b	2854
WiredHome	19:3f82c1161fd2	2855	//} // namespace
WiredHome	19:3f82c1161fd2	2856
WiredHome	19:3f82c1161fd2	2857	//using namespace SW_graphics;
WiredHome	19:3f82c1161fd2	2858
WiredHome	23:a50ded45dbaf	2859
WiredHome	23:a50ded45dbaf	2860	#ifdef TESTENABLE
WiredHome	23:a50ded45dbaf	2861	// ______________ ______________ ______________ _______________
WiredHome	23:a50ded45dbaf	2862	// /_____ _____/ / ___________/ / ___________/ /_____ ______/
WiredHome	23:a50ded45dbaf	2863	// / / / / / / / /
WiredHome	23:a50ded45dbaf	2864	// / / / /___ / /__________ / /
WiredHome	23:a50ded45dbaf	2865	// / / / ____/ /__________ / / /
WiredHome	23:a50ded45dbaf	2866	// / / / / / / / /
WiredHome	23:a50ded45dbaf	2867	// / / / /__________ ___________/ / / /
WiredHome	23:a50ded45dbaf	2868	// /__/ /_____________/ /_____________/ /__/
WiredHome	23:a50ded45dbaf	2869
WiredHome	23:a50ded45dbaf	2870	#include "WebColors.h"
WiredHome	23:a50ded45dbaf	2871	#include <algorithm>
WiredHome	23:a50ded45dbaf	2872
WiredHome	23:a50ded45dbaf	2873	extern "C" void mbed_reset();
WiredHome	23:a50ded45dbaf	2874
WiredHome	23:a50ded45dbaf	2875	/// This activates a small set of tests for the graphics library.
WiredHome	23:a50ded45dbaf	2876	///
WiredHome	23:a50ded45dbaf	2877	/// Call this API and pass it the reference to the display class.
WiredHome	23:a50ded45dbaf	2878	/// It will then run a series of tests. It accepts interaction via
WiredHome	23:a50ded45dbaf	2879	/// stdin to switch from automatic test mode to manual, run a specific
WiredHome	23:a50ded45dbaf	2880	/// test, or to exit the test mode.
WiredHome	23:a50ded45dbaf	2881	///
WiredHome	72:ecffe56af969	2882	/// @param[in] lcd is a reference to the display class.
WiredHome	72:ecffe56af969	2883	/// @param[in] pc is a reference to a serial interface, typically the USB to PC.
WiredHome	23:a50ded45dbaf	2884	///
WiredHome	23:a50ded45dbaf	2885	void RunTestSet(RA8875 & lcd, Serial & pc);
WiredHome	23:a50ded45dbaf	2886
WiredHome	23:a50ded45dbaf	2887
WiredHome	23:a50ded45dbaf	2888	// To enable the test code, uncomment this section, or copy the
WiredHome	23:a50ded45dbaf	2889	// necessary pieces to your "main()".
WiredHome	23:a50ded45dbaf	2890	//
WiredHome	23:a50ded45dbaf	2891	// #include "mbed.h"
WiredHome	23:a50ded45dbaf	2892	// #include "RA8875.h"
WiredHome	23:a50ded45dbaf	2893	// RA8875 lcd(p5, p6, p7, p12, NC, "tft"); // MOSI, MISO, SCK, /ChipSelect, /reset, name
WiredHome	23:a50ded45dbaf	2894	// Serial pc(USBTX, USBRX);
WiredHome	23:a50ded45dbaf	2895	// extern "C" void mbed_reset();
WiredHome	23:a50ded45dbaf	2896	// int main()
WiredHome	23:a50ded45dbaf	2897	// {
WiredHome	23:a50ded45dbaf	2898	// pc.baud(460800); // I like a snappy terminal, so crank it up!
WiredHome	23:a50ded45dbaf	2899	// pc.printf("\r\nRA8875 Test - Build " __DATE__ " " __TIME__ "\r\n");
WiredHome	23:a50ded45dbaf	2900	//
WiredHome	23:a50ded45dbaf	2901	// pc.printf("Turning on display\r\n");
WiredHome	101:e0aad446094a	2902	// lcd.init();
WiredHome	23:a50ded45dbaf	2903	// lcd.Reset();
WiredHome	23:a50ded45dbaf	2904	// lcd.Power(true); // display power is on, but the backlight is independent
WiredHome	23:a50ded45dbaf	2905	// lcd.Backlight(0.5);
WiredHome	23:a50ded45dbaf	2906	// RunTestSet(lcd, pc);
WiredHome	23:a50ded45dbaf	2907	// }
WiredHome	23:a50ded45dbaf	2908
WiredHome	23:a50ded45dbaf	2909	#endif // TESTENABLE
WiredHome	23:a50ded45dbaf	2910
WiredHome	56:7a85d226ad0d	2911	#endif

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	12 Jan 2014
Imports:	363
Forks:	7
Commits:	210
Dependents:	20
Dependencies:	0
Followers:	13
Issues:	2

The code in this repository is MIT licensed.

Components

RA8875: 4" to 8" (WQVGA, WVGA, Multi-Touch, Keypad)