From 89a412690ca7ed11c32ce62007468741c3d8fcb0 Mon Sep 17 00:00:00 2001
From: omar <omarcornut@gmail.com>
Date: Sat, 25 Oct 2014 11:01:20 +0100
Subject: [PATCH] Added comment on return value of Begin()

---
 imgui.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/imgui.h b/imgui.h
index 39cb1a91..14c167a2 100644
--- a/imgui.h
+++ b/imgui.h
@@ -139,7 +139,7 @@ namespace ImGui
     void        ShowTestWindow(bool* open = NULL);
 
     // Window
-    bool        Begin(const char* name = "Debug", bool* open = NULL, ImVec2 size = ImVec2(0,0), float fill_alpha = -1.0f, ImGuiWindowFlags flags = 0);
+    bool        Begin(const char* name = "Debug", bool* open = NULL, ImVec2 size = ImVec2(0,0), float fill_alpha = -1.0f, ImGuiWindowFlags flags = 0);    // return false when window is collapsed, so you can early out in your code.
     void        End();
     void        BeginChild(const char* str_id, ImVec2 size = ImVec2(0,0), bool border = false, ImGuiWindowFlags extra_flags = 0);
     void        EndChild();