chore: rename d3d12interop to d3d12SwapChainActive

[doodlum]

Summary by CodeRabbit

• Bug Fixes

  • Frame Generation settings and indicators now accurately reflect D3D12 swap chain activity.
  • Improved consistency when enabling/disabling related options and managing resources.
  • Frame pacing path correctly engages under applicable conditions.

• Style

  • Footer updated to display “D3D12 Swap Chain: Active/Inactive” for clearer status visibility.

• Refactor

  • Internal state handling streamlined to improve reliability and consistency across UI and runtime behavior.

[coderabbitai]

Walkthrough

Internal flag d3d12Interop was renamed to d3d12SwapChainActive and propagated across Upscaling.cpp, Upscaling.h, and Menu.cpp. All conditionals, logging, and UI strings now reference the new name; no public API signatures changed. Logic that gates frame generation, resource updates, and footer display now reads the new flag.

Changes

Cohort / File(s)	Summary
Upscaling runtime logic src/Features/Upscaling.cpp	Replaced all references to d3d12Interop with d3d12SwapChainActive across initialization, resource checks/updates, copy paths, frame limiter, UI gating, and logging; adjusted control branches to use the new flag; D3D11CreateDeviceAndSwapChainUpscaling now sets d3d12SwapChainActive.
Upscaling header state src/Features/Upscaling.h	Renamed public member: bool d3d12Interop → bool d3d12SwapChainActive (default false unchanged).
Menu footer display src/Menu.cpp	Footer label changed from “D3D12 Interop” to “D3D12 Swap Chain”; status now reads globals::features::upscaling.d3d12SwapChainActive.

Sequence Diagram(s)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• feat: performance overlay #1070 — Touches Upscaling methods using the same flag for DX12 swap-chain timing; overlaps with this rename.
• feat(frame generation): improve frame generation quality #1125 — Modifies Upscaling D3D hooks and members in paths affected by the flag rename.
• chore(upscaling): improve upscaling for xess and fsr #1466 — Adjusts Upscaling shared D3D12 interop/resource handling where this flag is read.

Suggested reviewers

• jiayev
• alandtse

Poem

I toggled a flag with a whisker’s sway,
From interop’s warren to swap-chain’s play.
Bits hop in order, frames align tight,
UI carrots glow “Active” tonight.
Thump goes the log—clean, concise, exact—
A tidy rename, a precise rabbit act. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 10.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ 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 "chore: rename d3d12interop to d3d12SwapChainActive" concisely and accurately summarizes the primary change in the diff — renaming the internal d3d12interop flag to d3d12SwapChainActive and updating related UI text and conditionals in Upscaling and Menu. It is specific, focused, and uses a conventional commit prefix, making the intent clear to reviewers scanning history. It avoids unnecessary detail and correctly reflects the changeset.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch d3d12-interop-rename

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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]

Using provided base ref: 76cb9a0
Using base ref: 76cb9a0
Base commit date: 2025-09-18T20:03:59+01:00 (Thursday, September 18, 2025 08:03 PM)
No actionable suggestions for changed features.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (11)

src/Features/Upscaling.h (3)

82-82: Optional: add a tiny accessor to avoid direct flag reads.

Keeps call‑sites consistent and future‑proof if backing logic changes.

 struct Upscaling : Feature
 {
+	inline bool IsD3D12SwapChainActive() const noexcept { return d3d12SwapChainActive; }

---

143-155: Comment tweak for consistency (nit).

Section comment still says “interop”; you can mention the swap chain explicitly for discoverability.

-// D3D11/D3D12 shared fence for interop synchronization
+// D3D11/D3D12 shared fence for interop/proxy swap-chain synchronization

---

171-171: Consider renaming the static to match terminology (optional).

If you plan further renames, dx12SwapChain → d3d12SwapChain for consistency with the new flag.

src/Features/Upscaling.cpp (8)

506-513: Use a local alias for the repeated condition (minor).

Improves readability and reduces duplication.

- bool frameGenModeChanged = (settings.frameGenerationMode && d3d12SwapChainActive) != previousFrameGenMode;
+ const bool fgRequested = settings.frameGenerationMode && d3d12SwapChainActive;
+ bool frameGenModeChanged = fgRequested != previousFrameGenMode;
 ...
- (int)previousUpscaleMode, (int)a_upscalemethod, previousFrameGenMode, (settings.frameGenerationMode && d3d12SwapChainActive));
+ (int)previousUpscaleMode, (int)a_upscalemethod, previousFrameGenMode, fgRequested);
 ...
- previousFrameGenMode = (settings.frameGenerationMode && d3d12SwapChainActive);
+ previousFrameGenMode = fgRequested;

Also applies to: 552-553

---

905-907: VRAM tidy-up when proxy is active but features are off (optional).

You purposely retain depth/motion when the proxy is active even if neither upscaling nor FG needs them. Consider freeing them to save VRAM and lazily re‑creating on demand.

Also applies to: 926-935, 1008-1018

---

1038-1052: Add parentheses for readability (nit).

Operator precedence is correct, but explicit grouping avoids confusion.

-if (upscaleMethod == UpscaleMethod::kFSR || (d3d12SwapChainActive && settings.frameGenerationMode && upscaleMethod != UpscaleMethod::kXESS)) {
+if (upscaleMethod == UpscaleMethod::kFSR ||
+    ((d3d12SwapChainActive && settings.frameGenerationMode) && (upscaleMethod != UpscaleMethod::kXESS))) {

---

1054-1103: Same parentheses nit here.

-if (upscaleMethod == UpscaleMethod::kFSR || upscaleMethod == UpscaleMethod::kXESS || d3d12SwapChainActive && settings.frameGenerationMode) {
+if (upscaleMethod == UpscaleMethod::kFSR ||
+    upscaleMethod == UpscaleMethod::kXESS ||
+    (d3d12SwapChainActive && settings.frameGenerationMode)) {

---

1149-1172: Guard waitable object (edge case).

If the backend fails to provide a waitable object, WaitForSingleObject(nullptr, …) will crash.

- if (d3d12SwapChainActive) {
+ if (d3d12SwapChainActive) {
     // Use frame latency waitable object if available for better frame pacing
-    HANDLE waitableObject = GetFrameLatencyWaitableObject();
+    HANDLE waitableObject = GetFrameLatencyWaitableObject();
 
     // Wait for the next frame presentation slot
-    WaitForSingleObject(waitableObject, INFINITE);
+    if (waitableObject) {
+        WaitForSingleObject(waitableObject, INFINITE);
+    } else {
+        logger::warn("[FrameLimiter] Frame latency waitable object unavailable; falling back to QPC pacing.");
+    }

---

150-150: Minor doc tweak (nit).

Comment says “optional D3D12 proxying”; consider mentioning “swap chain” to align with the rename.

---

352-356: IAT hook install unchanged; consider setting flag false here (defensive, optional).

If you ever reinitialize after a teardown, resetting the flag avoids stale state.

 void Upscaling::Load()
 {
   *(uintptr_t*)&ptrD3D11CreateDeviceAndSwapChainUpscaling = SKSE::PatchIAT(hk_D3D11CreateDeviceAndSwapChainUpscaling, "d3d11.dll", "D3D11CreateDeviceAndSwapChain");
+  d3d12SwapChainActive = false;
 }

---

275-321: UI copy still mentions “D3D12 interop” in VR path (nit).

Optional wording change to “swap chain interop” for consistency.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 76cb9a0 and 3b21df0.

📒 Files selected for processing (3)

• src/Features/Upscaling.cpp (13 hunks)
• src/Features/Upscaling.h (1 hunks)
• src/Menu.cpp (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{cpp,cxx,cc,c,h,hpp,hxx,hlsl,hlsli,fx,fxh,py}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Do not include TODO/FIXME placeholders; provide complete, working solutions

Files:

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

src/**/*.{cpp,cxx,cc,h,hpp,hxx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

src/**/*.{cpp,cxx,cc,h,hpp,hxx}: Ensure SE/AE/VR runtime compatibility; use runtime detection patterns (e.g., REL::RelocateMember())
Include robust error handling and resource management with graceful degradation in the plugin code

Files:

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

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build plugin and addons

🔇 Additional comments (12)

src/Features/Upscaling.h (1)

82-82: Rename improves clarity; OK to merge.

Public runtime flag now clearly reflects the proxy swap-chain state.

src/Menu.cpp (2)

403-404: Footer label and source updated; looks good.

String now reflects swap‑chain terminology and reads the new flag.

---

403-404: No 'D3D12 Interop' labels found — resolved.
Repo-wide search for "D3D12 Interop"/"d3d12Interop" returned no matches; only D3D12 tokens appear in shader comments (features/Screen-Space Shadows/Shaders/ScreenSpaceShadows/RaymarchCS.hlsl).

src/Features/Upscaling.cpp (9)

242-247: Restart hint logic reads well with the new flag.

Warns only when FG is enabled but the proxy isn’t active yet.

---

255-262: UI gating matches swap‑chain availability.

Disabling controls when the proxy isn’t active prevents invalid states.

---

1133-1134: UI buffer update now correctly keyed off swap‑chain activity.

Matches the rename; no issues.

---

1238-1239: IsFrameGenerationActive() updated; OK.

Condition remains semantically identical with the new flag.

---

1020-1022: Nice: consolidated debug line reflects all three needs.

No action needed.

---

111-121: Happy path remains unchanged aside from the flag; LGTM.

No behavioral regressions spotted.

Also applies to: 140-148

---

323-333: Settings (de)serialization unaffected; good.

Rename doesn’t touch persisted schema.

---

1263-1270: SDK loads unaffected; OK.

No coupling to the renamed flag here.

---

111-112: Flag is set when proxy swap chain is created — ensure it’s cleared on teardown.

Repo search shows no src/Features/Upscaling.cpp and no assignment that resets upscaling.d3d12SwapChainActive = false; add a reset in the swapchain/device teardown path (or point to the current file/path so I can re-verify).

[github-actions]

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