From 9e8b38ba943b339b966b1011bab899720d6305fc Mon Sep 17 00:00:00 2001
From: inmarket <andrewh@inmarket.com.au>
Date: Fri, 9 May 2014 21:25:31 +1000
Subject: Add gwinClearInit() and gwinWidgetClearInit() to clear gwin
 initialisation structures. Incorporate into demo's

---
 src/gwin/sys_defs.h | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

(limited to 'src/gwin/sys_defs.h')

diff --git a/src/gwin/sys_defs.h b/src/gwin/sys_defs.h
index f4e1c2f7..fa5084a3 100644
--- a/src/gwin/sys_defs.h
+++ b/src/gwin/sys_defs.h
@@ -34,7 +34,7 @@
  */
 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
@@ -54,6 +54,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.
  *
  * @{
  */
@@ -102,6 +106,18 @@ extern "C" {
  * Functions that affect all windows
  *-------------------------------------------------*/
 
+	/**
+	 * @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
 	 *
-- 
cgit v1.2.3