sani7/2023-Webservices_And_Applications
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add note on images that can go out of frame

Browse Source
This commit is contained in:
xoreo
2023-11-14 15:01:38 +01:00
parent 1621c8feb7
commit ec5691a9ab
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/lcd_api.md
View File

@@ -91,6 +91,8 @@ void main(void) {
``` ```
Draw raw image from a C array to the LCD screen at position X, Y. In color mode ARGB8888, RGB888, RGB565 or ARGB1555 Supports ARGB8888, RGB565, RGB888 (see LCD_* defines in header file). Draw raw image from a C array to the LCD screen at position X, Y. In color mode ARGB8888, RGB888, RGB565 or ARGB1555 Supports ARGB8888, RGB565, RGB888 (see LCD_* defines in header file).
Note that when an image exceeds the X or Y size of the LCD display, the image will go out of the visible LCD area.
#### Drawing a BMP image onto the screen #### Drawing a BMP image onto the screen
```c ```c
void lcd_draw_bmp_img(uint8_t* bmp_buff, uint32_t x_pos, uint32_t y_pos); void lcd_draw_bmp_img(uint8_t* bmp_buff, uint32_t x_pos, uint32_t y_pos);
@@ -110,6 +112,8 @@ void main(void) {
``` ```
Drawing a BMP image (either from filesystem or a C-array) to the LCD screen at position X, Y. The image size and color scheme do not have to be passed as arguments like in the `lcd_draw_raw_img(...)` function, these values are present in the BMP header. Drawing a BMP image (either from filesystem or a C-array) to the LCD screen at position X, Y. The image size and color scheme do not have to be passed as arguments like in the `lcd_draw_raw_img(...)` function, these values are present in the BMP header.
Note that when an image exceeds the X or Y size of the LCD display, the image will go out of the visible LCD area.
#### Drawing a BMP from the filesystem to the LCD #### Drawing a BMP from the filesystem to the LCD
```c ```c
void lcd_draw_img_from_fs_with_name(const char* name, uint32_t x_pos, uint32_t y_pos); void lcd_draw_img_from_fs_with_name(const char* name, uint32_t x_pos, uint32_t y_pos);
@@ -128,7 +132,7 @@ void main(void) {
This function expects the name of the BMP image as argument, together with the X and Y coordinates. This function expects the name of the BMP image as argument, together with the X and Y coordinates.
Note that this function only works for BMP images and not raw images. Note that this function only works for BMP images and not raw images and when an image exceeds the X or Y size of the LCD display, the image will go out of the visible LCD area.
#### Clearing the LCD screen #### Clearing the LCD screen
```c ```c