diff --git a/docs/lcd_api.md b/docs/lcd_api.md index fdb4caf..58b2692 100644 --- a/docs/lcd_api.md +++ b/docs/lcd_api.md @@ -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). +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 ```c 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. +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 ```c 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. -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 ```c