perf: cache frequent ui checks

[jiayev]

#1972

Summary by CodeRabbit

• Refactor
  • Menu open state is now tracked centrally per frame, streamlining checks across visuals, VR overlays, lighting, and background blur.
• Bug Fixes
  • More consistent behavior for overlays, lighting, and background blur when main, loading, or map menus are open—reduces spurious rendering, incorrect overlay visibility, and edge-case glitches.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: beda9880-8ef0-4e06-97ec-25725de482a1

📥 Commits

Reviewing files that changed from the base of the PR and between 22e76d5 and 6274e66.

📒 Files selected for processing (3)

• src/Features/LinearLighting.cpp
• src/Features/VR/Input.cpp
• src/Menu/BackgroundBlur.cpp

🚧 Files skipped from review as they are similar to previous changes (3)

• src/Features/LinearLighting.cpp
• src/Menu/BackgroundBlur.cpp
• src/Features/VR/Input.cpp

---

📝 Walkthrough

Walkthrough

Replaces direct UI menu-open queries with per-frame cached booleans on State and updates multiple features to read those cached flags instead of calling UI::IsMenuOpen each time.

Changes

Cohort / File(s)	Summary
State Caching Infrastructure src/State.h, src/State.cpp	Add isMainMenuOpen, isLoadingMenuOpen, isMapMenuOpen to State; populate once per frame in Reset() and use cached flags in UpdateSharedData.
Lighting Features src/Features/LinearLighting.cpp, src/Features/Skylighting.cpp	Replace UI::IsMenuOpen checks with globals::state->isMainMenuOpen / isLoadingMenuOpen / isMapMenuOpen for early-return gating.
VR Features src/Features/VR/Input.cpp, src/Features/VR/SettingsUI.cpp	Determine overlay/menu validity using globals::state->isMainMenuOpen (alongside existing TweenMenu checks) instead of requiring runtime UI menu queries.
Menu & Scene Utilities src/Menu/BackgroundBlur.cpp, src/SceneSettingsManager.cpp	Switch shader/scene early-out conditions from UI menu queries to cached State flags.
Includes Added src/Features/..., src/Menu/..., src/SceneSettingsManager.cpp	Added #include "State.h" where code now reads globals::state flags.

Sequence Diagram(s)

sequenceDiagram
    participant UI as UI subsystem
    participant State as globals::state
    participant Feature as Feature modules (Lighting / VR / Blur / Scene)
    participant Renderer as Renderer / Shader / Overlay

    UI->>State: Reset() — query IsMenuOpen or return false
    State-->>State: set isMainMenuOpen / isLoadingMenuOpen / isMapMenuOpen
    Feature->>State: read cached menu flags
    alt menu flagged open
        Feature-->>Renderer: early return / skip processing
    else menu not open
        Feature->>Renderer: proceed with rendering / update
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

• doodlum
• alandtse

Poem

🐰 I cached the menus, quick and neat,
No more strings each frame to beat.
Flags hop in, one check to find,
Lighting, VR, blur — all aligned.
Hooray — frames sprint, light on their feet!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 15.38% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'perf: cache frequent ui checks' accurately reflects the main objective of the changeset, which introduces caching of menu state checks to reduce repeated UI queries.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

No actionable suggestions for changed features.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/Features/VR/Input.cpp (1)

31-32: Consider caching TweenMenu state for consistency.

This uses the cached isMainMenuOpen but still queries TweenMenu directly via globals::game::ui->IsMenuOpen. Since State::Reset() only caches MainMenu, LoadingMenu, and MapMenu, the TweenMenu check must remain a live query.

If TweenMenu is queried frequently in VR input paths, consider adding isTweenMenuOpen to the cached flags in State::Reset() for consistency and to further reduce BSFixedString overhead.

♻️ Optional: Add TweenMenu to cached state

In src/State.h:

 	bool isMainMenuOpen = false;
 	bool isLoadingMenuOpen = false;
 	bool isMapMenuOpen = false;
+	bool isTweenMenuOpen = false;

In src/State.cpp (Reset()):

 	if (auto ui = globals::game::ui) {
 		isMainMenuOpen = ui->IsMenuOpen(RE::MainMenu::MENU_NAME);
 		isLoadingMenuOpen = ui->IsMenuOpen(RE::LoadingMenu::MENU_NAME);
 		isMapMenuOpen = ui->IsMenuOpen(RE::MapMenu::MENU_NAME);
+		isTweenMenuOpen = ui->IsMenuOpen(RE::TweenMenu::MENU_NAME);
 	} else {
 		isMainMenuOpen = false;
 		isLoadingMenuOpen = false;
 		isMapMenuOpen = false;
+		isTweenMenuOpen = false;
 	}

Then in this file:

-	bool uiMenusOpen = globals::state->isMainMenuOpen ||
-	                   (globals::game::ui && globals::game::ui->IsMenuOpen(RE::TweenMenu::MENU_NAME));
+	bool uiMenusOpen = globals::state->isMainMenuOpen || globals::state->isTweenMenuOpen;

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/Features/VR/Input.cpp` around lines 31 - 32, The current uiMenusOpen
calculation mixes a cached flag (globals::state->isMainMenuOpen) with a live
query to globals::game::ui->IsMenuOpen(RE::TweenMenu::MENU_NAME); add a cached
isTweenMenuOpen flag to State (declare isTweenMenuOpen in State.h and set its
value inside State::Reset() alongside isMainMenuOpen/isLoadingMenu/isMapMenu)
and then replace the direct IsMenuOpen call in this file with
globals::state->isTweenMenuOpen to keep consistency and reduce repeated
BSFixedString lookups; ensure State::Reset() updates isTweenMenuOpen by querying
the UI once.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/State.cpp`:
- Around line 147-160: The code calls globals::game::ui->GameIsPaused() before
confirming globals::game::ui is non-null, risking a null dereference; change it
to first grab a local pointer (e.g., auto ui = globals::game::ui) and check it
before any use, then only call ui->GameIsPaused() and ui->IsMenuOpen(...) (or,
if you prefer, guard the existing GameIsPaused() call with an if
(globals::game::ui) check), and keep updating timer with
RE::GetSecondsSinceLastFrame() only when ui is valid; ensure
isMainMenuOpen/isLoadingMenuOpen/isMapMenuOpen logic uses the same local ui
pointer to avoid duplicate lookups.

---

Nitpick comments:
In `@src/Features/VR/Input.cpp`:
- Around line 31-32: The current uiMenusOpen calculation mixes a cached flag
(globals::state->isMainMenuOpen) with a live query to
globals::game::ui->IsMenuOpen(RE::TweenMenu::MENU_NAME); add a cached
isTweenMenuOpen flag to State (declare isTweenMenuOpen in State.h and set its
value inside State::Reset() alongside isMainMenuOpen/isLoadingMenu/isMapMenu)
and then replace the direct IsMenuOpen call in this file with
globals::state->isTweenMenuOpen to keep consistency and reduce repeated
BSFixedString lookups; ensure State::Reset() updates isTweenMenuOpen by querying
the UI once.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 81b21972-5230-48a2-afc5-1d9e5c6dd47f

📥 Commits

Reviewing files that changed from the base of the PR and between 47e3a79 and 7bd3afe.

📒 Files selected for processing (8)

• src/Features/LinearLighting.cpp
• src/Features/Skylighting.cpp
• src/Features/VR/Input.cpp
• src/Features/VR/SettingsUI.cpp
• src/Menu/BackgroundBlur.cpp
• src/SceneSettingsManager.cpp
• src/State.cpp
• src/State.h

[github-actions]

✅ A pre-release build is available for this PR:
Download