mirror of
https://github.com/espressif/esp-idf.git
synced 2025-10-31 21:14:37 +00:00
c8617fe965
Doxygen warnings would previously not result in a failed pipeline. Fixed this as well as all current warnings.
71 lines
2.5 KiB
C
71 lines
2.5 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "esp_lcd_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Configuration structure for panel device
|
|
*/
|
|
typedef struct {
|
|
int reset_gpio_num; /*!< GPIO used to reset the LCD panel, set to -1 if it's not used */
|
|
esp_lcd_color_space_t color_space; /*!< Set the color space used by the LCD panel */
|
|
unsigned int bits_per_pixel; /*!< Color depth, in bpp */
|
|
struct {
|
|
unsigned int reset_active_high: 1; /*!< Setting this if the panel reset is high level active */
|
|
} flags; /*!< LCD panel config flags */
|
|
void *vendor_config; /*!< vendor specific configuration, optional, left as NULL if not used */
|
|
} esp_lcd_panel_dev_config_t;
|
|
|
|
/**
|
|
* @brief Create LCD panel for model ST7789
|
|
*
|
|
* @param[in] io LCD panel IO handle
|
|
* @param[in] panel_dev_config general panel device configuration
|
|
* @param[out] ret_panel Returned LCD panel handle
|
|
* @return
|
|
* - ESP_ERR_INVALID_ARG if parameter is invalid
|
|
* - ESP_ERR_NO_MEM if out of memory
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t esp_lcd_new_panel_st7789(const esp_lcd_panel_io_handle_t io, const esp_lcd_panel_dev_config_t *panel_dev_config, esp_lcd_panel_handle_t *ret_panel);
|
|
|
|
/**
|
|
* @brief Create LCD panel for model NT35510
|
|
*
|
|
* @param[in] io LCD panel IO handle
|
|
* @param[in] panel_dev_config general panel device configuration
|
|
* @param[out] ret_panel Returned LCD panel handle
|
|
* @return
|
|
* - ESP_ERR_INVALID_ARG if parameter is invalid
|
|
* - ESP_ERR_NO_MEM if out of memory
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t esp_lcd_new_panel_nt35510(const esp_lcd_panel_io_handle_t io, const esp_lcd_panel_dev_config_t *panel_dev_config, esp_lcd_panel_handle_t *ret_panel);
|
|
|
|
/**
|
|
* @brief Create LCD panel for model SSD1306
|
|
*
|
|
* @param[in] io LCD panel IO handle
|
|
* @param[in] panel_dev_config general panel device configuration
|
|
* @param[out] ret_panel Returned LCD panel handle
|
|
* @return
|
|
* - ESP_ERR_INVALID_ARG if parameter is invalid
|
|
* - ESP_ERR_NO_MEM if out of memory
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t esp_lcd_new_panel_ssd1306(const esp_lcd_panel_io_handle_t io, const esp_lcd_panel_dev_config_t *panel_dev_config, esp_lcd_panel_handle_t *ret_panel);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|