RA8875 - This is the David Smart RA8875 Library with mods …

Users » lamell » Code » RA8875

This is the David Smart RA8875 Library with mods for working with FRDM-K64F

RA8875.h@198:18d25c15a7b5, 2020-03-03 (annotated)

Committer:: lamell
Date:: Tue Mar 03 10:08:41 2020 -0400
Revision:: 198:18d25c15a7b5
Parent:: 197:853d08e2fb53
Child:: 199:08eb9e55567b

Commented the lines 3166 to 3171. AttachPrintHandler because it gives errors using K64F.

will try to find a solution later, for now I don't need it.

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	190:3132b7dfad82	5	/// can support displays up to 800 x 480 pixels x 16-bit color.
WiredHome	167:8aa3fb2a5a31	6	///
WiredHome	182:8832d03a2a29	7	/// @image html Example_Program.png "Image of an Example Program"
WiredHome	182:8832d03a2a29	8	///
WiredHome	190:3132b7dfad82	9	/// Aside from 800 x 480 pixel displays, another common implementation is
WiredHome	190:3132b7dfad82	10	/// 480 x 272 x 16 with two layers. The two layers can be exchanged, or blended
WiredHome	190:3132b7dfad82	11	/// in various ways (transparency, OR, AND, and more). It includes graphics
WiredHome	190:3132b7dfad82	12	/// acceleration capabilities for drawing primitives, such as line, rectangle,
WiredHome	167:8aa3fb2a5a31	13	/// circles, and more.
WiredHome	167:8aa3fb2a5a31	14	///
WiredHome	190:3132b7dfad82	15	/// It is not a display for video-speed animations, and maybe could hold its own
WiredHome	190:3132b7dfad82	16	/// as a slow picture frame, at least when using the SPI ports. How the performance
WiredHome	167:8aa3fb2a5a31	17	/// differs using I2C, 8-bit parallel or 16-bit parallel has not been evaluated.
WiredHome	167:8aa3fb2a5a31	18	/// Certainly the parallel interface option would be expected to be a lot faster.
WiredHome	167:8aa3fb2a5a31	19	///
WiredHome	167:8aa3fb2a5a31	20	/// What it is good at is performing as a basic display for appliance or simple
WiredHome	190:3132b7dfad82	21	/// home automation, and because of the built-in capability to draw lines, circles,
WiredHome	190:3132b7dfad82	22	/// ellipses, rectangles, rounded rectangles, and triangles, it does a lot of the
WiredHome	167:8aa3fb2a5a31	23	/// work that your host micro would otherwise be doing, and in many cases it does
WiredHome	167:8aa3fb2a5a31	24	/// it much faster.
WiredHome	78:faf49c381591	25	///
WiredHome	167:8aa3fb2a5a31	26	/// While it is good to know about Bresenham's algorithm (to draw a line) and how
WiredHome	190:3132b7dfad82	27	/// to implement it in software, this controller simplifies things -
WiredHome	190:3132b7dfad82	28	/// You just give it (x1,y1), (x2,y2) and tell it to draw a line.
WiredHome	167:8aa3fb2a5a31	29	/// Without the hardware acceleration built into the RA8875, the host would have to
WiredHome	167:8aa3fb2a5a31	30	/// compute every point, set the graphics cursor to that point, and fill in that
WiredHome	167:8aa3fb2a5a31	31	/// point with the target color. A diagonal line of some length might take 100
WiredHome	190:3132b7dfad82	32	/// interactions instead of just a few. Other drawing primitives are similarly easy.
WiredHome	167:8aa3fb2a5a31	33	///
WiredHome	190:3132b7dfad82	34	/// It has some built-in fonts, which can be enhanced with optional font-chips, and
WiredHome	167:8aa3fb2a5a31	35	/// with the provided software font engine, and a few instructions, you can convert
WiredHome	190:3132b7dfad82	36	/// most any True Type Font into the data structures suitable for this display.
WiredHome	167:8aa3fb2a5a31	37	///
WiredHome	167:8aa3fb2a5a31	38	/// To round out the features, this library offers the ability to render Bitmap (BMP),
WiredHome	190:3132b7dfad82	39	/// Icon (ICO), Join Photographic Experts Group (JPG), and Graphics Interchange Format
WiredHome	190:3132b7dfad82	40	/// (GIF) images. These are implemented primarily in software, taking advantage of the
WiredHome	190:3132b7dfad82	41	/// hardware acceleration where it can.
WiredHome	167:8aa3fb2a5a31	42	///
WiredHome	190:3132b7dfad82	43	/// When you are satisfied with what appears on screen, there is a PrintScreen method
WiredHome	167:8aa3fb2a5a31	44	/// to pull that image back out and write it to a file system as a BitMap image.
WiredHome	101:e0aad446094a	45	///
WiredHome	78:faf49c381591	46	/// The controller additionally supports backlight control (via PWM), keypad scanning
WiredHome	167:8aa3fb2a5a31	47	/// (for a 4 x 5 matrix) and resistive touch-panel support. Support for capacitive
WiredHome	167:8aa3fb2a5a31	48	/// touch screens is also integrated, in a manner that makes the resistive and
WiredHome	190:3132b7dfad82	49	/// capacitive interfaces nearly API identical. The capacitive touch support is for
WiredHome	167:8aa3fb2a5a31	50	/// either the FT5206 or the GSL1680 controller chips.
WiredHome	167:8aa3fb2a5a31	51	///
WiredHome	167:8aa3fb2a5a31	52	/// Here's a few hints to get started:
WiredHome	167:8aa3fb2a5a31	53	/// * @ref Display_Config
WiredHome	167:8aa3fb2a5a31	54	/// * @ref Touch_Panel
WiredHome	167:8aa3fb2a5a31	55	/// * @ref Hardwired_KeyPad
WiredHome	167:8aa3fb2a5a31	56	/// * @ref Example_Program
WiredHome	167:8aa3fb2a5a31	57	/// * @ref Wiring_Diagram
WiredHome	182:8832d03a2a29	58	/// * @ref External_Resources
WiredHome	167:8aa3fb2a5a31	59	/// * @ref Future_Plans
WiredHome	167:8aa3fb2a5a31	60	///
WiredHome	196:56820026701b	61	/// @todo Move the global enums into the class (e.g. NOFILL becomes RA8875::NOFILL) to
WiredHome	196:56820026701b	62	/// avoid namespace clashes.
WiredHome	196:56820026701b	63	/// @todo Integrate the touch as a runtime linkable feature, which can then eliminate
WiredHome	196:56820026701b	64	/// the huge memory footprint for the GSL1680 firmware when it is not needed.
WiredHome	196:56820026701b	65	/// @todo Integrate installed font-rom.
WiredHome	167:8aa3fb2a5a31	66	/// @todo Figure out how to "init()" in the constructor. I ran into some issues if
WiredHome	167:8aa3fb2a5a31	67	/// the display was instantiated before main(), and the code would not run,
WiredHome	167:8aa3fb2a5a31	68	/// thus the exposure and activation of the init() function. If the constructor
WiredHome	167:8aa3fb2a5a31	69	/// was within main(), then it seemed to work as expected.
WiredHome	196:56820026701b	70	/// @todo Add Scroll support for text.
WiredHome	196:56820026701b	71	/// @todo Add Hardware reset signal - but testing to date indicates it is not needed.
WiredHome	196:56820026701b	72	/// @todo Add high level objects - x-y graph, meter, others... but these will
WiredHome	196:56820026701b	73	/// probably be best served in another class, since they may not
WiredHome	196:56820026701b	74	/// be needed for many uses.
WiredHome	196:56820026701b	75	/// @todo Add APIs for the 2nd RA8875 PWM channel. If the frequency can be independently
WiredHome	196:56820026701b	76	/// controlled, it could be used as a simple beeper.
WiredHome	78:faf49c381591	77	///
WiredHome	167:8aa3fb2a5a31	78	/// @note As the author of this library, let me state that I am not affiliated with
WiredHome	190:3132b7dfad82	79	/// Raio (silicon provider of the RA8875), or with BuyDisplay.com (where a lot
WiredHome	190:3132b7dfad82	80	/// of these displays can be purchased), I am simply a very satisfied customer
WiredHome	167:8aa3fb2a5a31	81	/// of the technology of the RA8875 chip.
WiredHome	167:8aa3fb2a5a31	82	///
WiredHome	196:56820026701b	83	/// @copyright Copyright © 2012-2020 by Smartware Computing, all rights reserved.
WiredHome	167:8aa3fb2a5a31	84	/// This library is predominantly, that of Smartware Computing, however some
WiredHome	190:3132b7dfad82	85	/// portions are compiled from the work of others. Where the contribution of
WiredHome	190:3132b7dfad82	86	/// others was listed as copyright, that copyright is maintained, even as a
WiredHome	167:8aa3fb2a5a31	87	/// derivative work may have been created for better integration in this library.
WiredHome	167:8aa3fb2a5a31	88	/// See @ref Copyright_References.
WiredHome	167:8aa3fb2a5a31	89	///
WiredHome	167:8aa3fb2a5a31	90	/// @page Copyright_References Copyright References
WiredHome	190:3132b7dfad82	91	///
WiredHome	167:8aa3fb2a5a31	92	/// Following are links to the known copyright references. If I overlooked any, it was
WiredHome	167:8aa3fb2a5a31	93	/// unintentional - please let me know so I can update it. Some portions of the code
WiredHome	167:8aa3fb2a5a31	94	/// have been acquired from the cloud, and where any copyright information was available,
WiredHome	167:8aa3fb2a5a31	95	/// it was preserved.
WiredHome	167:8aa3fb2a5a31	96	///
WiredHome	167:8aa3fb2a5a31	97	/// * @ref GraphicDisplay_Copyright
WiredHome	167:8aa3fb2a5a31	98	/// * @ref TextDisplay_Copyright
WiredHome	167:8aa3fb2a5a31	99	/// * @ref TinyJPEGDecompressor_Copyright
WiredHome	167:8aa3fb2a5a31	100	/// * @ref RA8875::TouchPanelComputeCalibration
WiredHome	167:8aa3fb2a5a31	101	///
WiredHome	167:8aa3fb2a5a31	102	/// @page Display_Config Display Configuration
WiredHome	78:faf49c381591	103	///
WiredHome	78:faf49c381591	104	/// This section details basics for bringing the display online. At a minimum,
WiredHome	167:8aa3fb2a5a31	105	/// the display is instantiated, after which nearly any of the available commands
WiredHome	78:faf49c381591	106	/// may be issued.
WiredHome	78:faf49c381591	107	///
WiredHome	182:8832d03a2a29	108	/// @image html RA8875_Display.png "Schematic Representation of the Display"
WiredHome	182:8832d03a2a29	109	///
WiredHome	78:faf49c381591	110	/// During the instantiation, the display is powered on, cleared, and the backlight
WiredHome	78:faf49c381591	111	/// is energized. Additionally, the keypad and touchscreen features are activated.
WiredHome	190:3132b7dfad82	112	/// It is important to keep in mind that the keypad has its default mapping,
WiredHome	190:3132b7dfad82	113	/// a resistive touchscreen does not yet have the calibration matrix configured,
WiredHome	167:8aa3fb2a5a31	114	/// and the RA8875::init() function is required to configure other important options
WiredHome	167:8aa3fb2a5a31	115	/// like the display resolution.
WiredHome	190:3132b7dfad82	116	///
WiredHome	190:3132b7dfad82	117	/// @code
WiredHome	78:faf49c381591	118	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	81:01da2e34283d	119	/// lcd.init();
WiredHome	78:faf49c381591	120	/// lcd.foreground(Blue);
WiredHome	78:faf49c381591	121	/// lcd.line(0,0, 479,271);
WiredHome	78:faf49c381591	122	/// ...
WiredHome	78:faf49c381591	123	/// @endcode
WiredHome	78:faf49c381591	124	///
WiredHome	167:8aa3fb2a5a31	125	/// @section RA8875_Capabilities Basic Capabilities
WiredHome	167:8aa3fb2a5a31	126	/// @subsection RA8875_Resolution Display Resolution
WiredHome	167:8aa3fb2a5a31	127	/// There are two very common display resolutions that use the RA8875:
WiredHome	167:8aa3fb2a5a31	128	/// * 480 x 272 pixels
WiredHome	167:8aa3fb2a5a31	129	/// * 800 x 480 pixels
WiredHome	167:8aa3fb2a5a31	130	///
WiredHome	167:8aa3fb2a5a31	131	/// @subsection RA8875_Layers Display Layers
WiredHome	190:3132b7dfad82	132	/// The RA8875 Controller, depending on the resolution and color depth, can support
WiredHome	167:8aa3fb2a5a31	133	/// multiple display layers.
WiredHome	167:8aa3fb2a5a31	134	///
WiredHome	167:8aa3fb2a5a31	135	/// * 1 Layer - when the color depth is 16 bits per pixel
WiredHome	167:8aa3fb2a5a31	136	/// * 2 Layers - when the color depth is 8 bits per pixel and the resolution is 480 x 272.
WiredHome	78:faf49c381591	137	///
WiredHome	167:8aa3fb2a5a31	138	///
WiredHome	167:8aa3fb2a5a31	139	///
WiredHome	167:8aa3fb2a5a31	140	/// @page Touch_Panel Touch Panel
WiredHome	167:8aa3fb2a5a31	141	///
WiredHome	167:8aa3fb2a5a31	142	/// There is support for various touch panel interfaces.
WiredHome	190:3132b7dfad82	143	/// * @ref Resistive_Touch_Panel - native control for a resistive touch panel.
WiredHome	167:8aa3fb2a5a31	144	/// There are a few steps to enable this interface.
WiredHome	182:8832d03a2a29	145	///
WiredHome	182:8832d03a2a29	146	/// For the Capacitive Touch controllers, an I2C interface is required.
WiredHome	182:8832d03a2a29	147	///
WiredHome	182:8832d03a2a29	148	/// @image html RA8875_Touch.png "Schematic Representation of the Touch Interface"
WiredHome	182:8832d03a2a29	149	///
WiredHome	190:3132b7dfad82	150	/// * @ref CapSense_FT5206 - FT5206 capacitive touch controller, integrated in
WiredHome	167:8aa3fb2a5a31	151	/// several popular RA8875-based displays. See @ref Capacitive_Touch_Panel.
WiredHome	190:3132b7dfad82	152	/// * @ref CapSense_GSL1680 - GSL1680 capacitive touch controller, integrated in
WiredHome	167:8aa3fb2a5a31	153	/// several popular RA8875-based displays. See @ref Capacitive_Touch_Panel.
WiredHome	167:8aa3fb2a5a31	154	///
WiredHome	182:8832d03a2a29	155	/// @page MicroSD_Interface Micro SD Interface
WiredHome	182:8832d03a2a29	156	///
WiredHome	182:8832d03a2a29	157	/// Several of the displays from BuyDisplay.com include the option for a Micro SD
WiredHome	182:8832d03a2a29	158	/// card adapter. This is not tied in to the RA8875 controller, it is just provided
WiredHome	182:8832d03a2a29	159	/// as a convenience to the display product.
WiredHome	182:8832d03a2a29	160	///
WiredHome	182:8832d03a2a29	161	/// @image html RA8875_MicroSD.png "Schematic Representation of the Micro SD Interface"
WiredHome	78:faf49c381591	162	///
WiredHome	167:8aa3fb2a5a31	163	///
WiredHome	167:8aa3fb2a5a31	164	/// @page Hardwired_KeyPad Hardwired Keypad
WiredHome	167:8aa3fb2a5a31	165	///
WiredHome	167:8aa3fb2a5a31	166	/// The RA8875 controller supports a hardwired matrix of keys, which can be used to
WiredHome	167:8aa3fb2a5a31	167	/// easily monitor for up to 20 keys (4 x 5 matrix). It is quite flexible, so these
WiredHome	190:3132b7dfad82	168	/// could be a set of independent functions, or they could be wired as a simple
WiredHome	167:8aa3fb2a5a31	169	/// calculator or telephone style of keypad.
WiredHome	167:8aa3fb2a5a31	170	///
WiredHome	182:8832d03a2a29	171	/// @image html RA8875_Keypad.png "Schematic Representation of the Keypad Interface"
WiredHome	182:8832d03a2a29	172	///
WiredHome	167:8aa3fb2a5a31	173	/// Various parameters can be configured, such as the scan rate, using @ref RA8875::KeypadInit().
WiredHome	167:8aa3fb2a5a31	174	/// The keypad has a default keypad mapping, but there is an API that permits
WiredHome	167:8aa3fb2a5a31	175	/// installing a custom @ref RA8875::SetKeyMap().
WiredHome	78:faf49c381591	176	///
WiredHome	167:8aa3fb2a5a31	177	/// @page Resistive_Touch_Panel Resistive Touch Panel
WiredHome	167:8aa3fb2a5a31	178	///
WiredHome	167:8aa3fb2a5a31	179	/// The RA8875 controller supports a native resistive touchscreen interface than can
WiredHome	190:3132b7dfad82	180	/// track a single touch-point.
WiredHome	78:faf49c381591	181	///
WiredHome	167:8aa3fb2a5a31	182	/// If your display has this option, you can easily accept touch input, but it comes with
WiredHome	167:8aa3fb2a5a31	183	/// some additional requirements - calibration being the primary concern.
WiredHome	167:8aa3fb2a5a31	184	///
WiredHome	167:8aa3fb2a5a31	185	/// @section Touch_Panel_Enable Touch Panel Enable
WiredHome	167:8aa3fb2a5a31	186	///
WiredHome	190:3132b7dfad82	187	/// @ref RA8875::TouchPanelInit() has two forms - one fully automatic, and more controlled.
WiredHome	167:8aa3fb2a5a31	188	/// See the APIs for details.
WiredHome	167:8aa3fb2a5a31	189	///
WiredHome	167:8aa3fb2a5a31	190	/// @section Touch_Panel_Calibration
WiredHome	190:3132b7dfad82	191	///
WiredHome	190:3132b7dfad82	192	/// The touch panel is not initially calibrated on startup. The application should
WiredHome	78:faf49c381591	193	/// provide a means to activate the calibration process, and that should not require
WiredHome	78:faf49c381591	194	/// the touchscreen as it may not yet be usable. Alternately, a calibration matrix
WiredHome	78:faf49c381591	195	/// can be loaded from non-volatile and installed.
WiredHome	78:faf49c381591	196	///
WiredHome	167:8aa3fb2a5a31	197	/// @page Capacitive_Touch_Panel Capacitive Touch Panel
WiredHome	167:8aa3fb2a5a31	198	///
WiredHome	167:8aa3fb2a5a31	199	/// Common to many of the commercially available display modules that use the RA8875 is
WiredHome	167:8aa3fb2a5a31	200	/// an option for a capacitive sense touch screen [Cap Sense] There are two known Cap Sense
WiredHome	167:8aa3fb2a5a31	201	/// controllers that this library can work with:
WiredHome	167:8aa3fb2a5a31	202	///
WiredHome	167:8aa3fb2a5a31	203	/// * @ref CapSense_FT5206.
WiredHome	167:8aa3fb2a5a31	204	/// * @ref CapSense_GSL1680.
WiredHome	190:3132b7dfad82	205	///
WiredHome	167:8aa3fb2a5a31	206	/// @page CapSense_FT5206 Capacitive Sense - FT5206 Controller
WiredHome	167:8aa3fb2a5a31	207	///
WiredHome	167:8aa3fb2a5a31	208	/// This is the more common controller. It supports up to 5 simultaneous touch point
WiredHome	167:8aa3fb2a5a31	209	/// tracking.
WiredHome	167:8aa3fb2a5a31	210	///
WiredHome	167:8aa3fb2a5a31	211	/// @page CapSense_GSL1680 Capacitive Sense - GSL1680 Controller
WiredHome	167:8aa3fb2a5a31	212	///
WiredHome	167:8aa3fb2a5a31	213	/// This is the less common controller. It supports either 5 or 10 simultaneous touch point
WiredHome	167:8aa3fb2a5a31	214	/// tracking, depending on the firmware installed in the controller.
WiredHome	167:8aa3fb2a5a31	215	///
WiredHome	182:8832d03a2a29	216
WiredHome	182:8832d03a2a29	217
WiredHome	167:8aa3fb2a5a31	218	/// @page Example_Program Example Program
WiredHome	167:8aa3fb2a5a31	219	///
WiredHome	167:8aa3fb2a5a31	220	/// This is just a small sample of what can be done, and what it can look like:
WiredHome	167:8aa3fb2a5a31	221	/// @image html Example_Program.png "Example Program"
WiredHome	78:faf49c381591	222	///
WiredHome	167:8aa3fb2a5a31	223	/// @code
WiredHome	167:8aa3fb2a5a31	224	/// // Small test program
WiredHome	167:8aa3fb2a5a31	225	/// #include "mbed.h" // Working: v146, not fully working: v147
WiredHome	167:8aa3fb2a5a31	226	/// #include "RA8875.h" // Working: v149
WiredHome	167:8aa3fb2a5a31	227	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	190:3132b7dfad82	228	///
WiredHome	167:8aa3fb2a5a31	229	/// int main()
WiredHome	167:8aa3fb2a5a31	230	/// {
WiredHome	167:8aa3fb2a5a31	231	/// lcd.init(480,272,16,100);
WiredHome	167:8aa3fb2a5a31	232	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	167:8aa3fb2a5a31	233	/// lcd.circle( 400,25, 25, BrightRed);
WiredHome	167:8aa3fb2a5a31	234	/// lcd.fillcircle( 400,25, 15, RGB(128,255,128));
WiredHome	167:8aa3fb2a5a31	235	/// lcd.ellipse( 440,75, 35,20, BrightBlue);
WiredHome	167:8aa3fb2a5a31	236	/// lcd.fillellipse( 440,75, 25,10, Blue);
WiredHome	167:8aa3fb2a5a31	237	/// lcd.triangle( 440,100, 475,110, 450,125, Magenta);
WiredHome	167:8aa3fb2a5a31	238	/// lcd.filltriangle( 445,105, 467,111, 452,120, Cyan);
WiredHome	167:8aa3fb2a5a31	239	/// lcd.rect( 400,130, 475,155, Brown);
WiredHome	167:8aa3fb2a5a31	240	/// lcd.fillrect( 405,135, 470,150, Pink);
WiredHome	167:8aa3fb2a5a31	241	/// lcd.roundrect( 410,160, 475,190, 10,8, Yellow);
WiredHome	167:8aa3fb2a5a31	242	/// lcd.fillroundrect(415,165, 470,185, 5,3, Orange);
WiredHome	167:8aa3fb2a5a31	243	/// lcd.line( 430,200, 460,230, RGB(0,255,0));
WiredHome	190:3132b7dfad82	244	/// for (int i=0; i<=30; i+=5)
WiredHome	167:8aa3fb2a5a31	245	/// lcd.pixel(435+i,200+i, White);
WiredHome	167:8aa3fb2a5a31	246	/// }
WiredHome	167:8aa3fb2a5a31	247	/// @endcode
WiredHome	78:faf49c381591	248	///
WiredHome	182:8832d03a2a29	249
WiredHome	182:8832d03a2a29	250
WiredHome	167:8aa3fb2a5a31	251	/// @page Wiring_Diagram Example Wiring Diagram
WiredHome	167:8aa3fb2a5a31	252	///
WiredHome	190:3132b7dfad82	253	/// This library was crafted around the 4-Wire SPI interface. This was the chosen
WiredHome	190:3132b7dfad82	254	/// interface method in order to balance the requirements of the host micro IO with
WiredHome	167:8aa3fb2a5a31	255	/// the capability of this display. Alternatives include: 3-Wire SPI, I2C, 8-bit and
WiredHome	167:8aa3fb2a5a31	256	/// 16-bit parallel.
WiredHome	190:3132b7dfad82	257	///
WiredHome	190:3132b7dfad82	258	/// @section Schematic_Basic Basic Schematic
WiredHome	182:8832d03a2a29	259	///
WiredHome	182:8832d03a2a29	260	/// The basic schematic should be the most portable to any system that has SPI support.
WiredHome	190:3132b7dfad82	261	///
WiredHome	182:8832d03a2a29	262	/// @image html RA8875_display_schematic.png "Basic Display support"
WiredHome	182:8832d03a2a29	263	///
WiredHome	182:8832d03a2a29	264	/// @section Schematic_DisplayTouch Display with Capacitive Touch
WiredHome	182:8832d03a2a29	265	///
WiredHome	182:8832d03a2a29	266	/// A more advanced schematic - this with the I2C interface connecting to the Capacitive
WiredHome	182:8832d03a2a29	267	/// Touch controller. Note that this requires additional IO pins.
WiredHome	182:8832d03a2a29	268	///
WiredHome	182:8832d03a2a29	269	/// @image html RA8875_captouch_wiring.png "Display and Capacitive Touch support"
WiredHome	182:8832d03a2a29	270	///
WiredHome	182:8832d03a2a29	271	/// @section Schematic_DisplayTouchMicroSD Display with Capacitive Touch and micro SD
WiredHome	182:8832d03a2a29	272	///
WiredHome	190:3132b7dfad82	273	/// The most advanced schematic - taking advantage of the display, the capacitive touch
WiredHome	190:3132b7dfad82	274	/// controller, and the peripheral support for a micro SD card on some of the display
WiredHome	182:8832d03a2a29	275	/// modules.
WiredHome	182:8832d03a2a29	276	///
WiredHome	182:8832d03a2a29	277	/// @note There are online indications that the RA8875 has a defect in its SPI interface
WiredHome	182:8832d03a2a29	278	/// where it will not release the MISO pin. If this pin is shared with the micro SD
WiredHome	190:3132b7dfad82	279	/// port, then it could interfere with successful read/write of the files.
WiredHome	182:8832d03a2a29	280	/// The easiest solution is to put that interface on a separate SPI port.
WiredHome	182:8832d03a2a29	281	///
WiredHome	182:8832d03a2a29	282	/// @image html RA8875_display_full.png "Display, Touch, and micro SD support"
WiredHome	167:8aa3fb2a5a31	283	///
WiredHome	182:8832d03a2a29	284	/// @page External_Resources External Resources
WiredHome	182:8832d03a2a29	285	///
WiredHome	190:3132b7dfad82	286	/// There are many websites with information on the RA8875 Display. This partial list
WiredHome	182:8832d03a2a29	287	/// may be helpful:
WiredHome	182:8832d03a2a29	288	///
WiredHome	190:3132b7dfad82	289	/// * <a href="https://os.mbed.com/components/RA8875-Based-Display/">RA8875 Library</a>
WiredHome	182:8832d03a2a29	290	/// on the <a href="https://os.mbed.com/">mbed site</a><br/>
WiredHome	182:8832d03a2a29	291	/// This page has a lot of detail, schematices, sample programs, instructions to
WiredHome	182:8832d03a2a29	292	/// create your own fonts, and more...
WiredHome	182:8832d03a2a29	293	/// * <a href="https://os.mbed.com/search/?q=RA8875">RA8875 search on the mbed site</a><br/>
WiredHome	182:8832d03a2a29	294	/// Many more links, discussions, questions and answers, and more...
WiredHome	182:8832d03a2a29	295	/// * <a href="https://www.buydisplay.com/">Buy Display</a> site<br/>
WiredHome	182:8832d03a2a29	296	/// Where you can find many inexpensive displays, some with the RA8875 controller
WiredHome	182:8832d03a2a29	297	/// (which this library supports), and others using different controllers (thus not
WiredHome	182:8832d03a2a29	298	/// supported by this library).
WiredHome	182:8832d03a2a29	299	/// * <a href="https://github.com/sumotoy/RA8875/wiki/Fix-compatibility-with-other-SPI-devices">SPI Bug notes</a><br/>
WiredHome	182:8832d03a2a29	300	/// A link to a site that discusses a SPI bug on the RA8875. [I have not verified this
WiredHome	182:8832d03a2a29	301	/// bug]
WiredHome	182:8832d03a2a29	302	/// * <a href="https://www.google.com/search?safe=on&source=hp&ei=1oN1XP6hEsPq_AbZlKMw&q=RA8875">RA8875 - Google</a><br/>
WiredHome	182:8832d03a2a29	303	/// Because new things show up all the time.
WiredHome	182:8832d03a2a29	304	/// * <a href="https://www.bing.com/search?q=RA8875">RA8875 - Bing</a><br/>
WiredHome	182:8832d03a2a29	305	/// And you want to look in more than one place.
WiredHome	182:8832d03a2a29	306	///
WiredHome	182:8832d03a2a29	307	/// @image html RA8875_display_full.png "Example Wiring Diagram"
WiredHome	182:8832d03a2a29	308	///
WiredHome	182:8832d03a2a29	309
WiredHome	182:8832d03a2a29	310
WiredHome	167:8aa3fb2a5a31	311	/// @page Future_Plans Future Plans
WiredHome	167:8aa3fb2a5a31	312	///
WiredHome	167:8aa3fb2a5a31	313	/// Following are some notions of future plans. This does not mean they will all be
WiredHome	167:8aa3fb2a5a31	314	/// implemented, just consider them as things I'm thinking about. If you have a suggestion,
WiredHome	167:8aa3fb2a5a31	315	/// please send it to me.
WiredHome	167:8aa3fb2a5a31	316	///
WiredHome	167:8aa3fb2a5a31	317	/// - Change the return values for several functions. Most functions return @ref RA8875::RetCode_t,
WiredHome	167:8aa3fb2a5a31	318	/// but would benefit from returning a data type related to that function. For example,
WiredHome	167:8aa3fb2a5a31	319	/// @ref RA8875::SelectDrawingLayer() could return the current drawing layer even as a new
WiredHome	167:8aa3fb2a5a31	320	/// layer is defined. This can facilitate switching back and forth between configurations.
WiredHome	167:8aa3fb2a5a31	321	/// Examples:
WiredHome	167:8aa3fb2a5a31	322	/// - @ref RA8875::SelectDrawingLayer()
WiredHome	167:8aa3fb2a5a31	323	/// - @ref RA8875::SelectUserFont()
WiredHome	167:8aa3fb2a5a31	324	/// - @ref RA8875::SetBackgroundTransparencyColor()
WiredHome	167:8aa3fb2a5a31	325	/// - @ref RA8875::SetLayerMode()
WiredHome	167:8aa3fb2a5a31	326	/// - @ref RA8875::SetLayerTransparency()
WiredHome	167:8aa3fb2a5a31	327	/// - @ref RA8875::SetOrientation()
WiredHome	167:8aa3fb2a5a31	328	/// - @ref RA8875::SetTextCursor()
WiredHome	167:8aa3fb2a5a31	329	/// - @ref RA8875::SetTextCursorControl()
WiredHome	167:8aa3fb2a5a31	330	/// - @ref RA8875::SetTextFont()
WiredHome	167:8aa3fb2a5a31	331	/// - @ref RA8875::SetTextFontControl()
WiredHome	167:8aa3fb2a5a31	332	/// - @ref RA8875::SetTextFontSize()
WiredHome	167:8aa3fb2a5a31	333	/// - @ref RA8875::background()
WiredHome	167:8aa3fb2a5a31	334	/// - @ref RA8875::foreground()
WiredHome	167:8aa3fb2a5a31	335	/// - @ref RA8875::Backlight()
WiredHome	167:8aa3fb2a5a31	336	/// - @ref RA8875::window()
WiredHome	167:8aa3fb2a5a31	337	/// - @ref RA8875::WindowMax()
WiredHome	167:8aa3fb2a5a31	338	///
WiredHome	190:3132b7dfad82	339	/// - Change the title-case of the functions to be consistent. Because this was adapted
WiredHome	167:8aa3fb2a5a31	340	/// from parts of several different libraries, it isn't very consistently titled.
WiredHome	167:8aa3fb2a5a31	341	///
WiredHome	190:3132b7dfad82	342	/// - Change names of some of the functions to be more consistent. Why are some Set*
WiredHome	167:8aa3fb2a5a31	343	/// and others are Select*. The layer commands SetDrawingLayer and GetDrawingLayer do
WiredHome	167:8aa3fb2a5a31	344	/// not need 'Drawing' in them.
WiredHome	167:8aa3fb2a5a31	345	///
WiredHome	190:3132b7dfad82	346	/// - Improve the PrintScreen method. There are two functions - one that accepts a filename,
WiredHome	167:8aa3fb2a5a31	347	/// and a second more experimental version that could pipe the image stream back to
WiredHome	167:8aa3fb2a5a31	348	/// a calling process. This could be used, for example, to send the image over a
WiredHome	167:8aa3fb2a5a31	349	/// network interface. The intended side effect is that there is then only a single
WiredHome	167:8aa3fb2a5a31	350	/// PrintScreen method with either an internal helper (for file system access) or
WiredHome	167:8aa3fb2a5a31	351	/// a callback for the user handled process.
WiredHome	101:e0aad446094a	352	///
WiredHome	182:8832d03a2a29	353	/// - Add support for the hardware reset pin
WiredHome	182:8832d03a2a29	354	///
WiredHome	190:3132b7dfad82	355	/// - Figure out how to "init()" in the constructor when it is not in main(). I ran into
WiredHome	190:3132b7dfad82	356	/// some issues if the display was instantiated before main(), and the code would not
WiredHome	190:3132b7dfad82	357	/// run, thus the exposure and activation of the init() function. If the instantiation
WiredHome	190:3132b7dfad82	358	/// is within main(), then it seemed to work as expected.
WiredHome	182:8832d03a2a29	359	///
WiredHome	190:3132b7dfad82	360	/// - Add Scroll support for text.
WiredHome	182:8832d03a2a29	361	///
WiredHome	190:3132b7dfad82	362	/// - Add high level objects - x-y graph, meter, buttons, ... but these will probably be
WiredHome	182:8832d03a2a29	363	/// best served in another class, since they may not be needed for many uses.
WiredHome	182:8832d03a2a29	364	///
WiredHome	19:3f82c1161fd2	365	#ifndef RA8875_H
WiredHome	19:3f82c1161fd2	366	#define RA8875_H
WiredHome	19:3f82c1161fd2	367	#include <mbed.h>
WiredHome	19:3f82c1161fd2	368
WiredHome	77:9206c13aa527	369	#include "RA8875_Regs.h"
WiredHome	165:695c24cc5197	370	#include "RA8875_Touch_FT5206.h"
WiredHome	165:695c24cc5197	371	#include "RA8875_Touch_GSL1680.h"
WiredHome	19:3f82c1161fd2	372	#include "GraphicsDisplay.h"
WiredHome	19:3f82c1161fd2	373
WiredHome	41:2956a0a221e5	374	#define RA8875_DEFAULT_SPI_FREQ 5000000
WiredHome	19:3f82c1161fd2	375
WiredHome	156:4bdb2772128d	376	#ifndef MBED_ENCODE_VERSION
WiredHome	181:0032d1b8f5d4	377	#define MBED_MAJOR_VERSION 2
WiredHome	181:0032d1b8f5d4	378	#define MBED_MINOR_VERSION 0
WiredHome	181:0032d1b8f5d4	379	#define MBED_PATCH_VERSION MBED_LIBRARY_VERSION
WiredHome	156:4bdb2772128d	380	#define MBED_ENCODE_VERSION(major, minor, patch) ((major)10000 + (minor)100 + (patch))
WiredHome	156:4bdb2772128d	381	#endif
WiredHome	156:4bdb2772128d	382
WiredHome	19:3f82c1161fd2	383	// Define this to enable code that monitors the performance of various
WiredHome	19:3f82c1161fd2	384	// graphics commands.
WiredHome	78:faf49c381591	385	//#define PERF_METRICS
WiredHome	19:3f82c1161fd2	386
WiredHome	23:a50ded45dbaf	387	// What better place for some test code than in here and the companion
WiredHome	23:a50ded45dbaf	388	// .cpp file. See also the bottom of this file.
WiredHome	99:66edf771373a	389	//#define TESTENABLE
WiredHome	19:3f82c1161fd2	390
WiredHome	167:8aa3fb2a5a31	391	/// @page PredefinedColors Predefined Colors
WiredHome	167:8aa3fb2a5a31	392	///
WiredHome	167:8aa3fb2a5a31	393	/// Keep in mind that the color scheme shown here is unlikely to precisely match
WiredHome	190:3132b7dfad82	394	/// that on the actual display. The perceived color is additional affected by
WiredHome	167:8aa3fb2a5a31	395	/// other attributes, such as the backlight brightness.
WiredHome	167:8aa3fb2a5a31	396	///
WiredHome	190:3132b7dfad82	397	/// These are the predefined colors that are typically used where any @ref color_t
WiredHome	167:8aa3fb2a5a31	398	/// variable is applied.
WiredHome	167:8aa3fb2a5a31	399	///
WiredHome	167:8aa3fb2a5a31	400	/// <blockquote>
WiredHome	167:8aa3fb2a5a31	401	/// <table>
WiredHome	167:8aa3fb2a5a31	402	/// <tr>
WiredHome	167:8aa3fb2a5a31	403	/// <td bgcolor='#000000'> </td><td>@ref Black</td>
WiredHome	167:8aa3fb2a5a31	404	/// <td bgcolor='#0000BB'> </td><td>@ref Blue</td>
WiredHome	167:8aa3fb2a5a31	405	/// <td bgcolor='#00BB00'> </td><td>@ref Green</td>
WiredHome	167:8aa3fb2a5a31	406	/// <td bgcolor='#00BBBB'> </td><td>@ref Cyan</td>
WiredHome	167:8aa3fb2a5a31	407	/// </tr>
WiredHome	167:8aa3fb2a5a31	408	/// <tr>
WiredHome	167:8aa3fb2a5a31	409	/// <td bgcolor='#BB0000'> </td><td>@ref Red</td>
WiredHome	167:8aa3fb2a5a31	410	/// <td bgcolor='#BB00BB'> </td><td>@ref Magenta</td>
WiredHome	167:8aa3fb2a5a31	411	/// <td bgcolor='#3F3F3F'> </td><td>@ref Brown</td>
WiredHome	167:8aa3fb2a5a31	412	/// <td bgcolor='#BBBBBB'> </td><td>@ref Gray</td>
WiredHome	167:8aa3fb2a5a31	413	/// </tr>
WiredHome	167:8aa3fb2a5a31	414	/// <tr>
WiredHome	167:8aa3fb2a5a31	415	/// <td bgcolor='#555555'> </td><td>@ref Charcoal</td>
WiredHome	167:8aa3fb2a5a31	416	/// <td bgcolor='#0000FF'> </td><td>@ref BrightBlue</td>
WiredHome	167:8aa3fb2a5a31	417	/// <td bgcolor='#00FF00'> </td><td>@ref BrightGreen</td>
WiredHome	167:8aa3fb2a5a31	418	/// <td bgcolor='#00FFFF'> </td><td>@ref BrightCyan</td>
WiredHome	167:8aa3fb2a5a31	419	/// </tr>
WiredHome	167:8aa3fb2a5a31	420	/// <tr>
WiredHome	167:8aa3fb2a5a31	421	/// <td bgcolor='#FF5555'> </td><td>@ref Orange</td>
WiredHome	167:8aa3fb2a5a31	422	/// <td bgcolor='#FF55FF'> </td><td>@ref Pink</td>
WiredHome	167:8aa3fb2a5a31	423	/// <td bgcolor='#BBBB00'> </td><td>@ref Yellow</td>
WiredHome	167:8aa3fb2a5a31	424	/// <td bgcolor='#FFFFFF'> </td><td>@ref White</td>
WiredHome	167:8aa3fb2a5a31	425	/// </tr>
WiredHome	167:8aa3fb2a5a31	426	/// <tr>
WiredHome	167:8aa3fb2a5a31	427	/// <td bgcolor='#00003F'> </td><td>@ref DarkBlue </td>
WiredHome	167:8aa3fb2a5a31	428	/// <td bgcolor='#003F00'> </td><td>@ref DarkGreen</td>
WiredHome	167:8aa3fb2a5a31	429	/// <td bgcolor='#003F3F'> </td><td>@ref DarkCyan </td>
WiredHome	167:8aa3fb2a5a31	430	/// <td bgcolor='#3F0000'> </td><td>@ref DarkRed </td>
WiredHome	167:8aa3fb2a5a31	431	/// </tr>
WiredHome	167:8aa3fb2a5a31	432	/// <tr>
WiredHome	167:8aa3fb2a5a31	433	/// <td bgcolor='#3F003F'> </td><td>@ref DarkMagenta</td>
WiredHome	167:8aa3fb2a5a31	434	/// <td bgcolor='#3F3F00'> </td><td>@ref DarkBrown </td>
WiredHome	167:8aa3fb2a5a31	435	/// <td bgcolor='#3F3F3F'> </td><td>@ref DarkGray </td>
WiredHome	167:8aa3fb2a5a31	436	/// <td bgcolor='#FFFFFF'> </td><td> </td>
WiredHome	167:8aa3fb2a5a31	437	/// </tr>
WiredHome	167:8aa3fb2a5a31	438	/// </table>
WiredHome	167:8aa3fb2a5a31	439	/// </blockquote>
WiredHome	167:8aa3fb2a5a31	440	///
WiredHome	167:8aa3fb2a5a31	441
WiredHome	185:cb7591a43f44	442	#define Black (color_t)(RGB(0,0,0))
WiredHome	185:cb7591a43f44	443	#define Blue (color_t)(RGB(0,0,187))
WiredHome	185:cb7591a43f44	444	#define Green (color_t)(RGB(0,187,0))
WiredHome	185:cb7591a43f44	445	#define Cyan (color_t)(RGB(0,187,187))
WiredHome	185:cb7591a43f44	446	#define Red (color_t)(RGB(187,0,0))
WiredHome	185:cb7591a43f44	447	#define Magenta (color_t)(RGB(187,0,187))
WiredHome	185:cb7591a43f44	448	#define Brown (color_t)(RGB(63,63,0))
WiredHome	185:cb7591a43f44	449	#define Gray (color_t)(RGB(187,187,187))
WiredHome	185:cb7591a43f44	450	#define Charcoal (color_t)(RGB(85,85,85))
WiredHome	185:cb7591a43f44	451	#define BrightBlue (color_t)(RGB(0,0,255))
WiredHome	185:cb7591a43f44	452	#define BrightGreen (color_t)(RGB(0,255,0))
WiredHome	185:cb7591a43f44	453	#define BrightCyan (color_t)(RGB(0,255,255))
WiredHome	185:cb7591a43f44	454	#define BrightRed (color_t)(RGB(255,0,0))
WiredHome	185:cb7591a43f44	455	#define Orange (color_t)(RGB(255,85,85))
WiredHome	185:cb7591a43f44	456	#define Pink (color_t)(RGB(255,85,255))
WiredHome	185:cb7591a43f44	457	#define Yellow (color_t)(RGB(187,187,0))
WiredHome	186:910fc2335c45	458	#define BrightYellow (color_t)(RGB(255,255,0))
WiredHome	185:cb7591a43f44	459	#define White (color_t)(RGB(255,255,255))
WiredHome	20:6e2e4a8372eb	460
WiredHome	185:cb7591a43f44	461	#define DarkBlue (color_t)(RGB(0,0,63))
WiredHome	185:cb7591a43f44	462	#define DarkGreen (color_t)(RGB(0,63,0))
WiredHome	185:cb7591a43f44	463	#define DarkCyan (color_t)(RGB(0,63,63))
WiredHome	185:cb7591a43f44	464	#define DarkRed (color_t)(RGB(63,0,0))
WiredHome	185:cb7591a43f44	465	#define DarkMagenta (color_t)(RGB(63,0,63))
WiredHome	185:cb7591a43f44	466	#define DarkBrown (color_t)(RGB(63,63,0))
WiredHome	185:cb7591a43f44	467	#define DarkGray (color_t)(RGB(63,63,63))
WiredHome	61:8f3153bf0baa	468
WiredHome	82:f7d300f26540	469	#define min(a,b) ((a<b)?a:b)
WiredHome	82:f7d300f26540	470	#define max(a,b) ((a>b)?a:b)
WiredHome	82:f7d300f26540	471
WiredHome	19:3f82c1161fd2	472
WiredHome	19:3f82c1161fd2	473	//namespace SW_graphics
WiredHome	19:3f82c1161fd2	474	//{
WiredHome	19:3f82c1161fd2	475
WiredHome	96:40b74dd3695b	476	class FPointerDummy; // used by the callback methods.
WiredHome	24:8ca861acf12d	477
WiredHome	21:3c1efb192927	478	/// This is a graphics library for the Raio RA8875 Display Controller chip
WiredHome	21:3c1efb192927	479	/// attached to a 4-wire SPI interface.
WiredHome	21:3c1efb192927	480	///
WiredHome	56:7a85d226ad0d	481	/// It offers both primitive and high level APIs.
WiredHome	56:7a85d226ad0d	482	///
WiredHome	21:3c1efb192927	483	/// Central to this API is a coordinate system, where the origin (0,0) is in
WiredHome	56:7a85d226ad0d	484	/// the top-left corner of the display, and the width (x) extends positive to the
WiredHome	56:7a85d226ad0d	485	/// right and the height (y) extends positive toward the bottom.
WiredHome	21:3c1efb192927	486	///
WiredHome	125:7a0b70f56550	487	/// @note As there are both graphics and text commands, one must take care to use
WiredHome	21:3c1efb192927	488	/// the proper coordinate system for each. Some of the text APIs are in units
WiredHome	29:422616aa04bd	489	/// of column and row, which is measured in character positions (and dependent
WiredHome	56:7a85d226ad0d	490	/// on the font size), where other text APIs permit pixel level positioning.
WiredHome	56:7a85d226ad0d	491	///
WiredHome	56:7a85d226ad0d	492	/// @code
WiredHome	56:7a85d226ad0d	493	/// #include "RA8875.h"
WiredHome	56:7a85d226ad0d	494	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	56:7a85d226ad0d	495	///
WiredHome	56:7a85d226ad0d	496	/// int main()
WiredHome	56:7a85d226ad0d	497	/// {
WiredHome	81:01da2e34283d	498	/// lcd.init();
WiredHome	56:7a85d226ad0d	499	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	56:7a85d226ad0d	500	/// lcd.circle( 400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	501	/// lcd.fillcircle( 400,25, 15, RGB(128,255,128));
WiredHome	56:7a85d226ad0d	502	/// lcd.ellipse( 440,75, 35,20, BrightBlue);
WiredHome	56:7a85d226ad0d	503	/// lcd.fillellipse( 440,75, 25,10, Blue);
WiredHome	56:7a85d226ad0d	504	/// lcd.triangle( 440,100, 475,110, 450,125, Magenta);
WiredHome	56:7a85d226ad0d	505	/// lcd.filltriangle( 445,105, 467,111, 452,120, Cyan);
WiredHome	56:7a85d226ad0d	506	/// lcd.rect( 400,130, 475,155, Brown);
WiredHome	56:7a85d226ad0d	507	/// lcd.fillrect( 405,135, 470,150, Pink);
WiredHome	56:7a85d226ad0d	508	/// lcd.roundrect( 410,160, 475,190, 10,8, Yellow);
WiredHome	56:7a85d226ad0d	509	/// lcd.fillroundrect(415,165, 470,185, 5,3, Orange);
WiredHome	56:7a85d226ad0d	510	/// lcd.line( 430,200, 460,230, RGB(0,255,0));
WiredHome	190:3132b7dfad82	511	/// for (int i=0; i<=30; i+=5)
WiredHome	56:7a85d226ad0d	512	/// lcd.pixel(435+i,200+i, White);
WiredHome	56:7a85d226ad0d	513	/// }
WiredHome	56:7a85d226ad0d	514	/// @endcode
WiredHome	29:422616aa04bd	515	///
WiredHome	19:3f82c1161fd2	516	class RA8875 : public GraphicsDisplay
WiredHome	19:3f82c1161fd2	517	{
WiredHome	190:3132b7dfad82	518	public:
WiredHome	190:3132b7dfad82	519	/// Vertical alignment attribute. Used to align one rect against another.
WiredHome	190:3132b7dfad82	520	/// @ref AlignRectInRect
WiredHome	190:3132b7dfad82	521	typedef enum {
WiredHome	190:3132b7dfad82	522	top, ///< vertically align to the top
WiredHome	190:3132b7dfad82	523	middle, ///< vertically align to the middle
WiredHome	190:3132b7dfad82	524	bottom ///< vertically align to the bottom
WiredHome	190:3132b7dfad82	525	} valign_t;
WiredHome	190:3132b7dfad82	526
WiredHome	190:3132b7dfad82	527	/// Horizontal alignment attribute. Used to align one rect against another.
WiredHome	190:3132b7dfad82	528	/// @ref AlignRectInRect
WiredHome	190:3132b7dfad82	529	typedef enum {
WiredHome	190:3132b7dfad82	530	left, ///< horizontally align to the left
WiredHome	190:3132b7dfad82	531	center, ///< horizontally align to the center
WiredHome	190:3132b7dfad82	532	right ///< horizontally align to the right
WiredHome	190:3132b7dfad82	533	} halign_t;
WiredHome	190:3132b7dfad82	534
WiredHome	167:8aa3fb2a5a31	535	/// cursor type argument for @ref SetTextCursorControl()
WiredHome	53:86d24b9480b9	536	typedef enum
WiredHome	53:86d24b9480b9	537	{
WiredHome	53:86d24b9480b9	538	NOCURSOR, ///< cursor is hidden
WiredHome	167:8aa3fb2a5a31	539	IBEAM, ///< I Beam '\|' cursor
WiredHome	167:8aa3fb2a5a31	540	UNDER, ///< Underscore '_' cursor
WiredHome	53:86d24b9480b9	541	BLOCK ///< Block cursor
WiredHome	53:86d24b9480b9	542	} cursor_t;
WiredHome	53:86d24b9480b9	543
WiredHome	167:8aa3fb2a5a31	544	/// font type selection argument for @ref SetTextFont()
WiredHome	19:3f82c1161fd2	545	typedef enum
WiredHome	19:3f82c1161fd2	546	{
WiredHome	31:c72e12cd5c67	547	ISO8859_1, ///< ISO8859-1 font
WiredHome	31:c72e12cd5c67	548	ISO8859_2, ///< ISO8859-2 font
WiredHome	31:c72e12cd5c67	549	ISO8859_3, ///< ISO8859-3 font
WiredHome	31:c72e12cd5c67	550	ISO8859_4 ///< ISO8859-4 font
WiredHome	19:3f82c1161fd2	551	} font_t;
WiredHome	190:3132b7dfad82	552
WiredHome	167:8aa3fb2a5a31	553	/// display orientation argument for @ref SetOrientation()
WiredHome	167:8aa3fb2a5a31	554	/// with landscape mode as the normal (0 degree) orientation.
WiredHome	19:3f82c1161fd2	555	typedef enum
WiredHome	19:3f82c1161fd2	556	{
WiredHome	84:e102021864b5	557	normal, ///< normal (landscape) orientation
WiredHome	84:e102021864b5	558	rotate_0 = normal, ///< alternate to 'normal'
WiredHome	84:e102021864b5	559	rotate_90, ///< rotated clockwise 90 degree
WiredHome	84:e102021864b5	560	rotate_180, ///< rotated (clockwise) 180 degree
WiredHome	84:e102021864b5	561	rotate_270, ///< rotated clockwise 270 degree
WiredHome	84:e102021864b5	562	} orientation_t;
WiredHome	190:3132b7dfad82	563
WiredHome	167:8aa3fb2a5a31	564	/// alignment control argument for @ref SetTextFontControl()
WiredHome	19:3f82c1161fd2	565	typedef enum
WiredHome	19:3f82c1161fd2	566	{
WiredHome	31:c72e12cd5c67	567	align_none, ///< align - none
WiredHome	31:c72e12cd5c67	568	align_full ///< align - full
WiredHome	190:3132b7dfad82	569	} alignment_t;
WiredHome	190:3132b7dfad82	570
WiredHome	167:8aa3fb2a5a31	571	/// Font Horizontal Scale factor - 1, 2, 3 4 for @ref SetTextFontSize(), @ref GetTextFontSize()
WiredHome	40:04aa280dfa39	572	typedef int HorizontalScale;
WiredHome	190:3132b7dfad82	573
WiredHome	167:8aa3fb2a5a31	574	/// Font Vertical Scale factor - 1, 2, 3, 4 for @ref SetTextFontSize(), @ref GetTextFontSize()
WiredHome	40:04aa280dfa39	575	typedef int VerticalScale;
WiredHome	19:3f82c1161fd2	576
WiredHome	167:8aa3fb2a5a31	577	/// Clear screen region option for @ref clsw()
WiredHome	19:3f82c1161fd2	578	typedef enum
WiredHome	19:3f82c1161fd2	579	{
WiredHome	31:c72e12cd5c67	580	FULLWINDOW, ///< Full screen
WiredHome	31:c72e12cd5c67	581	ACTIVEWINDOW ///< active window/region
WiredHome	19:3f82c1161fd2	582	} Region_t;
WiredHome	167:8aa3fb2a5a31	583
WiredHome	167:8aa3fb2a5a31	584	/// Layer Display Mode argument for @ref SetLayerMode, @ref GetLayerMode
WiredHome	53:86d24b9480b9	585	typedef enum
WiredHome	53:86d24b9480b9	586	{
WiredHome	61:8f3153bf0baa	587	ShowLayer0, ///< Only layer 0 is visible, layer 1 is hidden (default)
WiredHome	56:7a85d226ad0d	588	ShowLayer1, ///< Only layer 1 is visible, layer 0 is hidden
WiredHome	53:86d24b9480b9	589	LightenOverlay, ///< Lighten-overlay mode
WiredHome	53:86d24b9480b9	590	TransparentMode, ///< Transparent mode
WiredHome	53:86d24b9480b9	591	BooleanOR, ///< Boolean OR mode
WiredHome	53:86d24b9480b9	592	BooleanAND, ///< Boolean AND mode
WiredHome	53:86d24b9480b9	593	FloatingWindow ///< Floating Window mode
WiredHome	53:86d24b9480b9	594	} LayerMode_T;
WiredHome	190:3132b7dfad82	595
hexley	54:e117ad10fba6	596	/// Touch Panel modes
hexley	54:e117ad10fba6	597	typedef enum
hexley	54:e117ad10fba6	598	{
hexley	54:e117ad10fba6	599	TP_Auto, ///< Auto touch detection mode
hexley	54:e117ad10fba6	600	TP_Manual, ///< Manual touch detection mode
hexley	54:e117ad10fba6	601	} tpmode_t;
WiredHome	96:40b74dd3695b	602
WiredHome	167:8aa3fb2a5a31	603	/// PrintScreen callback commands for the user code @ref PrintCallback_T()
WiredHome	96:40b74dd3695b	604	typedef enum
WiredHome	96:40b74dd3695b	605	{
WiredHome	96:40b74dd3695b	606	OPEN, ///< command to open the file. cast uint32_t * to the buffer to get the total size to be written.
WiredHome	96:40b74dd3695b	607	WRITE, ///< command to write some data, buffer points to the data and the size is in bytes.
WiredHome	96:40b74dd3695b	608	CLOSE, ///< command to close the file
WiredHome	96:40b74dd3695b	609	} filecmd_t;
WiredHome	96:40b74dd3695b	610
WiredHome	96:40b74dd3695b	611	/// print screen callback
WiredHome	96:40b74dd3695b	612	///
WiredHome	190:3132b7dfad82	613	/// The special form of the print screen will pass one blob at a time
WiredHome	149:c62c4b2d6a15	614	/// to the callback. There are basic commands declaring that the stream
WiredHome	96:40b74dd3695b	615	/// can be opened, a block written, and the stream closed. There is
WiredHome	96:40b74dd3695b	616	/// also a command to communicate the total size being delivered.
WiredHome	96:40b74dd3695b	617	///
WiredHome	149:c62c4b2d6a15	618	/// If the idle callback is registered, it will be activated passing
WiredHome	149:c62c4b2d6a15	619	/// a parameter indicating the percent complete, which may be of value.
WiredHome	149:c62c4b2d6a15	620	///
WiredHome	96:40b74dd3695b	621	/// @code
WiredHome	96:40b74dd3695b	622	/// lcd.PrintScreen(x,y,w,h,callback);
WiredHome	190:3132b7dfad82	623	/// ...
WiredHome	96:40b74dd3695b	624	/// void callback(filecmd_t cmd, uint8_t * buffer, uint16_t size) {
WiredHome	96:40b74dd3695b	625	/// switch(cmd) {
WiredHome	96:40b74dd3695b	626	/// case OPEN:
WiredHome	96:40b74dd3695b	627	/// pc.printf("About to write %u bytes\r\n", (uint32_t )buffer);
WiredHome	96:40b74dd3695b	628	/// fh = fopen("file.bmp", "w+b");
WiredHome	96:40b74dd3695b	629	/// break;
WiredHome	96:40b74dd3695b	630	/// case WRITE:
WiredHome	96:40b74dd3695b	631	/// fwrite(buffer, size, fh);
WiredHome	96:40b74dd3695b	632	/// break;
WiredHome	96:40b74dd3695b	633	/// case CLOSE:
WiredHome	96:40b74dd3695b	634	/// fclose(fh);
WiredHome	96:40b74dd3695b	635	/// break;
WiredHome	96:40b74dd3695b	636	/// default:
WiredHome	96:40b74dd3695b	637	/// pc.printf("Unexpected callback %d\r\n", cmd);
WiredHome	96:40b74dd3695b	638	/// break;
WiredHome	96:40b74dd3695b	639	/// }
WiredHome	96:40b74dd3695b	640	/// }
WiredHome	96:40b74dd3695b	641	/// @endcode
WiredHome	96:40b74dd3695b	642	///
WiredHome	106:c80828f5dea4	643	/// @param cmd is the command to execute. See @ref filecmd_t.
WiredHome	96:40b74dd3695b	644	/// @param buffer is a pointer to the buffer being passed.
WiredHome	96:40b74dd3695b	645	/// @param size is the number of bytes in the buffer.
WiredHome	167:8aa3fb2a5a31	646	/// @returns @ref RetCode_t value.
WiredHome	96:40b74dd3695b	647	///
WiredHome	96:40b74dd3695b	648	typedef RetCode_t (* PrintCallback_T)(filecmd_t cmd, uint8_t * buffer, uint16_t size);
WiredHome	190:3132b7dfad82	649
WiredHome	167:8aa3fb2a5a31	650	/// Idle reason provided in the Idle Callback @ref IdleCallback_T()
WiredHome	123:2f45e80fec5f	651	typedef enum {
WiredHome	123:2f45e80fec5f	652	unknown, ///< reason has not been assigned (this should not happen)
WiredHome	123:2f45e80fec5f	653	status_wait, ///< driver is polling the status register while busy
WiredHome	123:2f45e80fec5f	654	command_wait, ///< driver is polling the command register while busy
WiredHome	123:2f45e80fec5f	655	getc_wait, ///< user has called the getc function
WiredHome	123:2f45e80fec5f	656	touch_wait, ///< user has called the touch function
WiredHome	149:c62c4b2d6a15	657	touchcal_wait, ///< driver is performing a touch calibration
WiredHome	149:c62c4b2d6a15	658	progress, ///< communicates progress
WiredHome	123:2f45e80fec5f	659	} IdleReason_T;
WiredHome	190:3132b7dfad82	660
WiredHome	190:3132b7dfad82	661	/// Idle Callback
WiredHome	190:3132b7dfad82	662	///
WiredHome	190:3132b7dfad82	663	/// This defines the interface for an idle callback. That is, when the
WiredHome	125:7a0b70f56550	664	/// driver is held up, pending some event, it can call a previously registered
WiredHome	123:2f45e80fec5f	665	/// idle function. This could be most useful for servicing a watchdog.
WiredHome	123:2f45e80fec5f	666	///
WiredHome	123:2f45e80fec5f	667	/// The user code, which is notified via this API, can force the idle
WiredHome	123:2f45e80fec5f	668	/// to abort, by returning the external_abort value back to the driver.
WiredHome	125:7a0b70f56550	669	/// It is important to note that the abort could leave the driver in
WiredHome	125:7a0b70f56550	670	/// an undesireable state, so this should be used with care.
WiredHome	125:7a0b70f56550	671	///
WiredHome	125:7a0b70f56550	672	/// @note Should it be called the BusyCallback? It is true, that it will
WiredHome	125:7a0b70f56550	673	/// call this function when the RA8875 is busy, but this is also
WiredHome	125:7a0b70f56550	674	/// when the CPU is largely idle.
WiredHome	125:7a0b70f56550	675	///
WiredHome	125:7a0b70f56550	676	/// @code
WiredHome	149:c62c4b2d6a15	677	/// RetCode_t myIdle_handler(RA8875::IdleReason_T reason, uint16_t param)
WiredHome	125:7a0b70f56550	678	/// {
WiredHome	125:7a0b70f56550	679	/// idleFlasher = !idleFlasher;
WiredHome	125:7a0b70f56550	680	/// if (it_has_been_too_long())
WiredHome	125:7a0b70f56550	681	/// return external_abort;
WiredHome	125:7a0b70f56550	682	/// else
WiredHome	125:7a0b70f56550	683	/// return noerror;
WiredHome	125:7a0b70f56550	684	/// }
WiredHome	125:7a0b70f56550	685	/// @endcode
WiredHome	125:7a0b70f56550	686	///
WiredHome	125:7a0b70f56550	687	/// @param reason informs the callback why it is idle.
WiredHome	149:c62c4b2d6a15	688	/// @param param is a 2nd parameter, which is used for certain reason codes
WiredHome	149:c62c4b2d6a15	689	/// for 'progress' reason code, param ranges from 0 to 100 (percent)
WiredHome	167:8aa3fb2a5a31	690	/// @returns @ref RetCode_t value.
WiredHome	123:2f45e80fec5f	691	///
WiredHome	190:3132b7dfad82	692	typedef RetCode_t (* IdleCallback_T)(IdleReason_T reason, uint16_t param);
WiredHome	190:3132b7dfad82	693
WiredHome	190:3132b7dfad82	694	/// Basic constructor for a display based on the RAiO RA8875
WiredHome	125:7a0b70f56550	695	/// display controller, which can be used with no touchscreen,
WiredHome	125:7a0b70f56550	696	/// or the RA8875 managed resistive touchscreen.
WiredHome	124:1690a7ae871c	697	///
WiredHome	124:1690a7ae871c	698	/// This constructor differs from the alternate by supportting
WiredHome	124:1690a7ae871c	699	/// either No Touch Screen, or the RA8875 built-in resistive
WiredHome	125:7a0b70f56550	700	/// touch screen. If the application requires the use of the
WiredHome	190:3132b7dfad82	701	/// capacitive touchscreen, the alternate constructor must
WiredHome	125:7a0b70f56550	702	/// be used.
WiredHome	19:3f82c1161fd2	703	///
WiredHome	61:8f3153bf0baa	704	/// This configures the registers and calls the @ref init method.
WiredHome	61:8f3153bf0baa	705	///
WiredHome	56:7a85d226ad0d	706	/// @code
WiredHome	56:7a85d226ad0d	707	/// #include "RA8875.h"
WiredHome	56:7a85d226ad0d	708	/// RA8875 lcd(p5, p6, p7, p12, NC, "tft");
WiredHome	56:7a85d226ad0d	709	///
WiredHome	56:7a85d226ad0d	710	/// int main()
WiredHome	56:7a85d226ad0d	711	/// {
WiredHome	157:1565f38ca44b	712	/// lcd.init(); // defaults for 480x272x16 at low brightness
WiredHome	56:7a85d226ad0d	713	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	56:7a85d226ad0d	714	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	715	/// }
WiredHome	56:7a85d226ad0d	716	/// @endcode
WiredHome	56:7a85d226ad0d	717	///
WiredHome	72:ecffe56af969	718	/// @param[in] mosi is the SPI master out slave in pin on the mbed.
WiredHome	72:ecffe56af969	719	/// @param[in] miso is the SPI master in slave out pin on the mbed.
WiredHome	72:ecffe56af969	720	/// @param[in] sclk is the SPI shift clock pin on the mbed.
WiredHome	72:ecffe56af969	721	/// @param[in] csel is the DigitalOut pin on the mbed to use as the
WiredHome	19:3f82c1161fd2	722	/// active low chip select for the display controller.
WiredHome	190:3132b7dfad82	723	/// @param[in] reset is the DigitalOut pin on the mbed to use as the
WiredHome	190:3132b7dfad82	724	/// active low reset input on the display controller -
WiredHome	19:3f82c1161fd2	725	/// but this is not currently used.
WiredHome	72:ecffe56af969	726	/// @param[in] name is a text name for this object, which will permit
WiredHome	72:ecffe56af969	727	/// capturing stdout to puts() and printf() directly to it.
WiredHome	19:3f82c1161fd2	728	///
WiredHome	190:3132b7dfad82	729	RA8875(PinName mosi, PinName miso, PinName sclk, PinName csel, PinName reset,
WiredHome	124:1690a7ae871c	730	const char * name = "lcd");
WiredHome	190:3132b7dfad82	731
WiredHome	190:3132b7dfad82	732
WiredHome	190:3132b7dfad82	733	/// Constructor for a display based on the RAiO RA8875 display controller
WiredHome	165:695c24cc5197	734	/// (using the FT5206 Capacitive TouchScreen Controller)
WiredHome	124:1690a7ae871c	735	///
WiredHome	125:7a0b70f56550	736	/// @code
WiredHome	125:7a0b70f56550	737	/// #include "RA8875.h"
WiredHome	197:853d08e2fb53	738	/// RA8875 lcd(p5,p6,p7,p12,NC, p9,p10,p13, "tft");
WiredHome	190:3132b7dfad82	739	///
WiredHome	125:7a0b70f56550	740	/// int main()
WiredHome	125:7a0b70f56550	741	/// {
WiredHome	125:7a0b70f56550	742	/// lcd.init();
WiredHome	125:7a0b70f56550	743	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	125:7a0b70f56550	744	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	125:7a0b70f56550	745	/// TouchCode_t tp = lcd.TouchPanelReadable();
WiredHome	125:7a0b70f56550	746	/// if (tp == touch)
WiredHome	125:7a0b70f56550	747	/// ...
WiredHome	125:7a0b70f56550	748	/// }
WiredHome	125:7a0b70f56550	749	/// @endcode
WiredHome	125:7a0b70f56550	750	///
WiredHome	124:1690a7ae871c	751	/// @param[in] mosi is the SPI master out slave in pin on the mbed.
WiredHome	124:1690a7ae871c	752	/// @param[in] miso is the SPI master in slave out pin on the mbed.
WiredHome	124:1690a7ae871c	753	/// @param[in] sclk is the SPI shift clock pin on the mbed.
WiredHome	124:1690a7ae871c	754	/// @param[in] csel is the DigitalOut pin on the mbed to use as the
WiredHome	124:1690a7ae871c	755	/// active low chip select for the display controller.
WiredHome	190:3132b7dfad82	756	/// @param[in] reset is the DigitalOut pin on the mbed to use as the
WiredHome	190:3132b7dfad82	757	/// active low reset input on the display controller -
WiredHome	124:1690a7ae871c	758	/// but this is not currently used.
WiredHome	124:1690a7ae871c	759	/// @param[in] sda is the I2C Serial Data pin you are wiring to the FT5206.
WiredHome	124:1690a7ae871c	760	/// @param[in] scl is the I2C Serial Clock pin you are wiring to the FT5206.
WiredHome	124:1690a7ae871c	761	/// @param[in] irq is the Interrupt Request pin you are wiring to the FT5206.
WiredHome	124:1690a7ae871c	762	/// @param[in] name is a text name for this object, which will permit
WiredHome	124:1690a7ae871c	763	/// capturing stdout to puts() and printf() directly to it.
WiredHome	124:1690a7ae871c	764	///
WiredHome	190:3132b7dfad82	765	RA8875(PinName mosi, PinName miso, PinName sclk, PinName csel, PinName reset,
WiredHome	124:1690a7ae871c	766	PinName sda, PinName scl, PinName irq, const char * name = "lcd");
WiredHome	190:3132b7dfad82	767
WiredHome	190:3132b7dfad82	768
WiredHome	190:3132b7dfad82	769	/// Constructor for a display based on the RAiO RA8875 display controller
WiredHome	165:695c24cc5197	770	/// (using the GSL1680 Capacitive TouchScreen Controller)
WiredHome	165:695c24cc5197	771	///
WiredHome	165:695c24cc5197	772	/// @code
WiredHome	165:695c24cc5197	773	/// #include "RA8875.h"
WiredHome	197:853d08e2fb53	774	/// RA8875 lcd(p5,p6,p7,p12,NC, p9,p10,p13,p14, "tft");
WiredHome	190:3132b7dfad82	775	///
WiredHome	165:695c24cc5197	776	/// int main()
WiredHome	165:695c24cc5197	777	/// {
WiredHome	165:695c24cc5197	778	/// lcd.init();
WiredHome	165:695c24cc5197	779	/// lcd.printf("printing 3 x 2 = %d", 3*2);
WiredHome	165:695c24cc5197	780	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	165:695c24cc5197	781	/// TouchCode_t tp = lcd.TouchPanelReadable();
WiredHome	165:695c24cc5197	782	/// if (tp == touch)
WiredHome	165:695c24cc5197	783	/// ...
WiredHome	165:695c24cc5197	784	/// }
WiredHome	165:695c24cc5197	785	/// @endcode
WiredHome	165:695c24cc5197	786	///
WiredHome	165:695c24cc5197	787	/// @param[in] mosi is the SPI master out slave in pin on the mbed.
WiredHome	165:695c24cc5197	788	/// @param[in] miso is the SPI master in slave out pin on the mbed.
WiredHome	165:695c24cc5197	789	/// @param[in] sclk is the SPI shift clock pin on the mbed.
WiredHome	165:695c24cc5197	790	/// @param[in] csel is the DigitalOut pin on the mbed to use as the
WiredHome	165:695c24cc5197	791	/// active low chip select for the display controller.
WiredHome	190:3132b7dfad82	792	/// @param[in] reset is the DigitalOut pin on the mbed to use as the
WiredHome	190:3132b7dfad82	793	/// active low reset input on the display controller -
WiredHome	165:695c24cc5197	794	/// but this is not currently used.
WiredHome	165:695c24cc5197	795	/// @param[in] sda is the I2C Serial Data pin you are wiring to the GSL1680.
WiredHome	165:695c24cc5197	796	/// @param[in] scl is the I2C Serial Clock pin you are wiring to the GSL1680.
WiredHome	165:695c24cc5197	797	/// @param[in] wake is the wake control pin you are wiring to the GSL1680.
WiredHome	165:695c24cc5197	798	/// @param[in] irq is the Interrupt Request pin you are wiring to the GSL1680.
WiredHome	165:695c24cc5197	799	/// @param[in] name is a text name for this object, which will permit
WiredHome	165:695c24cc5197	800	/// capturing stdout to puts() and printf() directly to it.
WiredHome	165:695c24cc5197	801	///
WiredHome	190:3132b7dfad82	802	RA8875(PinName mosi, PinName miso, PinName sclk, PinName csel, PinName reset,
WiredHome	165:695c24cc5197	803	PinName sda, PinName scl, PinName wake, PinName irq, const char * name = "lcd");
WiredHome	190:3132b7dfad82	804
WiredHome	190:3132b7dfad82	805
WiredHome	45:679c2fb8480c	806	// Destructor doesn't have much to do as this would typically be created
WiredHome	45:679c2fb8480c	807	// at startup, and not at runtime.
WiredHome	19:3f82c1161fd2	808	//~RA8875();
WiredHome	190:3132b7dfad82	809
WiredHome	79:544eb4964795	810	/// Initialize the driver.
WiredHome	79:544eb4964795	811	///
WiredHome	190:3132b7dfad82	812	/// The RA8875 can control typical displays from the 480x272 to 800x480, and it supports 8 or 16-bit color.
WiredHome	190:3132b7dfad82	813	/// It also supports 2 graphics layers, but it cannot support 2 layers at the maximum color depth and
WiredHome	190:3132b7dfad82	814	/// screen size. When configured under 480x400, it will support both 16-bit color depth and 2 drawing layers.
WiredHome	132:a5d7a8541683	815	/// Above 480x400 it support either 16-bit color, or 2 layers, but not both.
WiredHome	132:a5d7a8541683	816	///
WiredHome	132:a5d7a8541683	817	/// Typical of the displays that are readily purchased, you will find 480x272 and 800x480 resolutions.
WiredHome	106:c80828f5dea4	818	///
WiredHome	81:01da2e34283d	819	/// @param[in] width in pixels to configure the display for. This parameter is optional
WiredHome	81:01da2e34283d	820	/// and the default is 480.
WiredHome	81:01da2e34283d	821	/// @param[in] height in pixels to configure the display for. This parameter is optional
WiredHome	81:01da2e34283d	822	/// and the default is 272.
WiredHome	81:01da2e34283d	823	/// @param[in] color_bpp can be either 8 or 16, but must be consistent
WiredHome	81:01da2e34283d	824	/// with the width and height parameters. This parameter is optional
WiredHome	81:01da2e34283d	825	/// and the default is 16.
WiredHome	131:5bd6ba2ee4a1	826	/// @param[in] poweron defines if the display should be initialized into the power-on or off state.
WiredHome	132:a5d7a8541683	827	/// If power is non-zero(on), the backlight is set to this value. This parameter is optional
WiredHome	157:1565f38ca44b	828	/// and the default is 40 (on at a low brightness level because many users power
WiredHome	157:1565f38ca44b	829	/// the module from their PC USB port and it often cannot support the curent
WiredHome	157:1565f38ca44b	830	/// required for full brightness). See @ref Power.
WiredHome	81:01da2e34283d	831	/// @param[in] keypadon defines if the keypad support should be enabled. This parameter is optional
WiredHome	106:c80828f5dea4	832	/// and the default is true (enabled). See @ref KeypadInit.
WiredHome	190:3132b7dfad82	833	/// @param[in] touchscreeenon defines if the touchscreen support should be enabled.
WiredHome	132:a5d7a8541683	834	/// This parameter is optional and the default is true (enabled). See @ref TouchPanelInit.
WiredHome	190:3132b7dfad82	835	/// - If the constructor was called with support for the capacitive driver, this
WiredHome	124:1690a7ae871c	836	/// parameter causes the driver to initialize.
WiredHome	124:1690a7ae871c	837	/// - If the constructor was called without support for the capacitive driver, this
WiredHome	124:1690a7ae871c	838	/// parameter is used to enable and initialize the resistive touchscreen driver.
WiredHome	167:8aa3fb2a5a31	839	/// @returns @ref RetCode_t value.
WiredHome	79:544eb4964795	840	///
WiredHome	190:3132b7dfad82	841	RetCode_t init(int width = 480, int height = 272, int color_bpp = 16,
WiredHome	157:1565f38ca44b	842	uint8_t poweron = 40, bool keypadon = true, bool touchscreeenon = true);
WiredHome	124:1690a7ae871c	843
WiredHome	125:7a0b70f56550	844
WiredHome	167:8aa3fb2a5a31	845	/// Get a pointer to the text string representing the RetCode_t
WiredHome	79:544eb4964795	846	///
WiredHome	79:544eb4964795	847	/// This method returns a pointer to a text string that matches the
WiredHome	106:c80828f5dea4	848	/// code. See @ref RetCode_t.
WiredHome	79:544eb4964795	849	///
WiredHome	79:544eb4964795	850	/// @param[in] code is the return value from RetCode_t to look up.
WiredHome	79:544eb4964795	851	/// @returns a pointer to the text message representing code. If code
WiredHome	79:544eb4964795	852	/// is not a valid value, then it returns the text for bad_parameter;
WiredHome	125:7a0b70f56550	853	///
WiredHome	79:544eb4964795	854	const char * GetErrorMessage(RetCode_t code);
WiredHome	190:3132b7dfad82	855
WiredHome	190:3132b7dfad82	856
WiredHome	50:2c4f474a2453	857	/// Select the drawing layer for subsequent commands.
WiredHome	43:3becae133285	858	///
WiredHome	190:3132b7dfad82	859	/// If the screen configuration is 480 x 272, or if it is 800 x 480
WiredHome	190:3132b7dfad82	860	/// and 8-bit color, the the display supports two layers, which can
WiredHome	43:3becae133285	861	/// be independently drawn on and shown. Additionally, complex
WiredHome	43:3becae133285	862	/// operations involving both layers are permitted.
WiredHome	43:3becae133285	863	///
WiredHome	142:6e9bff59878a	864	/// @attention If the current display configuration does not support
WiredHome	142:6e9bff59878a	865	/// multiple layers, then layer 0 will be selected.
WiredHome	142:6e9bff59878a	866	///
WiredHome	56:7a85d226ad0d	867	/// @code
WiredHome	56:7a85d226ad0d	868	/// //lcd.SetLayerMode(OnlyLayer0); // default is layer 0
WiredHome	56:7a85d226ad0d	869	/// lcd.rect(400,130, 475,155,Brown);
WiredHome	56:7a85d226ad0d	870	/// lcd.SelectDrawingLayer(1);
WiredHome	56:7a85d226ad0d	871	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	872	/// wait(1);
WiredHome	56:7a85d226ad0d	873	/// lcd.SetLayerMode(ShowLayer1);
WiredHome	56:7a85d226ad0d	874	/// @endcode
WiredHome	56:7a85d226ad0d	875	///
WiredHome	61:8f3153bf0baa	876	/// @attention The user manual refers to Layer 1 and Layer 2, however the
WiredHome	61:8f3153bf0baa	877	/// actual register values are value 0 and 1. This API as well as
WiredHome	61:8f3153bf0baa	878	/// others that reference the layers use the values 0 and 1 for
WiredHome	61:8f3153bf0baa	879	/// cleaner iteration in the code.
WiredHome	43:3becae133285	880	///
WiredHome	190:3132b7dfad82	881	/// @param[in] layer is 0 or 1 to select the layer for subsequent
WiredHome	61:8f3153bf0baa	882	/// commands.
WiredHome	143:e872d65a710d	883	/// @param[out] prevLayer is an optiona pointer to where the previous layer
WiredHome	143:e872d65a710d	884	/// will be written, making it a little easer to restore layers.
WiredHome	143:e872d65a710d	885	/// Writes 0 or 1 when the pointer is not NULL.
WiredHome	167:8aa3fb2a5a31	886	/// @returns @ref RetCode_t value.
WiredHome	143:e872d65a710d	887	///
WiredHome	143:e872d65a710d	888	virtual RetCode_t SelectDrawingLayer(uint16_t layer, uint16_t * prevLayer = NULL);
WiredHome	190:3132b7dfad82	889
WiredHome	190:3132b7dfad82	890
WiredHome	61:8f3153bf0baa	891	/// Get the currently active drawing layer.
WiredHome	61:8f3153bf0baa	892	///
WiredHome	61:8f3153bf0baa	893	/// This returns a value, 0 or 1, based on the screen configuration
WiredHome	61:8f3153bf0baa	894	/// and the currently active drawing layer.
WiredHome	61:8f3153bf0baa	895	///
WiredHome	61:8f3153bf0baa	896	/// @code
WiredHome	61:8f3153bf0baa	897	/// uint16_t prevLayer = lcd.GetDrawingLayer();
WiredHome	61:8f3153bf0baa	898	/// lcd.SelectDrawingLayer(x);
WiredHome	61:8f3153bf0baa	899	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	61:8f3153bf0baa	900	/// lcd.SelectDrawingLayer(prevLayer);
WiredHome	61:8f3153bf0baa	901	/// @endcode
WiredHome	61:8f3153bf0baa	902	///
WiredHome	61:8f3153bf0baa	903	/// @attention The user manual refers to Layer 1 and Layer 2, however the
WiredHome	61:8f3153bf0baa	904	/// actual register values are value 0 and 1. This API as well as
WiredHome	61:8f3153bf0baa	905	/// others that reference the layers use the values 0 and 1 for
WiredHome	61:8f3153bf0baa	906	/// cleaner iteration in the code.
WiredHome	61:8f3153bf0baa	907	///
WiredHome	61:8f3153bf0baa	908	/// @returns the current drawing layer; 0 or 1.
WiredHome	190:3132b7dfad82	909	///
WiredHome	142:6e9bff59878a	910	virtual uint16_t GetDrawingLayer(void);
WiredHome	190:3132b7dfad82	911
WiredHome	190:3132b7dfad82	912
WiredHome	44:207594dece70	913	/// Set the Layer presentation mode.
WiredHome	44:207594dece70	914	///
WiredHome	44:207594dece70	915	/// This sets the presentation mode for layers, and permits showing
WiredHome	44:207594dece70	916	/// a single layer, or applying a mode where the two layers
WiredHome	44:207594dece70	917	/// are combined using one of the hardware methods.
WiredHome	44:207594dece70	918	///
WiredHome	61:8f3153bf0baa	919	/// Refer to the RA8875 data sheet for full details.
WiredHome	61:8f3153bf0baa	920	///
WiredHome	56:7a85d226ad0d	921	/// @code
WiredHome	56:7a85d226ad0d	922	/// //lcd.SetLayerMode(OnlyLayer0); // default is layer 0
WiredHome	56:7a85d226ad0d	923	/// lcd.rect(400,130, 475,155,Brown);
WiredHome	56:7a85d226ad0d	924	/// lcd.SelectDrawingLayer(1);
WiredHome	56:7a85d226ad0d	925	/// lcd.circle(400,25, 25, BrightRed);
WiredHome	56:7a85d226ad0d	926	/// wait(1);
WiredHome	56:7a85d226ad0d	927	/// lcd.SetLayerMode(ShowLayer1);
WiredHome	56:7a85d226ad0d	928	/// @endcode
WiredHome	56:7a85d226ad0d	929	///
WiredHome	72:ecffe56af969	930	/// @param[in] mode sets the mode in the Layer Transparency Register.
WiredHome	167:8aa3fb2a5a31	931	/// @returns @ref RetCode_t value.
WiredHome	44:207594dece70	932	///
WiredHome	53:86d24b9480b9	933	RetCode_t SetLayerMode(LayerMode_T mode);
WiredHome	190:3132b7dfad82	934
WiredHome	190:3132b7dfad82	935
WiredHome	82:f7d300f26540	936	/// Get the Layer presentation mode.
WiredHome	82:f7d300f26540	937	///
WiredHome	106:c80828f5dea4	938	/// This gets the current layer mode. See @ref LayerMode_T.
WiredHome	82:f7d300f26540	939	///
WiredHome	82:f7d300f26540	940	/// @returns layer mode.
WiredHome	82:f7d300f26540	941	///
WiredHome	82:f7d300f26540	942	LayerMode_T GetLayerMode(void);
WiredHome	190:3132b7dfad82	943
WiredHome	190:3132b7dfad82	944
WiredHome	44:207594dece70	945	/// Set the layer transparency for each layer.
WiredHome	44:207594dece70	946	///
WiredHome	44:207594dece70	947	/// Set the transparency, where the range of values is
WiredHome	44:207594dece70	948	/// from zero (fully visible) to eight (fully transparent).
WiredHome	44:207594dece70	949	/// The input value is automatically limited to this range.
WiredHome	44:207594dece70	950	///
WiredHome	56:7a85d226ad0d	951	/// @code
WiredHome	56:7a85d226ad0d	952	/// // draw something on each layer, then step-fade across
WiredHome	56:7a85d226ad0d	953	/// display.SetLayerMode(RA8875::TransparentMode);
WiredHome	56:7a85d226ad0d	954	/// for (i=0; i<=8; i++) {
WiredHome	56:7a85d226ad0d	955	/// display.SetLayerTransparency(i, 8-i);
WiredHome	197:853d08e2fb53	956	/// wait_us(200000);
WiredHome	56:7a85d226ad0d	957	/// }
WiredHome	56:7a85d226ad0d	958	/// @endcode
WiredHome	56:7a85d226ad0d	959	///
WiredHome	72:ecffe56af969	960	/// @param[in] layer1 sets the layer 1 transparency.
WiredHome	72:ecffe56af969	961	/// @param[in] layer2 sets the layer 2 transparency.
WiredHome	167:8aa3fb2a5a31	962	/// @returns @ref RetCode_t value.
WiredHome	190:3132b7dfad82	963	///
WiredHome	44:207594dece70	964	RetCode_t SetLayerTransparency(uint8_t layer1, uint8_t layer2);
WiredHome	190:3132b7dfad82	965
WiredHome	190:3132b7dfad82	966
WiredHome	53:86d24b9480b9	967	/// Set the background color register used for transparency.
WiredHome	53:86d24b9480b9	968	///
WiredHome	53:86d24b9480b9	969	/// This command sets the background color registers that are used
WiredHome	53:86d24b9480b9	970	/// in the transparent color operations involving the layers.
WiredHome	190:3132b7dfad82	971	///
WiredHome	72:ecffe56af969	972	/// @param[in] color is optional and expressed in 16-bit format. If not
WiredHome	53:86d24b9480b9	973	/// supplied, a default of Black is used.
WiredHome	167:8aa3fb2a5a31	974	/// @returns @ref RetCode_t value.
WiredHome	53:86d24b9480b9	975	///
WiredHome	53:86d24b9480b9	976	RetCode_t SetBackgroundTransparencyColor(color_t color = RGB(0,0,0));
WiredHome	190:3132b7dfad82	977
WiredHome	190:3132b7dfad82	978
WiredHome	73:f22a18707b5e	979	/// Get the background color value used for transparency.
WiredHome	73:f22a18707b5e	980	///
WiredHome	73:f22a18707b5e	981	/// This command reads the background color registers that define
WiredHome	73:f22a18707b5e	982	/// the transparency color for operations involving layers.
WiredHome	73:f22a18707b5e	983	///
WiredHome	73:f22a18707b5e	984	/// @returns the color.
WiredHome	73:f22a18707b5e	985	///
WiredHome	73:f22a18707b5e	986	color_t GetBackgroundTransparencyColor(void);
WiredHome	190:3132b7dfad82	987
WiredHome	190:3132b7dfad82	988
WiredHome	190:3132b7dfad82	989	/// Initialize theTouch Panel controller with default values
hexley	54:e117ad10fba6	990	///
WiredHome	78:faf49c381591	991	/// This activates the simplified touch panel init, which may work for
WiredHome	78:faf49c381591	992	/// most uses. The alternate API is available if fine-grained control
WiredHome	124:1690a7ae871c	993	/// of the numerous settings of the resistive panel is needed.
WiredHome	78:faf49c381591	994	///
WiredHome	157:1565f38ca44b	995	/// Additionally, for an even simpler interface for most RESISTIVE
WiredHome	157:1565f38ca44b	996	/// touch use cases, the init() method can perform the calibration.
WiredHome	157:1565f38ca44b	997	///
WiredHome	167:8aa3fb2a5a31	998	/// @returns @ref RetCode_t value.
WiredHome	56:7a85d226ad0d	999	///
hexley	54:e117ad10fba6	1000	RetCode_t TouchPanelInit(void);
WiredHome	190:3132b7dfad82	1001
WiredHome	190:3132b7dfad82	1002
hexley	54:e117ad10fba6	1003	/// Initialize the Touch Panel controller with detailed settings.
hexley	54:e117ad10fba6	1004	///
WiredHome	78:faf49c381591	1005	/// This is the detailed touch panel init, which provides the ability
WiredHome	124:1690a7ae871c	1006	/// to set nearly every option.
WiredHome	124:1690a7ae871c	1007	///
WiredHome	124:1690a7ae871c	1008	/// @note If the capacitive touch panel was constructed, this behaves
WiredHome	124:1690a7ae871c	1009	/// the same as the simplified version.
WiredHome	78:faf49c381591	1010	///
hexley	54:e117ad10fba6	1011	/// @param[in] bTpEnable Touch Panel enable/disable control:
hexley	54:e117ad10fba6	1012	/// - TP_ENABLE: enable the touch panel
hexley	54:e117ad10fba6	1013	/// - TP_DISABLE: disable the touch panel
WiredHome	56:7a85d226ad0d	1014	/// @param[in] bTpAutoManual Touch Panel operating mode:
hexley	54:e117ad10fba6	1015	/// - TP_MODE_AUTO: automatic capture
hexley	54:e117ad10fba6	1016	/// - TP_MODE_MANUAL: manual capture
WiredHome	56:7a85d226ad0d	1017	/// @param[in] bTpDebounce Debounce circuit enable for touch panel interrupt:
hexley	54:e117ad10fba6	1018	/// - TP_DEBOUNCE_OFF: disable the debounce circuit
WiredHome	190:3132b7dfad82	1019	/// - TP_DEBOUNCE_ON: enable the debounce circuit
WiredHome	56:7a85d226ad0d	1020	/// @param[in] bTpManualMode When Manual Mode is selected, this sets the mode:
WiredHome	190:3132b7dfad82	1021	/// - TP_MANUAL_IDLE: touch panel is idle
WiredHome	190:3132b7dfad82	1022	/// - TP_MANUAL_WAIT: wait for touch panel event
WiredHome	190:3132b7dfad82	1023	/// - TP_MANUAL_LATCH_X: latch X data
WiredHome	190:3132b7dfad82	1024	/// - TP_MANUAL_LATCH_Y: latch Y data
WiredHome	56:7a85d226ad0d	1025	/// @param[in] bTpAdcClkDiv Sets the ADC clock as a fraction of the System CLK:
WiredHome	190:3132b7dfad82	1026	/// - TP_ADC_CLKDIV_1: Use CLK
WiredHome	190:3132b7dfad82	1027	/// - TP_ADC_CLKDIV_2: Use CLK/2
WiredHome	190:3132b7dfad82	1028	/// - TP_ADC_CLKDIV_4: Use CLK/4
WiredHome	190:3132b7dfad82	1029	/// - TP_ADC_CLKDIV_8: Use CLK/8
WiredHome	190:3132b7dfad82	1030	/// - TP_ADC_CLKDIV_16: Use CLK/16
WiredHome	190:3132b7dfad82	1031	/// - TP_ADC_CLKDIV_32: Use CLK/32
WiredHome	190:3132b7dfad82	1032	/// - TP_ADC_CLKDIV_64: Use CLK/64
WiredHome	190:3132b7dfad82	1033	/// - TP_ADC_CLKDIV_128: Use CLK/128
WiredHome	56:7a85d226ad0d	1034	/// @param[in] bTpAdcSampleTime Touch Panel sample time delay before ADC data is ready:
WiredHome	190:3132b7dfad82	1035	/// - TP_ADC_SAMPLE_512_CLKS: Wait 512 system clocks
WiredHome	190:3132b7dfad82	1036	/// - TP_ADC_SAMPLE_1024_CLKS: Wait 1024 system clocks
WiredHome	190:3132b7dfad82	1037	/// - TP_ADC_SAMPLE_2048_CLKS: Wait 2048 system clocks
WiredHome	190:3132b7dfad82	1038	/// - TP_ADC_SAMPLE_4096_CLKS: Wait 4096 system clocks
WiredHome	190:3132b7dfad82	1039	/// - TP_ADC_SAMPLE_8192_CLKS: Wait 8192 system clocks
WiredHome	190:3132b7dfad82	1040	/// - TP_ADC_SAMPLE_16384_CLKS: Wait 16384 system clocks
WiredHome	190:3132b7dfad82	1041	/// - TP_ADC_SAMPLE_32768_CLKS: Wait 32768 system clocks
hexley	54:e117ad10fba6	1042	/// - TP_ADC_SAMPLE_65536_CLKS: Wait 65536 system clocks
WiredHome	190:3132b7dfad82	1043	/// @returns @ref RetCode_t value.
WiredHome	190:3132b7dfad82	1044	///
WiredHome	190:3132b7dfad82	1045	RetCode_t TouchPanelInit(uint8_t bTpEnable, uint8_t bTpAutoManual, uint8_t bTpDebounce,
WiredHome	78:faf49c381591	1046	uint8_t bTpManualMode, uint8_t bTpAdcClkDiv, uint8_t bTpAdcSampleTime);
WiredHome	190:3132b7dfad82	1047
WiredHome	190:3132b7dfad82	1048
WiredHome	123:2f45e80fec5f	1049	/// Get the screen calibrated point of touch.
WiredHome	123:2f45e80fec5f	1050	///
WiredHome	123:2f45e80fec5f	1051	/// This method determines if there is a touch and if so it will provide
WiredHome	123:2f45e80fec5f	1052	/// the screen-relative touch coordinates. This method can be used in
WiredHome	190:3132b7dfad82	1053	/// a manner similar to Serial.readable(), to determine if there was a
WiredHome	123:2f45e80fec5f	1054	/// touch and indicate that - but not care about the coordinates. Alternately,
WiredHome	123:2f45e80fec5f	1055	/// if a valid pointer to a point_t is provided, then if a touch is detected
WiredHome	190:3132b7dfad82	1056	/// the point_t will be populated with data.
WiredHome	123:2f45e80fec5f	1057	///
WiredHome	123:2f45e80fec5f	1058	/// @code
WiredHome	123:2f45e80fec5f	1059	/// Timer t;
WiredHome	123:2f45e80fec5f	1060	/// t.start();
WiredHome	123:2f45e80fec5f	1061	/// do {
WiredHome	123:2f45e80fec5f	1062	/// point_t point = {0, 0};
WiredHome	123:2f45e80fec5f	1063	/// if (display.TouchPanelReadable(&point)) {
WiredHome	123:2f45e80fec5f	1064	/// display.pixel(point, Red);
WiredHome	123:2f45e80fec5f	1065	/// }
WiredHome	123:2f45e80fec5f	1066	/// } while (t.read_ms() < 30000);
WiredHome	123:2f45e80fec5f	1067	/// @endcode
WiredHome	123:2f45e80fec5f	1068	///
WiredHome	190:3132b7dfad82	1069	/// @param[out] TouchPoint is a pointer to a point_t, which is set as the touch point,
WiredHome	165:695c24cc5197	1070	/// if a touch is registered.
WiredHome	123:2f45e80fec5f	1071	/// @returns a value indicating the state of the touch,
WiredHome	123:2f45e80fec5f	1072	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	123:2f45e80fec5f	1073	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	123:2f45e80fec5f	1074	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	123:2f45e80fec5f	1075	/// - held: held after touch, touch coordinates are returned.
WiredHome	123:2f45e80fec5f	1076	/// - release: indicates a release, touch coordinates are returned.
WiredHome	123:2f45e80fec5f	1077	///
WiredHome	123:2f45e80fec5f	1078	TouchCode_t TouchPanelReadable(point_t * TouchPoint = NULL);
WiredHome	123:2f45e80fec5f	1079
WiredHome	125:7a0b70f56550	1080
WiredHome	124:1690a7ae871c	1081	/// Get the reported touch gesture, if any.
WiredHome	190:3132b7dfad82	1082	///
WiredHome	124:1690a7ae871c	1083	/// If it could detect a gesture, it will return a value based on
WiredHome	132:a5d7a8541683	1084	/// the interpreted gesture.
WiredHome	124:1690a7ae871c	1085	///
WiredHome	124:1690a7ae871c	1086	/// Valid gesture values are:
WiredHome	124:1690a7ae871c	1087	/// @li 0x00 No gesture
WiredHome	132:a5d7a8541683	1088	/// @li 0x48 Zoom in
WiredHome	132:a5d7a8541683	1089	/// @li 0x49 Zoom out
WiredHome	132:a5d7a8541683	1090	///
WiredHome	132:a5d7a8541683	1091	/// The following gestures are defined in the FT5206 specification, but
WiredHome	132:a5d7a8541683	1092	/// do not appear to work.
WiredHome	124:1690a7ae871c	1093	/// @li 0x10 Move up
WiredHome	124:1690a7ae871c	1094	/// @li 0x14 Move left
WiredHome	124:1690a7ae871c	1095	/// @li 0x18 Move down
WiredHome	124:1690a7ae871c	1096	/// @li 0x1C Move right
WiredHome	124:1690a7ae871c	1097	///
WiredHome	124:1690a7ae871c	1098	/// @returns gesture information.
WiredHome	124:1690a7ae871c	1099	///
WiredHome	124:1690a7ae871c	1100	uint8_t TouchGesture(void) { return gesture; }
WiredHome	190:3132b7dfad82	1101
WiredHome	123:2f45e80fec5f	1102
WiredHome	124:1690a7ae871c	1103	/// Get the count of registered touches.
WiredHome	124:1690a7ae871c	1104	///
WiredHome	124:1690a7ae871c	1105	/// @returns count of touch points to communicate; 0 to 5.
WiredHome	124:1690a7ae871c	1106	///
WiredHome	124:1690a7ae871c	1107	int TouchCount(void) { return numberOfTouchPoints; }
WiredHome	125:7a0b70f56550	1108
WiredHome	190:3132b7dfad82	1109
WiredHome	124:1690a7ae871c	1110	/// Get the count of possible touch channels.
WiredHome	124:1690a7ae871c	1111	///
WiredHome	124:1690a7ae871c	1112	/// @returns count of touch channels supported by the hardware.
WiredHome	124:1690a7ae871c	1113	///
WiredHome	124:1690a7ae871c	1114	int TouchChannels(void);
WiredHome	125:7a0b70f56550	1115
WiredHome	190:3132b7dfad82	1116
WiredHome	124:1690a7ae871c	1117	/// Get the Touch ID value for a specified touch channel.
WiredHome	124:1690a7ae871c	1118	///
WiredHome	124:1690a7ae871c	1119	/// Touch ID is a tracking number based on the order of the touch
WiredHome	190:3132b7dfad82	1120	/// detections. The first touch is ID 0, the next is ID 1, and
WiredHome	124:1690a7ae871c	1121	/// so on. If the first touch is lifted (no touch), the touch count
WiredHome	124:1690a7ae871c	1122	/// decrements, and the remaining touch is communicated on
WiredHome	124:1690a7ae871c	1123	/// touch channel zero, even as the Touch ID remains as originally
WiredHome	190:3132b7dfad82	1124	/// reported (1 in this example). In this way, it is easy to track
WiredHome	132:a5d7a8541683	1125	/// a specific touch.
WiredHome	124:1690a7ae871c	1126	///
WiredHome	124:1690a7ae871c	1127	/// It is possible to query the data for a channel that is not
WiredHome	124:1690a7ae871c	1128	/// presently reported as touched.
WiredHome	124:1690a7ae871c	1129	///
WiredHome	166:53fd4a876dac	1130	/// @param[in] channel is the touch channel, from 0 to 4, or 0 to TouchChannels()-1
WiredHome	124:1690a7ae871c	1131	/// It defaults to 0, in case the user is not interested in multi-touch.
WiredHome	124:1690a7ae871c	1132	/// @returns the touch ID, or 15 if you get the ID for an untouched channel.
WiredHome	124:1690a7ae871c	1133	/// @returns 0 if an invalid channel is queried.
WiredHome	124:1690a7ae871c	1134	///
WiredHome	166:53fd4a876dac	1135	uint8_t TouchID(uint8_t channel = 0);
WiredHome	190:3132b7dfad82	1136
WiredHome	124:1690a7ae871c	1137	/// Get the Touch Code for a touch channel.
WiredHome	124:1690a7ae871c	1138	///
WiredHome	124:1690a7ae871c	1139	/// It is possible to query the data for a channel that is not
WiredHome	124:1690a7ae871c	1140	/// presently reported as touched.
WiredHome	124:1690a7ae871c	1141	///
WiredHome	166:53fd4a876dac	1142	/// @param[in] channel is the touch channel, from 0 to 4, or 0 to TouchChannels()-1
WiredHome	124:1690a7ae871c	1143	/// It defaults to 0, in case the user is not interested in multi-touch.
WiredHome	124:1690a7ae871c	1144	/// @returns the touch code (@ref TouchCode_t).
WiredHome	124:1690a7ae871c	1145	/// @returns channel 0 information if an invalid channel is queried.
WiredHome	124:1690a7ae871c	1146	///
WiredHome	166:53fd4a876dac	1147	TouchCode_t TouchCode(uint8_t channel = 0);
WiredHome	124:1690a7ae871c	1148
WiredHome	125:7a0b70f56550	1149
WiredHome	124:1690a7ae871c	1150	/// Get the coordinates for a touch channel.
WiredHome	124:1690a7ae871c	1151	///
WiredHome	124:1690a7ae871c	1152	/// This returns the (X,Y) coordinates for a touch channel.
WiredHome	132:a5d7a8541683	1153	///
WiredHome	124:1690a7ae871c	1154	///
WiredHome	124:1690a7ae871c	1155	/// It is possible to query the data for a channel that is not
WiredHome	124:1690a7ae871c	1156	/// presently reported as touched.
WiredHome	124:1690a7ae871c	1157	///
WiredHome	166:53fd4a876dac	1158	/// @param[in] channel is an optional touch channel, from 0 to 4, or 0 to TouchChannels()-1.
WiredHome	124:1690a7ae871c	1159	/// It defaults to 0, in case the user is not interested in multi-touch.
WiredHome	124:1690a7ae871c	1160	/// @returns the coordinates as a point_t structure.
WiredHome	124:1690a7ae871c	1161	/// @returns channel 0 information if an invalid channel is queried.
WiredHome	124:1690a7ae871c	1162	///
WiredHome	166:53fd4a876dac	1163	point_t TouchCoordinates(uint8_t channel = 0);
WiredHome	190:3132b7dfad82	1164
WiredHome	131:5bd6ba2ee4a1	1165
WiredHome	79:544eb4964795	1166	/// Poll the TouchPanel and on a touch event return the a to d filtered x, y coordinates.
hexley	54:e117ad10fba6	1167	///
WiredHome	78:faf49c381591	1168	/// This method reads the touch controller, which has a 10-bit range for each the
WiredHome	79:544eb4964795	1169	/// x and the y axis.
WiredHome	79:544eb4964795	1170	///
WiredHome	79:544eb4964795	1171	/// @note The returned values are not in display (pixel) units but are in analog to
WiredHome	79:544eb4964795	1172	/// digital converter units.
WiredHome	190:3132b7dfad82	1173	///
WiredHome	190:3132b7dfad82	1174	/// @note This API is usually not needed and is likely to be deprecated.
WiredHome	190:3132b7dfad82	1175	/// See @ref TouchPanelComputeCalibration.
WiredHome	106:c80828f5dea4	1176	/// See @ref TouchPanelReadable.
WiredHome	190:3132b7dfad82	1177	///
WiredHome	79:544eb4964795	1178	/// @param[out] x is the x scale a/d value.
WiredHome	79:544eb4964795	1179	/// @param[out] y is the y scale a/d value.
WiredHome	83:7bad0068cca0	1180	/// @returns a value indicating the state of the touch,
WiredHome	83:7bad0068cca0	1181	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	1182	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	1183	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	83:7bad0068cca0	1184	/// - held: held after touch, touch coordinates are returned.
WiredHome	83:7bad0068cca0	1185	/// - release: indicates a release, touch coordinates are returned.
WiredHome	56:7a85d226ad0d	1186	///
WiredHome	83:7bad0068cca0	1187	TouchCode_t TouchPanelA2DFiltered(int x, int y);
hexley	54:e117ad10fba6	1188
WiredHome	125:7a0b70f56550	1189
WiredHome	79:544eb4964795	1190	/// Poll the TouchPanel and on a touch event return the a to d raw x, y coordinates.
hexley	54:e117ad10fba6	1191	///
WiredHome	78:faf49c381591	1192	/// This method reads the touch controller, which has a 10-bit range for each the
WiredHome	78:faf49c381591	1193	/// x and the y axis. A number of samples of the raw data are taken, filtered,
WiredHome	190:3132b7dfad82	1194	/// and the results are returned.
WiredHome	78:faf49c381591	1195	///
WiredHome	79:544eb4964795	1196	/// @note The returned values are not in display (pixel) units but are in analog to
WiredHome	79:544eb4964795	1197	/// digital converter units.
WiredHome	190:3132b7dfad82	1198	///
WiredHome	190:3132b7dfad82	1199	/// @note This API is usually not needed and is likely to be deprecated.
WiredHome	190:3132b7dfad82	1200	/// See @ref TouchPanelComputeCalibration.
WiredHome	106:c80828f5dea4	1201	/// See @ref TouchPanelReadable.
WiredHome	190:3132b7dfad82	1202	///
WiredHome	79:544eb4964795	1203	/// @param[out] x is the x scale a/d value.
WiredHome	79:544eb4964795	1204	/// @param[out] y is the y scale a/d value.
WiredHome	83:7bad0068cca0	1205	/// @returns a value indicating the state of the touch,
WiredHome	83:7bad0068cca0	1206	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	1207	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	83:7bad0068cca0	1208	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	83:7bad0068cca0	1209	/// - held: held after touch, touch coordinates are returned.
WiredHome	83:7bad0068cca0	1210	/// - release: indicates a release, touch coordinates are returned.
WiredHome	83:7bad0068cca0	1211	///
WiredHome	83:7bad0068cca0	1212	TouchCode_t TouchPanelA2DRaw(int x, int y);
WiredHome	125:7a0b70f56550	1213
WiredHome	190:3132b7dfad82	1214
WiredHome	85:022bba13c5c4	1215	/// Wait for a touch panel touch and return it.
WiredHome	190:3132b7dfad82	1216	///
WiredHome	85:022bba13c5c4	1217	/// This method is similar to Serial.getc() in that it will wait for a touch
WiredHome	85:022bba13c5c4	1218	/// and then return. In order to extract the coordinates of the touch, a
WiredHome	85:022bba13c5c4	1219	/// valid pointer to a point_t must be provided.
WiredHome	85:022bba13c5c4	1220	///
WiredHome	85:022bba13c5c4	1221	/// @note There is no timeout on this function, so its use is not recommended.
WiredHome	85:022bba13c5c4	1222	///
WiredHome	85:022bba13c5c4	1223	/// @code
WiredHome	85:022bba13c5c4	1224	/// Timer t;
WiredHome	85:022bba13c5c4	1225	/// t.start();
WiredHome	85:022bba13c5c4	1226	/// do {
WiredHome	85:022bba13c5c4	1227	/// point_t point = {0, 0};
WiredHome	85:022bba13c5c4	1228	/// display.TouchPanelGet(&point); // hangs here until touch
WiredHome	85:022bba13c5c4	1229	/// display.pixel(point, Red);
WiredHome	85:022bba13c5c4	1230	/// } while (t.read_ms() < 30000);
WiredHome	85:022bba13c5c4	1231	/// @endcode
WiredHome	85:022bba13c5c4	1232	///
WiredHome	85:022bba13c5c4	1233	/// @param[out] TouchPoint is the touch point, if a touch is registered.
WiredHome	85:022bba13c5c4	1234	/// @returns a value indicating the state of the touch,
WiredHome	85:022bba13c5c4	1235	/// - no_cal: no calibration matrix is available, touch coordinates are not returned.
WiredHome	85:022bba13c5c4	1236	/// - no_touch: no touch is detected, touch coordinates are not returned.
WiredHome	85:022bba13c5c4	1237	/// - touch: touch is detected, touch coordinates are returned.
WiredHome	85:022bba13c5c4	1238	/// - held: held after touch, touch coordinates are returned.
WiredHome	85:022bba13c5c4	1239	/// - release: indicates a release, touch coordinates are returned.
WiredHome	85:022bba13c5c4	1240	///
WiredHome	85:022bba13c5c4	1241	TouchCode_t TouchPanelGet(point_t * TouchPoint);
WiredHome	85:022bba13c5c4	1242
WiredHome	83:7bad0068cca0	1243
WiredHome	157:1565f38ca44b	1244	/// Configuration Option for the Resistive Touch Panel Calibration.
WiredHome	157:1565f38ca44b	1245	///
WiredHome	157:1565f38ca44b	1246	/// This method is only useful for the resistive touchscreen.
WiredHome	157:1565f38ca44b	1247	///
WiredHome	157:1565f38ca44b	1248	/// Also, this method is optional - the user can take all of the responsibility
WiredHome	157:1565f38ca44b	1249	/// in their code, or for simplicity sake, this API can be used prior
WiredHome	157:1565f38ca44b	1250	/// to the init method.
WiredHome	157:1565f38ca44b	1251	///
WiredHome	157:1565f38ca44b	1252	/// @code
WiredHome	157:1565f38ca44b	1253	/// RA8875 lcd(p5, p6, p7, p12, NC);
WiredHome	157:1565f38ca44b	1254	/// ...
WiredHome	190:3132b7dfad82	1255	/// LocalFileSystem local();
WiredHome	157:1565f38ca44b	1256	/// // Be sure you previously mounted the "/sd" file system to put the cal there.
WiredHome	157:1565f38ca44b	1257	/// lcd.ResTouchPanelCfg("/sd/tpcal.cfg", "Touch '+' to calibrate the touch panel");
WiredHome	157:1565f38ca44b	1258	///
WiredHome	190:3132b7dfad82	1259	/// // Only if the touch panel is enabled, AND is configured as the resistive
WiredHome	157:1565f38ca44b	1260	/// // panel will the prior command be useful.
WiredHome	157:1565f38ca44b	1261	/// lcd.init(LCD_W,LCD_H,LCD_C,40, false, true);
WiredHome	157:1565f38ca44b	1262	///
WiredHome	157:1565f38ca44b	1263	/// @endcode
WiredHome	157:1565f38ca44b	1264	///
WiredHome	157:1565f38ca44b	1265	/// @param[in] tpFQFN is a pointer to a fully qualified read-write accessible
WiredHome	157:1565f38ca44b	1266	/// filename where the calibration is held.
WiredHome	157:1565f38ca44b	1267	/// @param[in] tpCalMessage is an optional pointer to a message shown to the
WiredHome	190:3132b7dfad82	1268	/// user in the calibration process.
WiredHome	157:1565f38ca44b	1269	/// - If this parameter is not included, a default message will be shown.
WiredHome	157:1565f38ca44b	1270	/// - If this parameter points to a NULL string, no message is shown.
WiredHome	157:1565f38ca44b	1271	/// - If this parameter points to a non-NULL string, that string will be shown.
WiredHome	157:1565f38ca44b	1272	///
WiredHome	157:1565f38ca44b	1273	void ResTouchPanelCfg(const char * tpFQFN = NULL, const char * tpCalMessage = NULL);
WiredHome	157:1565f38ca44b	1274
WiredHome	157:1565f38ca44b	1275
WiredHome	77:9206c13aa527	1276	/// Calibrate the touch panel.
WiredHome	77:9206c13aa527	1277	///
WiredHome	77:9206c13aa527	1278	/// This method accepts two lists - one list is target points in ,
WiredHome	190:3132b7dfad82	1279	/// display coordinates and the other is a lit of raw touch coordinate
WiredHome	77:9206c13aa527	1280	/// values. It generates a calibration matrix for later use. This
WiredHome	77:9206c13aa527	1281	/// matrix is also accessible to the calling API, which may store
WiredHome	77:9206c13aa527	1282	/// the matrix in persistent memory and then install the calibration
WiredHome	77:9206c13aa527	1283	/// matrix on the next power cycle. By doing so, it can avoid the
WiredHome	77:9206c13aa527	1284	/// need to calibrate on every power cycle.
WiredHome	77:9206c13aa527	1285	///
WiredHome	81:01da2e34283d	1286	/// @note The methods "TouchPanelComputeCalibration", "TouchPanelReadable", and
WiredHome	77:9206c13aa527	1287	/// indirectly the "TouchPanelSetMatrix" methods are all derived
WiredHome	77:9206c13aa527	1288	/// from a program by Carlos E. Vidales. See the copyright note
WiredHome	77:9206c13aa527	1289	/// for further details. See also the article
WiredHome	77:9206c13aa527	1290	/// http://www.embedded.com/design/system-integration/4023968/How-To-Calibrate-Touch-Screens
WiredHome	77:9206c13aa527	1291	///
WiredHome	167:8aa3fb2a5a31	1292	/// @copyright Copyright © 2001, Carlos E. Vidales. All rights reserved.
WiredHome	190:3132b7dfad82	1293	/// This sample program was written and put in the public domain
WiredHome	190:3132b7dfad82	1294	/// by Carlos E. Vidales. The program is provided "as is"
WiredHome	78:faf49c381591	1295	/// without warranty of any kind, either expressed or implied.
WiredHome	78:faf49c381591	1296	/// If you choose to use the program within your own products
WiredHome	78:faf49c381591	1297	/// you do so at your own risk, and assume the responsibility
WiredHome	78:faf49c381591	1298	/// for servicing, repairing or correcting the program should
WiredHome	78:faf49c381591	1299	/// it prove defective in any manner.
WiredHome	190:3132b7dfad82	1300	/// You may copy and distribute the program's source code in any
WiredHome	78:faf49c381591	1301	/// medium, provided that you also include in each copy an
WiredHome	78:faf49c381591	1302	/// appropriate copyright notice and disclaimer of warranty.
WiredHome	78:faf49c381591	1303	/// You may also modify this program and distribute copies of
WiredHome	190:3132b7dfad82	1304	/// it provided that you include prominent notices stating
WiredHome	78:faf49c381591	1305	/// that you changed the file(s) and the date of any change,
WiredHome	190:3132b7dfad82	1306	/// and that you do not charge any royalties or licenses for
WiredHome	78:faf49c381591	1307	/// its use.
WiredHome	77:9206c13aa527	1308	///
WiredHome	190:3132b7dfad82	1309	/// @param[in] display is a pointer to a set of 3 points, which
WiredHome	77:9206c13aa527	1310	/// are in display units of measure. These are the targets
WiredHome	77:9206c13aa527	1311	/// the calibration was aiming for.
WiredHome	77:9206c13aa527	1312	/// @param[in] screen is a pointer to a set of 3 points, which
WiredHome	77:9206c13aa527	1313	/// are in touchscreen units of measure. These are the
WiredHome	77:9206c13aa527	1314	/// registered touches.
WiredHome	190:3132b7dfad82	1315	/// @param[out] matrix is an optional parameter to hold the calibration matrix
WiredHome	190:3132b7dfad82	1316	/// as a result of the calibration. This can be saved in
WiredHome	77:9206c13aa527	1317	/// non-volatile memory to recover the calibration after a power fail.
WiredHome	167:8aa3fb2a5a31	1318	/// @returns @ref RetCode_t value.
WiredHome	77:9206c13aa527	1319	///
WiredHome	81:01da2e34283d	1320	RetCode_t TouchPanelComputeCalibration(point_t display[3], point_t screen[3], tpMatrix_t * matrix);
WiredHome	81:01da2e34283d	1321
WiredHome	81:01da2e34283d	1322
WiredHome	81:01da2e34283d	1323	/// Perform the touch panel calibration process.
WiredHome	81:01da2e34283d	1324	///
WiredHome	81:01da2e34283d	1325	/// This method provides the easy "shortcut" to calibrating the touch panel.
WiredHome	81:01da2e34283d	1326	/// The process will automatically generate the calibration points, present
WiredHome	81:01da2e34283d	1327	/// the targets on-screen, detect the touches, compute the calibration
WiredHome	81:01da2e34283d	1328	/// matrix, and optionally provide the calibration matrix to the calling code
WiredHome	81:01da2e34283d	1329	/// for persistence in non-volatile memory.
WiredHome	81:01da2e34283d	1330	///
WiredHome	190:3132b7dfad82	1331	/// @param[out] matrix is an optional parameter to hold the calibration matrix
WiredHome	190:3132b7dfad82	1332	/// as a result of the calibration. This can be saved in
WiredHome	81:01da2e34283d	1333	/// non-volatile memory to recover the calibration after a power fail.
WiredHome	167:8aa3fb2a5a31	1334	/// @returns @ref RetCode_t value.
WiredHome	81:01da2e34283d	1335	///
WiredHome	85:022bba13c5c4	1336	RetCode_t TouchPanelCalibrate(tpMatrix_t * matrix = NULL);
WiredHome	81:01da2e34283d	1337
WiredHome	125:7a0b70f56550	1338
WiredHome	81:01da2e34283d	1339	/// Perform the touch panel calibration process.
WiredHome	81:01da2e34283d	1340	///
WiredHome	81:01da2e34283d	1341	/// This method provides the easy "shortcut" to calibrating the touch panel.
WiredHome	81:01da2e34283d	1342	/// The process will automatically generate the calibration points, present
WiredHome	81:01da2e34283d	1343	/// the targets on-screen, detect the touches, compute the calibration
WiredHome	81:01da2e34283d	1344	/// matrix, and optionally provide the calibration matrix to the calling code
WiredHome	81:01da2e34283d	1345	/// for persistence in non-volatile memory.
WiredHome	81:01da2e34283d	1346	///
WiredHome	81:01da2e34283d	1347	/// @param[in] msg is a text message to present on the screen during the
WiredHome	81:01da2e34283d	1348	/// calibration process.
WiredHome	190:3132b7dfad82	1349	/// @param[out] matrix is an optional parameter to hold the calibration matrix
WiredHome	190:3132b7dfad82	1350	/// as a result of the calibration. This can be saved in
WiredHome	81:01da2e34283d	1351	/// non-volatile memory to recover the calibration after a power fail.
WiredHome	88:bfddef6ec836	1352	/// @param[in] maxwait_s is the maximum number of seconds to wait for a touch
WiredHome	88:bfddef6ec836	1353	/// calibration. If no touch panel installed, it then reports
WiredHome	155:b3f225ae572c	1354	/// touch_cal_timeout. Default: 30 s.
WiredHome	167:8aa3fb2a5a31	1355	/// @returns @ref RetCode_t value.
WiredHome	81:01da2e34283d	1356	///
WiredHome	155:b3f225ae572c	1357	RetCode_t TouchPanelCalibrate(const char * msg, tpMatrix_t * matrix = NULL, int maxwait_s = 30);
WiredHome	77:9206c13aa527	1358
WiredHome	125:7a0b70f56550	1359
WiredHome	157:1565f38ca44b	1360	/// Set the calibration matrix for the resistive touch panel.
WiredHome	77:9206c13aa527	1361	///
WiredHome	77:9206c13aa527	1362	/// This method is used to set the calibration matrix for the touch panel. After
WiredHome	106:c80828f5dea4	1363	/// performing the calibration (See @ref TouchPanelComputeCalibration), the matrix can be stored.
WiredHome	77:9206c13aa527	1364	/// On a subsequence power cycle, the matrix may be restored from non-volatile and
WiredHome	77:9206c13aa527	1365	/// passed in to this method. It will then be held to perform the corrections when
WiredHome	77:9206c13aa527	1366	/// reading the touch panel point.
WiredHome	77:9206c13aa527	1367	///
WiredHome	78:faf49c381591	1368	/// @code
WiredHome	78:faf49c381591	1369	/// FILE * fh = fopen("/local/tpmatrix.cfg", "r");
WiredHome	78:faf49c381591	1370	/// if (fh) {
WiredHome	78:faf49c381591	1371	/// tpMatrix_t matrix;
WiredHome	78:faf49c381591	1372	/// if (fread(fh, &matrix, sizeof(tpMatrix_t))) {
WiredHome	78:faf49c381591	1373	/// lcd.TouchPanelSetMatrix(&matrix);
WiredHome	78:faf49c381591	1374	/// }
WiredHome	78:faf49c381591	1375	/// fclose(fh);
WiredHome	78:faf49c381591	1376	/// }
WiredHome	78:faf49c381591	1377	/// @endcode
WiredHome	190:3132b7dfad82	1378	///
WiredHome	77:9206c13aa527	1379	/// @param[in] matrix is a pointer to the touch panel calibration matrix.
WiredHome	167:8aa3fb2a5a31	1380	/// @returns @ref RetCode_t value.
WiredHome	77:9206c13aa527	1381	///
WiredHome	190:3132b7dfad82	1382	///
WiredHome	77:9206c13aa527	1383	RetCode_t TouchPanelSetMatrix(tpMatrix_t * matrix);
WiredHome	157:1565f38ca44b	1384
WiredHome	157:1565f38ca44b	1385	/// Get the calibration matrix for the resistive touch panel.
WiredHome	157:1565f38ca44b	1386	///
WiredHome	157:1565f38ca44b	1387	/// This method returns a const pointer to the matrix. If this matrix has
WiredHome	157:1565f38ca44b	1388	/// not be set, with either the TouchPanelSetMatrix API or the calibration
WiredHome	157:1565f38ca44b	1389	/// process, the results are indeterminate.
WiredHome	157:1565f38ca44b	1390	///
WiredHome	157:1565f38ca44b	1391	/// return const tpMatrix_t pointer
WiredHome	190:3132b7dfad82	1392	///
WiredHome	157:1565f38ca44b	1393	const tpMatrix_t * TouchPanelGetMatrix();
WiredHome	125:7a0b70f56550	1394
WiredHome	75:ca78388cfd77	1395	#if 0
hexley	54:e117ad10fba6	1396	/// Append interrupt handler for specific RA8875 interrupt source
hexley	54:e117ad10fba6	1397	///
hexley	54:e117ad10fba6	1398	/// @param[in] bISRType Interrupt Source, should be:
hexley	54:e117ad10fba6	1399	/// - RA8875_INT_KEYSCAN: KEYCAN interrupt
hexley	54:e117ad10fba6	1400	/// - RA8875_INT_DMA: DMA interrupt
hexley	54:e117ad10fba6	1401	/// - RA8875_INT_TP: Touch panel interrupt
hexley	54:e117ad10fba6	1402	/// - RA8875_INT_BTE: BTE process complete interrupt
WiredHome	190:3132b7dfad82	1403	/// - RA8875_INT_BTEMCU_FONTWR: Multi-purpose interrupt (see spec sheet)
WiredHome	56:7a85d226ad0d	1404	/// @param[in] fptr is a callback function to handle the interrupt event.
WiredHome	56:7a85d226ad0d	1405	/// @returns none
hexley	54:e117ad10fba6	1406	///
hexley	54:e117ad10fba6	1407	void AppendISR(uint8_t bISRType, void(*fptr)(void));
hexley	54:e117ad10fba6	1408
hexley	54:e117ad10fba6	1409	/// Unappend interrupt handler for specific RA8875 interrupt source
hexley	54:e117ad10fba6	1410	///
hexley	54:e117ad10fba6	1411	/// @param[in] bISRType Interrupt Source, should be:
hexley	54:e117ad10fba6	1412	/// - RA8875_INT_KEYSCAN: KEYCAN interrupt
hexley	54:e117ad10fba6	1413	/// - RA8875_INT_DMA: DMA interrupt
hexley	54:e117ad10fba6	1414	/// - RA8875_INT_TP: Touch panel interrupt
hexley	54:e117ad10fba6	1415	/// - RA8875_INT_BTE: BTE process complete interrupt
WiredHome	190:3132b7dfad82	1416	/// - RA8875_INT_BTEMCU_FONTWR: Multi-purpose interrupt (see spec sheet)
hexley	54:e117ad10fba6	1417	/// @return none
hexley	54:e117ad10fba6	1418	///
hexley	54:e117ad10fba6	1419	void UnAppendISR(uint8_t bISRType);
WiredHome	75:ca78388cfd77	1420	#endif
WiredHome	77:9206c13aa527	1421
WiredHome	125:7a0b70f56550	1422
WiredHome	71:dcac8efd842d	1423	/// Initialize the keypad interface on the RA8875 controller.
WiredHome	71:dcac8efd842d	1424	///
WiredHome	71:dcac8efd842d	1425	/// Enables the keypad subsystem. It will scan the 4 x 5 matrix
WiredHome	182:8832d03a2a29	1426	/// and make available key presses. See also @ref SetKeyMap().
WiredHome	71:dcac8efd842d	1427	///
WiredHome	71:dcac8efd842d	1428	/// @note See section 5-13 of RAIO RA8875 data sheet for more details.
WiredHome	125:7a0b70f56550	1429	/// @note When using the display from buy-display.com, be sure that
WiredHome	71:dcac8efd842d	1430	/// the option for the keypad is configured on the hardware.
WiredHome	71:dcac8efd842d	1431	///
WiredHome	71:dcac8efd842d	1432	/// All parameters are optional.
WiredHome	76:c981284eb513	1433	/// @param[in] scanEnable when true, enables the key scan function (default: true).
WiredHome	76:c981284eb513	1434	/// @param[in] longDetect when true, additionally enables the long key held detection (default: false).
WiredHome	71:dcac8efd842d	1435	/// @param[in] sampleTime setting (range: 0 - 3, default: 0).
WiredHome	71:dcac8efd842d	1436	/// @param[in] scanFrequency setting (range: 0 - 7, default: 0).
WiredHome	71:dcac8efd842d	1437	/// @param[in] longTimeAdjustment (range: 0 - 3, default: 0).
WiredHome	76:c981284eb513	1438	/// @param[in] interruptEnable when true, enables interrupts from keypress (default: false).
WiredHome	76:c981284eb513	1439	/// @param[in] wakeupEnable when true, activates the wakeup function (default: false).
WiredHome	71:dcac8efd842d	1440	///
WiredHome	167:8aa3fb2a5a31	1441	/// @returns @ref RetCode_t value.
WiredHome	71:dcac8efd842d	1442	///
WiredHome	190:3132b7dfad82	1443	RetCode_t KeypadInit(bool scanEnable = true, bool longDetect = false,
WiredHome	190:3132b7dfad82	1444	uint8_t sampleTime = 0, uint8_t scanFrequency = 0,
WiredHome	71:dcac8efd842d	1445	uint8_t longTimeAdjustment = 0,
WiredHome	71:dcac8efd842d	1446	bool interruptEnable = false, bool wakeupEnable = false);
WiredHome	71:dcac8efd842d	1447
WiredHome	125:7a0b70f56550	1448
WiredHome	75:ca78388cfd77	1449	/// Create Key Code definitions for the key matrix.
WiredHome	75:ca78388cfd77	1450	///
WiredHome	75:ca78388cfd77	1451	/// This API provides a table of 22 key-code assignments for the matrix of keys.
WiredHome	182:8832d03a2a29	1452	/// See also KeypadInit().
WiredHome	75:ca78388cfd77	1453	/// This can be used to translate the keys 1 - 20 into some other value, as
WiredHome	75:ca78388cfd77	1454	/// well as to communicate the "no key" (zero) and "error state" (21).
WiredHome	75:ca78388cfd77	1455	///
WiredHome	75:ca78388cfd77	1456	/// In this way, a keypad could easily emulate a piece of a keyboard, transforming
WiredHome	75:ca78388cfd77	1457	/// 0 - 20 into the values 0, '0', '1', '2', '3', '4', '5', '6', '7', '8',
WiredHome	125:7a0b70f56550	1458	/// '9', '+', '-', '*' , '/', '=', '(bs)', '(cr)', and so on...
WiredHome	75:ca78388cfd77	1459	///
WiredHome	75:ca78388cfd77	1460	/// @code
WiredHome	75:ca78388cfd77	1461	/// // Return Value by Row, Column Example reassignment
WiredHome	190:3132b7dfad82	1462	/// // Column 0 1 2 3 4
WiredHome	75:ca78388cfd77	1463	/// // +-------------------------+ +-------------------------+
WiredHome	76:c981284eb513	1464	/// // Row 0 \| 1 2 3 4 5 \| \| '7' '8' '9' ',' '<-' \|
WiredHome	75:ca78388cfd77	1465	/// // 1 \| 6 7 8 9 10 \| \| '4' '5' '6' '/' '-' \|
WiredHome	75:ca78388cfd77	1466	/// // 2 \| 11 12 13 14 15 \| \| '1' '2' '3' '*' '+' \|
WiredHome	76:c981284eb513	1467	/// // 3 \| 16 17 18 19 20 \| \| '0' '.' '(' ')' '\n' \|
WiredHome	75:ca78388cfd77	1468	/// // +-------------------------+ +-------------------------+
WiredHome	75:ca78388cfd77	1469	/// // Return value 0 = No Key pressed
WiredHome	75:ca78388cfd77	1470	/// // Return value 21 = Error
WiredHome	190:3132b7dfad82	1471	/// const uint8_t CodeList[22] =
WiredHome	190:3132b7dfad82	1472	/// {0, '7', '8', '9', ',', '\h',
WiredHome	77:9206c13aa527	1473	/// '4', '5', '6', '/', '-',
WiredHome	77:9206c13aa527	1474	/// '1', '2', '3', '*', '+',
WiredHome	190:3132b7dfad82	1475	/// '0', '.', '(', ')', '\n',
WiredHome	77:9206c13aa527	1476	/// '\x1b'};
WiredHome	77:9206c13aa527	1477	/// lcd.SetKeyMap(CodeList);
WiredHome	75:ca78388cfd77	1478	/// @endcode
WiredHome	190:3132b7dfad82	1479	///
WiredHome	190:3132b7dfad82	1480	/// @param[in] CodeList is a pointer to an always available byte-array
WiredHome	190:3132b7dfad82	1481	/// where the first 22 bytes are used as the transformation
WiredHome	75:ca78388cfd77	1482	/// from raw code to your reassigned value.
WiredHome	75:ca78388cfd77	1483	/// If CodeList is NULL, the original raw value key map is
WiredHome	75:ca78388cfd77	1484	/// restored.
WiredHome	167:8aa3fb2a5a31	1485	/// @returns @ref RetCode_t value.
WiredHome	75:ca78388cfd77	1486	///
WiredHome	75:ca78388cfd77	1487	RetCode_t SetKeyMap(const uint8_t * CodeList = NULL);
WiredHome	75:ca78388cfd77	1488
WiredHome	125:7a0b70f56550	1489
WiredHome	71:dcac8efd842d	1490	/// Determine if a key has been hit
WiredHome	71:dcac8efd842d	1491	///
WiredHome	71:dcac8efd842d	1492	/// @returns true if a key has been hit
WiredHome	71:dcac8efd842d	1493	///
WiredHome	75:ca78388cfd77	1494	bool readable();
WiredHome	71:dcac8efd842d	1495
WiredHome	125:7a0b70f56550	1496
WiredHome	71:dcac8efd842d	1497	/// Blocking read of the keypad.
WiredHome	71:dcac8efd842d	1498	///
WiredHome	125:7a0b70f56550	1499	/// @note: This is a blocking read, so it is important to first call _kbhit()
WiredHome	71:dcac8efd842d	1500	/// to avoid hanging your processes.
WiredHome	71:dcac8efd842d	1501	///
WiredHome	71:dcac8efd842d	1502	/// A keypad connected to the RA8875 is connected in a matrix of 4 rows and 5 columns.
WiredHome	75:ca78388cfd77	1503	/// When pressed, this method will return a code in the range of 1 through 20, reserving
WiredHome	75:ca78388cfd77	1504	/// the value 0 to indicate that no key is pressed.
WiredHome	71:dcac8efd842d	1505	///
WiredHome	71:dcac8efd842d	1506	/// Additionally, if configured to detect a "long press", bit 7 will be set to indicate
WiredHome	71:dcac8efd842d	1507	/// this. In this situation, first a "normal press" would be detected and signaled and
WiredHome	71:dcac8efd842d	1508	/// soon after that a "long press" of the same key would be detected and communicated.
WiredHome	71:dcac8efd842d	1509	///
WiredHome	75:ca78388cfd77	1510	/// @return 8-bit where bit 7 indicates a long press. The remaining bits indicate the
WiredHome	75:ca78388cfd77	1511	/// keypress using 0 = no key pressed, 1 - 20 = the key pressed.
WiredHome	71:dcac8efd842d	1512	///
WiredHome	75:ca78388cfd77	1513	uint8_t getc();
WiredHome	190:3132b7dfad82	1514
WiredHome	190:3132b7dfad82	1515
WiredHome	190:3132b7dfad82	1516	/// Align one rectangle against another.
WiredHome	190:3132b7dfad82	1517	///
WiredHome	190:3132b7dfad82	1518	/// This will accept a rectangle to align and align it against another rectangle.
WiredHome	190:3132b7dfad82	1519	/// It would be most typical if the rectangle to align is smaller than the reference rectangle.
WiredHome	190:3132b7dfad82	1520	///
WiredHome	190:3132b7dfad82	1521	/// @param[in] toAlign is a rectangular region to align against another.
WiredHome	190:3132b7dfad82	1522	/// @param[in] inRect is a rectangle to align against.
WiredHome	190:3132b7dfad82	1523	/// @param[in] v specifies the vertical alignment - top, middle, bottom.
WiredHome	190:3132b7dfad82	1524	/// @param[in] h specified the horizontal alignment - left, center, right.
WiredHome	190:3132b7dfad82	1525	/// @returns a new rectangle, the size of the toAlign.
WiredHome	190:3132b7dfad82	1526	///
WiredHome	190:3132b7dfad82	1527	rect_t AlignRectInRect(rect_t toAlign, rect_t inRect, valign_t v, halign_t h);
WiredHome	190:3132b7dfad82	1528
WiredHome	82:f7d300f26540	1529	/// Determine if a point is within a rectangle.
WiredHome	82:f7d300f26540	1530	///
WiredHome	82:f7d300f26540	1531	/// @param[in] rect is a rectangular region to use.
WiredHome	82:f7d300f26540	1532	/// @param[in] p is a point to analyze to see if it is within the rect.
WiredHome	82:f7d300f26540	1533	/// @returns true if p is within rect.
WiredHome	82:f7d300f26540	1534	///
WiredHome	82:f7d300f26540	1535	bool Intersect(rect_t rect, point_t p);
WiredHome	82:f7d300f26540	1536
WiredHome	131:5bd6ba2ee4a1	1537	/// Determine if a rectangle intersects another rectangle.
WiredHome	131:5bd6ba2ee4a1	1538	///
WiredHome	131:5bd6ba2ee4a1	1539	/// @param[in] rect1 is a rectangular region.
WiredHome	131:5bd6ba2ee4a1	1540	/// @param[in] rect2 is a second rectangular region.
WiredHome	147:3494792458d9	1541	/// @returns true if any part of rect2 intersects rect1.
WiredHome	131:5bd6ba2ee4a1	1542	///
WiredHome	131:5bd6ba2ee4a1	1543	bool Intersect(rect_t rect1, rect_t rect2);
WiredHome	190:3132b7dfad82	1544
WiredHome	147:3494792458d9	1545	/// Determine if a rectangle intersects another rectangle and provides
WiredHome	147:3494792458d9	1546	/// the area of intersection.
WiredHome	147:3494792458d9	1547	///
WiredHome	147:3494792458d9	1548	/// @code
WiredHome	147:3494792458d9	1549	/// +---------------------+
WiredHome	147:3494792458d9	1550	/// \| rect1 \|
WiredHome	147:3494792458d9	1551	/// \| \|
WiredHome	147:3494792458d9	1552	/// \| +------------------+
WiredHome	147:3494792458d9	1553	/// \| \| rect3 \| \|
WiredHome	147:3494792458d9	1554	/// \| \| \| \|
WiredHome	147:3494792458d9	1555	/// +---------------------+ \|
WiredHome	147:3494792458d9	1556	/// \| rect2 \|
WiredHome	147:3494792458d9	1557	/// +------------------+
WiredHome	147:3494792458d9	1558	/// @endcode
WiredHome	147:3494792458d9	1559	///
WiredHome	190:3132b7dfad82	1560	/// @note that the first parameter is a pointer to a rect and the
WiredHome	147:3494792458d9	1561	///
WiredHome	147:3494792458d9	1562	/// @param[inout] pRect1 is a pointer to a rectangular region, and returns
WiredHome	147:3494792458d9	1563	/// the area of intersection.
WiredHome	147:3494792458d9	1564	/// @param[in] pRect2 is a pointer to a second rectangular region.
WiredHome	147:3494792458d9	1565	/// @returns true if pRect1 and pRect2 intersect and pRect1 is written with
WiredHome	147:3494792458d9	1566	/// the rectangle describing the intersection.
WiredHome	147:3494792458d9	1567	///
WiredHome	167:8aa3fb2a5a31	1568	bool Intersect(rect_t * pRect1, const rect_t * pRect2);
WiredHome	190:3132b7dfad82	1569
WiredHome	190:3132b7dfad82	1570
WiredHome	38:38d503b4fad6	1571	/// Write a command to the display with a word of data.
WiredHome	38:38d503b4fad6	1572	///
WiredHome	38:38d503b4fad6	1573	/// This is a high level command, and may invoke several primitives.
WiredHome	38:38d503b4fad6	1574	///
WiredHome	72:ecffe56af969	1575	/// @param[in] command is the command to write.
WiredHome	72:ecffe56af969	1576	/// @param[in] data is data to be written to the command register.
WiredHome	167:8aa3fb2a5a31	1577	/// @returns @ref RetCode_t value.
WiredHome	38:38d503b4fad6	1578	///
WiredHome	38:38d503b4fad6	1579	RetCode_t WriteCommandW(uint8_t command, uint16_t data);
WiredHome	38:38d503b4fad6	1580
WiredHome	125:7a0b70f56550	1581
WiredHome	19:3f82c1161fd2	1582	/// Write a command to the display
WiredHome	19:3f82c1161fd2	1583	///
WiredHome	19:3f82c1161fd2	1584	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1585	///
WiredHome	72:ecffe56af969	1586	/// @param[in] command is the command to write.
WiredHome	72:ecffe56af969	1587	/// @param[in] data is optional data to be written to the command register
WiredHome	19:3f82c1161fd2	1588	/// and only occurs if the data is in the range [0 - 0xFF].
WiredHome	167:8aa3fb2a5a31	1589	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1590	///
WiredHome	32:0e4f2ae512e2	1591	virtual RetCode_t WriteCommand(unsigned char command, unsigned int data = 0xFFFF);
WiredHome	125:7a0b70f56550	1592
WiredHome	190:3132b7dfad82	1593
WiredHome	38:38d503b4fad6	1594	/// Write a data word to the display
WiredHome	38:38d503b4fad6	1595	///
WiredHome	38:38d503b4fad6	1596	/// This is a high level command, and may invoke several primitives.
WiredHome	38:38d503b4fad6	1597	///
WiredHome	72:ecffe56af969	1598	/// @param[in] data is the data to write.
WiredHome	167:8aa3fb2a5a31	1599	/// @returns @ref RetCode_t value.
WiredHome	38:38d503b4fad6	1600	///
WiredHome	38:38d503b4fad6	1601	RetCode_t WriteDataW(uint16_t data);
WiredHome	125:7a0b70f56550	1602
WiredHome	190:3132b7dfad82	1603
WiredHome	19:3f82c1161fd2	1604	/// Write a data byte to the display
WiredHome	19:3f82c1161fd2	1605	///
WiredHome	19:3f82c1161fd2	1606	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1607	///
WiredHome	72:ecffe56af969	1608	/// @param[in] data is the data to write.
WiredHome	167:8aa3fb2a5a31	1609	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1610	///
WiredHome	32:0e4f2ae512e2	1611	virtual RetCode_t WriteData(unsigned char data);
WiredHome	125:7a0b70f56550	1612
WiredHome	190:3132b7dfad82	1613
WiredHome	19:3f82c1161fd2	1614	/// Read a command register
WiredHome	19:3f82c1161fd2	1615	///
WiredHome	72:ecffe56af969	1616	/// @param[in] command is the command register to read.
WiredHome	19:3f82c1161fd2	1617	/// @returns the value read from the register.
WiredHome	19:3f82c1161fd2	1618	///
WiredHome	19:3f82c1161fd2	1619	unsigned char ReadCommand(unsigned char command);
WiredHome	136:224e03d5c31f	1620
WiredHome	136:224e03d5c31f	1621
WiredHome	136:224e03d5c31f	1622	/// Read a word from a command register
WiredHome	136:224e03d5c31f	1623	///
WiredHome	136:224e03d5c31f	1624	/// @param[in] command is the command register to read.
WiredHome	136:224e03d5c31f	1625	/// @returns the value read from the register.
WiredHome	136:224e03d5c31f	1626	///
WiredHome	136:224e03d5c31f	1627	uint16_t ReadCommandW(unsigned char command);
WiredHome	190:3132b7dfad82	1628
WiredHome	190:3132b7dfad82	1629
WiredHome	41:2956a0a221e5	1630	/// Read a data byte from the display
WiredHome	19:3f82c1161fd2	1631	///
WiredHome	19:3f82c1161fd2	1632	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1633	///
WiredHome	19:3f82c1161fd2	1634	/// @returns data that was read.
WiredHome	19:3f82c1161fd2	1635	///
WiredHome	19:3f82c1161fd2	1636	unsigned char ReadData(void);
WiredHome	125:7a0b70f56550	1637
WiredHome	190:3132b7dfad82	1638
WiredHome	41:2956a0a221e5	1639	/// Read a word from the display
WiredHome	41:2956a0a221e5	1640	///
WiredHome	41:2956a0a221e5	1641	/// This is a high level command, and may invoke several primitives.
WiredHome	41:2956a0a221e5	1642	///
WiredHome	41:2956a0a221e5	1643	/// @returns data that was read.
WiredHome	41:2956a0a221e5	1644	///
WiredHome	41:2956a0a221e5	1645	uint16_t ReadDataW(void);
WiredHome	41:2956a0a221e5	1646
WiredHome	125:7a0b70f56550	1647
WiredHome	19:3f82c1161fd2	1648	/// Read the display status
WiredHome	19:3f82c1161fd2	1649	///
WiredHome	19:3f82c1161fd2	1650	/// This is a high level command, and may invoke several primitives.
WiredHome	19:3f82c1161fd2	1651	///
WiredHome	19:3f82c1161fd2	1652	/// @returns data that was read.
WiredHome	19:3f82c1161fd2	1653	///
WiredHome	19:3f82c1161fd2	1654	unsigned char ReadStatus(void);
WiredHome	19:3f82c1161fd2	1655
WiredHome	125:7a0b70f56550	1656
WiredHome	19:3f82c1161fd2	1657	/// get the width in pixels of the currently active font
WiredHome	19:3f82c1161fd2	1658	///
WiredHome	19:3f82c1161fd2	1659	/// @returns font width in pixels.
WiredHome	190:3132b7dfad82	1660	///
WiredHome	37:f19b7e7449dc	1661	dim_t fontwidth(void);
WiredHome	190:3132b7dfad82	1662
WiredHome	125:7a0b70f56550	1663
WiredHome	19:3f82c1161fd2	1664	/// get the height in pixels of the currently active font
WiredHome	19:3f82c1161fd2	1665	///
WiredHome	19:3f82c1161fd2	1666	/// @returns font height in pixels.
WiredHome	190:3132b7dfad82	1667	///
WiredHome	37:f19b7e7449dc	1668	dim_t fontheight(void);
WiredHome	125:7a0b70f56550	1669
WiredHome	190:3132b7dfad82	1670
WiredHome	19:3f82c1161fd2	1671	/// get the number of colums based on the currently active font
WiredHome	19:3f82c1161fd2	1672	///
WiredHome	19:3f82c1161fd2	1673	/// @returns number of columns.
WiredHome	190:3132b7dfad82	1674	///
WiredHome	19:3f82c1161fd2	1675	virtual int columns(void);
WiredHome	19:3f82c1161fd2	1676
WiredHome	125:7a0b70f56550	1677
WiredHome	19:3f82c1161fd2	1678	/// get the number of rows based on the currently active font
WiredHome	19:3f82c1161fd2	1679	///
WiredHome	19:3f82c1161fd2	1680	/// @returns number of rows.
WiredHome	190:3132b7dfad82	1681	///
WiredHome	19:3f82c1161fd2	1682	virtual int rows(void);
WiredHome	19:3f82c1161fd2	1683
WiredHome	125:7a0b70f56550	1684
WiredHome	19:3f82c1161fd2	1685	/// get the screen width in pixels
WiredHome	19:3f82c1161fd2	1686	///
WiredHome	19:3f82c1161fd2	1687	/// @returns screen width in pixels.
WiredHome	19:3f82c1161fd2	1688	///
WiredHome	38:38d503b4fad6	1689	virtual dim_t width(void);
WiredHome	19:3f82c1161fd2	1690
WiredHome	125:7a0b70f56550	1691
WiredHome	19:3f82c1161fd2	1692	/// get the screen height in pixels
WiredHome	19:3f82c1161fd2	1693	///
WiredHome	19:3f82c1161fd2	1694	/// @returns screen height in pixels.
WiredHome	19:3f82c1161fd2	1695	///
WiredHome	38:38d503b4fad6	1696	virtual dim_t height(void);
WiredHome	19:3f82c1161fd2	1697
WiredHome	125:7a0b70f56550	1698
WiredHome	43:3becae133285	1699	/// get the color depth in bits per pixel.
WiredHome	43:3becae133285	1700	///
WiredHome	43:3becae133285	1701	/// @returns 8 or 16 only.
WiredHome	43:3becae133285	1702	///
WiredHome	43:3becae133285	1703	virtual dim_t color_bpp(void);
WiredHome	43:3becae133285	1704
WiredHome	19:3f82c1161fd2	1705	/// Set cursor position based on the current font size.
WiredHome	190:3132b7dfad82	1706	///
WiredHome	72:ecffe56af969	1707	/// @param[in] column is the horizontal position in character positions
WiredHome	72:ecffe56af969	1708	/// @param[in] row is the vertical position in character positions
WiredHome	167:8aa3fb2a5a31	1709	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1710	///
WiredHome	37:f19b7e7449dc	1711	virtual RetCode_t locate(textloc_t column, textloc_t row);
WiredHome	19:3f82c1161fd2	1712
WiredHome	190:3132b7dfad82	1713	/// Enable word-wrap in _puts()
WiredHome	190:3132b7dfad82	1714	///
WiredHome	190:3132b7dfad82	1715	/// @todo Consider adding a method to define the word-delimiters, which could then
WiredHome	190:3132b7dfad82	1716	/// include user-selection of characters (e.g. ' ', '-', ';', and so on).
WiredHome	190:3132b7dfad82	1717	///
WiredHome	190:3132b7dfad82	1718	/// @param[in] _wordwrap when true controls _puts() to wrap on word-boundary, which
WiredHome	190:3132b7dfad82	1719	/// is delimited by 'space' character or 'cr' 'lf' sequences.
WiredHome	190:3132b7dfad82	1720	/// @returns previous wordwrap setting to permit an easy restore.
WiredHome	190:3132b7dfad82	1721	///
WiredHome	190:3132b7dfad82	1722	bool SetWordWrap(bool _wordwrap);
WiredHome	190:3132b7dfad82	1723
WiredHome	125:7a0b70f56550	1724
WiredHome	19:3f82c1161fd2	1725	/// Prepare the controller to write text to the screen by positioning
WiredHome	19:3f82c1161fd2	1726	/// the cursor.
WiredHome	19:3f82c1161fd2	1727	///
WiredHome	56:7a85d226ad0d	1728	/// @code
WiredHome	56:7a85d226ad0d	1729	/// lcd.SetTextCursor(100, 25);
WiredHome	56:7a85d226ad0d	1730	/// lcd.puts("Hello");
WiredHome	56:7a85d226ad0d	1731	/// @endcode
WiredHome	56:7a85d226ad0d	1732	///
WiredHome	72:ecffe56af969	1733	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	1734	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	167:8aa3fb2a5a31	1735	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1736	///
WiredHome	37:f19b7e7449dc	1737	RetCode_t SetTextCursor(loc_t x, loc_t y);
WiredHome	29:422616aa04bd	1738
WiredHome	125:7a0b70f56550	1739
WiredHome	103:7e0464ca6c5c	1740	/// Prepare the controller to write text to the screen by positioning
WiredHome	103:7e0464ca6c5c	1741	/// the cursor.
WiredHome	103:7e0464ca6c5c	1742	///
WiredHome	103:7e0464ca6c5c	1743	/// @code
WiredHome	103:7e0464ca6c5c	1744	/// point_t point = {100, 25};
WiredHome	103:7e0464ca6c5c	1745	/// lcd.SetTextCursor(point);
WiredHome	103:7e0464ca6c5c	1746	/// lcd.puts("Hello");
WiredHome	103:7e0464ca6c5c	1747	/// @endcode
WiredHome	103:7e0464ca6c5c	1748	///
WiredHome	103:7e0464ca6c5c	1749	/// @param[in] p is the x:y point in pixels from the top-left.
WiredHome	167:8aa3fb2a5a31	1750	/// @returns @ref RetCode_t value.
WiredHome	103:7e0464ca6c5c	1751	///
WiredHome	103:7e0464ca6c5c	1752	RetCode_t SetTextCursor(point_t p);
WiredHome	103:7e0464ca6c5c	1753
WiredHome	125:7a0b70f56550	1754
WiredHome	37:f19b7e7449dc	1755	/// Get the current cursor position in pixels.
WiredHome	37:f19b7e7449dc	1756	///
WiredHome	56:7a85d226ad0d	1757	/// @code
WiredHome	56:7a85d226ad0d	1758	/// point_t point = GetTextCursor();
WiredHome	56:7a85d226ad0d	1759	/// if (point.x > 100 && point.y > 150)
WiredHome	56:7a85d226ad0d	1760	/// //...
WiredHome	56:7a85d226ad0d	1761	/// @endcode
WiredHome	56:7a85d226ad0d	1762	///
WiredHome	37:f19b7e7449dc	1763	/// @returns cursor position.
WiredHome	37:f19b7e7449dc	1764	///
WiredHome	37:f19b7e7449dc	1765	point_t GetTextCursor(void);
WiredHome	190:3132b7dfad82	1766
WiredHome	125:7a0b70f56550	1767
WiredHome	29:422616aa04bd	1768	/// Get the current cursor horizontal position in pixels.
WiredHome	29:422616aa04bd	1769	///
WiredHome	29:422616aa04bd	1770	/// @returns cursor position horizontal offset.
WiredHome	29:422616aa04bd	1771	///
WiredHome	37:f19b7e7449dc	1772	loc_t GetTextCursor_X(void);
WiredHome	29:422616aa04bd	1773
WiredHome	125:7a0b70f56550	1774
WiredHome	29:422616aa04bd	1775	/// Get the current cursor vertical position in pixels.
WiredHome	29:422616aa04bd	1776	///
WiredHome	29:422616aa04bd	1777	/// @returns cursor position vertical offset.
WiredHome	29:422616aa04bd	1778	///
WiredHome	37:f19b7e7449dc	1779	loc_t GetTextCursor_Y(void);
WiredHome	29:422616aa04bd	1780
WiredHome	125:7a0b70f56550	1781
WiredHome	23:a50ded45dbaf	1782	/// Configure additional Cursor Control settings.
WiredHome	23:a50ded45dbaf	1783	///
WiredHome	190:3132b7dfad82	1784	/// This API lets you modify other cursor control settings;
WiredHome	190:3132b7dfad82	1785	/// Cursor visible/hidden, Cursor blink/normal,
WiredHome	23:a50ded45dbaf	1786	/// Cursor I-Beam/underscore/box.
WiredHome	23:a50ded45dbaf	1787	///
WiredHome	72:ecffe56af969	1788	/// @param[in] cursor can be set to NOCURSOR (default), IBEAM,
WiredHome	24:8ca861acf12d	1789	/// UNDER, or BLOCK.
WiredHome	72:ecffe56af969	1790	/// @param[in] blink can be set to true or false (default false)
WiredHome	167:8aa3fb2a5a31	1791	/// @returns @ref RetCode_t value.
WiredHome	23:a50ded45dbaf	1792	///
WiredHome	24:8ca861acf12d	1793	RetCode_t SetTextCursorControl(cursor_t cursor = NOCURSOR, bool blink = false);
WiredHome	125:7a0b70f56550	1794
WiredHome	190:3132b7dfad82	1795
WiredHome	98:ecebed9b80b2	1796	/// Select the built-in ISO 8859-X font to use next.
WiredHome	19:3f82c1161fd2	1797	///
WiredHome	19:3f82c1161fd2	1798	/// Supported fonts: ISO 8859-1, -2, -3, -4
WiredHome	19:3f82c1161fd2	1799	///
WiredHome	125:7a0b70f56550	1800	/// @note This only modifies the choice of font from the RA8875 internal
WiredHome	98:ecebed9b80b2	1801	/// fonts.
WiredHome	98:ecebed9b80b2	1802	///
WiredHome	72:ecffe56af969	1803	/// @param[in] font selects the font for the subsequent text rendering.
WiredHome	19:3f82c1161fd2	1804	///
WiredHome	19:3f82c1161fd2	1805	/// @note if either hScale or vScale is outside of its permitted range,
WiredHome	19:3f82c1161fd2	1806	/// the command is not executed.
WiredHome	167:8aa3fb2a5a31	1807	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1808	///
WiredHome	19:3f82c1161fd2	1809	RetCode_t SetTextFont(font_t font = ISO8859_1);
WiredHome	190:3132b7dfad82	1810
WiredHome	125:7a0b70f56550	1811
WiredHome	191:0fad2e45e196	1812	/// Gets the display orientation
WiredHome	197:853d08e2fb53	1813	///
WiredHome	197:853d08e2fb53	1814
WiredHome	191:0fad2e45e196	1815	/// @returns the basic display orientationas an @ref orientation_t value.
WiredHome	191:0fad2e45e196	1816	///
WiredHome	191:0fad2e45e196	1817	orientation_t GetOrientation();
WiredHome	191:0fad2e45e196	1818
WiredHome	84:e102021864b5	1819	/// Sets the display orientation.
WiredHome	84:e102021864b5	1820	///
WiredHome	84:e102021864b5	1821	/// @note This command does not let you "merge" text onto an existing
WiredHome	84:e102021864b5	1822	/// image, since it reuses the memory for the new orientation.
WiredHome	84:e102021864b5	1823	/// Therefore, it is recommended that you issue a cls() prior
WiredHome	84:e102021864b5	1824	/// to sending text to the screen, or you end with a blended
WiredHome	84:e102021864b5	1825	/// image that is probably not as intended.
WiredHome	84:e102021864b5	1826	///
WiredHome	125:7a0b70f56550	1827	/// @note This command only operates on the RA8875 internal fonts.
WiredHome	98:ecebed9b80b2	1828	///
WiredHome	191:0fad2e45e196	1829	/// @note more sophisticated control of drawings with rotated text may
WiredHome	191:0fad2e45e196	1830	/// be achieved by direct control of the registers. See the RA8875
WiredHome	191:0fad2e45e196	1831	/// datasheet.
WiredHome	191:0fad2e45e196	1832	///
WiredHome	84:e102021864b5	1833	/// @code
WiredHome	84:e102021864b5	1834	/// lcd.cls();
WiredHome	84:e102021864b5	1835	/// lcd.SetOrientation(RA8875::normal);
WiredHome	84:e102021864b5	1836	/// lcd.puts(30,30, "Normal Landscape");
WiredHome	197:853d08e2fb53	1837	/// wait_us(2500000);
WiredHome	190:3132b7dfad82	1838	///
WiredHome	84:e102021864b5	1839	/// lcd.cls();
WiredHome	84:e102021864b5	1840	/// lcd.SetOrientation(RA8875::rotate_90);
WiredHome	84:e102021864b5	1841	/// lcd.puts(30,30, "Rotated 90 Text\r\n");
WiredHome	197:853d08e2fb53	1842	/// wait_us(2500000);
WiredHome	190:3132b7dfad82	1843	///
WiredHome	84:e102021864b5	1844	/// lcd.cls();
WiredHome	84:e102021864b5	1845	/// lcd.SetOrientation(RA8875::rotate_180);
WiredHome	84:e102021864b5	1846	/// lcd.puts(30,30, "Rotated 180 Text\r\n");
WiredHome	197:853d08e2fb53	1847	/// wait_us(2500000);
WiredHome	190:3132b7dfad82	1848	///
WiredHome	84:e102021864b5	1849	/// lcd.cls();
WiredHome	84:e102021864b5	1850	/// lcd.SetOrientation(RA8875::rotate_270);
WiredHome	84:e102021864b5	1851	/// lcd.puts(30,30, "Rotated 270 Text\r\n");
WiredHome	197:853d08e2fb53	1852	/// wait_us(2500000);
WiredHome	84:e102021864b5	1853	/// @endcode
WiredHome	84:e102021864b5	1854	///
WiredHome	84:e102021864b5	1855	/// @param[in] angle defaults to normal, but can be rotated
WiredHome	84:e102021864b5	1856	/// - normal \| rotate_0
WiredHome	84:e102021864b5	1857	/// - rotate_90 (clockwise)
WiredHome	84:e102021864b5	1858	/// - rotate_180
WiredHome	84:e102021864b5	1859	/// - rotate_270 (clockwise)
WiredHome	167:8aa3fb2a5a31	1860	/// @returns @ref RetCode_t value.
WiredHome	84:e102021864b5	1861	///
WiredHome	84:e102021864b5	1862	RetCode_t SetOrientation(orientation_t angle = normal);
WiredHome	190:3132b7dfad82	1863
WiredHome	125:7a0b70f56550	1864
WiredHome	19:3f82c1161fd2	1865	/// Control the font behavior.
WiredHome	19:3f82c1161fd2	1866	///
WiredHome	19:3f82c1161fd2	1867	/// This command lets you make several modifications to any text that
WiredHome	56:7a85d226ad0d	1868	/// will be written to the screen.
WiredHome	19:3f82c1161fd2	1869	///
WiredHome	125:7a0b70f56550	1870	/// @note This command only operates on the RA8875 internal fonts.
WiredHome	98:ecebed9b80b2	1871	///
WiredHome	19:3f82c1161fd2	1872	/// Options can be combined:
WiredHome	19:3f82c1161fd2	1873	/// Default:
WiredHome	190:3132b7dfad82	1874	/// @li Full alignment disabled,
WiredHome	190:3132b7dfad82	1875	/// @li Font with Background color,
WiredHome	84:e102021864b5	1876	/// @li Font in normal orientiation, or rotated 90, 180, or 270 clockwise,
WiredHome	84:e102021864b5	1877	/// @li Horizontal scale x 1, 2, 3, or 4
WiredHome	84:e102021864b5	1878	/// @li Vertical scale x 1, 2, 3, or 4
WiredHome	84:e102021864b5	1879	///
WiredHome	84:e102021864b5	1880	/// @note alignment is a special mode for the fonts, when mixing half and
WiredHome	84:e102021864b5	1881	/// full fonts on one presentation. 'align_full' starts each full
WiredHome	84:e102021864b5	1882	/// character on an even alignment. See section 7-4-7 of the RA8875
WiredHome	84:e102021864b5	1883	/// specification.
WiredHome	190:3132b7dfad82	1884	///
WiredHome	72:ecffe56af969	1885	/// @param[in] fillit defaults to FILL, but can be NOFILL
WiredHome	72:ecffe56af969	1886	/// @param[in] hScale defaults to 1, but can be 1, 2, 3, or 4,
WiredHome	19:3f82c1161fd2	1887	/// and scales the font size by this amount.
WiredHome	72:ecffe56af969	1888	/// @param[in] vScale defaults to 1, but can be 1, 2, 3, or 4,
WiredHome	19:3f82c1161fd2	1889	/// and scales the font size by this amount.
WiredHome	72:ecffe56af969	1890	/// @param[in] alignment defaults to align_none, but can be
WiredHome	19:3f82c1161fd2	1891	/// align_full.
WiredHome	190:3132b7dfad82	1892	///
WiredHome	19:3f82c1161fd2	1893	/// @note if either hScale or vScale is outside of its permitted range,
WiredHome	19:3f82c1161fd2	1894	/// the command is not executed.
WiredHome	167:8aa3fb2a5a31	1895	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1896	///
WiredHome	190:3132b7dfad82	1897	RetCode_t SetTextFontControl(fill_t fillit = FILL,
WiredHome	190:3132b7dfad82	1898	HorizontalScale hScale = 1,
WiredHome	190:3132b7dfad82	1899	VerticalScale vScale = 1,
WiredHome	19:3f82c1161fd2	1900	alignment_t alignment = align_none);
WiredHome	190:3132b7dfad82	1901
WiredHome	190:3132b7dfad82	1902
WiredHome	190:3132b7dfad82	1903	/// Control the font - to background fill or "ink-only"
WiredHome	190:3132b7dfad82	1904	///
WiredHome	190:3132b7dfad82	1905	/// This command configures the font presentation to write
WiredHome	190:3132b7dfad82	1906	/// only the font "ink", or to write the ink and also overwrite
WiredHome	190:3132b7dfad82	1907	/// the background with the background color.
WiredHome	190:3132b7dfad82	1908	///
WiredHome	190:3132b7dfad82	1909	/// @note This command applies only to the internal fonts not to user fonts
WiredHome	190:3132b7dfad82	1910	/// e.g. SelectUserFont(...) out of concerns for performance.
WiredHome	190:3132b7dfad82	1911	/// User fonts always write the character block as a continuous
WiredHome	190:3132b7dfad82	1912	/// stream (for efficiency). This precludes first reading the
WiredHome	190:3132b7dfad82	1913	/// character block before writing it. Alternately, addressing
WiredHome	190:3132b7dfad82	1914	/// individual pixels would also be a significant performance
WiredHome	190:3132b7dfad82	1915	/// impact.
WiredHome	190:3132b7dfad82	1916	///
WiredHome	190:3132b7dfad82	1917	/// @param[in] fillit set to FILL will also write the background,
WiredHome	190:3132b7dfad82	1918	/// and set to NOFILL will write only the ink.
WiredHome	190:3132b7dfad82	1919	/// @returns the previous fill setting permitting easy restore.
WiredHome	190:3132b7dfad82	1920	///
WiredHome	190:3132b7dfad82	1921	fill_t SetTextFontFill(fill_t fillit);
WiredHome	125:7a0b70f56550	1922
WiredHome	153:8a85efb3eb71	1923	/// Control the font size of the RA8875 rendered fonts.
WiredHome	19:3f82c1161fd2	1924	///
WiredHome	19:3f82c1161fd2	1925	/// This command lets you set the font enlargement for both horizontal
WiredHome	190:3132b7dfad82	1926	/// and vertical, independent of the rotation, background, and
WiredHome	106:c80828f5dea4	1927	/// alignment. See @ref SetTextFontControl.
WiredHome	19:3f82c1161fd2	1928	///
WiredHome	153:8a85efb3eb71	1929	/// @note This command operates on the RA8875 internal fonts.
WiredHome	153:8a85efb3eb71	1930	/// @note This command also operates on the selected soft font.
WiredHome	98:ecebed9b80b2	1931	///
WiredHome	72:ecffe56af969	1932	/// @param[in] hScale defaults to 1, but can be 1, 2, 3, or 4,
WiredHome	19:3f82c1161fd2	1933	/// and scales the font size by this amount.
WiredHome	190:3132b7dfad82	1934	/// @param[in] vScale is an optional parameter that defaults to the hScale value,
WiredHome	40:04aa280dfa39	1935	/// but can be 1, 2, 3, or 4, and scales the font size by this amount.
WiredHome	40:04aa280dfa39	1936	///
WiredHome	40:04aa280dfa39	1937	/// @code
WiredHome	40:04aa280dfa39	1938	/// lcd.SetTextFontSize(2); // Set the font to 2x normal size
WiredHome	56:7a85d226ad0d	1939	/// lcd.puts("Two times");
WiredHome	40:04aa280dfa39	1940	/// lcd.SetTextFontSize(2,3); // Set the font to 2x Width and 3x Height
WiredHome	56:7a85d226ad0d	1941	/// lcd.puts("22 3h");
WiredHome	40:04aa280dfa39	1942	/// lcd.SetTextFontSize(); // Restore to normal size in both dimensions
WiredHome	56:7a85d226ad0d	1943	/// lcd.puts("normal");
WiredHome	153:8a85efb3eb71	1944	/// lcd.SelectUserFont(BPG_Arial63x63); // Large user font
WiredHome	153:8a85efb3eb71	1945	/// lcd.puts("B63x63"); // Show a sample
WiredHome	153:8a85efb3eb71	1946	/// lcd.SetTextFontSize(2); // Now twice as big
WiredHome	153:8a85efb3eb71	1947	/// lcd.puts("x2"); // Show a sample
WiredHome	40:04aa280dfa39	1948	/// @endcode
WiredHome	19:3f82c1161fd2	1949	///
WiredHome	19:3f82c1161fd2	1950	/// @note if either hScale or vScale is outside of its permitted range,
WiredHome	19:3f82c1161fd2	1951	/// the command is not executed.
WiredHome	167:8aa3fb2a5a31	1952	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	1953	///
WiredHome	40:04aa280dfa39	1954	RetCode_t SetTextFontSize(HorizontalScale hScale = 1, VerticalScale vScale = -1);
WiredHome	127:db7f2c704693	1955
WiredHome	127:db7f2c704693	1956
WiredHome	127:db7f2c704693	1957	/// Get the text font size of the RA8875 internal fonts.
WiredHome	127:db7f2c704693	1958	///
WiredHome	127:db7f2c704693	1959	/// This command lets you retrieve the current settings for the font
WiredHome	190:3132b7dfad82	1960	/// horizontal and vertical scale factors. The return value is
WiredHome	127:db7f2c704693	1961	/// one of the scale factors 1, 2, 3, or 4.
WiredHome	127:db7f2c704693	1962	///
WiredHome	127:db7f2c704693	1963	/// @param[out] hScale is a pointer to memory where the horizontal scale factor
WiredHome	127:db7f2c704693	1964	/// will be written. If the pointer is null, that item will be ignored.
WiredHome	127:db7f2c704693	1965	/// @param[out] vScale is a pointer to memory where the vertical scale factor
WiredHome	127:db7f2c704693	1966	/// will be written. If the pointer is null, that item will be ignored.
WiredHome	167:8aa3fb2a5a31	1967	/// @returns @ref RetCode_t value.
WiredHome	127:db7f2c704693	1968	///
WiredHome	127:db7f2c704693	1969	RetCode_t GetTextFontSize(HorizontalScale * hScale, VerticalScale * vScale);
WiredHome	125:7a0b70f56550	1970
WiredHome	19:3f82c1161fd2	1971	/// put a character on the screen.
WiredHome	19:3f82c1161fd2	1972	///
WiredHome	190:3132b7dfad82	1973	/// @param[in] text is a pointer to a text string to evaluate.
WiredHome	190:3132b7dfad82	1974	/// @param[in] charOnly defaults to false, which computes over the whole string.
WiredHome	190:3132b7dfad82	1975	/// @returns width in pixels, given the selected font and scale.
WiredHome	190:3132b7dfad82	1976	///
WiredHome	190:3132b7dfad82	1977	dim_t GetTextWidth(const char * text, bool charOnly = false);
WiredHome	190:3132b7dfad82	1978
WiredHome	190:3132b7dfad82	1979
WiredHome	190:3132b7dfad82	1980	/// put a character on the screen.
WiredHome	190:3132b7dfad82	1981	///
WiredHome	72:ecffe56af969	1982	/// @param[in] c is the character.
WiredHome	19:3f82c1161fd2	1983	/// @returns the character, or EOF if there is an error.
WiredHome	19:3f82c1161fd2	1984	///
WiredHome	19:3f82c1161fd2	1985	virtual int _putc(int c);
WiredHome	19:3f82c1161fd2	1986
WiredHome	125:7a0b70f56550	1987
WiredHome	19:3f82c1161fd2	1988	/// Write string of text to the display
WiredHome	19:3f82c1161fd2	1989	///
WiredHome	56:7a85d226ad0d	1990	/// @code
WiredHome	56:7a85d226ad0d	1991	/// lcd.puts("Test STring");
WiredHome	56:7a85d226ad0d	1992	/// @endcode
WiredHome	56:7a85d226ad0d	1993	///
WiredHome	72:ecffe56af969	1994	/// @param[in] string is the null terminated string to send to the display.
WiredHome	19:3f82c1161fd2	1995	///
WiredHome	19:3f82c1161fd2	1996	void puts(const char * string);
WiredHome	125:7a0b70f56550	1997
WiredHome	190:3132b7dfad82	1998
WiredHome	19:3f82c1161fd2	1999	/// Write string of text to the display at the specified location.
WiredHome	19:3f82c1161fd2	2000	///
WiredHome	56:7a85d226ad0d	2001	/// @code
WiredHome	196:56820026701b	2002	/// const point_t pt = {10, 25};
WiredHome	196:56820026701b	2003	/// lcd.puts(pt, "Test STring");
WiredHome	196:56820026701b	2004	/// @endcode
WiredHome	196:56820026701b	2005	///
WiredHome	196:56820026701b	2006	/// @param[in] pt is the x,y position as a point
WiredHome	196:56820026701b	2007	/// @param[in] string is the null terminated string to send to the display.
WiredHome	196:56820026701b	2008	///
WiredHome	196:56820026701b	2009	void puts(point_t pt, const char * string);
WiredHome	196:56820026701b	2010
WiredHome	196:56820026701b	2011	/// Write string of text to the display at the specified location.
WiredHome	196:56820026701b	2012	///
WiredHome	196:56820026701b	2013	/// @code
WiredHome	56:7a85d226ad0d	2014	/// lcd.puts(10,25, "Test STring");
WiredHome	56:7a85d226ad0d	2015	/// @endcode
WiredHome	56:7a85d226ad0d	2016	///
WiredHome	72:ecffe56af969	2017	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	2018	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	72:ecffe56af969	2019	/// @param[in] string is the null terminated string to send to the display.
WiredHome	19:3f82c1161fd2	2020	///
WiredHome	37:f19b7e7449dc	2021	void puts(loc_t x, loc_t y, const char * string);
WiredHome	190:3132b7dfad82	2022
WiredHome	125:7a0b70f56550	2023
WiredHome	19:3f82c1161fd2	2024	/// Prepare the controller to write binary data to the screen by positioning
WiredHome	19:3f82c1161fd2	2025	/// the memory cursor.
WiredHome	19:3f82c1161fd2	2026	///
WiredHome	72:ecffe56af969	2027	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	2028	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	167:8aa3fb2a5a31	2029	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2030	///
WiredHome	37:f19b7e7449dc	2031	virtual RetCode_t SetGraphicsCursor(loc_t x, loc_t y);
WiredHome	125:7a0b70f56550	2032
WiredHome	136:224e03d5c31f	2033	/// Prepare the controller to write binary data to the screen by positioning
WiredHome	136:224e03d5c31f	2034	/// the memory cursor.
WiredHome	136:224e03d5c31f	2035	///
WiredHome	136:224e03d5c31f	2036	/// @param[in] p is the point representing the cursor position to set
WiredHome	167:8aa3fb2a5a31	2037	/// @returns @ref RetCode_t value.
WiredHome	136:224e03d5c31f	2038	///
WiredHome	136:224e03d5c31f	2039	virtual RetCode_t SetGraphicsCursor(point_t p);
WiredHome	190:3132b7dfad82	2040
WiredHome	136:224e03d5c31f	2041	/// Read the current graphics cursor position as a point.
WiredHome	136:224e03d5c31f	2042	///
WiredHome	136:224e03d5c31f	2043	/// @returns the graphics cursor as a point.
WiredHome	136:224e03d5c31f	2044	///
WiredHome	136:224e03d5c31f	2045	virtual point_t GetGraphicsCursor(void);
WiredHome	136:224e03d5c31f	2046
WiredHome	190:3132b7dfad82	2047
WiredHome	41:2956a0a221e5	2048	/// Prepare the controller to read binary data from the screen by positioning
WiredHome	41:2956a0a221e5	2049	/// the memory read cursor.
WiredHome	41:2956a0a221e5	2050	///
WiredHome	72:ecffe56af969	2051	/// @param[in] x is the horizontal position in pixels (from the left edge)
WiredHome	72:ecffe56af969	2052	/// @param[in] y is the vertical position in pixels (from the top edge)
WiredHome	167:8aa3fb2a5a31	2053	/// @returns @ref RetCode_t value.
WiredHome	41:2956a0a221e5	2054	///
WiredHome	41:2956a0a221e5	2055	virtual RetCode_t SetGraphicsCursorRead(loc_t x, loc_t y);
WiredHome	190:3132b7dfad82	2056
WiredHome	125:7a0b70f56550	2057
WiredHome	111:efe436c43aba	2058	/// Set the window, constraining where items are written to the screen.
WiredHome	111:efe436c43aba	2059	///
WiredHome	111:efe436c43aba	2060	/// After setting the window, text and graphics are constrained to this
WiredHome	111:efe436c43aba	2061	/// window. Text will wrap from the right edge back to the left and down
WiredHome	111:efe436c43aba	2062	/// one row and from the bottom to the top. Graphics drawing will be clipped
WiredHome	111:efe436c43aba	2063	/// at the edge of the window.
WiredHome	111:efe436c43aba	2064	///
WiredHome	111:efe436c43aba	2065	/// @note If the initial text write is outside the window, it will be shown
WiredHome	111:efe436c43aba	2066	/// where the cursor position it. Once the write hits the right edge of
WiredHome	111:efe436c43aba	2067	/// the defined window, it will then wrap back to the left edge. Once it
WiredHome	111:efe436c43aba	2068	/// hits the bottom, it wraps to the top of the window. For this reason,
WiredHome	111:efe436c43aba	2069	/// it is common to set the text cursor to the window.
WiredHome	19:3f82c1161fd2	2070	///
WiredHome	111:efe436c43aba	2071	/// @code
WiredHome	111:efe436c43aba	2072	/// rect_t r = {10,10, 90,90};
WiredHome	111:efe436c43aba	2073	/// lcd.window(r);
WiredHome	111:efe436c43aba	2074	/// lcd.SetTextCursor(r.p1.x, r.p1.y);
WiredHome	111:efe436c43aba	2075	/// lcd.puts("012345678901234567890123456789012345678901234567890");
WiredHome	111:efe436c43aba	2076	/// lcd.window(); restore to full screen
WiredHome	111:efe436c43aba	2077	/// @endcode
WiredHome	111:efe436c43aba	2078	///
WiredHome	111:efe436c43aba	2079	/// @param[in] r is the rect_t used to set the window.
WiredHome	167:8aa3fb2a5a31	2080	/// @returns @ref RetCode_t value.
WiredHome	111:efe436c43aba	2081	///
WiredHome	111:efe436c43aba	2082	virtual RetCode_t window(rect_t r);
WiredHome	190:3132b7dfad82	2083
WiredHome	125:7a0b70f56550	2084
WiredHome	111:efe436c43aba	2085	/// Set the window, constraining where items are written to the screen.
WiredHome	111:efe436c43aba	2086	///
WiredHome	111:efe436c43aba	2087	/// After setting the window, text and graphics are constrained to this
WiredHome	111:efe436c43aba	2088	/// window. Text will wrap from the right edge back to the left and down
WiredHome	111:efe436c43aba	2089	/// one row and from the bottom to the top. Graphics drawing will be clipped
WiredHome	111:efe436c43aba	2090	/// at the edge of the window.
WiredHome	111:efe436c43aba	2091	///
WiredHome	114:dbfb996bfbf3	2092	/// @note if no parameters are provided, it restores the window to full screen.
WiredHome	114:dbfb996bfbf3	2093	///
WiredHome	111:efe436c43aba	2094	/// @note If the initial text write is outside the window, it will be shown
WiredHome	111:efe436c43aba	2095	/// where the cursor position it. Once the write hits the right edge of
WiredHome	111:efe436c43aba	2096	/// the defined window, it will then wrap back to the left edge. Once it
WiredHome	111:efe436c43aba	2097	/// hits the bottom, it wraps to the top of the window. For this reason,
WiredHome	111:efe436c43aba	2098	/// it is common to set the text cursor to the window.
WiredHome	19:3f82c1161fd2	2099	///
WiredHome	56:7a85d226ad0d	2100	/// @code
WiredHome	56:7a85d226ad0d	2101	/// lcd.window(10,10, 80,80);
WiredHome	111:efe436c43aba	2102	/// lcd.SetTextCursor(10,10);
WiredHome	56:7a85d226ad0d	2103	/// lcd.puts("012345678901234567890123456789012345678901234567890");
WiredHome	111:efe436c43aba	2104	/// lcd.window(); restore to full screen
WiredHome	56:7a85d226ad0d	2105	/// @endcode
WiredHome	56:7a85d226ad0d	2106	///
WiredHome	72:ecffe56af969	2107	/// @param[in] x is the left edge in pixels.
WiredHome	72:ecffe56af969	2108	/// @param[in] y is the top edge in pixels.
WiredHome	72:ecffe56af969	2109	/// @param[in] width is the window width in pixels.
WiredHome	72:ecffe56af969	2110	/// @param[in] height is the window height in pixels.
WiredHome	167:8aa3fb2a5a31	2111	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2112	///
WiredHome	111:efe436c43aba	2113	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	190:3132b7dfad82	2114
WiredHome	125:7a0b70f56550	2115
WiredHome	61:8f3153bf0baa	2116	/// Clear either the specified layer, or the active layer.
WiredHome	19:3f82c1161fd2	2117	///
WiredHome	61:8f3153bf0baa	2118	/// The behavior is to clear the whole screen for the specified
WiredHome	61:8f3153bf0baa	2119	/// layer. When not specified, the active drawing layer is cleared.
WiredHome	61:8f3153bf0baa	2120	/// This command can also be used to specifically clear either,
WiredHome	106:c80828f5dea4	2121	/// or both layers. See @ref clsw().
WiredHome	19:3f82c1161fd2	2122	///
WiredHome	56:7a85d226ad0d	2123	/// @code
WiredHome	56:7a85d226ad0d	2124	/// lcd.cls();
WiredHome	56:7a85d226ad0d	2125	/// @endcode
WiredHome	56:7a85d226ad0d	2126	///
WiredHome	72:ecffe56af969	2127	/// @param[in] layers is optional. If not provided, the active layer
WiredHome	61:8f3153bf0baa	2128	/// is cleared. If bit 0 is set, layer 0 is cleared, if bit
WiredHome	61:8f3153bf0baa	2129	/// 1 is set, layer 1 is cleared. If both are set, both layers
WiredHome	61:8f3153bf0baa	2130	/// are cleared. Any other value does not cause an action.
WiredHome	190:3132b7dfad82	2131	///
WiredHome	167:8aa3fb2a5a31	2132	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2133	///
WiredHome	61:8f3153bf0baa	2134	virtual RetCode_t cls(uint16_t layers = 0);
WiredHome	125:7a0b70f56550	2135
WiredHome	190:3132b7dfad82	2136
WiredHome	19:3f82c1161fd2	2137	/// Clear the screen, or clear only the active window.
WiredHome	19:3f82c1161fd2	2138	///
WiredHome	190:3132b7dfad82	2139	/// The default behavior is to clear the whole screen. With the optional
WiredHome	19:3f82c1161fd2	2140	/// parameter, the action can be restricted to the active window, which
WiredHome	106:c80828f5dea4	2141	/// can be set with the See @ref window method.
WiredHome	19:3f82c1161fd2	2142	///
WiredHome	56:7a85d226ad0d	2143	/// @code
WiredHome	56:7a85d226ad0d	2144	/// lcd.window(20,20, 40,10);
WiredHome	56:7a85d226ad0d	2145	/// lcd.clsw();
WiredHome	56:7a85d226ad0d	2146	/// @endcode
WiredHome	56:7a85d226ad0d	2147	///
WiredHome	72:ecffe56af969	2148	/// @param[in] region is an optional parameter that defaults to FULLWINDOW
WiredHome	19:3f82c1161fd2	2149	/// or may be set to ACTIVEWINDOW.
WiredHome	167:8aa3fb2a5a31	2150	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2151	///
WiredHome	19:3f82c1161fd2	2152	RetCode_t clsw(RA8875::Region_t region = FULLWINDOW);
WiredHome	19:3f82c1161fd2	2153
WiredHome	125:7a0b70f56550	2154
WiredHome	19:3f82c1161fd2	2155	/// Set the background color.
WiredHome	19:3f82c1161fd2	2156	///
WiredHome	72:ecffe56af969	2157	/// @param[in] color is expressed in 16-bit format.
WiredHome	167:8aa3fb2a5a31	2158	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2159	///
WiredHome	19:3f82c1161fd2	2160	virtual RetCode_t background(color_t color);
WiredHome	125:7a0b70f56550	2161
WiredHome	190:3132b7dfad82	2162
WiredHome	19:3f82c1161fd2	2163	/// Set the background color.
WiredHome	19:3f82c1161fd2	2164	///
WiredHome	72:ecffe56af969	2165	/// @param[in] r is the red element of the color.
WiredHome	72:ecffe56af969	2166	/// @param[in] g is the green element of the color.
WiredHome	72:ecffe56af969	2167	/// @param[in] b is the blue element of the color.
WiredHome	167:8aa3fb2a5a31	2168	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2169	///
WiredHome	19:3f82c1161fd2	2170	virtual RetCode_t background(unsigned char r, unsigned char g, unsigned char b);
WiredHome	190:3132b7dfad82	2171
WiredHome	125:7a0b70f56550	2172
WiredHome	19:3f82c1161fd2	2173	/// Set the foreground color.
WiredHome	19:3f82c1161fd2	2174	///
WiredHome	72:ecffe56af969	2175	/// @param[in] color is expressed in 16-bit format.
WiredHome	167:8aa3fb2a5a31	2176	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2177	///
WiredHome	19:3f82c1161fd2	2178	virtual RetCode_t foreground(color_t color);
WiredHome	190:3132b7dfad82	2179
WiredHome	125:7a0b70f56550	2180
WiredHome	19:3f82c1161fd2	2181	/// Set the foreground color.
WiredHome	19:3f82c1161fd2	2182	///
WiredHome	72:ecffe56af969	2183	/// @param[in] r is the red element of the color.
WiredHome	72:ecffe56af969	2184	/// @param[in] g is the green element of the color.
WiredHome	72:ecffe56af969	2185	/// @param[in] b is the blue element of the color.
WiredHome	167:8aa3fb2a5a31	2186	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2187	///
WiredHome	37:f19b7e7449dc	2188	virtual RetCode_t foreground(unsigned char r, unsigned char g, unsigned char b);
WiredHome	190:3132b7dfad82	2189
WiredHome	190:3132b7dfad82	2190
WiredHome	19:3f82c1161fd2	2191	/// Get the current foreground color value.
WiredHome	19:3f82c1161fd2	2192	///
WiredHome	167:8aa3fb2a5a31	2193	/// @returns the current foreground color as @ref color_t.
WiredHome	19:3f82c1161fd2	2194	///
WiredHome	37:f19b7e7449dc	2195	color_t GetForeColor(void);
WiredHome	190:3132b7dfad82	2196
WiredHome	190:3132b7dfad82	2197
WiredHome	87:ee2240581aa7	2198	/// Draw a pixel in the specified color.
WiredHome	87:ee2240581aa7	2199	///
WiredHome	87:ee2240581aa7	2200	/// @note Unlike many other operations, this does not
WiredHome	87:ee2240581aa7	2201	/// set the forecolor!
WiredHome	87:ee2240581aa7	2202	///
WiredHome	87:ee2240581aa7	2203	/// @param[in] p is the point_t defining the location.
WiredHome	167:8aa3fb2a5a31	2204	/// @param[in] color is expressed in 16-bit format.
WiredHome	167:8aa3fb2a5a31	2205	/// @returns @ref RetCode_t value.
WiredHome	87:ee2240581aa7	2206	///
WiredHome	87:ee2240581aa7	2207	virtual RetCode_t pixel(point_t p, color_t color);
WiredHome	190:3132b7dfad82	2208
WiredHome	190:3132b7dfad82	2209
WiredHome	87:ee2240581aa7	2210	/// Draw a pixel in the current foreground color.
WiredHome	87:ee2240581aa7	2211	///
WiredHome	87:ee2240581aa7	2212	/// @param[in] p is the point_t defining the location.
WiredHome	167:8aa3fb2a5a31	2213	/// @returns @ref RetCode_t value.
WiredHome	87:ee2240581aa7	2214	///
WiredHome	87:ee2240581aa7	2215	virtual RetCode_t pixel(point_t p);
WiredHome	190:3132b7dfad82	2216
WiredHome	190:3132b7dfad82	2217
WiredHome	19:3f82c1161fd2	2218	/// Draw a pixel in the specified color.
WiredHome	19:3f82c1161fd2	2219	///
WiredHome	41:2956a0a221e5	2220	/// @note Unlike many other operations, this does not
WiredHome	41:2956a0a221e5	2221	/// set the forecolor!
WiredHome	19:3f82c1161fd2	2222	///
WiredHome	72:ecffe56af969	2223	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	2224	/// @param[in] y is the vertical offset to this pixel.
WiredHome	72:ecffe56af969	2225	/// @param[in] color defines the color for the pixel.
WiredHome	167:8aa3fb2a5a31	2226	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2227	///
WiredHome	37:f19b7e7449dc	2228	virtual RetCode_t pixel(loc_t x, loc_t y, color_t color);
WiredHome	190:3132b7dfad82	2229
WiredHome	190:3132b7dfad82	2230
WiredHome	19:3f82c1161fd2	2231	/// Draw a pixel in the current foreground color.
WiredHome	19:3f82c1161fd2	2232	///
WiredHome	72:ecffe56af969	2233	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	2234	/// @param[in] y is the veritical offset to this pixel.
WiredHome	167:8aa3fb2a5a31	2235	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2236	///
WiredHome	37:f19b7e7449dc	2237	virtual RetCode_t pixel(loc_t x, loc_t y);
WiredHome	190:3132b7dfad82	2238
WiredHome	190:3132b7dfad82	2239
WiredHome	41:2956a0a221e5	2240	/// Get a pixel from the display.
WiredHome	41:2956a0a221e5	2241	///
WiredHome	72:ecffe56af969	2242	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	2243	/// @param[in] y is the vertical offset to this pixel.
WiredHome	167:8aa3fb2a5a31	2244	/// @returns the pixel. See @ref color_t
WiredHome	41:2956a0a221e5	2245	///
WiredHome	41:2956a0a221e5	2246	virtual color_t getPixel(loc_t x, loc_t y);
WiredHome	190:3132b7dfad82	2247
WiredHome	190:3132b7dfad82	2248
WiredHome	136:224e03d5c31f	2249	/// Write an RGB565 stream of pixels to the display.
WiredHome	41:2956a0a221e5	2250	///
WiredHome	72:ecffe56af969	2251	/// @param[in] p is a pointer to a color_t array to write.
WiredHome	72:ecffe56af969	2252	/// @param[in] count is the number of pixels to write.
WiredHome	72:ecffe56af969	2253	/// @param[in] x is the horizontal position on the display.
WiredHome	72:ecffe56af969	2254	/// @param[in] y is the vertical position on the display.
WiredHome	167:8aa3fb2a5a31	2255	/// @returns @ref RetCode_t value.
WiredHome	41:2956a0a221e5	2256	///
WiredHome	41:2956a0a221e5	2257	virtual RetCode_t pixelStream(color_t * p, uint32_t count, loc_t x, loc_t y);
WiredHome	190:3132b7dfad82	2258
WiredHome	190:3132b7dfad82	2259
WiredHome	41:2956a0a221e5	2260	/// Get a stream of pixels from the display.
WiredHome	41:2956a0a221e5	2261	///
WiredHome	72:ecffe56af969	2262	/// @param[in] p is a pointer to a color_t array to accept the stream.
WiredHome	72:ecffe56af969	2263	/// @param[in] count is the number of pixels to read.
WiredHome	72:ecffe56af969	2264	/// @param[in] x is the horizontal offset to this pixel.
WiredHome	72:ecffe56af969	2265	/// @param[in] y is the vertical offset to this pixel.
WiredHome	167:8aa3fb2a5a31	2266	/// @returns @ref RetCode_t value.
WiredHome	41:2956a0a221e5	2267	///
WiredHome	41:2956a0a221e5	2268	virtual RetCode_t getPixelStream(color_t * p, uint32_t count, loc_t x, loc_t y);
WiredHome	131:5bd6ba2ee4a1	2269
WiredHome	131:5bd6ba2ee4a1	2270
WiredHome	109:7b94f06f085b	2271	/// Write a boolean stream to the display.
WiredHome	109:7b94f06f085b	2272	///
WiredHome	109:7b94f06f085b	2273	/// This takes a bit stream in memory and using the current color settings
WiredHome	109:7b94f06f085b	2274	/// it will stream it to the display. Along the way, each bit is translated
WiredHome	109:7b94f06f085b	2275	/// to either the foreground or background color value and then that pixel
WiredHome	109:7b94f06f085b	2276	/// is pushed onward.
WiredHome	109:7b94f06f085b	2277	///
WiredHome	190:3132b7dfad82	2278	/// This is similar, but different, to the @ref pixelStream API, which is
WiredHome	109:7b94f06f085b	2279	/// given a stream of color values.
WiredHome	190:3132b7dfad82	2280	///
WiredHome	153:8a85efb3eb71	2281	/// This is most often used for Soft Fonts, and for that reason, this method
WiredHome	190:3132b7dfad82	2282	/// will scale the presentation based on the selected font size.
WiredHome	153:8a85efb3eb71	2283	/// See @ref SetTextFontSize, So, users may want to SetTextFontSize(1) for
WiredHome	153:8a85efb3eb71	2284	/// 1:1 scaling.
WiredHome	190:3132b7dfad82	2285	///
WiredHome	109:7b94f06f085b	2286	/// @param[in] x is the horizontal position on the display.
WiredHome	109:7b94f06f085b	2287	/// @param[in] y is the vertical position on the display.
WiredHome	109:7b94f06f085b	2288	/// @param[in] w is the width of the rectangular region to fill.
WiredHome	109:7b94f06f085b	2289	/// @param[in] h is the height of the rectangular region to fill.
WiredHome	109:7b94f06f085b	2290	/// @param[in] boolStream is the inline memory image from which to extract
WiredHome	109:7b94f06f085b	2291	/// the bitstream.
WiredHome	167:8aa3fb2a5a31	2292	/// @returns @ref RetCode_t value.
WiredHome	109:7b94f06f085b	2293	///
WiredHome	109:7b94f06f085b	2294	virtual RetCode_t booleanStream(loc_t x, loc_t y, dim_t w, dim_t h, const uint8_t * boolStream);
WiredHome	125:7a0b70f56550	2295
WiredHome	19:3f82c1161fd2	2296	/// Draw a line in the specified color
WiredHome	19:3f82c1161fd2	2297	///
WiredHome	19:3f82c1161fd2	2298	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2299	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2300	///
WiredHome	83:7bad0068cca0	2301	/// @param[in] p1 is the point to start the line.
WiredHome	83:7bad0068cca0	2302	/// @param[in] p2 is the point to end the line.
WiredHome	83:7bad0068cca0	2303	/// @param[in] color defines the foreground color.
WiredHome	167:8aa3fb2a5a31	2304	/// @returns @ref RetCode_t value.
WiredHome	83:7bad0068cca0	2305	///
WiredHome	83:7bad0068cca0	2306	RetCode_t line(point_t p1, point_t p2, color_t color);
WiredHome	83:7bad0068cca0	2307
WiredHome	125:7a0b70f56550	2308
WiredHome	83:7bad0068cca0	2309	/// Draw a line
WiredHome	83:7bad0068cca0	2310	///
WiredHome	83:7bad0068cca0	2311	/// Draws a line using the foreground color setting.
WiredHome	83:7bad0068cca0	2312	///
WiredHome	83:7bad0068cca0	2313	/// @param[in] p1 is the point to start the line.
WiredHome	83:7bad0068cca0	2314	/// @param[in] p2 is the point to end the line.
WiredHome	167:8aa3fb2a5a31	2315	/// @returns @ref RetCode_t value.
WiredHome	83:7bad0068cca0	2316	///
WiredHome	83:7bad0068cca0	2317	RetCode_t line(point_t p1, point_t p2);
WiredHome	125:7a0b70f56550	2318
WiredHome	190:3132b7dfad82	2319
WiredHome	83:7bad0068cca0	2320	/// Draw a line in the specified color
WiredHome	83:7bad0068cca0	2321	///
WiredHome	83:7bad0068cca0	2322	/// @note As a side effect, this changes the current
WiredHome	83:7bad0068cca0	2323	/// foreground color for subsequent operations.
WiredHome	83:7bad0068cca0	2324	///
WiredHome	72:ecffe56af969	2325	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	2326	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	2327	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	2328	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	2329	/// @param[in] color defines the foreground color.
WiredHome	167:8aa3fb2a5a31	2330	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2331	///
WiredHome	56:7a85d226ad0d	2332	RetCode_t line(loc_t x1, loc_t y1, loc_t x2, loc_t y2, color_t color);
WiredHome	19:3f82c1161fd2	2333
WiredHome	125:7a0b70f56550	2334
WiredHome	19:3f82c1161fd2	2335	/// Draw a line
WiredHome	19:3f82c1161fd2	2336	///
WiredHome	19:3f82c1161fd2	2337	/// Draws a line using the foreground color setting.
WiredHome	19:3f82c1161fd2	2338	///
WiredHome	72:ecffe56af969	2339	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	2340	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	2341	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	2342	/// @param[in] y2 is the vertical end of the line.
WiredHome	167:8aa3fb2a5a31	2343	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2344	///
WiredHome	37:f19b7e7449dc	2345	RetCode_t line(loc_t x1, loc_t y1, loc_t x2, loc_t y2);
WiredHome	19:3f82c1161fd2	2346
WiredHome	125:7a0b70f56550	2347
WiredHome	144:ba002c4b21b3	2348	/// Draw a thick line
WiredHome	144:ba002c4b21b3	2349	///
WiredHome	144:ba002c4b21b3	2350	/// Draw a line of a specified thickness and color.
WiredHome	144:ba002c4b21b3	2351	///
WiredHome	190:3132b7dfad82	2352	/// In order to draw a thick line, this draws filled circles using
WiredHome	190:3132b7dfad82	2353	/// and then draws the 'body' of the thick line using filled triangles. This
WiredHome	190:3132b7dfad82	2354	/// method makes it significantly faster than in prior versions.
WiredHome	190:3132b7dfad82	2355	///
WiredHome	190:3132b7dfad82	2356	/// An older version of this library used Bresenham's algorithm to move the
WiredHome	190:3132b7dfad82	2357	/// center point of the circle along the line. As a result, this was much
WiredHome	190:3132b7dfad82	2358	/// slower than drawing a 1-pixel line which uses the hardware line drawing
WiredHome	190:3132b7dfad82	2359	/// algorithm.
WiredHome	144:ba002c4b21b3	2360	///
WiredHome	144:ba002c4b21b3	2361	/// Drawing multiple parallel lines to create a thick line is faster,
WiredHome	144:ba002c4b21b3	2362	/// however the line drawing was not guaranteed to fill every pixel
WiredHome	144:ba002c4b21b3	2363	/// on the diagonals.
WiredHome	144:ba002c4b21b3	2364	///
WiredHome	144:ba002c4b21b3	2365	/// @param[in] p1 is the point to start the line.
WiredHome	144:ba002c4b21b3	2366	/// @param[in] p2 is the point to end the line.
WiredHome	144:ba002c4b21b3	2367	/// @param[in] thickness is the line thickness.
WiredHome	144:ba002c4b21b3	2368	/// @param[in] color defines the foreground color.
WiredHome	167:8aa3fb2a5a31	2369	/// @returns @ref RetCode_t value.
WiredHome	190:3132b7dfad82	2370	///
WiredHome	144:ba002c4b21b3	2371	RetCode_t ThickLine(point_t p1, point_t p2, dim_t thickness, color_t color);
WiredHome	144:ba002c4b21b3	2372
WiredHome	144:ba002c4b21b3	2373
WiredHome	190:3132b7dfad82	2374	/// Set the end-cap for ThickLines - square (default) or rounded.
WiredHome	190:3132b7dfad82	2375	///
WiredHome	190:3132b7dfad82	2376	/// @param[in] roundCap when true causes the end-cap to be drawn as a filled circle.
WiredHome	190:3132b7dfad82	2377	/// @returns the previous end-cap setting, permitting easy restore.
WiredHome	190:3132b7dfad82	2378	///
WiredHome	190:3132b7dfad82	2379	bool SetEndCap(bool roundCap);
WiredHome	190:3132b7dfad82	2380
WiredHome	190:3132b7dfad82	2381
WiredHome	19:3f82c1161fd2	2382	/// Draw a rectangle in the specified color
WiredHome	19:3f82c1161fd2	2383	///
WiredHome	19:3f82c1161fd2	2384	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2385	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2386	///
WiredHome	81:01da2e34283d	2387	/// @param[in] rect defines the rectangle.
WiredHome	81:01da2e34283d	2388	/// @param[in] color defines the foreground color.
WiredHome	81:01da2e34283d	2389	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2390	/// @returns @ref RetCode_t value.
WiredHome	81:01da2e34283d	2391	///
WiredHome	82:f7d300f26540	2392	RetCode_t rect(rect_t rect, color_t color, fill_t fillit = NOFILL);
WiredHome	190:3132b7dfad82	2393
WiredHome	125:7a0b70f56550	2394
WiredHome	125:7a0b70f56550	2395	/// Draw a filled rectangle in the specified color
WiredHome	81:01da2e34283d	2396	///
WiredHome	81:01da2e34283d	2397	/// @note As a side effect, this changes the current
WiredHome	81:01da2e34283d	2398	/// foreground color for subsequent operations.
WiredHome	81:01da2e34283d	2399	///
WiredHome	81:01da2e34283d	2400	/// @param[in] rect defines the rectangle.
WiredHome	81:01da2e34283d	2401	/// @param[in] color defines the foreground color.
WiredHome	81:01da2e34283d	2402	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2403	/// @returns @ref RetCode_t value.
WiredHome	81:01da2e34283d	2404	///
WiredHome	81:01da2e34283d	2405	RetCode_t fillrect(rect_t rect, color_t color, fill_t fillit = FILL);
WiredHome	81:01da2e34283d	2406
WiredHome	125:7a0b70f56550	2407
WiredHome	81:01da2e34283d	2408	/// Draw a rectangle in the specified color
WiredHome	81:01da2e34283d	2409	///
WiredHome	81:01da2e34283d	2410	/// @note As a side effect, this changes the current
WiredHome	81:01da2e34283d	2411	/// foreground color for subsequent operations.
WiredHome	81:01da2e34283d	2412	///
WiredHome	72:ecffe56af969	2413	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	2414	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	2415	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	2416	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	2417	/// @param[in] color defines the foreground color.
WiredHome	81:01da2e34283d	2418	/// @param[in] fillit is optional to FILL the rectangle. default is FILL.
WiredHome	167:8aa3fb2a5a31	2419	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2420	///
WiredHome	190:3132b7dfad82	2421	RetCode_t rect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	19:3f82c1161fd2	2422	color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2423
WiredHome	125:7a0b70f56550	2424
WiredHome	19:3f82c1161fd2	2425	/// Draw a filled rectangle in the specified color
WiredHome	19:3f82c1161fd2	2426	///
WiredHome	19:3f82c1161fd2	2427	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2428	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2429	///
WiredHome	72:ecffe56af969	2430	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	2431	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	2432	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	2433	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	2434	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2435	/// @param[in] fillit is optional to NOFILL the rectangle. default is FILL.
WiredHome	167:8aa3fb2a5a31	2436	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2437	///
WiredHome	190:3132b7dfad82	2438	virtual RetCode_t fillrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	19:3f82c1161fd2	2439	color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	2440
WiredHome	125:7a0b70f56550	2441
WiredHome	19:3f82c1161fd2	2442	/// Draw a rectangle
WiredHome	19:3f82c1161fd2	2443	///
WiredHome	19:3f82c1161fd2	2444	/// Draws a rectangle using the foreground color setting.
WiredHome	19:3f82c1161fd2	2445	///
WiredHome	72:ecffe56af969	2446	/// @param[in] x1 is the horizontal start of the line.
WiredHome	72:ecffe56af969	2447	/// @param[in] y1 is the vertical start of the line.
WiredHome	72:ecffe56af969	2448	/// @param[in] x2 is the horizontal end of the line.
WiredHome	72:ecffe56af969	2449	/// @param[in] y2 is the vertical end of the line.
WiredHome	72:ecffe56af969	2450	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2451	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2452	///
WiredHome	190:3132b7dfad82	2453	RetCode_t rect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	19:3f82c1161fd2	2454	fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2455
WiredHome	125:7a0b70f56550	2456
WiredHome	19:3f82c1161fd2	2457	/// Draw a filled rectangle with rounded corners using the specified color.
WiredHome	19:3f82c1161fd2	2458	///
WiredHome	21:3c1efb192927	2459	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	21:3c1efb192927	2460	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	21:3c1efb192927	2461	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	21:3c1efb192927	2462	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	21:3c1efb192927	2463	///
WiredHome	19:3f82c1161fd2	2464	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2465	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2466	///
WiredHome	72:ecffe56af969	2467	/// @param[in] x1 is the horizontal start of the line and must be <= x2.
WiredHome	72:ecffe56af969	2468	/// @param[in] y1 is the vertical start of the line and must be <= y2.
WiredHome	72:ecffe56af969	2469	/// @param[in] x2 is the horizontal end of the line and must be >= x1.
WiredHome	72:ecffe56af969	2470	/// @param[in] y2 is the vertical end of the line and must be >= y1.
WiredHome	72:ecffe56af969	2471	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2472	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2473	/// is returned.
WiredHome	72:ecffe56af969	2474	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2475	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2476	/// is returned.
WiredHome	72:ecffe56af969	2477	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2478	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2479	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2480	///
WiredHome	190:3132b7dfad82	2481	RetCode_t fillroundrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2482	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	2483
WiredHome	125:7a0b70f56550	2484
WiredHome	107:f9ccffcb84f1	2485	/// Draw a filled rectangle with rounded corners using the specified color.
WiredHome	107:f9ccffcb84f1	2486	///
WiredHome	107:f9ccffcb84f1	2487	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	107:f9ccffcb84f1	2488	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	107:f9ccffcb84f1	2489	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	107:f9ccffcb84f1	2490	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	107:f9ccffcb84f1	2491	///
WiredHome	107:f9ccffcb84f1	2492	/// @note As a side effect, this changes the current
WiredHome	107:f9ccffcb84f1	2493	/// foreground color for subsequent operations.
WiredHome	107:f9ccffcb84f1	2494	///
WiredHome	107:f9ccffcb84f1	2495	/// @param[in] r is the rectangle to draw.
WiredHome	107:f9ccffcb84f1	2496	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2497	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	2498	/// is returned.
WiredHome	107:f9ccffcb84f1	2499	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2500	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	2501	/// is returned.
WiredHome	107:f9ccffcb84f1	2502	/// @param[in] color defines the foreground color.
WiredHome	107:f9ccffcb84f1	2503	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2504	/// @returns @ref RetCode_t value.
WiredHome	107:f9ccffcb84f1	2505	///
WiredHome	190:3132b7dfad82	2506	RetCode_t fillroundrect(rect_t r,
WiredHome	107:f9ccffcb84f1	2507	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = FILL);
WiredHome	107:f9ccffcb84f1	2508
WiredHome	125:7a0b70f56550	2509
WiredHome	107:f9ccffcb84f1	2510	/// Draw a rectangle with rounded corners using the specified color.
WiredHome	107:f9ccffcb84f1	2511	///
WiredHome	107:f9ccffcb84f1	2512	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	107:f9ccffcb84f1	2513	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	107:f9ccffcb84f1	2514	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	107:f9ccffcb84f1	2515	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	107:f9ccffcb84f1	2516	///
WiredHome	107:f9ccffcb84f1	2517	/// @note As a side effect, this changes the current
WiredHome	107:f9ccffcb84f1	2518	/// foreground color for subsequent operations.
WiredHome	107:f9ccffcb84f1	2519	///
WiredHome	107:f9ccffcb84f1	2520	/// @param[in] r is the rectangle to draw.
WiredHome	107:f9ccffcb84f1	2521	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2522	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	2523	/// is returned.
WiredHome	107:f9ccffcb84f1	2524	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2525	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	107:f9ccffcb84f1	2526	/// is returned.
WiredHome	107:f9ccffcb84f1	2527	/// @param[in] color defines the foreground color.
WiredHome	107:f9ccffcb84f1	2528	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2529	/// @returns @ref RetCode_t value.
WiredHome	107:f9ccffcb84f1	2530	///
WiredHome	190:3132b7dfad82	2531	RetCode_t roundrect(rect_t r,
WiredHome	107:f9ccffcb84f1	2532	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = NOFILL);
WiredHome	107:f9ccffcb84f1	2533
WiredHome	125:7a0b70f56550	2534
WiredHome	19:3f82c1161fd2	2535	/// Draw a rectangle with rounded corners using the specified color.
WiredHome	19:3f82c1161fd2	2536	///
WiredHome	21:3c1efb192927	2537	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	21:3c1efb192927	2538	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	21:3c1efb192927	2539	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	21:3c1efb192927	2540	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	21:3c1efb192927	2541	///
WiredHome	19:3f82c1161fd2	2542	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2543	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2544	///
WiredHome	72:ecffe56af969	2545	/// @param[in] x1 is the horizontal start of the line and must be <= x2.
WiredHome	72:ecffe56af969	2546	/// @param[in] y1 is the vertical start of the line and must be <= y2.
WiredHome	72:ecffe56af969	2547	/// @param[in] x2 is the horizontal end of the line and must be >= x1.
WiredHome	72:ecffe56af969	2548	/// @param[in] y2 is the vertical end of the line and must be >= y1.
WiredHome	72:ecffe56af969	2549	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2550	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2551	/// is returned.
WiredHome	72:ecffe56af969	2552	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2553	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2554	/// is returned.
WiredHome	72:ecffe56af969	2555	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2556	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2557	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2558	///
WiredHome	190:3132b7dfad82	2559	RetCode_t roundrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2560	dim_t radius1, dim_t radius2, color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2561
WiredHome	125:7a0b70f56550	2562
WiredHome	19:3f82c1161fd2	2563	/// Draw a rectangle with rounded corners.
WiredHome	19:3f82c1161fd2	2564	///
WiredHome	21:3c1efb192927	2565	/// This draws a rounded rectangle. A numbers of checks are made on the values,
WiredHome	21:3c1efb192927	2566	/// and it could reduce this to drawing a line (if either x1 == x2, or y1 == y2),
WiredHome	21:3c1efb192927	2567	/// or a single point (x1 == x2 && y1 == y2). If the radius parameters are
WiredHome	21:3c1efb192927	2568	/// > 1/2 the length of that side (width or height), an error value is returned.
WiredHome	19:3f82c1161fd2	2569	///
WiredHome	72:ecffe56af969	2570	/// @param[in] x1 is the horizontal start of the line and must be <= x2.
WiredHome	72:ecffe56af969	2571	/// @param[in] y1 is the vertical start of the line and must be <= y2.
WiredHome	72:ecffe56af969	2572	/// @param[in] x2 is the horizontal end of the line and must be >= x1.
WiredHome	72:ecffe56af969	2573	/// @param[in] y2 is the vertical end of the line and must be >= y1.
WiredHome	72:ecffe56af969	2574	/// @param[in] radius1 defines the horizontal radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2575	/// that this value < 1/2 the width of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2576	/// is returned.
WiredHome	72:ecffe56af969	2577	/// @param[in] radius2 defines the vertical radius of the curved corner. Take care
WiredHome	190:3132b7dfad82	2578	/// that this value < 1/2 the height of the rectangle, or bad_parameter
WiredHome	21:3c1efb192927	2579	/// is returned.
WiredHome	72:ecffe56af969	2580	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2581	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2582	///
WiredHome	190:3132b7dfad82	2583	RetCode_t roundrect(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2584	dim_t radius1, dim_t radius2, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2585
WiredHome	125:7a0b70f56550	2586
WiredHome	19:3f82c1161fd2	2587	/// Draw a triangle in the specified color.
WiredHome	19:3f82c1161fd2	2588	///
WiredHome	19:3f82c1161fd2	2589	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2590	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2591	///
WiredHome	178:ae472eb22740	2592	/// @param[in] p1 is point 1.
WiredHome	178:ae472eb22740	2593	/// @param[in] p2 is point 2.
WiredHome	178:ae472eb22740	2594	/// @param[in] p3 is point 3.
WiredHome	178:ae472eb22740	2595	/// @param[in] color defines the foreground color.
WiredHome	178:ae472eb22740	2596	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	178:ae472eb22740	2597	/// @returns @ref RetCode_t value.
WiredHome	178:ae472eb22740	2598	///
WiredHome	178:ae472eb22740	2599	RetCode_t filltriangle(point_t p1, point_t p2, point_t p3, color_t color, fill_t fillit = FILL);
WiredHome	178:ae472eb22740	2600
WiredHome	178:ae472eb22740	2601	/// Draw a triangle in the specified color.
WiredHome	178:ae472eb22740	2602	///
WiredHome	178:ae472eb22740	2603	/// @note As a side effect, this changes the current
WiredHome	178:ae472eb22740	2604	/// foreground color for subsequent operations.
WiredHome	178:ae472eb22740	2605	///
WiredHome	178:ae472eb22740	2606	/// @param[in] p1 is point 1.
WiredHome	178:ae472eb22740	2607	/// @param[in] p2 is point 2.
WiredHome	178:ae472eb22740	2608	/// @param[in] p3 is point 3.
WiredHome	178:ae472eb22740	2609	/// @param[in] color defines the foreground color.
WiredHome	178:ae472eb22740	2610	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	178:ae472eb22740	2611	/// @returns @ref RetCode_t value.
WiredHome	178:ae472eb22740	2612	///
WiredHome	178:ae472eb22740	2613	RetCode_t triangle(point_t p1, point_t p2, point_t p3, color_t color, fill_t fillit = NOFILL);
WiredHome	190:3132b7dfad82	2614
WiredHome	178:ae472eb22740	2615	/// Draw a triangle in the specified color.
WiredHome	178:ae472eb22740	2616	///
WiredHome	178:ae472eb22740	2617	/// @note As a side effect, this changes the current
WiredHome	178:ae472eb22740	2618	/// foreground color for subsequent operations.
WiredHome	178:ae472eb22740	2619	///
WiredHome	72:ecffe56af969	2620	/// @param[in] x1 is the horizontal for point 1.
WiredHome	190:3132b7dfad82	2621	/// @param[in] y1 is the vertical for point 1.
WiredHome	72:ecffe56af969	2622	/// @param[in] x2 is the horizontal for point 2.
WiredHome	72:ecffe56af969	2623	/// @param[in] y2 is the vertical for point 2.
WiredHome	72:ecffe56af969	2624	/// @param[in] x3 is the horizontal for point 3.
WiredHome	72:ecffe56af969	2625	/// @param[in] y3 is the vertical for point 3.
WiredHome	72:ecffe56af969	2626	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2627	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2628	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2629	///
WiredHome	190:3132b7dfad82	2630	RetCode_t triangle(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2631	loc_t x3, loc_t y3, color_t color, fill_t fillit = NOFILL);
WiredHome	190:3132b7dfad82	2632
WiredHome	125:7a0b70f56550	2633
WiredHome	19:3f82c1161fd2	2634	/// Draw a filled triangle in the specified color.
WiredHome	19:3f82c1161fd2	2635	///
WiredHome	19:3f82c1161fd2	2636	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2637	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2638	///
WiredHome	72:ecffe56af969	2639	/// @param[in] x1 is the horizontal for point 1.
WiredHome	72:ecffe56af969	2640	/// @param[in] y1 is the vertical for point 1.
WiredHome	72:ecffe56af969	2641	/// @param[in] x2 is the horizontal for point 2.
WiredHome	72:ecffe56af969	2642	/// @param[in] y2 is the vertical for point 2.
WiredHome	72:ecffe56af969	2643	/// @param[in] x3 is the horizontal for point 3.
WiredHome	72:ecffe56af969	2644	/// @param[in] y3 is the vertical for point 3.
WiredHome	72:ecffe56af969	2645	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2646	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2647	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2648	///
WiredHome	190:3132b7dfad82	2649	RetCode_t filltriangle(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2650	loc_t x3, loc_t y3, color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	2651
WiredHome	125:7a0b70f56550	2652
WiredHome	19:3f82c1161fd2	2653	/// Draw a triangle
WiredHome	19:3f82c1161fd2	2654	///
WiredHome	19:3f82c1161fd2	2655	/// Draws a triangle using the foreground color setting.
WiredHome	19:3f82c1161fd2	2656	///
WiredHome	72:ecffe56af969	2657	/// @param[in] x1 is the horizontal for point 1.
WiredHome	72:ecffe56af969	2658	/// @param[in] y1 is the vertical for point 1.
WiredHome	72:ecffe56af969	2659	/// @param[in] x2 is the horizontal for point 2.
WiredHome	72:ecffe56af969	2660	/// @param[in] y2 is the vertical for point 2.
WiredHome	72:ecffe56af969	2661	/// @param[in] x3 is the horizontal for point 3.
WiredHome	72:ecffe56af969	2662	/// @param[in] y3 is the vertical for point 3.
WiredHome	72:ecffe56af969	2663	/// @param[in] fillit is optional to FILL the rectangle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2664	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2665	///
WiredHome	190:3132b7dfad82	2666	RetCode_t triangle(loc_t x1, loc_t y1, loc_t x2, loc_t y2,
WiredHome	37:f19b7e7449dc	2667	loc_t x3, loc_t y3, fill_t fillit = NOFILL);
WiredHome	190:3132b7dfad82	2668
WiredHome	83:7bad0068cca0	2669
WiredHome	83:7bad0068cca0	2670	/// Draw a circle using the specified color.
WiredHome	83:7bad0068cca0	2671	///
WiredHome	83:7bad0068cca0	2672	/// @note As a side effect, this changes the current
WiredHome	83:7bad0068cca0	2673	/// foreground color for subsequent operations.
WiredHome	83:7bad0068cca0	2674	///
WiredHome	83:7bad0068cca0	2675	/// @param[in] p defines the center of the circle.
WiredHome	83:7bad0068cca0	2676	/// @param[in] radius defines the size of the circle.
WiredHome	83:7bad0068cca0	2677	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2678	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2679	/// @returns @ref RetCode_t value.
WiredHome	83:7bad0068cca0	2680	///
WiredHome	83:7bad0068cca0	2681	RetCode_t circle(point_t p, dim_t radius, color_t color, fill_t fillit = NOFILL);
WiredHome	83:7bad0068cca0	2682
WiredHome	125:7a0b70f56550	2683
WiredHome	83:7bad0068cca0	2684	/// Draw a filled circle using the specified color.
WiredHome	83:7bad0068cca0	2685	///
WiredHome	83:7bad0068cca0	2686	/// @note As a side effect, this changes the current
WiredHome	83:7bad0068cca0	2687	/// foreground color for subsequent operations.
WiredHome	83:7bad0068cca0	2688	///
WiredHome	83:7bad0068cca0	2689	/// @param[in] p defines the center of the circle.
WiredHome	83:7bad0068cca0	2690	/// @param[in] radius defines the size of the circle.
WiredHome	83:7bad0068cca0	2691	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2692	/// @param[in] fillit is optional to FILL the circle. default is FILL.
WiredHome	167:8aa3fb2a5a31	2693	/// @returns @ref RetCode_t value.
WiredHome	83:7bad0068cca0	2694	///
WiredHome	83:7bad0068cca0	2695	RetCode_t fillcircle(point_t p, dim_t radius, color_t color, fill_t fillit = FILL);
WiredHome	83:7bad0068cca0	2696
WiredHome	125:7a0b70f56550	2697
WiredHome	83:7bad0068cca0	2698	/// Draw a circle.
WiredHome	83:7bad0068cca0	2699	///
WiredHome	83:7bad0068cca0	2700	/// Draws a circle using the foreground color setting.
WiredHome	83:7bad0068cca0	2701	///
WiredHome	83:7bad0068cca0	2702	/// @param[in] p defines the center of the circle.
WiredHome	83:7bad0068cca0	2703	/// @param[in] radius defines the size of the circle.
WiredHome	125:7a0b70f56550	2704	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2705	/// @returns @ref RetCode_t value.
WiredHome	83:7bad0068cca0	2706	///
WiredHome	83:7bad0068cca0	2707	RetCode_t circle(point_t p, dim_t radius, fill_t fillit = NOFILL);
WiredHome	83:7bad0068cca0	2708
WiredHome	125:7a0b70f56550	2709
WiredHome	19:3f82c1161fd2	2710	/// Draw a circle using the specified color.
WiredHome	19:3f82c1161fd2	2711	///
WiredHome	19:3f82c1161fd2	2712	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2713	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2714	///
WiredHome	72:ecffe56af969	2715	/// @param[in] x is the horizontal center of the circle.
WiredHome	72:ecffe56af969	2716	/// @param[in] y is the vertical center of the circle.
WiredHome	72:ecffe56af969	2717	/// @param[in] radius defines the size of the circle.
WiredHome	72:ecffe56af969	2718	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2719	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2720	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2721	///
WiredHome	37:f19b7e7449dc	2722	RetCode_t circle(loc_t x, loc_t y, dim_t radius, color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2723
WiredHome	125:7a0b70f56550	2724
WiredHome	19:3f82c1161fd2	2725	/// Draw a filled circle using the specified color.
WiredHome	19:3f82c1161fd2	2726	///
WiredHome	19:3f82c1161fd2	2727	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2728	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2729	///
WiredHome	72:ecffe56af969	2730	/// @param[in] x is the horizontal center of the circle.
WiredHome	72:ecffe56af969	2731	/// @param[in] y is the vertical center of the circle.
WiredHome	72:ecffe56af969	2732	/// @param[in] radius defines the size of the circle.
WiredHome	72:ecffe56af969	2733	/// @param[in] color defines the foreground color.
WiredHome	125:7a0b70f56550	2734	/// @param[in] fillit is optional to FILL the circle. default is FILL.
WiredHome	167:8aa3fb2a5a31	2735	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2736	///
WiredHome	37:f19b7e7449dc	2737	RetCode_t fillcircle(loc_t x, loc_t y, dim_t radius, color_t color, fill_t fillit = FILL);
WiredHome	19:3f82c1161fd2	2738
WiredHome	125:7a0b70f56550	2739
WiredHome	19:3f82c1161fd2	2740	/// Draw a circle.
WiredHome	19:3f82c1161fd2	2741	///
WiredHome	19:3f82c1161fd2	2742	/// Draws a circle using the foreground color setting.
WiredHome	19:3f82c1161fd2	2743	///
WiredHome	72:ecffe56af969	2744	/// @param[in] x is the horizontal center of the circle.
WiredHome	72:ecffe56af969	2745	/// @param[in] y is the vertical center of the circle.
WiredHome	72:ecffe56af969	2746	/// @param[in] radius defines the size of the circle.
WiredHome	125:7a0b70f56550	2747	/// @param[in] fillit is optional to FILL the circle. default is NOFILL.
WiredHome	167:8aa3fb2a5a31	2748	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2749	///
WiredHome	37:f19b7e7449dc	2750	RetCode_t circle(loc_t x, loc_t y, dim_t radius, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2751
WiredHome	19:3f82c1161fd2	2752	/// Draw an Ellipse using the specified color
WiredHome	19:3f82c1161fd2	2753	///
WiredHome	19:3f82c1161fd2	2754	/// @note As a side effect, this changes the current
WiredHome	19:3f82c1161fd2	2755	/// foreground color for subsequent operations.
WiredHome	19:3f82c1161fd2	2756	///
WiredHome	72:ecffe56af969	2757	/// @param[in] x is the horizontal center of the ellipse.
WiredHome	72:ecffe56af969	2758	/// @param[in] y is the vertical center of the ellipse.
WiredHome	72:ecffe56af969	2759	/// @param[in] radius1 defines the horizontal radius of the ellipse.
WiredHome	72:ecffe56af969	2760	/// @param[in] radius2 defines the vertical radius of the ellipse.
WiredHome	72:ecffe56af969	2761	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2762	/// @param[in] fillit defines whether the circle is filled or not.
WiredHome	167:8aa3fb2a5a31	2763	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2764	///
WiredHome	190:3132b7dfad82	2765	RetCode_t ellipse(loc_t x, loc_t y, dim_t radius1, dim_t radius2,
WiredHome	19:3f82c1161fd2	2766	color_t color, fill_t fillit = NOFILL);
WiredHome	19:3f82c1161fd2	2767
WiredHome	125:7a0b70f56550	2768
WiredHome	25:9556a3a9b7cc	2769	/// Draw a filled Ellipse using the specified color
WiredHome	25:9556a3a9b7cc	2770	///
WiredHome	25:9556a3a9b7cc	2771	/// @note As a side effect, this changes the current
WiredHome	25:9556a3a9b7cc	2772	/// foreground color for subsequent operations.
WiredHome	25:9556a3a9b7cc	2773	///
WiredHome	72:ecffe56af969	2774	/// @param[in] x is the horizontal center of the ellipse.
WiredHome	72:ecffe56af969	2775	/// @param[in] y is the vertical center of the ellipse.
WiredHome	72:ecffe56af969	2776	/// @param[in] radius1 defines the horizontal radius of the ellipse.
WiredHome	72:ecffe56af969	2777	/// @param[in] radius2 defines the vertical radius of the ellipse.
WiredHome	72:ecffe56af969	2778	/// @param[in] color defines the foreground color.
WiredHome	72:ecffe56af969	2779	/// @param[in] fillit defines whether the circle is filled or not.
WiredHome	167:8aa3fb2a5a31	2780	/// @returns @ref RetCode_t value.
WiredHome	25:9556a3a9b7cc	2781	///
WiredHome	190:3132b7dfad82	2782	RetCode_t fillellipse(loc_t x, loc_t y, dim_t radius1, dim_t radius2,
WiredHome	25:9556a3a9b7cc	2783	color_t color, fill_t fillit = FILL);
WiredHome	25:9556a3a9b7cc	2784
WiredHome	125:7a0b70f56550	2785
WiredHome	19:3f82c1161fd2	2786	/// Draw an Ellipse
WiredHome	19:3f82c1161fd2	2787	///
WiredHome	19:3f82c1161fd2	2788	/// Draws it using the foreground color setting.
WiredHome	19:3f82c1161fd2	2789	///
WiredHome	72:ecffe56af969	2790	/// @param[in] x is the horizontal center of the ellipse.
WiredHome	72:ecffe56af969	2791	/// @param[in] y is the vertical center of the ellipse.
WiredHome	72:ecffe56af969	2792	/// @param[in] radius1 defines the horizontal radius of the ellipse.
WiredHome	72:ecffe56af969	2793	/// @param[in] radius2 defines the vertical radius of the ellipse.
WiredHome	72:ecffe56af969	2794	/// @param[in] fillit defines whether the circle is filled or not.
WiredHome	167:8aa3fb2a5a31	2795	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2796	///
WiredHome	37:f19b7e7449dc	2797	RetCode_t ellipse(loc_t x, loc_t y, dim_t radius1, dim_t radius2, fill_t fillit = NOFILL);
WiredHome	190:3132b7dfad82	2798
WiredHome	125:7a0b70f56550	2799
WiredHome	131:5bd6ba2ee4a1	2800
WiredHome	131:5bd6ba2ee4a1	2801	/// Block Move
WiredHome	131:5bd6ba2ee4a1	2802	///
WiredHome	131:5bd6ba2ee4a1	2803	/// The Block Move API activates the RA8875 Block Transfer Engine. Due to the complex
WiredHome	131:5bd6ba2ee4a1	2804	/// set of possible operations, the user should read the related sections of the
WiredHome	131:5bd6ba2ee4a1	2805	/// RA8875 user manual.
WiredHome	131:5bd6ba2ee4a1	2806	///
WiredHome	131:5bd6ba2ee4a1	2807	/// Some operations may require that other registers are configured, such as the
WiredHome	131:5bd6ba2ee4a1	2808	/// foreground and background color registers, and others. Those must be set
WiredHome	131:5bd6ba2ee4a1	2809	/// outside of this API.
WiredHome	131:5bd6ba2ee4a1	2810	///
WiredHome	138:61e93bed397e	2811	/// @code
WiredHome	167:8aa3fb2a5a31	2812	/// // Block Move Demo
WiredHome	190:3132b7dfad82	2813	///
WiredHome	154:ad2450fc3dc3	2814	/// // Calibrate the resistive touch screen, and store the data on the
WiredHome	154:ad2450fc3dc3	2815	/// // local file system.
WiredHome	154:ad2450fc3dc3	2816	/// //
WiredHome	154:ad2450fc3dc3	2817	/// void CalibrateTS(void)
WiredHome	154:ad2450fc3dc3	2818	/// {
WiredHome	154:ad2450fc3dc3	2819	/// FILE * fh;
WiredHome	154:ad2450fc3dc3	2820	/// tpMatrix_t matrix;
WiredHome	154:ad2450fc3dc3	2821	/// RetCode_t r;
WiredHome	154:ad2450fc3dc3	2822	/// Timer testperiod;
WiredHome	190:3132b7dfad82	2823	///
WiredHome	154:ad2450fc3dc3	2824	/// r = lcd.TouchPanelCalibrate("Calibrate the touch panel", &matrix);
WiredHome	154:ad2450fc3dc3	2825	/// if (r == noerror) {
WiredHome	154:ad2450fc3dc3	2826	/// fh = fopen("/local/tpcal.cfg", "wb");
WiredHome	154:ad2450fc3dc3	2827	/// if (fh) {
WiredHome	154:ad2450fc3dc3	2828	/// fwrite(&matrix, sizeof(tpMatrix_t), 1, fh);
WiredHome	154:ad2450fc3dc3	2829	/// fclose(fh);
WiredHome	154:ad2450fc3dc3	2830	/// printf(" tp cal written.\r\n");
WiredHome	154:ad2450fc3dc3	2831	/// lcd.cls();
WiredHome	154:ad2450fc3dc3	2832	/// } else {
WiredHome	154:ad2450fc3dc3	2833	/// printf(" couldn't open tpcal file.\r\n");
WiredHome	154:ad2450fc3dc3	2834	/// }
WiredHome	154:ad2450fc3dc3	2835	/// } else {
WiredHome	154:ad2450fc3dc3	2836	/// printf("error return: %d\r\n", r);
WiredHome	154:ad2450fc3dc3	2837	/// }
WiredHome	154:ad2450fc3dc3	2838	/// lcd.cls();
WiredHome	154:ad2450fc3dc3	2839	/// }
WiredHome	190:3132b7dfad82	2840	///
WiredHome	154:ad2450fc3dc3	2841	/// // Try to load a previous resistive touch screen calibration from storage. If it
WiredHome	154:ad2450fc3dc3	2842	/// // doesn't exist, activate the touch screen calibration process.
WiredHome	154:ad2450fc3dc3	2843	/// //
WiredHome	154:ad2450fc3dc3	2844	/// void InitTS(void)
WiredHome	154:ad2450fc3dc3	2845	/// {
WiredHome	154:ad2450fc3dc3	2846	/// FILE * fh;
WiredHome	154:ad2450fc3dc3	2847	/// tpMatrix_t matrix;
WiredHome	190:3132b7dfad82	2848	///
WiredHome	154:ad2450fc3dc3	2849	/// fh = fopen("/local/tpcal.cfg", "rb");
WiredHome	154:ad2450fc3dc3	2850	/// if (fh) {
WiredHome	154:ad2450fc3dc3	2851	/// fread(&matrix, sizeof(tpMatrix_t), 1, fh);
WiredHome	154:ad2450fc3dc3	2852	/// fclose(fh);
WiredHome	154:ad2450fc3dc3	2853	/// lcd.TouchPanelSetMatrix(&matrix);
WiredHome	154:ad2450fc3dc3	2854	/// printf(" tp cal loaded.\r\n");
WiredHome	154:ad2450fc3dc3	2855	/// } else {
WiredHome	154:ad2450fc3dc3	2856	/// CalibrateTS();
WiredHome	154:ad2450fc3dc3	2857	/// }
WiredHome	154:ad2450fc3dc3	2858	/// }
WiredHome	154:ad2450fc3dc3	2859	///
WiredHome	138:61e93bed397e	2860	/// int main()
WiredHome	138:61e93bed397e	2861	/// {
WiredHome	138:61e93bed397e	2862	/// point_t src;
WiredHome	138:61e93bed397e	2863	/// point_t dst;
WiredHome	138:61e93bed397e	2864	/// TouchCode_t touch;
WiredHome	138:61e93bed397e	2865	/// const dim_t RECT_W = 100;
WiredHome	138:61e93bed397e	2866	/// const dim_t RECT_H = 100;
WiredHome	190:3132b7dfad82	2867	///
WiredHome	138:61e93bed397e	2868	/// pc.baud(460800); //I like a snappy terminal, so crank it up!
WiredHome	138:61e93bed397e	2869	/// pc.printf("\r\nRA8875 BTE Move Test - Build " __DATE__ " " __TIME__ "\r\n");
WiredHome	138:61e93bed397e	2870	/// lcd.init(LCD_W,LCD_H,LCD_C, BL_NORM);
WiredHome	138:61e93bed397e	2871	/// lcd.TouchPanelInit();
WiredHome	138:61e93bed397e	2872	/// #ifndef CAP_TOUCH
WiredHome	138:61e93bed397e	2873	/// InitTS(); // Calibration for resistive touch panel
WiredHome	138:61e93bed397e	2874	/// #endif
WiredHome	190:3132b7dfad82	2875	///
WiredHome	138:61e93bed397e	2876	/// RetCode_t r = lcd.RenderImageFile(0,0,"/local/fullscrn.jpg");
WiredHome	138:61e93bed397e	2877	/// if (r) pc.printf(" Error: %d; %s\r\n", r, lcd.GetErrorMessage(r));
WiredHome	138:61e93bed397e	2878	/// while (1) {
WiredHome	138:61e93bed397e	2879	/// touch = lcd.TouchPanelReadable();
WiredHome	138:61e93bed397e	2880	/// if (touch) {
WiredHome	138:61e93bed397e	2881	/// point_t xy = lcd.TouchCoordinates();
WiredHome	138:61e93bed397e	2882	/// TouchCode_t t = lcd.TouchCode();
WiredHome	190:3132b7dfad82	2883	///
WiredHome	138:61e93bed397e	2884	/// if (t == touch) {
WiredHome	138:61e93bed397e	2885	/// src = ComputeTopLeftOfRect(xy, RECT_W/2, RECT_H/2, LCD_W, LCD_H);
WiredHome	138:61e93bed397e	2886	/// } else if (t == release) {
WiredHome	138:61e93bed397e	2887	/// dst = ComputeTopLeftOfRect(xy, RECT_W/2, RECT_H/2, LCD_W, LCD_H);
WiredHome	138:61e93bed397e	2888	/// r = lcd.BlockMove(0,0,dst, 0,0,src, RECT_W,RECT_H, 0x2, 0xC);
WiredHome	138:61e93bed397e	2889	/// }
WiredHome	138:61e93bed397e	2890	/// }
WiredHome	138:61e93bed397e	2891	/// }
WiredHome	138:61e93bed397e	2892	/// }
WiredHome	138:61e93bed397e	2893	/// @endcode
WiredHome	138:61e93bed397e	2894	///
WiredHome	139:99ec74e3273f	2895	/// @param[in] dstLayer layer [5B.7]. layer value is 0 or 1 representing layer 1 and 2.
WiredHome	131:5bd6ba2ee4a1	2896	/// @param[in] dstDataSelect [50.5] defines the destination data type 0: block, 1: linear.
WiredHome	131:5bd6ba2ee4a1	2897	/// @param[in] dstPoint [58-5B] is a point_t defining the destination coordinate.
WiredHome	139:99ec74e3273f	2898	/// @param[in] srcLayer layer [57.7]. layer value is 0 or 1 representing layer 1 and 2.
WiredHome	131:5bd6ba2ee4a1	2899	/// @param[in] srcDataSelect [50.6] defines the source data type 0: block, 1: linear.
WiredHome	131:5bd6ba2ee4a1	2900	/// @param[in] srcPoint [54-57] is a point_t defining the source coordinate.
WiredHome	131:5bd6ba2ee4a1	2901	/// @param[in] bte_width [5C-5D]. operation width.
WiredHome	131:5bd6ba2ee4a1	2902	/// @param[in] bte_height [5E-5F]. operation height.
WiredHome	190:3132b7dfad82	2903	/// @param[in] bte_op_code [51.3-0] defines the raster operation function
WiredHome	131:5bd6ba2ee4a1	2904	/// (write/read/move/...)
WiredHome	131:5bd6ba2ee4a1	2905	/// @param[in] bte_rop_code [51.7-4] defines what type of BTE operation to perform
WiredHome	131:5bd6ba2ee4a1	2906	/// (what is placed at the destination)
WiredHome	167:8aa3fb2a5a31	2907	/// @returns @ref RetCode_t value.
WiredHome	131:5bd6ba2ee4a1	2908	///
WiredHome	131:5bd6ba2ee4a1	2909	RetCode_t BlockMove(uint8_t dstLayer, uint8_t dstDataSelect, point_t dstPoint,
WiredHome	131:5bd6ba2ee4a1	2910	uint8_t srcLayer, uint8_t srcDataSelect, point_t srcPoint,
WiredHome	137:9e09f6081ef1	2911	dim_t bte_width, dim_t bte_height,
WiredHome	131:5bd6ba2ee4a1	2912	uint8_t bte_op_code, uint8_t bte_rop_code);
WiredHome	131:5bd6ba2ee4a1	2913
WiredHome	131:5bd6ba2ee4a1	2914
WiredHome	19:3f82c1161fd2	2915	/// Control display power
WiredHome	19:3f82c1161fd2	2916	///
WiredHome	72:ecffe56af969	2917	/// @param[in] on when set to true will turn on the display, when false it is turned off.
WiredHome	167:8aa3fb2a5a31	2918	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2919	///
WiredHome	19:3f82c1161fd2	2920	RetCode_t Power(bool on);
WiredHome	19:3f82c1161fd2	2921
WiredHome	125:7a0b70f56550	2922
WiredHome	19:3f82c1161fd2	2923	/// Reset the display controller via the Software Reset interface.
WiredHome	19:3f82c1161fd2	2924	///
WiredHome	167:8aa3fb2a5a31	2925	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2926	///
WiredHome	19:3f82c1161fd2	2927	RetCode_t Reset(void);
WiredHome	190:3132b7dfad82	2928
WiredHome	125:7a0b70f56550	2929
WiredHome	19:3f82c1161fd2	2930	/// Set backlight brightness.
WiredHome	19:3f82c1161fd2	2931	///
WiredHome	190:3132b7dfad82	2932	/// When the built-in PWM is used to control the backlight, this
WiredHome	19:3f82c1161fd2	2933	/// API can be used to set the brightness.
WiredHome	190:3132b7dfad82	2934	///
WiredHome	72:ecffe56af969	2935	/// @param[in] brightness ranges from 0 (off) to 255 (full on)
WiredHome	167:8aa3fb2a5a31	2936	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2937	///
WiredHome	131:5bd6ba2ee4a1	2938	RetCode_t Backlight_u8(uint8_t brightness);
WiredHome	125:7a0b70f56550	2939
WiredHome	190:3132b7dfad82	2940
WiredHome	86:e86b355940f4	2941	/// Get backlight brightness.
WiredHome	86:e86b355940f4	2942	///
WiredHome	86:e86b355940f4	2943	/// @returns backlight setting from 0 (off) to 255 (full on).
WiredHome	190:3132b7dfad82	2944	///
WiredHome	86:e86b355940f4	2945	uint8_t GetBacklight_u8(void);
WiredHome	86:e86b355940f4	2946
WiredHome	19:3f82c1161fd2	2947	/// Set backlight brightness.
WiredHome	19:3f82c1161fd2	2948	///
WiredHome	190:3132b7dfad82	2949	/// When the built-in PWM is used to control the backlight, this
WiredHome	19:3f82c1161fd2	2950	/// API can be used to set the brightness.
WiredHome	190:3132b7dfad82	2951	///
WiredHome	72:ecffe56af969	2952	/// @param[in] brightness ranges from 0.0 (off) to 1.0 (full on)
WiredHome	167:8aa3fb2a5a31	2953	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	2954	///
WiredHome	19:3f82c1161fd2	2955	RetCode_t Backlight(float brightness);
WiredHome	19:3f82c1161fd2	2956
WiredHome	125:7a0b70f56550	2957
WiredHome	86:e86b355940f4	2958	/// Get backlight brightness.
WiredHome	86:e86b355940f4	2959	///
WiredHome	86:e86b355940f4	2960	/// @returns backlight setting from 0 (off) to 1.0 (full on).
WiredHome	190:3132b7dfad82	2961	///
WiredHome	86:e86b355940f4	2962	float GetBacklight(void);
WiredHome	86:e86b355940f4	2963
WiredHome	125:7a0b70f56550	2964
WiredHome	98:ecebed9b80b2	2965	/// Select a User Font for all subsequent text.
WiredHome	98:ecebed9b80b2	2966	///
WiredHome	98:ecebed9b80b2	2967	/// @note Tool to create the fonts is accessible from its creator
WiredHome	190:3132b7dfad82	2968	/// available at http://www.mikroe.com.
WiredHome	98:ecebed9b80b2	2969	/// For version 1.2.0.0, choose the "Export for TFT and new GLCD"
WiredHome	98:ecebed9b80b2	2970	/// format.
WiredHome	98:ecebed9b80b2	2971	///
WiredHome	98:ecebed9b80b2	2972	/// @param[in] font is a pointer to a specially formed font resource.
WiredHome	167:8aa3fb2a5a31	2973	/// @returns @ref RetCode_t value.
WiredHome	98:ecebed9b80b2	2974	///
WiredHome	98:ecebed9b80b2	2975	virtual RetCode_t SelectUserFont(const uint8_t * font = NULL);
WiredHome	98:ecebed9b80b2	2976
WiredHome	127:db7f2c704693	2977	/// Get the currently selected user font.
WiredHome	127:db7f2c704693	2978	///
WiredHome	127:db7f2c704693	2979	/// @returns a pointer to the font, or null, if no user font is selected.
WiredHome	127:db7f2c704693	2980	///
WiredHome	127:db7f2c704693	2981	virtual const uint8_t * GetUserFont(void) { return font; }
WiredHome	19:3f82c1161fd2	2982
WiredHome	167:8aa3fb2a5a31	2983	/// Get the @ref color_t value from a DOS color index.
WiredHome	167:8aa3fb2a5a31	2984	///
WiredHome	167:8aa3fb2a5a31	2985	/// See @ref PredefinedColors, @ref color_t.
WiredHome	190:3132b7dfad82	2986	///
WiredHome	125:7a0b70f56550	2987	/// @code
WiredHome	125:7a0b70f56550	2988	/// color_t color = DOSColor(12);
WiredHome	125:7a0b70f56550	2989	/// @endcode
WiredHome	125:7a0b70f56550	2990	///
WiredHome	167:8aa3fb2a5a31	2991	/// @param[in] i is the color index, in the range 0 to 15;
WiredHome	190:3132b7dfad82	2992	/// @returns the @ref color_t value of the selected index,
WiredHome	167:8aa3fb2a5a31	2993	/// or 0 (@ref Black) if the index is out of bounds.
WiredHome	19:3f82c1161fd2	2994	///
WiredHome	19:3f82c1161fd2	2995	color_t DOSColor(int i);
WiredHome	19:3f82c1161fd2	2996
WiredHome	125:7a0b70f56550	2997
WiredHome	167:8aa3fb2a5a31	2998	/// Get the color name (string) from a DOS color index.
WiredHome	167:8aa3fb2a5a31	2999	///
WiredHome	167:8aa3fb2a5a31	3000	/// See @ref PredefinedColors, @ref color_t.
WiredHome	190:3132b7dfad82	3001	///
WiredHome	125:7a0b70f56550	3002	/// @code
WiredHome	125:7a0b70f56550	3003	/// printf("color is %s\n", DOSColorNames(12));
WiredHome	125:7a0b70f56550	3004	/// @endcode
WiredHome	125:7a0b70f56550	3005	///
WiredHome	167:8aa3fb2a5a31	3006	/// @param[in] i is the color index, in the range 0 to 15;
WiredHome	19:3f82c1161fd2	3007	/// @returns a pointer to a string with the color name,
WiredHome	19:3f82c1161fd2	3008	/// or NULL if the index is out of bounds.
WiredHome	190:3132b7dfad82	3009	///
WiredHome	19:3f82c1161fd2	3010	const char * DOSColorNames(int i);
WiredHome	19:3f82c1161fd2	3011
WiredHome	125:7a0b70f56550	3012
WiredHome	55:dfbabef7003e	3013	/// Advanced method indicating the start of a graphics stream.
WiredHome	55:dfbabef7003e	3014	///
WiredHome	55:dfbabef7003e	3015	/// This is called prior to a stream of pixel data being sent.
WiredHome	55:dfbabef7003e	3016	/// This may cause register configuration changes in the derived
WiredHome	55:dfbabef7003e	3017	/// class in order to prepare the hardware to accept the streaming
WiredHome	55:dfbabef7003e	3018	/// data.
WiredHome	55:dfbabef7003e	3019	///
WiredHome	106:c80828f5dea4	3020	/// Following this command, a series of See @ref _putp() commands can
WiredHome	55:dfbabef7003e	3021	/// be used to send individual pixels to the screen.
WiredHome	55:dfbabef7003e	3022	///
WiredHome	106:c80828f5dea4	3023	/// To conclude the graphics stream, See @ref _EndGraphicsStream should
WiredHome	167:8aa3fb2a5a31	3024	/// be called.
WiredHome	167:8aa3fb2a5a31	3025	///
WiredHome	167:8aa3fb2a5a31	3026	/// @returns @ref RetCode_t value.
WiredHome	55:dfbabef7003e	3027	///
WiredHome	55:dfbabef7003e	3028	virtual RetCode_t _StartGraphicsStream(void);
WiredHome	125:7a0b70f56550	3029
WiredHome	190:3132b7dfad82	3030
WiredHome	55:dfbabef7003e	3031	/// Advanced method to put a single color pixel to the screen.
WiredHome	55:dfbabef7003e	3032	///
WiredHome	190:3132b7dfad82	3033	/// This method may be called as many times as necessary after
WiredHome	190:3132b7dfad82	3034	/// See @ref _StartGraphicsStream() is called, and it should be followed
WiredHome	55:dfbabef7003e	3035	/// by _EndGraphicsStream.
WiredHome	55:dfbabef7003e	3036	///
WiredHome	125:7a0b70f56550	3037	/// @code
WiredHome	125:7a0b70f56550	3038	/// _putp(DOSColor(12));
WiredHome	125:7a0b70f56550	3039	/// @endcode
WiredHome	125:7a0b70f56550	3040	///
WiredHome	72:ecffe56af969	3041	/// @param[in] pixel is a color value to be put on the screen.
WiredHome	167:8aa3fb2a5a31	3042	/// @returns @ref RetCode_t value.
WiredHome	55:dfbabef7003e	3043	///
WiredHome	55:dfbabef7003e	3044	virtual RetCode_t _putp(color_t pixel);
WiredHome	125:7a0b70f56550	3045
WiredHome	190:3132b7dfad82	3046
WiredHome	55:dfbabef7003e	3047	/// Advanced method indicating the end of a graphics stream.
WiredHome	55:dfbabef7003e	3048	///
WiredHome	55:dfbabef7003e	3049	/// This is called to conclude a stream of pixel data that was sent.
WiredHome	55:dfbabef7003e	3050	/// This may cause register configuration changes in the derived
WiredHome	55:dfbabef7003e	3051	/// class in order to stop the hardware from accept the streaming
WiredHome	55:dfbabef7003e	3052	/// data.
WiredHome	55:dfbabef7003e	3053	///
WiredHome	167:8aa3fb2a5a31	3054	/// @returns @ref RetCode_t value.
WiredHome	55:dfbabef7003e	3055	///
WiredHome	55:dfbabef7003e	3056	virtual RetCode_t _EndGraphicsStream(void);
WiredHome	19:3f82c1161fd2	3057
WiredHome	125:7a0b70f56550	3058
WiredHome	57:bd53a9e165a1	3059	/// Set the SPI port frequency (in Hz).
WiredHome	57:bd53a9e165a1	3060	///
WiredHome	66:468a11f05580	3061	/// This uses the mbed SPI driver, and is therefore dependent on
WiredHome	66:468a11f05580	3062	/// its capabilities. The RA8875 can accept writes via SPI faster
WiredHome	66:468a11f05580	3063	/// than a read can be performed. The frequency set by this API
WiredHome	66:468a11f05580	3064	/// is for the SPI writes. It will automatically reduce the SPI
WiredHome	190:3132b7dfad82	3065	/// clock rate when a read is performed, and restore it for the
WiredHome	68:ab08efabfc88	3066	/// next write. Alternately, the 2nd parameters permits setting
WiredHome	68:ab08efabfc88	3067	/// the read speed rather than letting it compute it automatically.
WiredHome	57:bd53a9e165a1	3068	///
WiredHome	66:468a11f05580	3069	/// @note The primary effect of this is to recover more CPU cycles
WiredHome	66:468a11f05580	3070	/// for your application code. Keep in mind that when more than
WiredHome	66:468a11f05580	3071	/// one command is sent to the display controller, that it
WiredHome	66:468a11f05580	3072	/// will wait for the controller to finish the prior command.
WiredHome	66:468a11f05580	3073	/// In this case, the performance is limited by the RA8875.
WiredHome	57:bd53a9e165a1	3074	///
WiredHome	72:ecffe56af969	3075	/// @param[in] Hz is the frequency in Hz, tested range includes the
WiredHome	66:468a11f05580	3076	/// range from 1,000,000 (1MHz) to 10,000,000 (10 MHz). Values
WiredHome	66:468a11f05580	3077	/// outside this range will be accepted, but operation may
WiredHome	76:c981284eb513	3078	/// be unreliable. This depends partially on your hardware design
WiredHome	76:c981284eb513	3079	/// and the wires connecting the display module.
WiredHome	76:c981284eb513	3080	/// The default value is 5,000,000, which should work for most
WiredHome	76:c981284eb513	3081	/// applications as a starting point.
WiredHome	72:ecffe56af969	3082	/// @param[in] Hz2 is an optional parameter and will set the read
WiredHome	68:ab08efabfc88	3083	/// speed independently of the write speed.
WiredHome	167:8aa3fb2a5a31	3084	/// @returns @ref RetCode_t value.
WiredHome	57:bd53a9e165a1	3085	///
WiredHome	68:ab08efabfc88	3086	RetCode_t frequency(unsigned long Hz = RA8875_DEFAULT_SPI_FREQ, unsigned long Hz2 = 0);
WiredHome	125:7a0b70f56550	3087
WiredHome	125:7a0b70f56550	3088
WiredHome	72:ecffe56af969	3089	/// This method captures the specified area as a 24-bit bitmap file.
WiredHome	72:ecffe56af969	3090	///
WiredHome	72:ecffe56af969	3091	/// Even though this is a 16-bit display, the stored image is in
WiredHome	72:ecffe56af969	3092	/// 24-bit format.
WiredHome	72:ecffe56af969	3093	///
WiredHome	73:f22a18707b5e	3094	/// This method will interrogate the current display setting and
WiredHome	190:3132b7dfad82	3095	/// create a bitmap based on those settings. For instance, if
WiredHome	73:f22a18707b5e	3096	/// only layer 1 is visible, then the bitmap is only layer 1. However,
WiredHome	73:f22a18707b5e	3097	/// if there is some other operation in effect (transparent mode).
WiredHome	73:f22a18707b5e	3098	///
WiredHome	149:c62c4b2d6a15	3099	/// If the idle callback is registered, it will be activated passing
WiredHome	149:c62c4b2d6a15	3100	/// a parameter indicating the percent complete, which may be of value.
WiredHome	149:c62c4b2d6a15	3101	///
WiredHome	72:ecffe56af969	3102	/// @param[in] x is the left edge of the region to capture
WiredHome	72:ecffe56af969	3103	/// @param[in] y is the top edge of the region to capture
WiredHome	72:ecffe56af969	3104	/// @param[in] w is the width of the region to capture
WiredHome	72:ecffe56af969	3105	/// @param[in] h is the height of the region to capture.
WiredHome	163:17526689a3ed	3106	/// @param[in] Name_BMP is the filename to write the image to.
WiredHome	190:3132b7dfad82	3107	/// @param[in] bitsPerPixel is optional, defaults to 24, and only
WiredHome	163:17526689a3ed	3108	/// accepts the values 24, 8
WiredHome	164:76edd7d9cb68	3109	/// NOTE: The downscaling is CPU intensive, and the operation
WiredHome	164:76edd7d9cb68	3110	/// takes longer.
WiredHome	167:8aa3fb2a5a31	3111	/// @returns @ref RetCode_t value.
WiredHome	72:ecffe56af969	3112	///
WiredHome	163:17526689a3ed	3113	RetCode_t PrintScreen(loc_t x, loc_t y, dim_t w, dim_t h, const char *Name_BMP, uint8_t bitsPerPixel = 24);
WiredHome	125:7a0b70f56550	3114
WiredHome	190:3132b7dfad82	3115
WiredHome	96:40b74dd3695b	3116	/// This method captures the specified area as a 24-bit bitmap file
WiredHome	96:40b74dd3695b	3117	/// and delivers it to the previously attached callback.
WiredHome	96:40b74dd3695b	3118	///
WiredHome	96:40b74dd3695b	3119	/// Even though this is a 16-bit display, the stored image is in
WiredHome	96:40b74dd3695b	3120	/// 24-bit format.
WiredHome	96:40b74dd3695b	3121	///
WiredHome	96:40b74dd3695b	3122	/// This method will interrogate the current display setting and
WiredHome	190:3132b7dfad82	3123	/// create a bitmap based on those settings. For instance, if
WiredHome	96:40b74dd3695b	3124	/// only layer 1 is visible, then the bitmap is only layer 1. However,
WiredHome	96:40b74dd3695b	3125	/// if there is some other operation in effect (transparent mode), it
WiredHome	96:40b74dd3695b	3126	/// will return the blended image.
WiredHome	96:40b74dd3695b	3127	///
WiredHome	149:c62c4b2d6a15	3128	/// If the idle callback is registered, it will be activated passing
WiredHome	149:c62c4b2d6a15	3129	/// a parameter indicating the percent complete, which may be of value.
WiredHome	149:c62c4b2d6a15	3130	///
WiredHome	96:40b74dd3695b	3131	/// @param[in] x is the left edge of the region to capture
WiredHome	96:40b74dd3695b	3132	/// @param[in] y is the top edge of the region to capture
WiredHome	96:40b74dd3695b	3133	/// @param[in] w is the width of the region to capture
WiredHome	96:40b74dd3695b	3134	/// @param[in] h is the height of the region to capture.
WiredHome	190:3132b7dfad82	3135	/// @param[in] bitsPerPixel is optional, defaults to 24, and only
WiredHome	164:76edd7d9cb68	3136	/// accepts the values 24, 8
WiredHome	164:76edd7d9cb68	3137	/// NOTE: The downscaling is CPU intensive, and the operation
WiredHome	164:76edd7d9cb68	3138	/// takes longer.
WiredHome	167:8aa3fb2a5a31	3139	/// @returns @ref RetCode_t value.
WiredHome	96:40b74dd3695b	3140	///
WiredHome	164:76edd7d9cb68	3141	RetCode_t PrintScreen(loc_t x, loc_t y, dim_t w, dim_t h, uint8_t bitsPerPixel = 24);
WiredHome	125:7a0b70f56550	3142
WiredHome	190:3132b7dfad82	3143
WiredHome	96:40b74dd3695b	3144	/// PrintScreen callback registration.
WiredHome	96:40b74dd3695b	3145	///
WiredHome	96:40b74dd3695b	3146	/// This method attaches a simple c-compatible callback of type PrintCallback_T.
WiredHome	96:40b74dd3695b	3147	/// Then, the PrintScreen(x,y,w,h) method is called. Each chunk of data in the
WiredHome	96:40b74dd3695b	3148	/// BMP file to be created is passed to this callback.
WiredHome	190:3132b7dfad82	3149	///
WiredHome	123:2f45e80fec5f	3150	/// @param callback is the optional callback function. Without a callback function
WiredHome	123:2f45e80fec5f	3151	/// it will unregister the handler.
WiredHome	96:40b74dd3695b	3152	///
WiredHome	123:2f45e80fec5f	3153	void AttachPrintHandler(PrintCallback_T callback = NULL) { c_callback = callback; }
WiredHome	96:40b74dd3695b	3154
WiredHome	125:7a0b70f56550	3155
WiredHome	96:40b74dd3695b	3156	/// PrintScreen callback registration.
WiredHome	96:40b74dd3695b	3157	///
WiredHome	96:40b74dd3695b	3158	/// This method attaches a c++ class method as a callback of type PrintCallback_T.
WiredHome	96:40b74dd3695b	3159	/// Then, the PrintScreen(x,y,w,h) method is called. Each chunk of data in the
WiredHome	96:40b74dd3695b	3160	/// BMP file to be created is passed to this callback.
WiredHome	190:3132b7dfad82	3161	///
WiredHome	96:40b74dd3695b	3162	/// @param object is the class hosting the callback function.
WiredHome	102:fc60bfa0199f	3163	/// @param method is the callback method in the object to activate.
WiredHome	96:40b74dd3695b	3164	///
lamell	198:18d25c15a7b5	3165
lamell	198:18d25c15a7b5	3166	//Commeting out this part, becase it gives errors when using K64F.
lamell	198:18d25c15a7b5	3167	// template <class T>
lamell	198:18d25c15a7b5	3168	// void AttachPrintHandler(T object, RetCode_t (T::method)(void)) {
lamell	198:18d25c15a7b5	3169	// obj_callback = (FPointerDummy *)object;
lamell	198:18d25c15a7b5	3170	// method_callback = (uint32_t (FPointerDummy::)(uint32_t, uint8_t , uint16_t))method;
lamell	198:18d25c15a7b5	3171	// }
WiredHome	96:40b74dd3695b	3172
WiredHome	125:7a0b70f56550	3173
WiredHome	72:ecffe56af969	3174	/// This method captures the specified area as a 24-bit bitmap file,
WiredHome	72:ecffe56af969	3175	/// including the option of layer selection.
WiredHome	72:ecffe56af969	3176	///
WiredHome	125:7a0b70f56550	3177	/// @note This method is deprecated as the alternate PrintScreen API
WiredHome	74:686faa218914	3178	/// automatically examines the display layer configuration.
WiredHome	74:686faa218914	3179	/// Therefore, calls to this API will ignore the layer parameter
WiredHome	74:686faa218914	3180	/// and automatically execute the other method.
WiredHome	74:686faa218914	3181	///
WiredHome	72:ecffe56af969	3182	/// Even though this is a 16-bit display, the stored image is in
WiredHome	72:ecffe56af969	3183	/// 24-bit format.
WiredHome	72:ecffe56af969	3184	///
WiredHome	72:ecffe56af969	3185	/// @param[in] layer is 0 or 1 to select the layer to extract.
WiredHome	72:ecffe56af969	3186	/// @param[in] x is the left edge of the region to capture
WiredHome	72:ecffe56af969	3187	/// @param[in] y is the top edge of the region to capture
WiredHome	72:ecffe56af969	3188	/// @param[in] w is the width of the region to capture
WiredHome	72:ecffe56af969	3189	/// @param[in] h is the height of the region to capture.
WiredHome	72:ecffe56af969	3190	/// @param[out] Name_BMP is the filename to write the image to.
WiredHome	167:8aa3fb2a5a31	3191	/// @returns @ref RetCode_t value.
WiredHome	72:ecffe56af969	3192	///
WiredHome	72:ecffe56af969	3193	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	3194
WiredHome	190:3132b7dfad82	3195
WiredHome	123:2f45e80fec5f	3196	/// idle callback registration.
WiredHome	123:2f45e80fec5f	3197	///
WiredHome	125:7a0b70f56550	3198	/// This method attaches a simple c-compatible callback of type IdleCallback_T.
WiredHome	123:2f45e80fec5f	3199	/// Then, at any time when the display driver is waiting, it will call the
WiredHome	123:2f45e80fec5f	3200	/// registered function. This is probably most useful if you want to service
WiredHome	123:2f45e80fec5f	3201	/// a watchdog, when you may have called an API that will "hang" waiting
WiredHome	123:2f45e80fec5f	3202	/// on the user.
WiredHome	123:2f45e80fec5f	3203	///
WiredHome	149:c62c4b2d6a15	3204	/// @code
WiredHome	149:c62c4b2d6a15	3205	/// RetCode_t myIdle_handler(RA8875::IdleReason_T reason, uint16_t param)
WiredHome	149:c62c4b2d6a15	3206	/// {
WiredHome	149:c62c4b2d6a15	3207	/// static uint16_t lastProgress = 0xFFFF;
WiredHome	149:c62c4b2d6a15	3208	///
WiredHome	149:c62c4b2d6a15	3209	/// if (reason == RA8875::progress && param != lastProgress) {
WiredHome	149:c62c4b2d6a15	3210	/// printf("Progress %3d%%\r\n", param);
WiredHome	149:c62c4b2d6a15	3211	/// lastProgress = progress;
WiredHome	149:c62c4b2d6a15	3212	/// }
WiredHome	149:c62c4b2d6a15	3213	/// return noerror;
WiredHome	149:c62c4b2d6a15	3214	/// }
WiredHome	149:c62c4b2d6a15	3215	///
WiredHome	149:c62c4b2d6a15	3216	/// ...
WiredHome	149:c62c4b2d6a15	3217	/// lcd.AttachIdleHandler(myIdle_handler);
WiredHome	149:c62c4b2d6a15	3218	/// ...
WiredHome	149:c62c4b2d6a15	3219	/// RetCode_t r = lcd.PrintScreen(0,0,LCD_W,LCD_H,"/local/print.bmp");
WiredHome	149:c62c4b2d6a15	3220	/// if (r ...)
WiredHome	149:c62c4b2d6a15	3221	/// @endcode
WiredHome	149:c62c4b2d6a15	3222	///
WiredHome	149:c62c4b2d6a15	3223	///
WiredHome	123:2f45e80fec5f	3224	/// @param callback is the idle callback function. Without a callback function
WiredHome	123:2f45e80fec5f	3225	/// it will unregister the handler.
WiredHome	123:2f45e80fec5f	3226	///
WiredHome	123:2f45e80fec5f	3227	void AttachIdleHandler(IdleCallback_T callback = NULL) { idle_callback = callback; }
WiredHome	57:bd53a9e165a1	3228
WiredHome	133:e36dcfc2d756	3229
WiredHome	19:3f82c1161fd2	3230	#ifdef PERF_METRICS
WiredHome	19:3f82c1161fd2	3231	/// Clear the performance metrics to zero.
WiredHome	19:3f82c1161fd2	3232	void ClearPerformance();
WiredHome	190:3132b7dfad82	3233
WiredHome	66:468a11f05580	3234	/// Count idle time.
WiredHome	66:468a11f05580	3235	///
WiredHome	72:ecffe56af969	3236	/// @param[in] t is the amount of idle time to accumulate.
WiredHome	66:468a11f05580	3237	///
WiredHome	66:468a11f05580	3238	void CountIdleTime(uint32_t t);
WiredHome	190:3132b7dfad82	3239
WiredHome	19:3f82c1161fd2	3240	/// Report the performance metrics for drawing functions using
WiredHome	41:2956a0a221e5	3241	/// the available serial channel.
WiredHome	41:2956a0a221e5	3242	///
WiredHome	72:ecffe56af969	3243	/// @param[in,out] pc is the serial channel to write to.
WiredHome	41:2956a0a221e5	3244	///
WiredHome	41:2956a0a221e5	3245	void ReportPerformance(Serial & pc);
WiredHome	19:3f82c1161fd2	3246	#endif
WiredHome	19:3f82c1161fd2	3247
hexley	54:e117ad10fba6	3248
WiredHome	19:3f82c1161fd2	3249	private:
WiredHome	182:8832d03a2a29	3250	void InitAllMemberVars();
WiredHome	182:8832d03a2a29	3251
WiredHome	124:1690a7ae871c	3252	/// Touch panel parameters - common to both resistive and capacitive
WiredHome	190:3132b7dfad82	3253
WiredHome	124:1690a7ae871c	3254	/// Data type to indicate which TP, if any, is in use.
WiredHome	124:1690a7ae871c	3255	typedef enum {
WiredHome	124:1690a7ae871c	3256	TP_NONE, ///< no touch panel in use
WiredHome	124:1690a7ae871c	3257	TP_RES, ///< resistive touch panel using RA8875
WiredHome	165:695c24cc5197	3258	TP_FT5206, ///< Capacitive touch panel using FT5206
WiredHome	165:695c24cc5197	3259	TP_CAP=TP_FT5206, ///< DEPRECATED: used TP_CAP5206 for that chip-set
WiredHome	165:695c24cc5197	3260	TP_GSL1680, ///< Capacitive touch panel using GSL1680 chip
WiredHome	124:1690a7ae871c	3261	} WhichTP_T;
WiredHome	190:3132b7dfad82	3262
WiredHome	124:1690a7ae871c	3263	/// boolean flag set true when using Capacitive touch panel, and false
WiredHome	124:1690a7ae871c	3264	/// for resistive.
WiredHome	124:1690a7ae871c	3265	WhichTP_T useTouchPanel; ///< Indicates which TP is selected for use.
WiredHome	190:3132b7dfad82	3266
WiredHome	124:1690a7ae871c	3267	/// Touch State used by TouchPanelReadable. See @ref TouchCode_t.
WiredHome	124:1690a7ae871c	3268	TouchCode_t touchState;
WiredHome	124:1690a7ae871c	3269
WiredHome	124:1690a7ae871c	3270	////////////////// Start of Capacitive Touch Panel parameters
WiredHome	190:3132b7dfad82	3271
WiredHome	162:a2d7f1988711	3272	int RoundUp(int value, int roundTo);
WiredHome	165:695c24cc5197	3273	uint8_t FT5206_TouchPositions(void);
WiredHome	165:695c24cc5197	3274	uint8_t FT5206_ReadRegU8(uint8_t reg);
WiredHome	165:695c24cc5197	3275	uint8_t GSL1680_TouchPositions(void);
WiredHome	165:695c24cc5197	3276	uint8_t GSL1680_ReadRegU8(uint8_t reg, uint8_t * buf, int count);
WiredHome	165:695c24cc5197	3277	RetCode_t FT5206_Init();
WiredHome	165:695c24cc5197	3278	RetCode_t GSL1680_Init();
WiredHome	165:695c24cc5197	3279
WiredHome	124:1690a7ae871c	3280	void TouchPanelISR(void);
WiredHome	124:1690a7ae871c	3281	uint16_t numberOfTouchPoints;
WiredHome	165:695c24cc5197	3282	uint8_t gesture; ///< Holds the reported gesture information (which doesn't work well for the FT5206)
WiredHome	190:3132b7dfad82	3283
WiredHome	124:1690a7ae871c	3284	/// Touch Information data structure
WiredHome	124:1690a7ae871c	3285	typedef struct {
WiredHome	124:1690a7ae871c	3286	uint8_t touchID; ///< Contains the touch ID, which is the "order" of touch, from 0 to n-1
WiredHome	124:1690a7ae871c	3287	TouchCode_t touchCode; ///< Contains the touch code; no_touch, touch, held, release
WiredHome	124:1690a7ae871c	3288	point_t coordinates; ///< Contains the X,Y coordinate of the touch
WiredHome	124:1690a7ae871c	3289	} touchInfo_T;
WiredHome	124:1690a7ae871c	3290
WiredHome	166:53fd4a876dac	3291	touchInfo_T * touchInfo; /// Storage allocated by the constructor to contains the touch information
WiredHome	124:1690a7ae871c	3292
WiredHome	155:b3f225ae572c	3293	#if MBED_VERSION >= MBED_ENCODE_VERSION(5,8,0)
WiredHome	155:b3f225ae572c	3294	Thread eventThread;
WiredHome	155:b3f225ae572c	3295	EventQueue queue;
WiredHome	155:b3f225ae572c	3296	#endif
WiredHome	124:1690a7ae871c	3297	InterruptIn * m_irq;
WiredHome	124:1690a7ae871c	3298	I2C * m_i2c;
WiredHome	165:695c24cc5197	3299	int m_addr; /// I2C Address of the Cap Touch Controller
WiredHome	165:695c24cc5197	3300	//uint8_t data[2]; /// Transfer data for the I2C interface
WiredHome	124:1690a7ae871c	3301
WiredHome	124:1690a7ae871c	3302	bool panelTouched;
WiredHome	190:3132b7dfad82	3303
WiredHome	124:1690a7ae871c	3304	////////////////// Start of Resistive Touch Panel parameters
WiredHome	190:3132b7dfad82	3305
WiredHome	193:74f80834d59d	3306	#if 0
WiredHome	124:1690a7ae871c	3307	/// Resistive Touch Panel register name definitions
WiredHome	77:9206c13aa527	3308	#define TPCR0 0x70
WiredHome	77:9206c13aa527	3309	#define TPCR1 0x71
WiredHome	77:9206c13aa527	3310	#define TPXH 0x72
WiredHome	77:9206c13aa527	3311	#define TPYH 0x73
WiredHome	77:9206c13aa527	3312	#define TPXYL 0x74
WiredHome	77:9206c13aa527	3313	#define INTC1 0xF0
WiredHome	77:9206c13aa527	3314	#define INTC2 0xF1
WiredHome	193:74f80834d59d	3315	#endif
hexley	54:e117ad10fba6	3316
hexley	54:e117ad10fba6	3317	/// Specify the default settings for the Touch Panel, where different from the chip defaults
WiredHome	77:9206c13aa527	3318	#define TP_MODE_DEFAULT TP_MODE_AUTO
WiredHome	77:9206c13aa527	3319	#define TP_DEBOUNCE_DEFAULT TP_DEBOUNCE_ON
WiredHome	77:9206c13aa527	3320	#define TP_ADC_CLKDIV_DEFAULT TP_ADC_CLKDIV_8
hexley	54:e117ad10fba6	3321
WiredHome	77:9206c13aa527	3322	#define TP_ADC_SAMPLE_DEFAULT_CLKS TP_ADC_SAMPLE_8192_CLKS
hexley	54:e117ad10fba6	3323
hexley	54:e117ad10fba6	3324	/// Other Touch Panel params
WiredHome	77:9206c13aa527	3325	#define TPBUFSIZE 16 // Depth of the averaging buffers for x and y data
hexley	54:e117ad10fba6	3326
WiredHome	83:7bad0068cca0	3327	// Needs both a ticker and a timer. (could have created a timer from the ticker, but this is easier).
WiredHome	83:7bad0068cca0	3328	// on a touch, the timer is reset.
WiredHome	83:7bad0068cca0	3329	// the ticker monitors the timer to see if it has been a long time since
WiredHome	83:7bad0068cca0	3330	// a touch, and if so, it then clears the sample counter so it doesn't get partial old
WiredHome	83:7bad0068cca0	3331	// and partial new.
WiredHome	190:3132b7dfad82	3332
WiredHome	83:7bad0068cca0	3333	/// Touch Panel ticker
WiredHome	165:695c24cc5197	3334	/// This it bound to a timer to call the _TouchTicker() function periodically.
WiredHome	165:695c24cc5197	3335	///
WiredHome	83:7bad0068cca0	3336	Ticker touchTicker;
WiredHome	190:3132b7dfad82	3337
WiredHome	83:7bad0068cca0	3338	/// Touch Panel timer
WiredHome	165:695c24cc5197	3339	/// Reset on a touch, to expire on a non-touch
WiredHome	165:695c24cc5197	3340	///
WiredHome	165:695c24cc5197	3341	Timer timeSinceTouch;
WiredHome	190:3132b7dfad82	3342
WiredHome	83:7bad0068cca0	3343	/// keeps track of which sample we're collecting to filter out the noise.
WiredHome	83:7bad0068cca0	3344	int touchSample;
WiredHome	190:3132b7dfad82	3345
WiredHome	83:7bad0068cca0	3346	/// Private function for touch ticker callback.
WiredHome	83:7bad0068cca0	3347	void _TouchTicker(void);
WiredHome	190:3132b7dfad82	3348
WiredHome	77:9206c13aa527	3349	/// Touch Panel calibration matrix.
WiredHome	77:9206c13aa527	3350	tpMatrix_t tpMatrix;
hexley	54:e117ad10fba6	3351
WiredHome	157:1565f38ca44b	3352	/// RESISTIVE TP: The fully qualified filename for the RESISTIVE touch panel configuration settings.
WiredHome	157:1565f38ca44b	3353	const char * tpFQFN;
WiredHome	190:3132b7dfad82	3354
WiredHome	157:1565f38ca44b	3355	/// RESISTIVE TP: The text message shown to the user during the calibration process.
WiredHome	157:1565f38ca44b	3356	const char * tpCalMessage;
WiredHome	157:1565f38ca44b	3357
WiredHome	157:1565f38ca44b	3358	/// Internal method that performs the TS Cal when the user has so-configured it
WiredHome	157:1565f38ca44b	3359	RetCode_t _internal_ts_cal();
WiredHome	157:1565f38ca44b	3360
WiredHome	157:1565f38ca44b	3361
WiredHome	124:1690a7ae871c	3362	////////////////// End of Touch Panel parameters
WiredHome	124:1690a7ae871c	3363
WiredHome	124:1690a7ae871c	3364
WiredHome	29:422616aa04bd	3365	/// Internal function to put a character using the built-in (internal) font engine
WiredHome	29:422616aa04bd	3366	///
WiredHome	101:e0aad446094a	3367	/// @param[in] c is the character to put to the screen.
WiredHome	29:422616aa04bd	3368	/// @returns the character put.
WiredHome	29:422616aa04bd	3369	///
WiredHome	29:422616aa04bd	3370	int _internal_putc(int c);
WiredHome	190:3132b7dfad82	3371
WiredHome	29:422616aa04bd	3372	/// Internal function to put a character using the external font engine
WiredHome	29:422616aa04bd	3373	///
WiredHome	101:e0aad446094a	3374	/// @param[in] c is the character to put to the screen.
WiredHome	29:422616aa04bd	3375	/// @returns the character put.
WiredHome	29:422616aa04bd	3376	///
WiredHome	29:422616aa04bd	3377	int _external_putc(int c);
WiredHome	190:3132b7dfad82	3378
WiredHome	101:e0aad446094a	3379	/// Internal function to get the actual width of a character when using the external font engine
WiredHome	101:e0aad446094a	3380	///
WiredHome	101:e0aad446094a	3381	/// @param[in] c is the character to get the width.
WiredHome	101:e0aad446094a	3382	/// @returns the width in pixels of the character. zero if not found.
WiredHome	101:e0aad446094a	3383	///
WiredHome	101:e0aad446094a	3384	int _external_getCharWidth(int c);
WiredHome	190:3132b7dfad82	3385
WiredHome	133:e36dcfc2d756	3386	/// Write color to an RGB register set
WiredHome	133:e36dcfc2d756	3387	///
WiredHome	133:e36dcfc2d756	3388	/// This API takes a color value, and writes it into the specified
WiredHome	133:e36dcfc2d756	3389	/// color registers, which are a trio of 3 registers. The actual
WiredHome	133:e36dcfc2d756	3390	/// trio write is performed based on whether the display is configured
WiredHome	133:e36dcfc2d756	3391	/// for 8 or 16 bits per pixel.
WiredHome	133:e36dcfc2d756	3392	///
WiredHome	133:e36dcfc2d756	3393	/// @param[in] regAddr is the register address starting the trio
WiredHome	133:e36dcfc2d756	3394	/// @param[in] color is the color to write
WiredHome	167:8aa3fb2a5a31	3395	/// @returns @ref RetCode_t value.
WiredHome	133:e36dcfc2d756	3396	///
WiredHome	133:e36dcfc2d756	3397	RetCode_t _writeColorTrio(uint8_t regAddr, color_t color);
WiredHome	190:3132b7dfad82	3398
WiredHome	133:e36dcfc2d756	3399	/// Read color from an RGB register set
WiredHome	133:e36dcfc2d756	3400	///
WiredHome	133:e36dcfc2d756	3401	/// This API reads a color value from a trio of registers. The actual
WiredHome	133:e36dcfc2d756	3402	/// trio write is performed based on whether the display is configured
WiredHome	133:e36dcfc2d756	3403	/// for 8 or 16 bits per pixel.
WiredHome	133:e36dcfc2d756	3404	///
WiredHome	133:e36dcfc2d756	3405	/// @param[in] regAddr is the register address starting the trio
WiredHome	133:e36dcfc2d756	3406	/// @returns color_t value
WiredHome	133:e36dcfc2d756	3407	///
WiredHome	133:e36dcfc2d756	3408	color_t _readColorTrio(uint8_t regAddr);
WiredHome	190:3132b7dfad82	3409
WiredHome	190:3132b7dfad82	3410
WiredHome	105:4f116006ba1f	3411	/// Convert a 16-bit color value to an 8-bit value
WiredHome	105:4f116006ba1f	3412	///
WiredHome	105:4f116006ba1f	3413	/// @param[in] c16 is the 16-bit color value to convert.
WiredHome	105:4f116006ba1f	3414	/// @returns 8-bit color value.
WiredHome	105:4f116006ba1f	3415	///
WiredHome	105:4f116006ba1f	3416	uint8_t _cvt16to8(color_t c16);
WiredHome	105:4f116006ba1f	3417
WiredHome	105:4f116006ba1f	3418	/// Convert an 8-bit color value to a 16-bit value
WiredHome	105:4f116006ba1f	3419	///
WiredHome	105:4f116006ba1f	3420	/// @param[in] c8 is the 8-bit color value to convert.
WiredHome	105:4f116006ba1f	3421	/// @returns 16-bit color value.
WiredHome	105:4f116006ba1f	3422	///
WiredHome	105:4f116006ba1f	3423	color_t _cvt8to16(uint8_t c8);
WiredHome	190:3132b7dfad82	3424
WiredHome	19:3f82c1161fd2	3425	/// Select the peripheral to use it.
WiredHome	19:3f82c1161fd2	3426	///
WiredHome	72:ecffe56af969	3427	/// @param[in] chipsel when true will select the peripheral, and when false
WiredHome	19:3f82c1161fd2	3428	/// will deselect the chip. This is the logical selection, and
WiredHome	19:3f82c1161fd2	3429	/// the pin selection is the invert of this.
WiredHome	167:8aa3fb2a5a31	3430	/// @returns @ref RetCode_t value.
WiredHome	19:3f82c1161fd2	3431	///
WiredHome	79:544eb4964795	3432	RetCode_t _select(bool chipsel);
WiredHome	19:3f82c1161fd2	3433
WiredHome	66:468a11f05580	3434	/// Wait while the status register indicates the controller is busy.
WiredHome	66:468a11f05580	3435	///
WiredHome	72:ecffe56af969	3436	/// @param[in] mask is the mask of bits to monitor.
WiredHome	66:468a11f05580	3437	/// @returns true if a normal exit.
WiredHome	66:468a11f05580	3438	/// @returns false if a timeout exit.
WiredHome	66:468a11f05580	3439	///
WiredHome	66:468a11f05580	3440	bool _WaitWhileBusy(uint8_t mask);
WiredHome	66:468a11f05580	3441
WiredHome	66:468a11f05580	3442	/// Wait while the the register anded with the mask is true.
WiredHome	66:468a11f05580	3443	///
WiredHome	72:ecffe56af969	3444	/// @param[in] reg is the register to monitor
WiredHome	72:ecffe56af969	3445	/// @param[in] mask is the bit mask to monitor
WiredHome	66:468a11f05580	3446	/// @returns true if it was a normal exit
WiredHome	66:468a11f05580	3447	/// @returns false if it was a timeout that caused the exit.
WiredHome	66:468a11f05580	3448	///
WiredHome	66:468a11f05580	3449	bool _WaitWhileReg(uint8_t reg, uint8_t mask);
WiredHome	66:468a11f05580	3450
WiredHome	68:ab08efabfc88	3451	/// set the spi port to either the write or the read speed.
WiredHome	68:ab08efabfc88	3452	///
WiredHome	68:ab08efabfc88	3453	/// This is a private API used to toggle between the write
WiredHome	68:ab08efabfc88	3454	/// and the read speed for the SPI port to the RA8875, since
WiredHome	68:ab08efabfc88	3455	/// it can accept writes faster than reads.
WiredHome	68:ab08efabfc88	3456	///
WiredHome	72:ecffe56af969	3457	/// @param[in] writeSpeed when true selects the write frequency,
WiredHome	68:ab08efabfc88	3458	/// and when false it selects the read frequency.
WiredHome	68:ab08efabfc88	3459	///
WiredHome	68:ab08efabfc88	3460	void _setWriteSpeed(bool writeSpeed);
WiredHome	68:ab08efabfc88	3461
WiredHome	19:3f82c1161fd2	3462	/// The most primitive - to write a data value to the SPI interface.
WiredHome	19:3f82c1161fd2	3463	///
WiredHome	72:ecffe56af969	3464	/// @param[in] data is the value to write.
WiredHome	19:3f82c1161fd2	3465	/// @returns a value read from the port, since SPI is often shift
WiredHome	19:3f82c1161fd2	3466	/// in while shifting out.
WiredHome	19:3f82c1161fd2	3467	///
WiredHome	79:544eb4964795	3468	unsigned char _spiwrite(unsigned char data);
WiredHome	190:3132b7dfad82	3469
WiredHome	19:3f82c1161fd2	3470	/// The most primitive - to read a data value to the SPI interface.
WiredHome	19:3f82c1161fd2	3471	///
WiredHome	19:3f82c1161fd2	3472	/// This is really just a specialcase of the write command, where
WiredHome	19:3f82c1161fd2	3473	/// the value zero is written in order to read.
WiredHome	19:3f82c1161fd2	3474	///
WiredHome	19:3f82c1161fd2	3475	/// @returns a value read from the port, since SPI is often shift
WiredHome	19:3f82c1161fd2	3476	/// in while shifting out.
WiredHome	19:3f82c1161fd2	3477	///
WiredHome	79:544eb4964795	3478	unsigned char _spiread();
WiredHome	190:3132b7dfad82	3479
WiredHome	75:ca78388cfd77	3480	const uint8_t * pKeyMap;
WiredHome	190:3132b7dfad82	3481
WiredHome	19:3f82c1161fd2	3482	SPI spi; ///< spi port
WiredHome	68:ab08efabfc88	3483	bool spiWriteSpeed; ///< indicates if the current mode is write or read
WiredHome	68:ab08efabfc88	3484	unsigned long spiwritefreq; ///< saved write freq
WiredHome	66:468a11f05580	3485	unsigned long spireadfreq; ///< saved read freq
WiredHome	165:695c24cc5197	3486	DigitalOut cs; ///< RA8875 chip select pin, assumed active low
WiredHome	165:695c24cc5197	3487	DigitalOut res; ///< RA8875 reset pin, assumed active low
WiredHome	165:695c24cc5197	3488	DigitalOut * m_wake; ///< GSL1680 wake pin
WiredHome	190:3132b7dfad82	3489
WiredHome	105:4f116006ba1f	3490	// display metrics to avoid lengthy spi read queries
WiredHome	105:4f116006ba1f	3491	uint8_t screenbpp; ///< configured bits per pixel
WiredHome	90:d113d71ae4f0	3492	dim_t screenwidth; ///< configured screen width
WiredHome	90:d113d71ae4f0	3493	dim_t screenheight; ///< configured screen height
WiredHome	190:3132b7dfad82	3494	rect_t windowrect; ///< window commands are held here for speed of access
WiredHome	90:d113d71ae4f0	3495	bool portraitmode; ///< set true when in portrait mode (w,h are reversed)
WiredHome	190:3132b7dfad82	3496	bool wordwrap; ///< set true when wordwrap is in effect for _puts()
WiredHome	19:3f82c1161fd2	3497	const unsigned char * font; ///< reference to an external font somewhere in memory
WiredHome	98:ecebed9b80b2	3498	uint8_t extFontHeight; ///< computed from the font table when the user sets the font
WiredHome	98:ecebed9b80b2	3499	uint8_t extFontWidth; ///< computed from the font table when the user sets the font
WiredHome	190:3132b7dfad82	3500	bool roundCap; ///< draw round end cap on thick lines when set.
WiredHome	90:d113d71ae4f0	3501	loc_t cursor_x, cursor_y; ///< used for external fonts only
WiredHome	190:3132b7dfad82	3502
WiredHome	19:3f82c1161fd2	3503	#ifdef PERF_METRICS
WiredHome	19:3f82c1161fd2	3504	typedef enum
WiredHome	19:3f82c1161fd2	3505	{
WiredHome	19:3f82c1161fd2	3506	PRF_CLS,
WiredHome	41:2956a0a221e5	3507	PRF_DRAWPIXEL,
WiredHome	41:2956a0a221e5	3508	PRF_PIXELSTREAM,
WiredHome	109:7b94f06f085b	3509	PRF_BOOLSTREAM,
WiredHome	41:2956a0a221e5	3510	PRF_READPIXEL,
WiredHome	41:2956a0a221e5	3511	PRF_READPIXELSTREAM,
WiredHome	19:3f82c1161fd2	3512	PRF_DRAWLINE,
WiredHome	19:3f82c1161fd2	3513	PRF_DRAWRECTANGLE,
WiredHome	19:3f82c1161fd2	3514	PRF_DRAWROUNDEDRECTANGLE,
WiredHome	19:3f82c1161fd2	3515	PRF_DRAWTRIANGLE,
WiredHome	19:3f82c1161fd2	3516	PRF_DRAWCIRCLE,
WiredHome	19:3f82c1161fd2	3517	PRF_DRAWELLIPSE,
WiredHome	131:5bd6ba2ee4a1	3518	PRF_BLOCKMOVE,
WiredHome	182:8832d03a2a29	3519	METRICCOUNT = PRF_BLOCKMOVE
WiredHome	19:3f82c1161fd2	3520	} method_e;
WiredHome	19:3f82c1161fd2	3521	unsigned long metrics[METRICCOUNT];
WiredHome	75:ca78388cfd77	3522	unsigned long idletime_usec;
WiredHome	19:3f82c1161fd2	3523	void RegisterPerformance(method_e method);
WiredHome	19:3f82c1161fd2	3524	Timer performance;
WiredHome	19:3f82c1161fd2	3525	#endif
WiredHome	190:3132b7dfad82	3526
WiredHome	96:40b74dd3695b	3527	RetCode_t _printCallback(RA8875::filecmd_t cmd, uint8_t * buffer, uint16_t size);
WiredHome	190:3132b7dfad82	3528
WiredHome	96:40b74dd3695b	3529	FILE * _printFH; ///< PrintScreen file handle
WiredHome	190:3132b7dfad82	3530
WiredHome	96:40b74dd3695b	3531	RetCode_t privateCallback(filecmd_t cmd, uint8_t * buffer, uint16_t size) {
WiredHome	96:40b74dd3695b	3532	if (c_callback != NULL) {
WiredHome	96:40b74dd3695b	3533	return (*c_callback)(cmd, buffer, size);
WiredHome	96:40b74dd3695b	3534	}
WiredHome	96:40b74dd3695b	3535	else {
WiredHome	96:40b74dd3695b	3536	if (obj_callback != NULL && method_callback != NULL) {
WiredHome	96:40b74dd3695b	3537	return (obj_callback->*method_callback)(cmd, buffer, size);
WiredHome	96:40b74dd3695b	3538	}
WiredHome	96:40b74dd3695b	3539	}
WiredHome	96:40b74dd3695b	3540	return noerror;
WiredHome	96:40b74dd3695b	3541	}
WiredHome	190:3132b7dfad82	3542
WiredHome	96:40b74dd3695b	3543	RetCode_t (* c_callback)(filecmd_t cmd, uint8_t * buffer, uint16_t size);
WiredHome	96:40b74dd3695b	3544	FPointerDummy *obj_callback;
WiredHome	96:40b74dd3695b	3545	RetCode_t (FPointerDummy::method_callback)(filecmd_t cmd, uint8_t buffer, uint16_t size);
WiredHome	149:c62c4b2d6a15	3546	RetCode_t (* idle_callback)(IdleReason_T reason, uint16_t param);
WiredHome	190:3132b7dfad82	3547
WiredHome	181:0032d1b8f5d4	3548	orientation_t screen_orientation;
WiredHome	181:0032d1b8f5d4	3549	point_t TranslateOrientation(point_t rawPoint);
WiredHome	19:3f82c1161fd2	3550	};
WiredHome	19:3f82c1161fd2	3551
WiredHome	96:40b74dd3695b	3552
WiredHome	19:3f82c1161fd2	3553	//} // namespace
WiredHome	19:3f82c1161fd2	3554
WiredHome	19:3f82c1161fd2	3555	//using namespace SW_graphics;
WiredHome	19:3f82c1161fd2	3556
WiredHome	23:a50ded45dbaf	3557
WiredHome	23:a50ded45dbaf	3558	#ifdef TESTENABLE
WiredHome	23:a50ded45dbaf	3559	// ______________ ______________ ______________ _______________
WiredHome	23:a50ded45dbaf	3560	// /_____ _____/ / ___________/ / ___________/ /_____ ______/
WiredHome	23:a50ded45dbaf	3561	// / / / / / / / /
WiredHome	23:a50ded45dbaf	3562	// / / / /___ / /__________ / /
WiredHome	23:a50ded45dbaf	3563	// / / / ____/ /__________ / / /
WiredHome	23:a50ded45dbaf	3564	// / / / / / / / /
WiredHome	23:a50ded45dbaf	3565	// / / / /__________ ___________/ / / /
WiredHome	23:a50ded45dbaf	3566	// /__/ /_____________/ /_____________/ /__/
WiredHome	23:a50ded45dbaf	3567
WiredHome	23:a50ded45dbaf	3568	#include "WebColors.h"
WiredHome	23:a50ded45dbaf	3569	#include <algorithm>
WiredHome	23:a50ded45dbaf	3570
WiredHome	23:a50ded45dbaf	3571	extern "C" void mbed_reset();
WiredHome	23:a50ded45dbaf	3572
WiredHome	190:3132b7dfad82	3573	/// This activates a small set of tests for the graphics library.
WiredHome	23:a50ded45dbaf	3574	///
WiredHome	23:a50ded45dbaf	3575	/// Call this API and pass it the reference to the display class.
WiredHome	23:a50ded45dbaf	3576	/// It will then run a series of tests. It accepts interaction via
WiredHome	23:a50ded45dbaf	3577	/// stdin to switch from automatic test mode to manual, run a specific
WiredHome	23:a50ded45dbaf	3578	/// test, or to exit the test mode.
WiredHome	23:a50ded45dbaf	3579	///
WiredHome	72:ecffe56af969	3580	/// @param[in] lcd is a reference to the display class.
WiredHome	72:ecffe56af969	3581	/// @param[in] pc is a reference to a serial interface, typically the USB to PC.
WiredHome	23:a50ded45dbaf	3582	///
WiredHome	23:a50ded45dbaf	3583	void RunTestSet(RA8875 & lcd, Serial & pc);
WiredHome	23:a50ded45dbaf	3584
WiredHome	23:a50ded45dbaf	3585
WiredHome	23:a50ded45dbaf	3586	// To enable the test code, uncomment this section, or copy the
WiredHome	23:a50ded45dbaf	3587	// necessary pieces to your "main()".
WiredHome	23:a50ded45dbaf	3588	//
WiredHome	23:a50ded45dbaf	3589	// #include "mbed.h"
WiredHome	23:a50ded45dbaf	3590	// #include "RA8875.h"
WiredHome	23:a50ded45dbaf	3591	// RA8875 lcd(p5, p6, p7, p12, NC, "tft"); // MOSI, MISO, SCK, /ChipSelect, /reset, name
WiredHome	23:a50ded45dbaf	3592	// Serial pc(USBTX, USBRX);
WiredHome	23:a50ded45dbaf	3593	// extern "C" void mbed_reset();
WiredHome	23:a50ded45dbaf	3594	// int main()
WiredHome	23:a50ded45dbaf	3595	// {
WiredHome	23:a50ded45dbaf	3596	// pc.baud(460800); // I like a snappy terminal, so crank it up!
WiredHome	23:a50ded45dbaf	3597	// pc.printf("\r\nRA8875 Test - Build " __DATE__ " " __TIME__ "\r\n");
WiredHome	190:3132b7dfad82	3598	//
WiredHome	23:a50ded45dbaf	3599	// pc.printf("Turning on display\r\n");
WiredHome	101:e0aad446094a	3600	// lcd.init();
WiredHome	23:a50ded45dbaf	3601	// lcd.Reset();
WiredHome	23:a50ded45dbaf	3602	// lcd.Power(true); // display power is on, but the backlight is independent
WiredHome	23:a50ded45dbaf	3603	// lcd.Backlight(0.5);
WiredHome	23:a50ded45dbaf	3604	// RunTestSet(lcd, pc);
WiredHome	23:a50ded45dbaf	3605	// }
WiredHome	23:a50ded45dbaf	3606
WiredHome	23:a50ded45dbaf	3607	#endif // TESTENABLE
WiredHome	23:a50ded45dbaf	3608
WiredHome	56:7a85d226ad0d	3609	#endif

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	03 Mar 2020
Imports:	7
Forks:	0
Commits:	202
Dependents:	0
Dependencies:	0
Followers:	1

RA8875.h@198:18d25c15a7b5, 2020-03-03 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning