aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2013-07-04 00:54:25 +1000
committerinmarket <andrewh@inmarket.com.au>2013-07-04 00:54:25 +1000
commita7198b53ff82a02a86a55823a8be895ec5eca1e4 (patch)
treeea2f990745313ce82478d0b0d4e92ce070f7c383 /include
parent21e52bc85943ed7255380d8d8384780e617bcbf8 (diff)
downloaduGFX-a7198b53ff82a02a86a55823a8be895ec5eca1e4.tar.gz
uGFX-a7198b53ff82a02a86a55823a8be895ec5eca1e4.tar.bz2
uGFX-a7198b53ff82a02a86a55823a8be895ec5eca1e4.zip
Restore gwin base class image function
Diffstat (limited to 'include')
-rw-r--r--include/gwin/gwin.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h
index 4fb28bef..ba9e1e1a 100644
--- a/include/gwin/gwin.h
+++ b/include/gwin/gwin.h
@@ -720,6 +720,35 @@ extern "C" {
void gwinFillConvexPoly(GHandle gh, coord_t tx, coord_t ty, const point *pntarray, unsigned cnt);
#endif
+/*-------------------------------------------------
+ * Image functions
+ *-------------------------------------------------*/
+
+ #if GDISP_NEED_IMAGE || defined(__DOXYGEN__)
+ /**
+ * @brief Draw the image
+ * @return GDISP_IMAGE_ERR_OK (0) on success or an error code.
+ *
+ * @param[in] gh The window handle
+ * @param[in] img The image structure
+ * @param[in] x,y The window location to draw the image
+ * @param[in] cx,cy The area on the screen to draw
+ * @param[in] sx,sy The image position to start drawing at
+ *
+ * @pre gdispImageOpen() must have returned successfully.
+ *
+ * @note If sx,sy + cx,cy is outside the image boundaries the area outside the image
+ * is simply not drawn.
+ * @note If @p gdispImageCache() has been called first for this frame, this routine will draw using a
+ * fast blit from the cached frame. If not, it reads the input and decodes it as it
+ * is drawing. This may be significantly slower than if the image has been cached (but
+ * uses a lot less RAM)
+ *
+ * @api
+ */
+ gdispImageError gwinImageDraw(GHandle gh, gdispImage *img, coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t sx, coord_t sy);
+ #endif
+
#ifdef __cplusplus
}
#endif