modm API documentation
modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight > Class Template Referenceabstract

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

Inheritance diagram for modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >:
modm::GraphicDisplay modm::IOStream

Public Member Functions

uint16_t getWidth () const final
 
uint16_t getHeight () const final
 
std::size_t getBufferWidth () const final
 
std::size_t getBufferHeight () const final
 
virtual bool getPixel (int16_t x, int16_t y) const = 0
 
void clear () final
 
- Public Member Functions inherited from modm::GraphicDisplay
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 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)
 
- Public Member Functions inherited from modm::IOStream
 IOStream (IODevice &odevice)
 
IOStream & write (char c)
 
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 &IOStream & flush ()
 
IOStream & endl ()
 
IOStream & bin ()
 set the output mode to binary style for integer types
 
IOStream & hex ()
 set the output mode to hexadecimal style for integer types
 
IOStream & ascii ()
 set the output mode to ASCII 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 &))
 

Protected Attributes

uint8_t buffer [BufferHeight][BufferWidth]
 
- Protected Attributes inherited from modm::GraphicDisplay
Writer writer
 
modm::accessor::Flash< uint8_t > font
 
glcd::Point cursor
 

Additional Inherited Members

- Static Public Member Functions inherited from modm::GraphicDisplay
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 inherited from modm::IOStream
static constexpr char eof = -1
 
- Protected Member Functions inherited from modm::GraphicDisplay
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)
 
- Protected Member Functions inherited from modm::IOStream
template<typename T >
void writeIntegerMode (const T v)
 
void writeInteger (int16_t value)
 
void writeInteger (uint16_t value)
 
void writeInteger (int32_t value)
 
void writeInteger (uint32_t value)
 
void writePointer (const void *value)
 
void writeHex (uint8_t value)
 
void writeBin (uint8_t value)
 

Detailed Description

template<int16_t Width, int16_t Height, std::size_t BufferWidth, std::size_t BufferHeight>
class modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >

Base class for monochrome graphical displays with a RAM buffer.

Every operation works on the internal RAM buffer, therefore the content of the real display is not changed until a call of update().

Template Parameters
WidthHorizontal number of Pixels
HeightVertical number of Pixels
BufferWidthHorizontal (first) dimension of Buffer
BufferHeightVertical (first) dimension of Buffer
Author
Thomas Sommer

Member Function Documentation

template<int16_t Width, int16_t Height, std::size_t BufferWidth, std::size_t BufferHeight>
void modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >::clear ( )
finalvirtual

Set whole screen to backgroundColor

Implements modm::GraphicDisplay.

template<int16_t Width, int16_t Height, std::size_t BufferWidth, std::size_t BufferHeight>
std::size_t modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >::getBufferHeight ( ) const
inlinefinalvirtual

Buffer-array size of second dimension

Implements modm::GraphicDisplay.

template<int16_t Width, int16_t Height, std::size_t BufferWidth, std::size_t BufferHeight>
std::size_t modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >::getBufferWidth ( ) const
inlinefinalvirtual

Buffer-array size of first dimension

Implements modm::GraphicDisplay.

template<int16_t Width, int16_t Height, std::size_t BufferWidth, std::size_t BufferHeight>
uint16_t modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >::getHeight ( ) const
inlinefinalvirtual

Number of pixel in vertical direction.

Implements modm::GraphicDisplay.

template<int16_t Width, int16_t Height, std::size_t BufferWidth, std::size_t BufferHeight>
uint16_t modm::MonochromeGraphicDisplay< Width, Height, BufferWidth, BufferHeight >::getWidth ( ) const
inlinefinalvirtual

Number of pixel in horizontal direction.

Implements modm::GraphicDisplay.


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