feat(LLF): add debug overlay in llf visualiser

[davo0411]

just should add a text to the top left stating debug mode on to stop new users accidentally toggling it and thinking their game broke.

Summary by CodeRabbit

• New Features
  • Added a visual overlay for displaying light debugging information.
  • Light visualization mode is now configurable through settings and can be toggled on/off.
  • Cluster size data is now propagated through the per-frame data system.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The LightLimitFix feature is refactored to inherit from OverlayFeature, adding visual debugging capabilities through an overlay rendering system. New methods expose per-frame visualization settings, and a DrawOverlay() implementation renders a debug ImGui window when enabled.

Changes

Cohort / File(s)	Summary
Header updates src/Features/LightLimitFix.h	Changed inheritance from Feature to OverlayFeature; added DrawOverlay() and IsOverlayVisible() const override methods; included OverlayFeature.h dependency.
Implementation enhancements src/Features/LightLimitFix.cpp	Implemented DrawOverlay() to render a fixed-position ImGui debug window; extended GetCommonBufferData() return path to populate perFrame.EnableLightsVisualisation, perFrame.LightsVisualisationMode, and perFrame.ClusterSize from settings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• #1619 — Modifies the EnableLightsVisualisation setting and related light visualization feature configuration that this PR now reads and exposes.
• #1496 — Updates LightLimitFix class signature with additional override methods in the same header file.

Suggested reviewers

• jiayev
• alandtse

Poem

🐰 wiggles nose at geometry ✨
A rabbit brings visualization to light,
With overlays glowing so cheerful and bright,
The clusters and settings now dance into sight,
Debug windows hop joyfully through the night! 🌟

🚥 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%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title 'feat(LLF): add debug overlay in llf visualiser' clearly and accurately describes the main change—adding a debug overlay feature to the LightLimitFix visualiser, which is confirmed by the code changes.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing touches

• 📝 Generate docstrings

---

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: 5ed6701
Using base ref: 5ed6701
Base commit date: 2025-12-31T14:40:51+10:00 (Wednesday, December 31, 2025 02:40 PM)
No actionable suggestions for changed features.

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

src/Features/LightLimitFix.cpp (1)

10-13: Critical: Add EnableLightsVisualisation to serialization.

The EnableLightsVisualisation setting is not included in the serialization macro, which means the user's debug visualization preference won't persist across game restarts. This could lead to confusion, especially since the feature is described as needing a warning to prevent users from thinking their game broke.

🔎 Proposed fix

 NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(
 	LightLimitFix::Settings,
 	EnableContactShadows,
+	EnableLightsVisualisation,
 	LightsVisualisationMode)

📜 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 5ed6701 and 9045d45.

📒 Files selected for processing (2)

• src/Features/LightLimitFix.cpp
• src/Features/LightLimitFix.h

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{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/Features/LightLimitFix.cpp
• src/Features/LightLimitFix.h

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/Features/LightLimitFix.cpp
• src/Features/LightLimitFix.h

**/*

⚙️ CodeRabbit configuration file

**/*: When reviewing PRs, please provide suggestions for:

1. Conventional Commit Titles (if not following https://www.conventionalcommits.org/ or
   if the existing title does not describe the code changes):
   Format: type(scope): description
   Length: 50 characters limit for title, 72 for body
   Style: lowercase description, no ending period
   Examples:

   • feat(vr): add cross-eye sampling
   • fix(water): resolve flowmap bug
   • docs: update shader documentation

2. Issue References (if PR fixes bugs or implements features):
   Suggest adding appropriate GitHub keywords:

   • "Fixes #123" or "Closes #123" for bug fixes
   • "Implements #123" or "Addresses #123" for features
   • "Related to #123" for partial implementations

Otherwise, use your standard review approach focusing on code quality.

Files:

• src/Features/LightLimitFix.cpp
• src/Features/LightLimitFix.h

🧠 Learnings (1)

📚 Learning: 2025-08-17T18:37:35.839Z

Learnt from: CR
Repo: doodlum/skyrim-community-shaders PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T18:37:35.839Z
Learning: Applies to features/**/*.{cpp,cxx,cc,h,hpp,hxx} : Feature classes must inherit from Feature (src/Feature.h) and implement DrawSettings(), LoadSettings(), and SaveSettings()

Applied to files:

• src/Features/LightLimitFix.h

⏰ 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 (4)

src/Features/LightLimitFix.h (2)

4-6: LGTM! Clean refactor to overlay feature.

The inheritance change from Feature to OverlayFeature is appropriate for adding overlay rendering capabilities. The include change aligns with the new base class.

---

159-160: LGTM! Proper overlay interface implementation.

The DrawOverlay() and IsOverlayVisible() overrides correctly implement the overlay feature interface. The inline implementation of IsOverlayVisible() is clean and appropriate.

src/Features/LightLimitFix.cpp (2)

56-64: LGTM! Clear and prominent debug warning.

The overlay implementation correctly:

• Guards against rendering when disabled (early return)
• Uses appropriate ImGui flags for a fixed debug overlay
• Displays a prominent, color-coded warning message

The message "DEBUG FEATURE - LIGHT LIMIT VISUALISATION ENABLED" aligns well with the PR objective to warn users and prevent confusion.

---

66-73: LGTM! Proper per-frame data propagation.

The implementation correctly populates all three fields in the PerFrame struct:

• EnableLightsVisualisation from settings
• LightsVisualisationMode from settings
• ClusterSize array using std::copy

This ensures shader code receives the current visualization state.

[github-actions]

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

[brucenguyen]

iirc when RenderDoc is on it has a constant overlay on the top right, you might able to copy over most of that logic to keep the design consistent