aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin/sys_defs.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2014-05-09 21:46:32 +1000
committerinmarket <andrewh@inmarket.com.au>2014-05-09 21:46:32 +1000
commit21aac3d8532c9aa1decab30c00d9f5a37067aa13 (patch)
treec874ac8494028f09461e4329f0bcfae8c0e5adb8 /src/gwin/sys_defs.h
parentf7fa0dd78f3b807578d99cc0eefe40996b1f9037 (diff)
parent1478fdf41e3731cafacd22ff6f530fb724c02df3 (diff)
downloaduGFX-21aac3d8532c9aa1decab30c00d9f5a37067aa13.tar.gz
uGFX-21aac3d8532c9aa1decab30c00d9f5a37067aa13.tar.bz2
uGFX-21aac3d8532c9aa1decab30c00d9f5a37067aa13.zip
Merge branch 'master' into gwin
Diffstat (limited to 'src/gwin/sys_defs.h')
-rw-r--r--src/gwin/sys_defs.h20
1 files changed, 18 insertions, 2 deletions
diff --git a/src/gwin/sys_defs.h b/src/gwin/sys_defs.h
index be99be1e..431de67c 100644
--- a/src/gwin/sys_defs.h
+++ b/src/gwin/sys_defs.h
@@ -37,7 +37,7 @@ typedef struct GWindowObject *GHandle;
*/
typedef struct GWindowObject {
#if GWIN_NEED_WINDOWMANAGER
- // This MUST be the first member of the struct
+ // This MUST be the first member of the structure
gfxQueueASyncItem wmq; // @< The next window (for the window manager)
#endif
const struct gwinVMT *vmt; // @< The VMT for this GWIN
@@ -62,6 +62,10 @@ typedef struct GWindowObject {
*
* @note Some gwin's will need extra parameters.
* @note The dimensions and position may be changed to fit on the real screen.
+ * @note If you create this structure on the stack, you should always memset
+ * it to all zero's first in case a future version of the software
+ * add's extra fields. Alternatively you can use @p gwinClearInit()
+ * to clear it.
*
* @{
*/
@@ -111,6 +115,18 @@ extern "C" {
*-------------------------------------------------*/
/**
+ * @brief Clear a GWindowInit structure to all zero's
+ * @note This function is provided just to prevent problems
+ * on operating systems where using memset() causes issues
+ * in the users application.
+ *
+ * @param[in] pwi The GWindowInit structure to clear
+ *
+ * @api
+ */
+ void gwinClearInit(GWindowInit *pwi);
+
+ /**
* @brief Set the default foreground color for all new GWIN windows
*
* @param[in] clr The color to be set
@@ -941,7 +957,7 @@ extern "C" {
#endif
#if GWIN_NEED_IMAGE || defined(__DOXYGEN__)
- #include "src/gwin/image.h"
+ #include "src/gwin/gimage.h"
#endif
#endif /* GFX_USE_GWIN */