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>
 
#include <cstddef>
 
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;                       
        gpio::level reset_active_level = gpio::level::low;  
        void* vendor_config = nullptr; 
    };
 
    virtual ~panel() = default;
 
    panel(const panel&) = delete;
    panel& operator=(const panel&) = delete;
 
    [[nodiscard]] esp_lcd_panel_handle_t idf_handle() const { return do_idf_handle(); }
 
    [[nodiscard]] size_t width() const noexcept { return _width; }
 
    [[nodiscard]] size_t height() const noexcept { return _height; }
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void draw_bitmap(int x_start, int y_start, int x_end, int y_end, const void* color_data) {
        unwrap(try_draw_bitmap(x_start, y_start, x_end, y_end, color_data));
    }
 
    void invert_color(bool invert) { unwrap(try_invert_color(invert)); }
 
    void swap_xy(bool swap) { unwrap(try_swap_xy(swap)); }
 
    void mirror(bool mirror_x, bool mirror_y) { unwrap(try_mirror(mirror_x, mirror_y)); }
 
    void display_on(bool on) { unwrap(try_display_on(on)); }
#endif
 
    [[nodiscard]] result<void> try_draw_bitmap(int x_start, int y_start, int x_end, int y_end, const void* color_data) {
        return do_draw_bitmap(x_start, y_start, x_end, y_end, color_data);
    }
 
    [[nodiscard]] result<void> try_invert_color(bool invert) { return do_invert_color(invert); }
 
    [[nodiscard]] result<void> try_swap_xy(bool swap) { return do_swap_xy(swap); }
 
    [[nodiscard]] result<void> try_mirror(bool mirror_x, bool mirror_y) { return do_mirror(mirror_x, mirror_y); }
 
    [[nodiscard]] result<void> try_display_on(bool on) { return do_display_on(on); }
 
protected:
    panel() = default;
    panel(size_t width, size_t height) noexcept
        : _width(width)
        , _height(height) {}
    panel(panel&&) noexcept = default;
    panel& operator=(panel&&) noexcept = default;
 
    // =========================================================================
    // Customization hooks
    //
    // Concrete drivers override these (typically privately). Each hook
    // implements the correspondingly named public method.
    // =========================================================================
 
    [[nodiscard]] virtual esp_lcd_panel_handle_t do_idf_handle() const = 0;
    [[nodiscard]] virtual result<void>
    do_draw_bitmap(int x_start, int y_start, int x_end, int y_end, const void* color_data);
    [[nodiscard]] virtual result<void> do_invert_color(bool invert);
    [[nodiscard]] virtual result<void> do_swap_xy(bool swap);
    [[nodiscard]] virtual result<void> do_mirror(bool mirror_x, bool mirror_y);
    [[nodiscard]] virtual result<void> do_display_on(bool on);
 
private:
    size_t _width = 0;
    size_t _height = 0;
};
 
 
} // namespace idfxx::lcd