Driver::PicoDisplay::Api Class Reference

This class defines an interface for accessing the 'hardware bits' of the Pico Display board. More...

Detailed Description

This class defines an interface for accessing the 'hardware bits' of the Pico Display board.

The class is NOT thread safe. The application is RESPONSIBLE for ensuring thread-safe usage.

#include <Api.h>

Static Public Member Functions
static Driver::Button::PolledDebounced &	buttonA () noexcept
	This method returns the Button driver for the board's 'A' button.
static Driver::Button::PolledDebounced &	buttonB () noexcept
	This method returns the Button driver for the board's 'B' button.
static Driver::Button::PolledDebounced &	buttonX () noexcept
	This method returns the Button driver for the board's 'X' button.
static Driver::Button::PolledDebounced &	buttonY () noexcept
	This method returns the Button driver for the board's 'Y' button.
static Driver::LED::RedGreenBlue &	rgbLED () noexcept
	This method returns the RGB LED driver for the board's RGB LED.
static void	updateLCD (pimoroni::PicoGraphics &graphics)
	This method is used to update the display/LCD Controller with the specified frame buffer contents.
static void	setLCDBrightness (uint8_t brightnessLevel)
	This method sets the back-light brightness of the LCD (range: 0 - 255)
static void	nop ()
	This method performs a 'null operation' on the display board.

Member Function Documentation

buttonA()

static Driver::Button::PolledDebounced & Driver::PicoDisplay::Api::buttonA ( )

staticnoexcept

This method returns the Button driver for the board's 'A' button.

buttonB()

static Driver::Button::PolledDebounced & Driver::PicoDisplay::Api::buttonB ( )

staticnoexcept

This method returns the Button driver for the board's 'B' button.

buttonX()

static Driver::Button::PolledDebounced & Driver::PicoDisplay::Api::buttonX ( )

staticnoexcept

This method returns the Button driver for the board's 'X' button.

buttonY()

static Driver::Button::PolledDebounced & Driver::PicoDisplay::Api::buttonY ( )

staticnoexcept

This method returns the Button driver for the board's 'Y' button.

nop()

static void Driver::PicoDisplay::Api::nop ( )

static

This method performs a 'null operation' on the display board.

What 'null operation' means is target dependent (e.g. this method does nothing on the physical display, but on the Simulator it updates the simulation time on the GUI screen

rgbLED()

static Driver::LED::RedGreenBlue & Driver::PicoDisplay::Api::rgbLED ( )

staticnoexcept

This method returns the RGB LED driver for the board's RGB LED.

setLCDBrightness()

static void Driver::PicoDisplay::Api::setLCDBrightness ( uint8_t  brightnessLevel )

static

This method sets the back-light brightness of the LCD (range: 0 - 255)

updateLCD()

static void Driver::PicoDisplay::Api::updateLCD ( pimoroni::PicoGraphics &  graphics )

static

This method is used to update the display/LCD Controller with the specified frame buffer contents.

---

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

• Driver/PicoDisplay/Api.h