Added comment on return value of Begin()

ocornut · Oct 25, 2014 · 89a4126 · 89a4126
1 parent af37fb1
commit 89a4126
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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();