#include <modm/ui/display/graphic_display.hpp>

Inheritance diagram for modm::GraphicDisplay:

Classes
class	Writer

Public Member Functions
virtual uint16_t	getWidth () const = 0

virtual uint16_t	getHeight () const = 0

virtual std::size_t	getBufferWidth () const = 0

virtual std::size_t	getBufferHeight () const = 0

virtual void	setPixel (int16_t x, int16_t y) = 0

void	setPixel (glcd::Point p)

virtual void	clearPixel (int16_t x, int16_t y) = 0

void	clearPixel (glcd::Point p)

virtual void	clear () = 0

virtual void	update () = 0

void	drawLine (glcd::Point start, glcd::Point end)

void	drawLine (int16_t x1, int16_t y1, int16_t x2, int16_t y2)

void	drawRectangle (glcd::Point start, uint16_t width, uint16_t height)

void	drawRectangle (int16_t x, int16_t y, uint16_t width, uint16_t height)

void	fillRectangle (glcd::Point start, uint16_t width, uint16_t height)

void	fillRectangle (int16_t x, int16_t y, uint16_t width, uint16_t height)

void	drawRoundedRectangle (glcd::Point start, uint16_t width, uint16_t height, uint16_t radius)

void	drawCircle (glcd::Point center, uint16_t radius)

virtual void	fillCircle (glcd::Point center, uint16_t radius)

void	drawEllipse (glcd::Point center, int16_t rx, int16_t ry)

void	drawImage (glcd::Point start, modm::accessor::Flash< uint8_t > image)

virtual void	drawImageRaw (glcd::Point start, uint16_t width, uint16_t height, modm::accessor::Flash< uint8_t > data)

void	setCursor (glcd::Point position)

void	setCursor (int16_t x, int16_t y)

void	setCursorX (int16_t x)

void	setCursorY (int16_t y)

glcd::Point	getCursor () const

void	setFont (const uint8_t *newFont)

void	setFont (const modm::accessor::Flash< uint8_t > *font)

uint8_t	getFontHeight () const

uint16_t	getStringWidth (const char *s) const

void	write (char c)

IOStream &	ascii ()
	set the output mode to ASCII style for integer types

IOStream &	bin ()
	set the output mode to binary style for integer types

IOStream &	endl ()

IOStream &	flush ()

IOStream &	get (char &c)
	Reads one character and returns it if available. Otherwise, returns IOStream::eof.

IOStream &	get (char *s, size_t n)

template<size_t N>
IOStream &	get (char (&s)[N])

IOStream &	hex ()
	set the output mode to hexadecimal style for integer types

IOStream &	operator<< (const bool &v)

IOStream &	operator<< (const char &v)

IOStream &	operator<< (const uint8_t &v)

IOStream &	operator<< (const int16_t &v)

IOStream &	operator<< (const uint16_t &v)

IOStream &	operator<< (const int32_t &v)

IOStream &	operator<< (const uint32_t &v)

IOStream &	operator<< (const char *s)

IOStream &	operator<< (const void *p)
	write the hex value of a pointer

template<class Ret , class... Args>
IOStream &	operator<< (Ret (*pointer)(Args...))
	Write the hex value of any function pointer.

IOStream &	operator<< (IOStream &(*format)(IOStream &))

Static Public Member Functions
static uint8_t	getFontHeight (const modm::accessor::Flash< uint8_t > *font)

static uint16_t	getStringWidth (const char s, const modm::accessor::Flash< uint8_t > font)

Static Public Attributes
static constexpr char	eof = -1

Protected Member Functions
void	drawCircle4 (glcd::Point center, int16_t x, int16_t y)
	helper method for drawCircle() and drawEllipse()

virtual void	drawHorizontalLine (glcd::Point start, uint16_t length)

virtual void	drawVerticalLine (glcd::Point start, uint16_t length)

void	writeBin (uint8_t value)

void	writeHex (uint8_t value)

void	writeInteger (int16_t value)

void	writeInteger (uint16_t value)

void	writeInteger (int32_t value)

void	writeInteger (uint32_t value)

template<typename T >
void	writeIntegerMode (const T v)

void	writePointer (const void *value)

Protected Attributes
Writer	writer

modm::accessor::Flash< uint8_t >	font

glcd::Point	cursor

Friends
class	VirtualGraphicDisplay

Detailed Description

Base class for graphical displays.

Text mode:

left adjusted (default)
right adjusted
centered

All modes relative to the current viewport. This would make drawing a menu system easier.

Member Function Documentation

virtual void modm::GraphicDisplay::clear ( )

pure virtual

Set whole screen to backgroundColor

Implemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::ParallelTft< INTERFACE >, modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >, modm::MonochromeGraphicDisplay< Width, Height, Width, Height/8 >, modm::MonochromeGraphicDisplay< Width, Height, Width/8, Height >, and modm::VirtualGraphicDisplay.

void modm::GraphicDisplay::clearPixel ( glcd::Point p )

inline

Set a pixel to backgroundColor

Parameters

p point

virtual void modm::GraphicDisplay::clearPixel	(	int16_t	x,
		int16_t	y
	)

pure virtual

Set a pixel to backgroundColor

Parameters

x	x-position
y	y-position

void modm::GraphicDisplay::drawCircle	(	glcd::Point	center,
		uint16_t	radius
	)

Draw a filled rectangle with rounded corners

Parameters

start	Upper left corner
width	Width of rectangle
height	Height of rectangle
radius	Rounding radius

Draw a circle

Uses the midpoint circle algorithm.

Parameters

center	Center of the circle
radius	Radius of the circle

void modm::GraphicDisplay::drawEllipse	(	glcd::Point	center,
		int16_t	rx,
		int16_t	ry
	)

Draw an ellipse.

Uses a variation of the midpoint algorithm. May be improved through simplification of the used formula.

Parameters

center	Center of the ellipse
rx	Radius in x-direction
ry	Radius in y-direction

void modm::GraphicDisplay::drawImage	(	glcd::Point	start,
		modm::accessor::Flash< uint8_t >	image
	)

Draw an image.

The first byte in the image data specifies the with, the second byte the height. Afterwards the actual image data.

Parameters

start	Upper left corner
image	Image data in Flash

See also: drawImage()

void modm::GraphicDisplay::drawImageRaw	(	glcd::Point	start,
		uint16_t	width,
		uint16_t	height,
		modm::accessor::Flash< uint8_t >	data
	)

virtual

Draw an image.

Parameters

start	Upper left corner
width	Image width
height	Image height
data	Image data in Flash without any size information.

Reimplemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::MonochromeGraphicDisplayVertical< Width, Height >, modm::MonochromeGraphicDisplayVertical< 8 *COLUMNS, 8 *ROWS >, modm::MonochromeGraphicDisplayVertical< 132, 176 >, modm::MonochromeGraphicDisplayVertical< WIDTH, HEIGHT >, modm::MonochromeGraphicDisplayVertical< 128, Height >, modm::MonochromeGraphicDisplayVertical< 176, 136 >, and modm::MonochromeGraphicDisplayVertical< 84, 48 >.

void modm::GraphicDisplay::drawLine	(	glcd::Point	start,
		glcd::Point	end
	)

inline

Draw a line.

Uses the faster drawHorizontalLine() or drawVerticalLine() if possible, otherwise the line is rastered with the Bresenham line algorithm.

Parameters

start	first point
end	second point

void modm::GraphicDisplay::drawLine	(	int16_t	x1,
		int16_t	y1,
		int16_t	x2,
		int16_t	y2
	)

Draw a line

Parameters

x1	Start x-position
y1	Start y-position
x2	End x-position
y3	End y-position

void modm::GraphicDisplay::drawRectangle	(	glcd::Point	start,
		uint16_t	width,
		uint16_t	height
	)

Draw a rectangle.

Parameters

start	Upper left corner
width	Width of rectangle
height	Height of rectangle

void modm::GraphicDisplay::drawRectangle	(	int16_t	x,
		int16_t	y,
		uint16_t	width,
		uint16_t	height
	)

inline

Draw a rectangle.

Parameters

x	Upper left corner x-position
y	Upper left corner y-position
width	Width of rectangle
height	Height of rectangle

void modm::GraphicDisplay::drawRoundedRectangle	(	glcd::Point	start,
		uint16_t	width,
		uint16_t	height,
		uint16_t	radius
	)

Draw a rectangle with rounded corners

Parameters

start	Upper left corner
width	Width of rectangle
height	Height of rectangle
radius	Rounding radius

void modm::GraphicDisplay::fillCircle	(	glcd::Point	center,
		uint16_t	radius
	)

virtual

Draw a filled circle.

Parameters

center	Center of the circle
radius	Radius of the circle

Reimplemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >.

void modm::GraphicDisplay::fillRectangle	(	glcd::Point	start,
		uint16_t	width,
		uint16_t	height
	)

Draw a filled rectangle.

Parameters

start	Upper left corner
width	Width of rectangle
height	Height of rectangle

void modm::GraphicDisplay::fillRectangle	(	int16_t	x,
		int16_t	y,
		uint16_t	width,
		uint16_t	height
	)

inline

Draw a rectangle.

Parameters

x	Upper left corner x-position
y	Upper left corner y-position
width	Width of rectangle
height	Height of rectangle

IOStream & modm::IOStream::get	(	char *	s,
		size_t	n
	)

inherited

reads characters into NULL delimited c string in contrast to the standard implementation, this does not care about newline characters in the input

virtual std::size_t modm::GraphicDisplay::getBufferHeight ( ) const

pure virtual

Buffer-array size of second dimension

Implemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >, modm::MonochromeGraphicDisplay< Width, Height, Width, Height/8 >, modm::MonochromeGraphicDisplay< Width, Height, Width/8, Height >, and modm::ParallelTft< INTERFACE >.

virtual std::size_t modm::GraphicDisplay::getBufferWidth ( ) const

pure virtual

Buffer-array size of first dimension

Implemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >, modm::MonochromeGraphicDisplay< Width, Height, Width, Height/8 >, modm::MonochromeGraphicDisplay< Width, Height, Width/8, Height >, and modm::ParallelTft< INTERFACE >.

uint8_t modm::GraphicDisplay::getFontHeight ( ) const

Get the height of a character.

virtual uint16_t modm::GraphicDisplay::getHeight ( ) const

pure virtual

Number of pixel in vertical direction.

Implemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >, modm::MonochromeGraphicDisplay< Width, Height, Width, Height/8 >, modm::MonochromeGraphicDisplay< Width, Height, Width/8, Height >, modm::ParallelTft< INTERFACE >, and modm::VirtualGraphicDisplay.

uint16_t modm::GraphicDisplay::getStringWidth ( const char * s ) const

Get the width of (null terminated) string.

virtual uint16_t modm::GraphicDisplay::getWidth ( ) const

pure virtual

Number of pixel in horizontal direction.

Implemented in modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >, modm::MonochromeGraphicDisplay< Width, Height, Width, Height/8 >, modm::MonochromeGraphicDisplay< Width, Height, Width/8, Height >, modm::ParallelTft< INTERFACE >, and modm::VirtualGraphicDisplay.

void modm::GraphicDisplay::setCursor ( glcd::Point position )

inline

Set the cursor for text drawing.

Parameters

position Cursor position

void modm::GraphicDisplay::setCursor	(	int16_t	x,
		int16_t	y
	)

inline

Set the cursor for text drawing.

Parameters

x	Cursor x-position
y	Cursor y-position

void modm::GraphicDisplay::setCursorX ( int16_t x )

inline

Set the cursor x-position for text drawing.

Parameters

x	Cursor x-position

void modm::GraphicDisplay::setCursorY ( int16_t y )

inline

Set the cursor y-position for text drawing.

Parameters

y	Cursor y-position

void modm::GraphicDisplay::setFont ( const uint8_t * newFont )

inline

Set a new font.

Default font is modm::font::FixedWidth5x8.

Parameters

newFont Active font

See also: modm::font

void modm::GraphicDisplay::setPixel ( glcd::Point p )

inline

Set a pixel to foregroundColor

Parameters

p point

virtual void modm::GraphicDisplay::setPixel	(	int16_t	x,
		int16_t	y
	)

pure virtual

Set a pixel to foregroundColor

Parameters

x	x-position
y	y-position

virtual void modm::GraphicDisplay::update ( )

pure virtual

Transfer the content of the RAM buffer to the real display.

Implemented in modm::Max7219MatrixHorizontal< SPI, CS, COLUMNS, ROWS >, modm::Max7219Matrix< SPI, CS, COLUMNS, ROWS >, modm::St7586s< SPI, CS, RST, DC, Width, Height >, modm::ili9341< Interface, Reset, Backlight, BufferSize >, modm::ParallelTft< INTERFACE >, modm::VirtualGraphicDisplay, modm::St7565< SPI, CS, A0, Reset, Width, Height, TopView >, modm::St7565< SPI, CS, A0, Reset, 102, 64, TopView >, modm::St7565< SPI, CS, A0, Reset, 128, 64, TopView >, modm::St7565< SPI, CS, A0, Reset, 132, 32, TopView >, and modm::Nokia5110< Spi, Ce, Dc, Reset >.

void modm::GraphicDisplay::write ( char c )

Write a single character.

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

graphic_display.hpp
graphic_display.cpp
graphic_display_fill.cpp
graphic_display_text.cpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation