panel.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/error>
#include <idfxx/gpio>
#include <idfxx/lcd/color>
 
struct esp_lcd_panel_t;
typedef struct esp_lcd_panel_t* esp_lcd_panel_handle_t;
 
namespace idfxx::lcd {
 
class panel {
public:
    struct config {
        gpio reset_gpio = gpio::nc(); 
        enum rgb_element_order rgb_element_order = rgb_element_order::rgb; 
        rgb_data_endian data_endian = rgb_data_endian::big; 
        uint32_t bits_per_pixel = 16;                       
        struct {
            gpio::level reset_active_level = gpio::level::low; 
        } flags = {};                                          
        void* vendor_config = nullptr; 
    };
 
    virtual ~panel() = default;
 
    panel(const panel&) = delete;
    panel& operator=(const panel&) = delete;
 
    [[nodiscard]] virtual esp_lcd_panel_handle_t idf_handle() const = 0;
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void swap_xy(bool swap) { unwrap(try_swap_xy(swap)); }
#endif
 
    [[nodiscard]] virtual result<void> try_swap_xy(bool swap) = 0;
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void mirror(bool mirrorX, bool mirrorY) { unwrap(try_mirror(mirrorX, mirrorY)); }
#endif
 
    [[nodiscard]] virtual result<void> try_mirror(bool mirrorX, bool mirrorY) = 0;
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void display_on(bool on) { unwrap(try_display_on(on)); }
#endif
 
    [[nodiscard]] virtual result<void> try_display_on(bool on) = 0;
 
protected:
    panel() = default;
};
 
} // namespace idfxx::lcd