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

Users » WiredHome » Code » RA8875

Library to control a Graphics TFT connected to 4-wire SPI - revised for the Raio RA8875 Display Controller.

Dependents: FRDM_RA8875_mPaint RA8875_Demo RA8875_KeyPadDemo SignalGenerator ... more

Enhanced touch-screen support - where it previous supported both the Resistive Touch and Capacitive Touch based on the FT5206 Touch Controller, now it also has support for the GSL1680 Touch Controller.

Offline Help Manual (Windows chm)

/media/uploads/WiredHome/ra8875.zip.bin (download, rename to .zip and unzip)

RA8875.h@55:dfbabef7003e, 2014-03-30 (annotated)

Committer:: WiredHome
Date:: Sun Mar 30 23:37:41 2014 +0000
Revision:: 55:dfbabef7003e
Parent:: 54:e117ad10fba6
Child:: 56:7a85d226ad0d
Child:: 64:5479dc0c8738

Cursor locate method corrected to use 8 pixels as the font width, not 16.; Renamed putp to _putp to suggest it is special.; Migrated _StartGraphicsStream, _putp, _EndGraphicsStream from private to public for faster pixel based screen updates.

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

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

The code in this repository is MIT licensed.

Components

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