diff options
Diffstat (limited to 'include/gdisp/image.h')
| -rw-r--r-- | include/gdisp/image.h | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/include/gdisp/image.h b/include/gdisp/image.h index 696500a6..ea8a02d4 100644 --- a/include/gdisp/image.h +++ b/include/gdisp/image.h @@ -185,7 +185,7 @@ extern "C" { gdispImageError gdispImageOpen(gdispImage *img); /** - * @brief Close an image and release any dynamicly allocated working storage. + * @brief Close an image and release any dynamically allocated working storage. * * @param[in] img The image structure * @@ -196,6 +196,19 @@ extern "C" { void gdispImageClose(gdispImage *img); /** + * @brief Is an image open. + * @return TRUE if the image is currently open. + * + * @param[in] img The image structure + * + * @note Be careful with calling this on an uninitialized image structure as the image + * will contain random data which may be interpreted as meaning the image + * is open. Clearing the Image structure to 0's will guarantee the image + * is seen as being closed. + */ + bool_t gdispImageIsOpen(gdispImage *img); + + /** * @brief Set the background color of the image. * * @param[in] img The image structure |