ImGui: r_imgui cvar, skip frames when off, F11 toggle#175
Merged
cursor[bot] merged 1 commit intomainfrom May 4, 2026
Merged
Conversation
Introduce renderer cvar r_imgui (default on) with startup log; gate VkImgui BeginFrame/Draw when disabled to reduce CPU when the inspector is off. Client defines USE_IMGUI when USE_IMGUI CMake option is on; add toggle_imgui command and hardcoded F11 for Vulkan+ImGui builds. Co-authored-by: Tim Fox <timfox@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a runtime toggle for the Vulkan ImGui debug inspector without requiring
vid_restart.Changes
r_imgui(default1): when0, the renderer skipsVkImgui_BeginFrame/VkImgui_DrawCPU work for that frame. Renderer init logs[VK][imgui] debug inspector r_imgui=... (F11 toggles when enabled).toggle_imguicommand togglesr_imgui; F11 runstoggle_imguion first key repeat only (after console handling), only when not dedicated server. CMake definesUSE_IMGUIon theclienttarget whenUSE_IMGUIis ON so the key/command compile only in ImGui builds.Validation
./scripts/compile_engine.sh vulkanctestfrom build dir (all tests passed)Notes
F11 is hardcoded like K_PRINT/K_CONSOLE; bind another key with
bind x toggle_imguiif F11 conflicts with existing binds.