Generic buffered screen class. More...

#include <hV_Screen_Buffer.h>

Inheritance diagram for hV_Screen_Buffer:

[legend]

Collaboration diagram for hV_Screen_Buffer:

[legend]

Public Member Functions
	hV_Screen_Buffer ()
	Constructor.

General
virtual void	begin ()
	Initialisation.

virtual String	WhoAmI ()=0
	Request information about the screen.

virtual void	clear (uint16_t colour=myColours.black)
	Clear the screen.

virtual void	flush ()=0
	Send frame-buffer to display.

virtual void	setOrientation (uint8_t orientation)
	Set orientation.

uint8_t	getOrientation ()
	Get orientation.

virtual uint16_t	screenSizeX ()
	Screen size, x-axis of logical screen.

virtual uint16_t	screenSizeY ()
	Screen size, y-axis of logical screen.

virtual uint16_t	screenDiagonal ()
	Screen size, diagonal.

virtual uint8_t	screenColourBits ()
	Screen colour depth.

Graphics
virtual void	circle (uint16_t x0, uint16_t y0, uint16_t radius, uint16_t colour)
	Draw circle.

virtual void	line (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t colour)
	Draw line, rectangle coordinates.

virtual void	dLine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t colour)
	Draw line, vector coordinates.

virtual void	setPenSolid (bool flag=true)
	Set pen opaque.

virtual void	triangle (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t x3, uint16_t y3, uint16_t colour)
	Draw triangle, rectangle coordinates.

virtual void	rectangle (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t colour)
	Draw rectangle, rectangle coordinates.

virtual void	dRectangle (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t colour)
	Draw rectangle, vector coordinates.

virtual void	point (uint16_t x1, uint16_t y1, uint16_t colour)
	Draw pixel.

Text
virtual void	selectFont (uint8_t font)
	Select font number.

virtual uint8_t	getFont ()
	Get font number.

virtual uint8_t	addFont (font_s fontName)
	Add a font.

virtual void	setFontSolid (bool flag=true)
	Set transparent or opaque text.

virtual void	setFontSpaceX (uint8_t number=1)
	Set additional spaces between two characters, horizontal axis.

virtual void	setFontSpaceY (uint8_t number=1)
	Set additional spaces between two characters, vertical axis.

virtual uint16_t	characterSizeX (uint8_t character=0x00)
	Character size, x-axis.

virtual uint16_t	characterSizeY ()
	Character size, y-axis.

virtual uint16_t	stringSizeX (String text)
	String size, x-axis.

virtual uint8_t	stringLengthToFitX (String text, uint16_t pixels)
	Number of characters to fit a size, x-axis.

virtual uint8_t	fontMax ()
	Number of fonts.

virtual void	gText (uint16_t x0, uint16_t y0, String text, uint16_t textColour=myColours.black, uint16_t backColour=myColours.white)
	Draw ASCII Text (pixel coordinates) with selection of size.

Touch
Note Those functions are optional, and thus defined as empty and not compulsory.
bool	isTouch ()
	Is touch available?

bool	isTouchEvent ()
	Are touch events available?

bool	getTouch (uint16_t &x, uint16_t &y, uint16_t &z, uint16_t &t)
	Poll touch.

void	clearTouch ()
	Clear touch.

bool	getTouchInterrupt ()
	Check touch interrupt.

void	calibrateTouch ()
	Calibrate the touch.

Additional Inherited Members
Protected Member Functions inherited from hV_Font_Terminal
void	f_begin ()
	Initialisation.

void	f_selectFont (uint8_t font)
	Select font.

uint8_t	f_addFont (font_s fontName)
	Use a font.

void	f_setFontSolid (bool flag=true)
	Set transparent or opaque text.

void	f_setFontSpaceX (uint8_t number=1)
	Set additional pixels between two characters, horizontal axis.

void	f_setFontSpaceY (uint8_t number=1)
	Set additional pixels between two characters, vertical axis.

uint16_t	f_characterSizeX (uint8_t character=0x00)
	Character size, x-axis.

uint16_t	f_characterSizeY ()
	Character size, y-axis.

uint16_t	f_stringSizeX (String text)
	String size, x-axis.

uint8_t	f_stringLengthToFitX (String text, uint16_t pixels)
	Number of characters to fit a size, x-axis.

uint8_t	f_fontMax ()
	Number of fonts.

uint8_t	f_getFontKind ()
	Get selected font details.

uint8_t	f_getFontMaxWidth ()
	Get selected font details.

uint8_t	f_getCharacter (uint8_t character, uint16_t index)
	Get definition for line of character.

Protected Attributes inherited from hV_Font_Terminal
font_s	f_font
	font

uint8_t	f_fontNumber
	number of fonts available, 0.._fontNumber-1

uint8_t	f_fontSize
	actual font selected

uint8_t	f_fontSpaceX
	pixels between two characters, horizontal axis

uint8_t	f_fontSpaceY
	pixels between two characters, vertical axis

bool	f_fontSolid
	font

Detailed Description

Generic buffered screen class.

This class provides the text and graphic primitives for the buffered screen

Member Function Documentation

◆ addFont()

uint8_t hV_Screen_Buffer::addFont ( font_s fontName )

virtual

Add a font.

Parameters

fontName name of the font

Returns: number of the font, 0 otherwise

Note: Previously selectFont()
More: Fonts

◆ begin()

void hV_Screen_Buffer::begin ( )

virtual

Initialisation.

Reimplemented in Screen_EPD_EXT3_Fast.

◆ characterSizeX()

uint16_t hV_Screen_Buffer::characterSizeX ( uint8_t character = 0x00 )

virtual

Character size, x-axis.

Parameters

character character to evaluate, default = 0 = font general size

Returns: horizontal size of the font for the specified character, in pixels

Note: With setSpaceX included; In variable font, each character has a specific size. The general size is indicative.; Previously fontSizeX()
More: Fonts

◆ characterSizeY()

uint16_t hV_Screen_Buffer::characterSizeY ( )

virtual

Character size, y-axis.

Returns: vertical size for current font, in pixels

Note: Previously fontSizeY()
More: Fonts

◆ circle()

void hV_Screen_Buffer::circle	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	radius,
		uint16_t	colour )

virtual

Draw circle.

Parameters

x0	center, point coordinate, x-axis
y0	center, point coordinate, y-axis
radius	radius
colour	16-bit colour

More: Coordinate, Colour

◆ clear()

void hV_Screen_Buffer::clear ( uint16_t colour = myColours.black )

virtual

Clear the screen.

Parameters

colour 16-bit colour, default = white

Reimplemented in Screen_EPD_EXT3_Fast.

◆ dLine()

void hV_Screen_Buffer::dLine	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy,
		uint16_t	colour )

virtual

Draw line, vector coordinates.

Parameters

x0	point coordinate, x-axis
y0	point coordinate, y-axis
dx	length, x-axis
dy	height, y-axis
colour	16-bit colour

More: Coordinate, Colour

◆ dRectangle()

void hV_Screen_Buffer::dRectangle	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy,
		uint16_t	colour )

virtual

Draw rectangle, vector coordinates.

Parameters

x0	point coordinate, x-axis
y0	point coordinate, y-axis
dx	length, x-axis
dy	height, y-axis
colour	16-bit colour

More: Coordinate, Colour

◆ flush()

void hV_Screen_Buffer::flush ( )

pure virtual

Send frame-buffer to display.

Implemented in Screen_EPD_EXT3_Fast.

◆ fontMax()

uint8_t hV_Screen_Buffer::fontMax ( )

virtual

Number of fonts.

Returns: number of fonts available

Note: First font is numbered 0, second 1, ...
The latest font is numbered fontMax()-1

◆ getFont()

uint8_t hV_Screen_Buffer::getFont ( )

virtual

Get font number.

Returns: Number of the font, 0..fontMax()-1

◆ getOrientation()

uint8_t hV_Screen_Buffer::getOrientation ( )

Get orientation.

Returns

orientation orientation:

0 = portrait
1 = right rotated landscape
2 = reverse portrait
3 = left rotated landscape

◆ getTouch()

bool hV_Screen_Buffer::getTouch	(	uint16_t &	x,
		uint16_t &	y,
		uint16_t &	z,
		uint16_t &	t )

Poll touch.

Parameters

[out]	x	x coordinate
[out]	y	y coordinate
[out]	z	z coordinate=pressure
[out]	t	event if available, otherwise 0

Returns: true if pressed

More: Coordinate, Touch

◆ getTouchInterrupt()

bool hV_Screen_Buffer::getTouchInterrupt ( )

Check touch interrupt.

Returns: true interrupt raised, false otherwise

◆ gText()

void hV_Screen_Buffer::gText	(	uint16_t	x0,
		uint16_t	y0,
		String	text,
		uint16_t	textColour = myColours.black,
		uint16_t	backColour = myColours.white )

virtual

Draw ASCII Text (pixel coordinates) with selection of size.

Parameters

x0	point coordinate, x-axis
y0	point coordinate, y-axis
text	text string
textColour	16-bit colour, default = white
backColour	16-bit colour, default = black

Note: Previously gText() with ix and iy

More: Colour, Fonts, Coordinate

◆ isTouch()

bool hV_Screen_Buffer::isTouch ( )

Is touch available?

Returns: true is touch available, false otherwise

◆ isTouchEvent()

bool hV_Screen_Buffer::isTouchEvent ( )

Are touch events available?

Returns: true if touch events available, false otherwise

◆ line()

void hV_Screen_Buffer::line	(	uint16_t	x1,
		uint16_t	y1,
		uint16_t	x2,
		uint16_t	y2,
		uint16_t	colour )

virtual

Draw line, rectangle coordinates.

Parameters

x1	top left coordinate, x-axis
y1	top left coordinate, y-axis
x2	bottom right coordinate, x-axis
y2	bottom right coordinate, y-axis
colour	16-bit colour

More: Coordinate, Colour

◆ point()

void hV_Screen_Buffer::point	(	uint16_t	x1,
		uint16_t	y1,
		uint16_t	colour )

virtual

Draw pixel.

Parameters

x1	point coordinate, x-axis
y1	point coordinate, y-axis
colour	16-bit colour

More: Coordinate, Colour

◆ rectangle()

void hV_Screen_Buffer::rectangle	(	uint16_t	x1,
		uint16_t	y1,
		uint16_t	x2,
		uint16_t	y2,
		uint16_t	colour )

virtual

Draw rectangle, rectangle coordinates.

Parameters

x1	top left coordinate, x-axis
y1	top left coordinate, y-axis
x2	bottom right coordinate, x-axis
y2	bottom right coordinate, y-axis
colour	16-bit colour

More: Coordinate, Colour

◆ screenColourBits()

uint8_t hV_Screen_Buffer::screenColourBits ( )

virtual

Screen colour depth.

Returns: colour depth, in bits

Note: Examples: BW=1, BWR=2, RGB565=16

More: Coordinate

◆ screenDiagonal()

uint16_t hV_Screen_Buffer::screenDiagonal ( )

virtual

Screen size, diagonal.

Returns: diagonal size of the screen, in inches x 100

Note: 320 means 3.20"

◆ screenSizeX()

uint16_t hV_Screen_Buffer::screenSizeX ( )

virtual

Screen size, x-axis of logical screen.

Returns: x-axis size of the screen, in pixels

Note: 240 means 240 pixels and thus 0..239 coordinates (decimal)

◆ screenSizeY()

uint16_t hV_Screen_Buffer::screenSizeY ( )

virtual

Screen size, y-axis of logical screen.

Returns: y-axis size of the screen, in pixels

Note: 240 means 240 pixels and thus 0..239 coordinates (decimal)

◆ selectFont()

void hV_Screen_Buffer::selectFont ( uint8_t font )

virtual

Select font number.

Parameters

font	default = 0, 0..fontMax()-1

◆ setFontSolid()

void hV_Screen_Buffer::setFontSolid ( bool flag = true )

virtual

Set transparent or opaque text.

Parameters

flag	default = 1 = opaque = solid, false = transparent

◆ setFontSpaceX()

void hV_Screen_Buffer::setFontSpaceX ( uint8_t number = 1 )

virtual

Set additional spaces between two characters, horizontal axis.

Parameters

number of spaces default = 1 pixel

◆ setFontSpaceY()

void hV_Screen_Buffer::setFontSpaceY ( uint8_t number = 1 )

virtual

Set additional spaces between two characters, vertical axis.

Parameters

number of spaces default = 1 pixel

◆ setOrientation()

void hV_Screen_Buffer::setOrientation ( uint8_t orientation )

virtual

Set orientation.

Parameters

orientation

orientation,

0 = default
1 = right rotated
2 = reverse default
3 = left rotated
ORIENTATION_PORTRAIT = 6 = check portrait
ORIENTATION_LANDSCAPE = 7 = check landscape

Note: Run the Common_Orientation.ino example to identify the options

◆ setPenSolid()

void hV_Screen_Buffer::setPenSolid ( bool flag = true )

virtual

Set pen opaque.

Parameters

flag	default = true = opaque = solid, false = wire frame

◆ stringLengthToFitX()

uint8_t hV_Screen_Buffer::stringLengthToFitX	(	String	text,
		uint16_t	pixels )

virtual

Number of characters to fit a size, x-axis.

Parameters

text	string to evaluate
pixels	number of pixels to fit in

Returns: number of characters to be displayed inside the pixels
More: Fonts

◆ stringSizeX()

uint16_t hV_Screen_Buffer::stringSizeX ( String text )

virtual

String size, x-axis.

Parameters

text	string to evaluate

Returns: horizontal size of the string for current font, in pixels
More: Fonts

◆ triangle()

void hV_Screen_Buffer::triangle	(	uint16_t	x1,
		uint16_t	y1,
		uint16_t	x2,
		uint16_t	y2,
		uint16_t	x3,
		uint16_t	y3,
		uint16_t	colour )

virtual

Draw triangle, rectangle coordinates.

Parameters

x1	first point coordinate, x-axis
y1	first point coordinate, y-axis
x2	second point coordinate, x-axis
y2	second point coordinate, y-axis
x3	third point coordinate, x-axis
y3	third point coordinate, y-axis
colour	16-bit colour

Note: If two points are equal, draw a line

More: Coordinate, Colour

◆ WhoAmI()

virtual String hV_Screen_Buffer::WhoAmI ( )

pure virtual

Request information about the screen.

Returns: string with hardware version

Implemented in Screen_EPD_EXT3_Fast.

The documentation for this class was generated from the following files:

hV_Screen_Buffer.h
hV_Screen_Buffer.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addFont()

◆ begin()

◆ characterSizeX()

◆ characterSizeY()

◆ circle()

◆ clear()

◆ dLine()

◆ dRectangle()

◆ flush()

◆ fontMax()

◆ getFont()

◆ getOrientation()

◆ getTouch()

◆ getTouchInterrupt()

◆ gText()

◆ isTouch()

◆ isTouchEvent()

◆ line()

◆ point()

◆ rectangle()

◆ screenColourBits()

◆ screenDiagonal()

◆ screenSizeX()

◆ screenSizeY()

◆ selectFont()

◆ setFontSolid()

◆ setFontSpaceX()

◆ setFontSpaceY()

◆ setOrientation()

◆ setPenSolid()

◆ stringLengthToFitX()

◆ stringSizeX()

◆ triangle()

◆ WhoAmI()