LCD-ESP32-Driver 1.0
Project includes component for controlling LCD displays. Currently supports only one LCD controller - SSD1283A but it may change in the future.
Loading...
Searching...
No Matches
lcd.h
Go to the documentation of this file.
1/*
2 * MIT License
3 *
4 * Copyright (c) 2022 Damian Úlusarczyk
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
7 * and associated documentation files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all copies or substantial
13 * portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
16 * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
18 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
19 *
20 */
27#ifndef LCD_H
28#define LCD_H
29
30#include "lcd_low.h"
31
42
52
60
72LCD_error_t lcd__DrawRect(LCD_handle_t device, const uint16_t x, const uint16_t y, const uint16_t width, const uint16_t height, const uint16_t color);
73
83LCD_error_t lcd__DrawImage(LCD_handle_t device, const uint16_t x, const uint16_t y, const LCD_image_t *image);
84
99LCD_error_t lcd__DrawText(LCD_handle_t device, uint16_t x, uint16_t y, const char *text,
100 const int16_t letterSpacing, const int16_t lineSpacing, const LCD_font_t *font, const uint16_t fontColor, const uint16_t bgrColor);
101
109LCD_error_t lcd__ClearScreen(LCD_handle_t device, const uint16_t color);
110
120
121#endif /* LCD_H */
LCD_error_t lcd__DisplayOff(LCD_handle_t device)
Turns off the LCD display for the specific device.
Definition: lcd.c:51
LCD_error_t lcd__ClearScreen(LCD_handle_t device, const uint16_t color)
Clears the screen of the LCD display with specified color.
Definition: lcd.c:108
LCD_error_t lcd__Destroy(LCD_handle_t *device)
Destroys the specific LCD driver instance.
Definition: lcd.c:122
LCD_error_t lcd__DrawImage(LCD_handle_t device, const uint16_t x, const uint16_t y, const LCD_image_t *image)
Draws image on the LCD display in specific position.
Definition: lcd.c:79
LCD_error_t lcd__DisplayOn(LCD_handle_t device)
Turns on the LCD display for the specific device.
Definition: lcd.c:37
LCD_error_t lcd__DrawText(LCD_handle_t device, uint16_t x, uint16_t y, const char *text, const int16_t letterSpacing, const int16_t lineSpacing, const LCD_font_t *font, const uint16_t fontColor, const uint16_t bgrColor)
Draws text on the LCD display with specified properties.
Definition: lcd.c:93
LCD_error_t lcd__DrawRect(LCD_handle_t device, const uint16_t x, const uint16_t y, const uint16_t width, const uint16_t height, const uint16_t color)
Draws rectangle on the LCD display in specific position and color.
Definition: lcd.c:65
LCD_error_t lcd__Init(LCD_handle_t device)
Initializes the specific LCD device.
Definition: lcd.c:23
LCD_error_t
Describes the status of performed operation with LCD display.
Definition: lcd_error_codes.h:38
Contains all structures required for proper communication with LCD display that uses different contro...
Describes properties of the font to be drawn on LCD display.
Definition: lcd_font.h:43
Describes properties of the image to be drawn on LCD display.
Definition: lcd_image.h:39
Base structure describing characteristics of LCD display and its driver.
Definition: lcd_low.h:100