Graphics::Device Class Referenceabstract

A physical display device. More...

#include <Device.h>

Inheritance diagram for Graphics::Device:
Collaboration diagram for Graphics::Device:

Public Member Functions

virtual ~Device ()
 
virtual String getName () const =0
 Get name of display. More...
 
virtual bool setOrientation (Orientation orientation)=0
 Set display orientation. More...
 
virtual Size getNativeSize () const =0
 Get physical size of display. More...
 
Orientation getOrientation ()
 Get current display orientation. More...
 
virtual bool setScrollMargins (uint16_t top, uint16_t bottom)=0
 Set margins for hardware scrolling. More...
 
virtual bool scroll (int16_t y)=0
 Scroll region of display up or down using hardware scrolling. More...
 

Protected Attributes

Orientation orientation {}
 

Detailed Description

A physical display device.

Constructor & Destructor Documentation

◆ ~Device()

virtual Graphics::Device::~Device ( )
inlinevirtual

Member Function Documentation

◆ getName()

virtual String Graphics::Device::getName ( ) const
pure virtual

◆ getNativeSize()

virtual Size Graphics::Device::getNativeSize ( ) const
pure virtual

Get physical size of display.

Return values
SizeDimensions for NORMAL orientation

Implemented in Graphics::MipiDisplay, Graphics::Display::NullDevice, and Graphics::Display::Virtual.

◆ getOrientation()

Orientation Graphics::Device::getOrientation ( )
inline

Get current display orientation.

◆ scroll()

virtual bool Graphics::Device::scroll ( int16_t  y)
pure virtual

Scroll region of display up or down using hardware scrolling.

Parameters
yNumber of lines to scroll. Positive values scroll content down, negative values scroll up.

Implemented in Graphics::MipiDisplay, Graphics::Display::NullDevice, and Graphics::Display::Virtual.

◆ setOrientation()

virtual bool Graphics::Device::setOrientation ( Orientation  orientation)
pure virtual

Set display orientation.

Implemented in Graphics::MipiDisplay, Graphics::Display::NullDevice, and Graphics::Display::Virtual.

◆ setScrollMargins()

virtual bool Graphics::Device::setScrollMargins ( uint16_t  top,
uint16_t  bottom 
)
pure virtual

Set margins for hardware scrolling.

Parameters
topNumber of fixed pixels at top of screen
bottomNumber of fixed pixels at bottom of screen

Area between top/bottom can be scrolled using scroll() method.

Implemented in Graphics::MipiDisplay, Graphics::Display::NullDevice, and Graphics::Display::Virtual.

Member Data Documentation

◆ orientation

Orientation Graphics::Device::orientation {}
protected

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