feat(upscaling): framegen in menus option

[SkrubbySkrubInAShrub]

Summary by CodeRabbit

• New Features
  • Added a "Frame Generation in Menus" option (off by default) with tooltip; frame generation now respects this setting and whether menus/paused state allow it.
  • Centralized per-frame decision for when frame generation runs, used across timing, limiter, postprocessing, and presentation paths for consistent behavior.
• Chores
  • Upscaling feature version bumped to 1-4-0.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Adds a new setting frameGenerationAllowInMenus and UI checkbox, introduces Upscaling::ShouldUseFrameGenerationThisFrame() to centralize per-frame frame-generation eligibility (considers DX12 path, mode, menus/paused and the new setting), and updates frame-timing and Present calls to use that predicate. Config version bumped.

Changes

Frame Generation in Menus

Layer / File(s)	Summary
Data Shape src/Features/Upscaling.h	Adds Upscaling::Settings::frameGenerationAllowInMenus (bool, default false) and declares bool ShouldUseFrameGenerationThisFrame() const;.
Settings Serialization src/Features/Upscaling.cpp	Includes frameGenerationAllowInMenus in settings serialization.
Decision Logic src/Features/Upscaling.cpp	Implements Upscaling::ShouldUseFrameGenerationThisFrame() — returns true only when DX12 path active, settings.frameGenerationMode enabled, and (menus not open OR settings.frameGenerationAllowInMenus true), also checks UI paused state.
Frame Pacing Integration src/Features/Upscaling.cpp	FrameLimiter uses ShouldUseFrameGenerationThisFrame() to choose half-rate vs full-rate frame-time scaling.
Post-processing / Present Integration src/Features/Upscaling.cpp, src/Features/Upscaling/DX12SwapChain.cpp	Replaces inline checks with ShouldUseFrameGenerationThisFrame() in Main_PostProcessing and DX12SwapChain::Present (passed to FidelityFX Present).
UI Binding src/Features/Upscaling.cpp	Adds "Frame Generation in Menus" checkbox bound to settings.frameGenerationAllowInMenus with explanatory tooltip.
Version Bump features/Upscaling/Shaders/Features/Upscaling.ini	Config Version updated from 1-3-0 → 1-4-0.

Sequence Diagram(s)

sequenceDiagram
    participant UI as Game UI
    participant State as globals::state
    participant Upscaling as Upscaling
    participant SwapChain as DX12SwapChain
    participant FFX as fidelityFX

    UI->>Upscaling: toggle "Frame Generation in Menus" (settings updated)
    SwapChain->>Upscaling: call ShouldUseFrameGenerationThisFrame()
    Upscaling->>State: read menu flags / ui->GameIsPaused()
    Upscaling-->>SwapChain: return enabled/disabled
    SwapChain->>FFX: Present(..., frameGenerationEnabled=answer, isHDR)
    FFX-->>SwapChain: present result

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• community-shaders/skyrim-community-shaders#2274: Adds/uses the same per-frame gate (ShouldUseFrameGenerationThisFrame) and related frame-gen logic.
• community-shaders/skyrim-community-shaders#1482: Modifies Main_PostProcessing/menu interactions for frame generation behavior.
• community-shaders/skyrim-community-shaders#1524: Changes Upscaling UI around frame generation settings.

Suggested reviewers

• alandtse
• doodlum

Poem

🐰 I tick a box, let frames skip through,

Menus open wide but motion stays true.
A hop, a tweak, a tiny choice made,
Pixels hum on, unpaused in the glade.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

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

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat(upscaling): framegen in menus option' clearly summarizes the main change: adding a user-configurable option to enable frame generation in menus, which aligns with all modifications across the codebase.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{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

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/Features/Upscaling.cpp`:
- Around line 1615-1619: The current ShouldUseFrameGeneration uses
ui->GameIsPaused() as a proxy for menus (in the return expression with
settings.frameGenerationAllowInMenus), which is incorrect; replace that pause
check with a real "menu open" check (e.g., call an existing UI method like
ui->IsMenuOpen()/ui->MenuIsOpen() or add one to the UI class that accurately
reports whether any game menu is visible) and use that instead of
GameIsPaused(); update the condition in Upscaling::ShouldUseFrameGeneration to
consult that menu-open helper so settings.frameGenerationAllowInMenus behaves
consistently across menu types.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 20f6f1ce-8483-470a-9944-3f63d7dd97a2

📥 Commits

Reviewing files that changed from the base of the PR and between d919016 and 8e5c07d.

📒 Files selected for processing (3)

• src/Features/Upscaling.cpp
• src/Features/Upscaling.h
• src/Features/Upscaling/DX12SwapChain.cpp

[github-actions]

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

[alandtse]

Was there a reason we disabled it before?

[SkrubbySkrubInAShrub]

Was there a reason we disabled it before?

Latency in menus, but people constantly complain that is causes a jarring reduction in fps. It's a harmless option for those who want it.

[soda3000]

Nitpick comment, otherwise good.

[soda3000]

"can increase" -> "increases" since FG necessarily adds input latency