mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
e10202a608
* Support intel 8080 LCD panel IO on ESP32-S3 * Support RGB LCD panel on ESP32-S3 * Support SPI && I2C LCD panel IO on all esp chips
127 lines
4.3 KiB
C
127 lines
4.3 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef struct esp_lcd_panel_t esp_lcd_panel_t; /*!< Type of LCD panel */
|
|
|
|
/**
|
|
* @brief LCD panel interface
|
|
*/
|
|
struct esp_lcd_panel_t {
|
|
/**
|
|
* @brief Reset LCD panel
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t (*reset)(esp_lcd_panel_t *panel);
|
|
|
|
/**
|
|
* @brief Initialize LCD panel
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t (*init)(esp_lcd_panel_t *panel);
|
|
|
|
/**
|
|
* @brief Destory LCD panel
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t (*del)(esp_lcd_panel_t *panel);
|
|
|
|
/**
|
|
* @brief Draw bitmap on LCD panel
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @param[in] x_start Start index on x-axis (x_start included)
|
|
* @param[in] y_start Start index on y-axis (y_start included)
|
|
* @param[in] x_end End index on x-axis (x_end not included)
|
|
* @param[in] y_end End index on y-axis (y_end not included)
|
|
* @param[in] color_data RGB color data that will be dumped to the specific window range
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t (*draw_bitmap)(esp_lcd_panel_t *panel, int x_start, int y_start, int x_end, int y_end, const void *color_data);
|
|
|
|
/**
|
|
* @brief Mirror the LCD panel on specific axis
|
|
*
|
|
* @note Combine this function with `swap_xy`, one can realize screen rotatation
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @param[in] x_axis Whether the panel will be mirrored about the x_axis
|
|
* @param[in] y_axis Whether the panel will be mirrored about the y_axis
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_NOT_SUPPORTED if this function is not supported by the panel
|
|
*/
|
|
esp_err_t (*mirror)(esp_lcd_panel_t *panel, bool x_axis, bool y_axis);
|
|
|
|
/**
|
|
* @brief Swap/Exchange x and y axis
|
|
*
|
|
* @note Combine this function with `mirror`, one can realize screen rotatation
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @param[in] swap_axes Whether to swap the x and y axis
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_NOT_SUPPORTED if this function is not supported by the panel
|
|
*/
|
|
esp_err_t (*swap_xy)(esp_lcd_panel_t *panel, bool swap_axes);
|
|
|
|
/**
|
|
* @brief Set extra gap in x and y axis
|
|
*
|
|
* @note The gap is only used for calculating the real coordinates.
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @param[in] x_gap Extra gap on x axis, in pixels
|
|
* @param[in] y_gap Extra gap on y axis, in pixels
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t (*set_gap)(esp_lcd_panel_t *panel, int x_gap, int y_gap);
|
|
|
|
/**
|
|
* @brief Invert the color (bit 1 -> 0 for color data line, and vice versa)
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @param[in] invert_color_data Whether to invert the color data
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t (*invert_color)(esp_lcd_panel_t *panel, bool invert_color_data);
|
|
|
|
/**
|
|
* @brief Turn off the display
|
|
*
|
|
* @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
|
|
* @param[in] off Whether to turn off the screen
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_NOT_SUPPORTED if this function is not supported by the panel
|
|
*/
|
|
esp_err_t (*disp_off)(esp_lcd_panel_t *panel, bool off);
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|