Graphics::AddressWindow Struct Reference

Manages a rectangular area of display memory with position information. More...

#include <AddressWindow.h>

Collaboration diagram for Graphics::AddressWindow:

Public Types

enum class  Mode { none , write , read }
 

Public Member Functions

 AddressWindow ()
 
 AddressWindow (const Rect &rect)
 
void reset ()
 
bool setMode (Mode mode)
 
AddressWindowoperator= (const Rect &rect)
 
size_t getPixelCount () const
 Get remaining pixels in window from current position. More...
 
uint16_t seek (uint16_t count)
 
Point pos () const
 
uint16_t left () const
 
uint16_t top () const
 
uint16_t right () const
 
uint16_t bottom () const
 

Public Attributes

Rect bounds {}
 y and h are updated by seek() More...
 
uint16_t column {0}
 Relative x position within window. More...
 
Rect initial {}
 
Mode mode {}
 

Detailed Description

Manages a rectangular area of display memory with position information.

Accesses to display memory is controlled by first setting an active Address Window. This is a rectangular area into which following writes (or reads) will store data.

Although the display hardware usually manages this some operations require tracking the position within the driver.

Member Enumeration Documentation

◆ Mode

Enumerator
none 
write 
read 

Constructor & Destructor Documentation

◆ AddressWindow() [1/2]

Graphics::AddressWindow::AddressWindow ( )
inline

◆ AddressWindow() [2/2]

Graphics::AddressWindow::AddressWindow ( const Rect rect)
inline

Member Function Documentation

◆ bottom()

uint16_t Graphics::AddressWindow::bottom ( ) const
inline

◆ getPixelCount()

size_t Graphics::AddressWindow::getPixelCount ( ) const
inline

Get remaining pixels in window from current position.

◆ left()

uint16_t Graphics::AddressWindow::left ( ) const
inline

◆ operator=()

AddressWindow& Graphics::AddressWindow::operator= ( const Rect rect)
inline

◆ pos()

Point Graphics::AddressWindow::pos ( ) const
inline

◆ reset()

void Graphics::AddressWindow::reset ( )
inline

◆ right()

uint16_t Graphics::AddressWindow::right ( ) const
inline

◆ seek()

uint16_t Graphics::AddressWindow::seek ( uint16_t  count)
inline

◆ setMode()

bool Graphics::AddressWindow::setMode ( Mode  mode)
inline

◆ top()

uint16_t Graphics::AddressWindow::top ( ) const
inline

Member Data Documentation

◆ bounds

Rect Graphics::AddressWindow::bounds {}

y and h are updated by seek()

◆ column

uint16_t Graphics::AddressWindow::column {0}

Relative x position within window.

◆ initial

Rect Graphics::AddressWindow::initial {}

◆ mode

Mode Graphics::AddressWindow::mode {}

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