1
0

Documentation cleanup
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2021-11-03 10:13:25 +00:00
parent d4df2225b5
commit b8eccbe162
6 changed files with 44 additions and 9 deletions

View File

@ -3,6 +3,7 @@
/**
* Generic interface for a graphical display allowing for placement of text.
* Focused on TUI.
*/
class DisplayProxy
{
@ -12,6 +13,7 @@ public:
* @return True if successful.
*/
virtual bool on() = 0;
/**
* Turn off the display.
* @return True if successful.
@ -27,6 +29,7 @@ public:
* @return True if successful.
*/
virtual bool write(int x, int y, const char *text) = 0;
/**
* Clear the entire screen.
* @return True if successful.

View File

@ -6,12 +6,14 @@
/**
* Text-User-Interface on a Max7456
* Text-User-Interface on a MAX7456
*
* The Max7456 provides On-Screen-Display rendering for composite video.
* The MAX7456 provides On-Screen-Display rendering for composite video.
* (Think old school VCR menu overlay)
*
* @link https://www.maximintegrated.com/en/products/analog/video-products/MAX7456.html
* To find the offical documentation for the part please refer to the Maxim page for the MAX7456.
* [Maxim Page](https://www.maximintegrated.com/en/products/analog/video-products/MAX7456.html)
*
*/
class DisplayProxyMAX7456 : public DisplayProxy
{
@ -45,7 +47,19 @@ public:
* Since the signal is analog the characters might be rendered outside the display area
*/
bool setOffset(int x, int y);
/**
* Turn off the external video feed
* If the external feed is disabled the background will be grey
* @param enabled True to turn on the external video input
*/
bool externalVideo(bool enabled);
/**
* Turn on the overlay
*
* @param enabled True to turn on the overlay
*/
bool onScreenDisplay(bool enabled);
private: