idfxx::lcd::panel Class Reference

Abstract base class for LCD panels. More...

Inheritance diagram for idfxx::lcd::panel:

Classes
struct	config
	Configuration structure for LCD panels. More...

Public Member Functions
virtual	~panel ()=default
	panel (const panel &)=delete
panel &	operator= (const panel &)=delete
virtual esp_lcd_panel_handle_t	idf_handle () const =0
	Returns the underlying ESP-IDF handle.
void	swap_xy (bool swap)
	Swaps the X and Y axes.
virtual result< void >	try_swap_xy (bool swap)=0
	Swaps the X and Y axes.
void	mirror (bool mirrorX, bool mirrorY)
	Mirrors the display.
virtual result< void >	try_mirror (bool mirrorX, bool mirrorY)=0
	Mirrors the display.
void	display_on (bool on)
	Turns the display on or off.
virtual result< void >	try_display_on (bool on)=0
	Turns the display on or off.

Protected Member Functions
	panel ()=default

Detailed Description

Abstract base class for LCD panels.

Definition at line 30 of file panel.hpp.

Constructor & Destructor Documentation

~panel()

virtual idfxx::lcd::panel::~panel ( )

virtualdefault

panel() [1/2]

idfxx::lcd::panel::panel ( const panel &  )

delete

panel() [2/2]

idfxx::lcd::panel::panel ( )

protecteddefault

Member Function Documentation

display_on()

void idfxx::lcd::panel::display_on ( bool  on )

inline

Turns the display on or off.

Parameters

on	true to turn on, false to turn off.

Note

Only available when CONFIG_COMPILER_CXX_EXCEPTIONS is enabled in menuconfig.

Exceptions

std::system_error

on error.

Definition at line 98 of file panel.hpp.

References try_display_on(), and idfxx::unwrap().

idf_handle()

virtual esp_lcd_panel_handle_t idfxx::lcd::panel::idf_handle ( ) const

pure virtual

Returns the underlying ESP-IDF handle.

Implemented in idfxx::lcd::ili9341.

mirror()

void idfxx::lcd::panel::mirror ( bool  mirrorX, bool  mirrorY  )

inline

Mirrors the display.

Parameters

mirrorX	true to mirror horizontally.
mirrorY	true to mirror vertically.

Note

Only available when CONFIG_COMPILER_CXX_EXCEPTIONS is enabled in menuconfig.

Exceptions

std::system_error

on error.

Definition at line 80 of file panel.hpp.

References try_mirror(), and idfxx::unwrap().

operator=()

panel & idfxx::lcd::panel::operator= ( const panel &  )

delete

swap_xy()

void idfxx::lcd::panel::swap_xy ( bool  swap )

inline

Swaps the X and Y axes.

Parameters

swap	true to swap, false for normal.

Note

Only available when CONFIG_COMPILER_CXX_EXCEPTIONS is enabled in menuconfig.

Exceptions

std::system_error

on error.

Definition at line 62 of file panel.hpp.

References try_swap_xy(), and idfxx::unwrap().

try_display_on()

virtual result< void > idfxx::lcd::panel::try_display_on ( bool  on )

pure virtual

Turns the display on or off.

Parameters

on	true to turn on, false to turn off.

Returns

Success, or an error.

Implemented in idfxx::lcd::ili9341.

Referenced by display_on().

try_mirror()

virtual result< void > idfxx::lcd::panel::try_mirror ( bool  mirrorX, bool  mirrorY  )

pure virtual

Mirrors the display.

Parameters

mirrorX	true to mirror horizontally.
mirrorY	true to mirror vertically.

Returns

Success, or an error.

Implemented in idfxx::lcd::ili9341.

Referenced by mirror().

try_swap_xy()

virtual result< void > idfxx::lcd::panel::try_swap_xy ( bool  swap )

pure virtual

Swaps the X and Y axes.

Parameters

swap	true to swap, false for normal.

Returns

Success, or an error.

Implemented in idfxx::lcd::ili9341.

Referenced by swap_xy().

---

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

• idfxx_lcd/include/idfxx/lcd/panel.hpp