Update LCD API docs
This commit is contained in:
@@ -155,14 +155,14 @@ void lcd_clear(uint32_t color);
|
||||
/**
|
||||
* @brief Draw GIF image on screen from memory
|
||||
* Draw GIF image from memory to the LCD screen at position X, Y
|
||||
* @warning If the GIF has a loop count specified, it will stop after the specified amount of loops and the lcd_git_t handle will be invalid for further use
|
||||
* @warning If the GIF has a loop count specified, it will stop after the specified amount of loops and the lcd_gif_t handle will be invalid for further use
|
||||
* @note Before drawing over a GIF, make sure to call lcd_stop_gif(), otherwise the GIF will keep overwriting the screen
|
||||
*
|
||||
* @param src Pointer to the GIF image data
|
||||
* @param size The size of the GIF image data
|
||||
* @param x_pos The X position on the screen
|
||||
* @param y_pos The Y position on the screen
|
||||
* @return A handle to the GIF image, NULL if the GIF could not be opened
|
||||
* @return A handle to the GIF image, NULL if the GIF could not be opened @ref lcd_gif_t
|
||||
*/
|
||||
lcd_gif_t* lcd_draw_gif(uint8_t* src, size_t size, uint32_t x_pos, uint32_t y_pos);
|
||||
|
||||
@@ -175,7 +175,7 @@ lcd_gif_t* lcd_draw_gif(uint8_t* src, size_t size, uint32_t x_pos, uint32_t y_po
|
||||
* @param name The filename of the GIF image
|
||||
* @param x_pos The X position on the screen
|
||||
* @param y_pos The Y position on the screen
|
||||
* @return A handle to the GIF image, NULL if the GIF could not be opened
|
||||
* @return A handle to the GIF image, NULL if the GIF could not be opened @ref lcd_gif_t
|
||||
*/
|
||||
lcd_gif_t* lcd_draw_gif_from_fs(const char* name, uint32_t x_pos, uint32_t y_pos);
|
||||
|
||||
@@ -185,7 +185,7 @@ lcd_gif_t* lcd_draw_gif_from_fs(const char* name, uint32_t x_pos, uint32_t y_pos
|
||||
* Call this function before trying to draw over a GIF
|
||||
* @warning Make sure the GIF is still playing, otherwise it might stop another GIF
|
||||
*
|
||||
* @param gif The handle to the GIF image
|
||||
* @param gif The handle to the GIF image @ref lcd_gif_t
|
||||
*/
|
||||
void lcd_stop_gif(lcd_gif_t* gif);
|
||||
|
||||
@@ -193,7 +193,7 @@ void lcd_stop_gif(lcd_gif_t* gif);
|
||||
* @brief Check if a GIF is still playing
|
||||
* @note It is possible that the GIF has stopped playing, but another GIF has taken its slot and is still playing
|
||||
*
|
||||
* @param gif The handle to the GIF image
|
||||
* @param gif The handle to the GIF image @ref lcd_gif_t
|
||||
* @return True if the GIF is still playing, false if not
|
||||
*/
|
||||
bool lcd_gif_is_playing(lcd_gif_t* gif);
|
||||
|
||||
Reference in New Issue
Block a user