David Smart / RA8875 Featured

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

Dependents:   FRDM_RA8875_mPaint RA8875_Demo RA8875_KeyPadDemo SignalGenerator ... more

Fork of SPI_TFT by Peter Drescher

See Components - RA8875 Based Display

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

Offline Help Manual (Windows chm)

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

Diff: TextDisplay.h

Revision:
167:8aa3fb2a5a31
Parent:
125:7a0b70f56550
Child:
182:8832d03a2a29
--- a/TextDisplay.h	Sun Feb 24 19:28:26 2019 +0000
+++ b/TextDisplay.h	Tue Feb 26 19:52:57 2019 +0000
@@ -1,18 +1,19 @@
-/* mbed TextDisplay Library Base Class
- * Copyright (c) 2007-2009 sford
- * Released under the MIT License: http://mbed.org/license/mit
- *
- * A common base class for Text displays
- * To port a new display, derive from this class and implement
- * the constructor (setup the display), character (put a character
- * at a location), rows and columns (number of rows/cols) functions.
- * Everything else (locate, printf, putc, cls) will come for free
- *
- * The model is the display will wrap at the right and bottom, so you can
- * keep writing and will always get valid characters. The location is
- * maintained internally to the class to make this easy
- */
-
+/// @page TextDisplay_Copyright Text Display Library Base Class
+///
+/// mbed TextDisplay Library Base Class
+/// @copyright © 2007-2009 sford
+/// Released under the MIT License: http://mbed.org/license/mit
+///
+/// A common base class for Text displays
+/// To port a new display, derive from this class and implement
+/// the constructor (setup the display), character (put a character
+/// at a location), rows and columns (number of rows/cols) functions.
+/// Everything else (locate, printf, putc, cls) will come for free
+///
+/// The model is the display will wrap at the right and bottom, so you can
+/// keep writing and will always get valid characters. The location is
+/// maintained internally to the class to make this easy
+///
 #ifndef MBED_TEXTDISPLAY_H
 #define MBED_TEXTDISPLAY_H
 
@@ -87,7 +88,7 @@
     ///
     /// @param[in] layers is ignored, but supports maintaining the same 
     ///     API for the graphics layer.
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t cls(uint16_t layers = 0) = 0;
     
@@ -99,7 +100,7 @@
     ///
     /// @param[in] column is the horizontal offset from the left side.
     /// @param[in] row is the vertical offset from the top.
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t locate(textloc_t column, textloc_t row) = 0;
     
@@ -108,7 +109,7 @@
     /// @note this method may be overridden in a derived class.
     ///
     /// @param[in] color is color to use for foreground drawing.
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t foreground(color_t color) = 0;
 
@@ -117,7 +118,7 @@
     /// @note this method may be overridden in a derived class.
     ///
     /// @param[in] color is color to use for background drawing.
-    /// @returns error code.
+    /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t background(color_t color) = 0;
     // putc (from Stream)