LCDBoard Class Reference

#include <LCDBoardsCommon.h>

Inheritance diagram for LCDBoard:

Public Member Functions
virtual	~LCDBoard ()=default
virtual bool	begin ()=0
virtual size_t	width () const =0
	Panel width in pixels.
virtual size_t	height () const =0
	Panel height in pixels.
virtual DisplayDriver< RGB565 > &	display ()=0
	The board's display driver.
virtual TouchDriver *	touch ()=0
	The board's touch controller, or nullptr if none is wired up.
virtual const I2SPins &	i2s () const =0
	The board's I2S/PA pin assignment.
virtual const LEDPins &	led () const =0
	The board's LED pin assignment.
virtual int8_t	backlightPin () const
template<typename I2SConfig >
void	setI2SPins (I2SConfig &cfg)

Detailed Description

Common interface for a board that bundles a display, an optional touch controller, an I2S pin assignment, and an LED pin assignment behind one begin() call. All boards implementing this use RGB565 panels, so display() is pinned to that color type here (each concrete board still returns its own driver subclass via a covariant return type).

Constructor & Destructor Documentation

~LCDBoard()

virtual ~LCDBoard ( )

virtualdefault

Member Function Documentation

backlightPin()

virtual int8_t backlightPin ( ) const

inlinevirtual

The board's backlight GPIO pin, or -1 if unknown/not applicable. begin() already drives it digitally HIGH; this accessor exists so callers can reconfigure the same pin for PWM brightness control (e.g. via ledcAttach/ledcWrite) after begin().

Reimplemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, and LCDBoardWeActMiniSTM32H750.

begin()

virtual bool begin ( )

pure virtual

Brings up the board's backlight/bus/display/touch. Returns false if the display or touch begin() fails.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

display()

virtual DisplayDriver< RGB565 > & display ( )

pure virtual

The board's display driver.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

height()

virtual size_t height ( ) const

pure virtual

Panel height in pixels.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

i2s()

virtual const I2SPins & i2s ( ) const

pure virtual

The board's I2S/PA pin assignment.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

led()

virtual const LEDPins & led ( ) const

pure virtual

The board's LED pin assignment.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

setI2SPins()

void setI2SPins ( I2SConfig &  cfg )

inline

Copies this board's I2S pins into an audio_tools-style I2SConfig (any type exposing pin_bck/pin_ws/pin_data/pin_data_rx).

touch()

virtual TouchDriver * touch ( )

pure virtual

The board's touch controller, or nullptr if none is wired up.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

width()

virtual size_t width ( ) const

pure virtual

Panel width in pixels.

Implemented in LCDBoardESP32S3_2_8Display, LCDBoardGuitionESP32S3_4_3Display, LCDBoardGuitionESP32_LVGL_2_4Display, LCDBoardGuitionESP32H4_4_3Display, LCDBoardDesktopSDL, LCDBoardWeActMiniSTM32H750, LCDBoardSTM32F723Discovery, and LCDBoardTFTeSPI.

---

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

• src/TinyGPU/Boards/LCDBoardsCommon.h