fix(ssgi): guard VR only compilation

[alandtse]

Summary by CodeRabbit

• Bug Fixes
  • Screen Space GI VR shaders now properly compile conditionally when VR mode is active, ensuring correct behavior and improved efficiency across different rendering configurations.

[coderabbitai]

📝 Walkthrough

Walkthrough

These changes conditionally compile VR stereo sync functionality. The shader code is wrapped in #ifdef VR preprocessor guards, and the stereoSyncCompute shader registration in ScreenSpaceGI.cpp now includes only when VR is active at runtime, ensuring VR-specific code doesn't compile or execute in non-VR builds.

Changes

Cohort / File(s)	Summary
Conditional VR Compilation Guards features/Screen Space GI/Shaders/ScreenSpaceGI/stereoSync.cs.hlsl	Wraps all VR-specific shader code (texture declarations, outputs, main computation) inside #ifdef VR ... #endif`` preprocessor directives.
Runtime VR-Gated Shader Registration src/Features/ScreenSpaceGI.cpp	Gates stereoSyncCompute shader inclusion to only append to shaderInfos when REL::Module::IsVR() is true, replacing unconditional inclusion.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• PR #1926: Directly modifies the same stereoSync shader and its integration into ScreenSpaceGI with matching VR conditional logic.
• PR #1906: Similarly applies VR preprocessor guards in shader code to conditionally compile VR-specific functions and sections.

Suggested reviewers

• doodlum
• jiayev

Poem

🐰✨ A shader wrapped in ifdef's embrace,
VR-only code finds its rightful place,
No need to compile what won't be used,
Stereo sync logic—wisely excluded!
Hopping through shaders, clean and tight. 🎮

🚥 Pre-merge checks | ✅ 2 | ❌ 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 (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix(ssgi): guard VR only compilation' directly describes the main change—adding conditional compilation guards around VR-specific shader code.

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

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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]

🧹 Nitpick comments (1)

features/Screen Space GI/Shaders/ScreenSpaceGI/stereoSync.cs.hlsl (1)

10-14: #include directives sit outside the #ifdef VR guard — consider moving them inside.

All three includes are only needed when VR is defined (they feed the VR-guarded body exclusively). Leaving them outside means any out-of-tree compilation without -D VR (e.g., hlslkit standalone validation) silently processes the headers and then produces a shader with no main — no error, but the tool gives no useful feedback.

Moving the includes inside the guard makes the intent self-documenting and lets tooling catch the "no entry point" case more clearly.

♻️ Proposed layout

-#include "Common/FrameBuffer.hlsli"
-#include "Common/VR.hlsli"
-#include "ScreenSpaceGI/common.hlsli"
-
 `#ifdef` VR
 
+#include "Common/FrameBuffer.hlsli"
+#include "Common/VR.hlsli"
+#include "ScreenSpaceGI/common.hlsli"
+
 Texture2D<float> srcDepth : register(t0);

As per coding guidelines: "Validate shaders with targeted testing using hlslkit compilation during development."

🤖 Prompt for AI Agents

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

In `@features/Screen` Space GI/Shaders/ScreenSpaceGI/stereoSync.cs.hlsl around
lines 10 - 14, The three header includes (Common/FrameBuffer.hlsli,
Common/VR.hlsli, ScreenSpaceGI/common.hlsli) are outside the `#ifdef` VR guard and
should be moved inside it so they are only processed when VR is defined; update
stereoSync.cs.hlsl to relocate those `#include` lines into the `#ifdef` VR...#endif
block (referencing the VR preprocessor guard and the listed include filenames)
so out-of-tree or non-VR compilations fail fast with a missing entry point
rather than silently including VR-only headers.

🤖 Prompt for all review comments with AI agents

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

Nitpick comments:
In `@features/Screen` Space GI/Shaders/ScreenSpaceGI/stereoSync.cs.hlsl:
- Around line 10-14: The three header includes (Common/FrameBuffer.hlsli,
Common/VR.hlsli, ScreenSpaceGI/common.hlsli) are outside the `#ifdef` VR guard and
should be moved inside it so they are only processed when VR is defined; update
stereoSync.cs.hlsl to relocate those `#include` lines into the `#ifdef` VR...#endif
block (referencing the VR preprocessor guard and the listed include filenames)
so out-of-tree or non-VR compilations fail fast with a missing entry point
rather than silently including VR-only headers.

---

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 578f045 and 46a5466.

📒 Files selected for processing (2)

• features/Screen Space GI/Shaders/ScreenSpaceGI/stereoSync.cs.hlsl
• src/Features/ScreenSpaceGI.cpp

[github-actions]

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