Graphics::SpiDisplay Class Reference

#include <SpiDisplay.h>

Inheritance diagram for Graphics::SpiDisplay:
Collaboration diagram for Graphics::SpiDisplay:

Public Member Functions

 SpiDisplay (HSPI::Controller &spi)
 
bool begin (HSPI::PinSet pinSet, uint8_t chipSelect, uint8_t resetPin=PIN_NONE, uint32_t clockSpeed=4000000)
 
void execute (SpiDisplayList &list, DisplayList::Callback callback=nullptr, void *param=nullptr)
 
void execute (const SpiDisplayList::Commands &commands, const FSTR::ObjectBase &data)
 
void reset (bool state)
 
HSPI::IoModes getSupportedIoModes () const override
 Return set of IO modes supported by a device implementation. More...
 
AddressWindowgetAddressWindow ()
 
- Public Member Functions inherited from Graphics::AbstractDisplay
virtual ~AbstractDisplay ()
 
- Public Member Functions inherited from Graphics::Device
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...
 
- Public Member Functions inherited from Graphics::RenderTarget
virtual ~RenderTarget ()
 
virtual Size getSize () const =0
 Get target dimensions. More...
 
virtual PixelFormat getPixelFormat () const =0
 All surfaces support the same pixel format. More...
 
virtual SurfacecreateSurface (size_t bufferSize=0)=0
 Create a surface for use with this render target. More...
 
PackedColor getColor (Color color) const
 

Protected Attributes

uint8_t resetPin {PIN_NONE}
 
AddressWindow addrWindow {}
 
- Protected Attributes inherited from HSPI::Device
friend Controller
 
Controllercontroller
 
- Protected Attributes inherited from Graphics::Device
Orientation orientation {}
 

Additional Inherited Members

- Protected Member Functions inherited from HSPI::Device
void transferStarting (Request &request)
 
bool transferComplete (Request &request)
 
 Device (Controller &controller)
 
virtual ~Device ()
 
bool begin (PinSet pinSet, uint8_t chipSelect, uint32_t clockSpeed)
 Register device with controller and prepare for action. More...
 
void end ()
 
bool isReady () const
 Determine if the device is initialised. More...
 
PinSet getPinSet () const
 
uint8_t getChipSelect () const
 
uint32_t getSpeed () const
 
void setBitOrder (BitOrder bitOrder)
 
BitOrder getBitOrder () const
 
void setClockMode (ClockMode mode)
 
ClockMode getClockMode () const
 
bool isSupported (IoMode mode) const
 Determine if the device/controller combination supports an IO mode Must be called after begin() as other settings (e.g. pinset) can affect support. More...
 
virtual bool setIoMode (IoMode mode)
 
IoMode getIoMode () const
 
size_t getBitsPerClock () const
 
void execute (Request &request)
 
void onTransfer (Callback callback)
 Set a callback to be invoked before a request is started, and when it has finished. More...
 
void wait (Request &request)
 
- Protected Member Functions inherited from Graphics::AbstractDisplay
virtual ~AbstractDisplay ()
 
- Protected Member Functions inherited from Graphics::Device
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 Member Functions inherited from Graphics::RenderTarget
virtual ~RenderTarget ()
 
virtual Size getSize () const =0
 Get target dimensions. More...
 
virtual PixelFormat getPixelFormat () const =0
 All surfaces support the same pixel format. More...
 
virtual SurfacecreateSurface (size_t bufferSize=0)=0
 Create a surface for use with this render target. More...
 
PackedColor getColor (Color color) const
 

Constructor & Destructor Documentation

◆ SpiDisplay()

Graphics::SpiDisplay::SpiDisplay ( HSPI::Controller spi)
inline

Member Function Documentation

◆ begin()

bool Graphics::SpiDisplay::begin ( HSPI::PinSet  pinSet,
uint8_t  chipSelect,
uint8_t  resetPin = PIN_NONE,
uint32_t  clockSpeed = 4000000 
)

◆ execute() [1/2]

void Graphics::SpiDisplay::execute ( const SpiDisplayList::Commands commands,
const FSTR::ObjectBase data 
)

◆ execute() [2/2]

void Graphics::SpiDisplay::execute ( SpiDisplayList list,
DisplayList::Callback  callback = nullptr,
void *  param = nullptr 
)
inline

◆ getAddressWindow()

AddressWindow& Graphics::SpiDisplay::getAddressWindow ( )
inline

◆ getSupportedIoModes()

HSPI::IoModes Graphics::SpiDisplay::getSupportedIoModes ( ) const
inlineoverridevirtual

Return set of IO modes supported by a device implementation.

Implements HSPI::Device.

◆ reset()

void Graphics::SpiDisplay::reset ( bool  state)
inline

Member Data Documentation

◆ addrWindow

AddressWindow Graphics::SpiDisplay::addrWindow {}
protected

◆ resetPin

uint8_t Graphics::SpiDisplay::resetPin {PIN_NONE}
protected

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