From 452cfc1b1351e8070ed609d84cae0249411a236b Mon Sep 17 00:00:00 2001 From: inmarket Date: Thu, 24 Oct 2013 12:57:20 +1000 Subject: Add GDISP_NEED_TIMERFLUSH to enable automatic display flushing on a timer. --- include/gdisp/options.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'include/gdisp/options.h') diff --git a/include/gdisp/options.h b/include/gdisp/options.h index 72fe2038..4b199118 100644 --- a/include/gdisp/options.h +++ b/include/gdisp/options.h @@ -28,12 +28,25 @@ * Setting this to TRUE causes GDISP to automatically flush * after each drawing operation. Note this may be slow but enables * an application to avoid having to manually call the flush routine. + * @note If TRUE and GDISP_NEED_TIMERFLUSH is also TRUE, this takes precedence. * @note Most controllers don't need flushing which is why this is set to * FALSE by default. */ #ifndef GDISP_NEED_AUTOFLUSH #define GDISP_NEED_AUTOFLUSH FALSE #endif + /** + * @brief Should drawing operations be automatically flushed on a timer. + * @details Defaults to FALSE, Can be set to FALSE or a timer period in milliseconds. + * @note The period should not be set too short or it will consume all your CPU. A + * value between 250 and 500 milliseconds would probably be suitable. + * @note If TRUE and GDISP_NEED_AUTOFLUSH is also TRUE, this is ineffective. + * @note Most controllers don't need flushing which is why this is set to + * FALSE by default. + */ + #ifndef GDISP_NEED_TIMERFLUSH + #define GDISP_NEED_TIMERFLUSH FALSE + #endif /** * @brief Should all operations be clipped to the screen and colors validated. * @details Defaults to TRUE. -- cgit v1.2.3