aboutsummaryrefslogtreecommitdiffstats
path: root/gfx.h
diff options
context:
space:
mode:
authorinmarket <inmarket@ugfx.org>2017-03-04 17:35:17 +1000
committerinmarket <inmarket@ugfx.org>2017-03-04 17:35:39 +1000
commit7826664969f077342e098a1679faadf2b0b590d5 (patch)
tree8f7f7c307ebd228b9ee057e01d1c2dd932686a3e /gfx.h
parent3a0e49dabcbb9d138d81720cf7a315636a8ab2cb (diff)
downloaduGFX-7826664969f077342e098a1679faadf2b0b590d5.tar.gz
uGFX-7826664969f077342e098a1679faadf2b0b590d5.tar.bz2
uGFX-7826664969f077342e098a1679faadf2b0b590d5.zip
Make the uGFXMain() prototype always available
Diffstat (limited to 'gfx.h')
-rw-r--r--gfx.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/gfx.h b/gfx.h
index afaf7b87..2e25db88 100644
--- a/gfx.h
+++ b/gfx.h
@@ -229,6 +229,7 @@ extern "C" {
* @note If you define GFX_OS_EXTRA_DEINIT_FUNCTION in your gfxconf.h file the macro is the
* name of a void function with no parameters that is called immediately before
* operating system de-initialisation (as ugfx is exiting).
+ * @note If GFX_OS_CALL_UGFXMAIN is set uGFXMain() is called after all initialisation is complete.
*
* @api
*/
@@ -243,6 +244,17 @@ extern "C" {
*/
void gfxDeinit(void);
+ #if GFX_OS_CALL_UGFXMAIN || defined(__DOXYGEN__)
+ /**
+ * @brief The function containing all the user uGFX application code.
+ *
+ * @note This is called by gfxInit() and is expected to never return.
+ * It is defined by the user.
+ *
+ * @pre GFX_OS_CALL_UGFXMAIN is GFXON
+ */
+ void uGFXMain(void);
+ #endif
#ifdef __cplusplus
}
#endif