aboutsummaryrefslogtreecommitdiffstats
path: root/include/gdisp/gdisp.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2013-10-21 13:34:55 +1000
committerinmarket <andrewh@inmarket.com.au>2013-10-21 13:34:55 +1000
commit0b9db701a1d52c8a6d63ca692619b0dde47805d1 (patch)
tree0a7feae21974b21d0b15918aa438615f6bf1579b /include/gdisp/gdisp.h
parent51f4435cd10cdf4b629d524c425923b293263268 (diff)
downloaduGFX-0b9db701a1d52c8a6d63ca692619b0dde47805d1.tar.gz
uGFX-0b9db701a1d52c8a6d63ca692619b0dde47805d1.tar.bz2
uGFX-0b9db701a1d52c8a6d63ca692619b0dde47805d1.zip
Fix missing case in gdispStreamStop().
Add support for controllers that need flushing. Add both automatic and manual flushing (via the gdispFlush() method)
Diffstat (limited to 'include/gdisp/gdisp.h')
-rw-r--r--include/gdisp/gdisp.h21
1 files changed, 21 insertions, 0 deletions
diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h
index 0c8310bb..006fa08b 100644
--- a/include/gdisp/gdisp.h
+++ b/include/gdisp/gdisp.h
@@ -396,6 +396,27 @@ void gdispSetDisplay(GDisplay *g);
/* Drawing Functions */
/**
+ * @brief Flush current drawing operations to the display
+ * @note Some low level drivers do not update the display until
+ * the display is flushed. For others it is optional but can
+ * help prevent tearing effects. For some it is ignored.
+ * Calling it at the end of a logic set of drawing operations
+ * in your application will ensure controller portability. If you
+ * know your controller does not need to be flushed there is no
+ * need to call it (which is in reality most controllers).
+ * @note Even for displays that require flushing, there is no need to
+ * call this function if GDISP_NEED_AUTOFLUSH is TRUE.
+ * Calling it again won't hurt though.
+ *
+ *
+ * @param[in] display The display number (0..n)
+ *
+ * @api
+ */
+void gdispGFlush(GDisplay *g);
+#define gdispFlush() gdispGFlush(GDISP)
+
+/**
* @brief Clear the display to the specified color.
*
* @param[in] g The display to use