Improve doc / background color

pthom · Jan 30, 2024 · 14db51d · 14db51d
1 parent 133e2a0
commit 14db51d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/hello_imgui/imgui_window_params.h b/src/hello_imgui/imgui_window_params.h
@@ -121,7 +121,8 @@ struct ImGuiWindowParams
     ImGuiTheme::ImGuiTweakedTheme tweakedTheme;
 
     // backgroundColor:
-    // This is the "clearColor", visible if defaultImGuiWindowType!=ProvideFullScreenWindow.
+    // This is the "clearColor", i.e. the app window background color, is visible *only if*
+    //    runnerParams.imGuiWindowParams.defaultImGuiWindowType = NoDefaultWindow
     // Alternatively, you can set your own RunnerCallbacks.CustomBackground to have full
     // control over what is drawn behind the Gui.
     ImVec4 backgroundColor = ImVec4(0.f, 0.f, 0.f, 0.f);