Add API to completely disable Runtime Debug UI #5339

arttu-peltonen · 2021-08-12T13:44:55Z

Purpose of this PR

This PR is intended to mitigate issues raised in this forum thread: https://forum.unity.com/threads/renderpiplines-debugupdater-creates-duplicate-eventsystem-and-more.1154456/

Problem:

In order to support touch & mouse for Runtime Debug UI, we need to have EventSystem & corresponding *InputModule components present in the scene. To make this work out-of-the-box, DebugUpdater has been adding them automatically at startup, unless already present. This approach is problematic because some scenes (splash screen) might not have these components, but a subsequent scene would. Unity throws an error when more than one of these components are present, and this is what users are seeing.

Solution:

This PR makes it possible to disable DebugUpdater altogether using DebugManager.enableRuntimeUI (which replaces the enableWindowHotkey variable added in an earlier PR, meant to solve input conflicts). With this public API, users will be able to write scripts to initially disable the runtime UI, and also re-enable it later (at which point the UI will reuse existing EventSystem & *InputModule components if present).

This is not a perfect solution because some users will have to write custom scripts to make the runtime UI compatible with their game. The problem could be avoided if it were possible to have uGUI input (keyboard, touch, mouse, gamepad...) work without having to instantiate these components to the scene. AFAIK this is not currently possible (see slack discussion), so this is the best I have come up with.

Testing status

I used this test script in editor playmode to simulate users changing enableRuntimeUI value back and forth from script at runtime. Seems to work correctly - runtime UI disappears when value is disabled, and can be reopened when it is enabled again. Also when the value is disabled in Awake(), the DebugUpdater GameObject is never instantiated in the first place, thus avoiding any potential initialization overhead.

Additionally, tested that Debug UI & input still works as expected with these projects & platforms:

HDRP Sample (Windows) - Editor Playmode, both with Input Manager (Old) and Input System Package (New)
URP Sample (Windows) - both in Editor Playmode & Player build, both with Input Manager (Old) and Input System Package (New)
URP Sample (Android) - Player build, both with Input Manager (Old) and Input System Package (new)

I would appreciate some testing with "real projects" that have multiple scenes (ideally ones using input and others not using it), to see that Runtime Debug UI behaves sensibly when scene is changed.

…I that disables DebugUpdater entirely. - When this property is set, all scene components created by DebugUpdater are either instantiated or destroyed. - Also fixed a bug where debug actions were only enabled during the first time user enters playmode (when using new InputSystem).

- Moved previous changelog message from HDRP to Core since that's where the changes are.

github-actions · 2021-08-12T13:45:13Z

Hi! This comment will help you figure out which jobs to run before merging your PR. The suggestions are dynamic based on what files you have changed.
Link to Yamato: https://yamato.cds.internal.unity3d.com/jobs/902-Graphics
Search for your PR branch using the sidebar on the left, then add the following segment(s) to the end of the URL (you may need multiple tabs depending on how many packages you change)

HDRP
/.yamato%252Fall-hdrp.yml%2523PR_HDRP_2021.2

SRP Core
You could run ABV on your branch before merging your PR, but it will start A LOT of jobs. Please be responsible about it and run it only when you feel the PR is ready:
/.yamato%252F_abv.yml%2523all_project_ci_2021.2
Be aware that any modifications to the Core package impacts everyone in the Graphics repo so please discuss the PR with your lead.

Depending on the scope of your PR, you may need to run more jobs than what has been suggested. Please speak to your lead or a Graphics SDET (#devs-graphics-automation) if you are unsure.

com.unity.render-pipelines.core/Runtime/Debugging/DebugManager.cs

alex-vazquez

Minor comment about the docs

com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Debug-Window.md

…er-Pipeline-Debug-Window.md Co-authored-by: alex-vazquez <76204843+alex-vazquez@users.noreply.github.com>

JulienIgnace-Unity

Looks good to me.
Might be good to add a small section to the what's new page to point to the new doc for more information regarding this new option.

phi-lira

LGTM but it's not really addressing the issues in the forum thread .
If there's no alternative not not rely on the components, what if we enable/disable the DebugUpdater upon specific times, such as scene loading/unloading?

phi-lira · 2021-08-27T08:09:23Z

com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Debug-Window.md

@@ -16,10 +16,12 @@ The Render Pipeline Debugger window.

 ## Using the Render Pipeline Debugger window

-To open the Render Pipeline Debugger window in the Editor, go to  **Window > Analysis > Rendering Debugger**. You can also open this window at runtime in Play Mode, or in the standalone Unity Player on any device on **Development build**. Use the keyboard shortcut Ctrl+Backspace (Ctrl+Delete on macOS) or press L3 and R3 (Left Stick and Right Stick) on a controller to open the window. You can disable the shortcut through the [enableWindowHotkey variable](https://docs.unity3d.com/Packages/com.unity.render-pipelines.core@12.0/api/UnityEngine.Rendering.DebugManager.html#UnityEngine_Rendering_DebugManager_enableWindowHotkey).
+To open the Render Pipeline Debugger window in the Editor, go to  **Window > Analysis > Rendering Debugger**. You can also open this window at runtime in Play Mode, or in the standalone Unity Player on any device on **Development build**. Use the keyboard shortcut Ctrl+Backspace (Ctrl+Delete on macOS) or press L3 and R3 (Left Stick and Right Stick) on a controller to open the window.


This kind of information seems useful to have in the core part of the docs as it's common to both pipelines. It should be mentioned in mobile how you can enabled the window at runtime.

Agreed. Right now, all Rendering Debugger docs are under HDRP as the URP docs are not yet written. I'd like to leave it to @oleks-k to figure out if/how to split the shared "Core" parts of the documentation, and keep HDRP/URP-specific parts under their respective packages.

Right now we don't have an efficient way to reuse the doc content between packages.
I'll copy this into to URP, and after 2021.2 will think of a way to reuse content (this is a tooling limitation).

oleks-k

I've edited the description and approving the PR now.

simon-engelbrecht-soerensen

The changes work fine. Tested with boat attack and changing scenes with/without eventsystem/input.

Verasl

LGTM, a much needed improvement though it definitely still needs an automated solution in the near future as users will still encounter the issue still unless they add the extra code and systems to disable it thus will still feel compelled to send in bug reports.

# Conflicts: # com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Debug-Window.md

RemyUnity · 2021-08-31T17:20:43Z

Looks like @Unity-Technologies/gfx-qa-hdrp review is not needed anymore, but I still tested this PR with the spaceship demo project using this script .
I was able to reproduce the behavior described in the description, LGTM 👍

* Add DebugManager.enableRuntimeUI that disables DebugUpdater entirely. The code structure has changed quite a bit so this backport only includes the essential part required to fix case 1345783.

arttu-peltonen added 2 commits August 12, 2021 16:30

Update changelog & docs

e87cb37

- Moved previous changelog message from HDRP to Core since that's where the changes are.

github-actions bot added HDRP SRP labels Aug 12, 2021

arttu-peltonen commented Aug 13, 2021

View reviewed changes

com.unity.render-pipelines.core/Runtime/Debugging/DebugManager.cs Show resolved Hide resolved

arttu-peltonen changed the title ~~Srp/allow disabling runtime debug UI~~ Add API to completely disable Runtime Debug UI to avoid EventSystem conflicts Aug 13, 2021

arttu-peltonen changed the title ~~Add API to completely disable Runtime Debug UI to avoid EventSystem conflicts~~ Add API to completely disable Runtime Debug UI Aug 13, 2021

arttu-peltonen requested review from JulienIgnace-Unity, Verasl, adrien-de-tocqueville, a team and alex-vazquez August 13, 2021 11:41

RemyUnity requested a review from a team August 13, 2021 12:12

alex-vazquez approved these changes Aug 13, 2021

View reviewed changes

com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Debug-Window.md Outdated Show resolved Hide resolved

Update com.unity.render-pipelines.high-definition/Documentation~/Rend…

a17c228

…er-Pipeline-Debug-Window.md Co-authored-by: alex-vazquez <76204843+alex-vazquez@users.noreply.github.com>

JulienIgnace-Unity requested changes Aug 16, 2021

View reviewed changes

arttu-peltonen requested a review from oleks-k August 16, 2021 13:03

Added mention of the new property to "What's new" in RP Core docs.

0734b14

arttu-peltonen requested a review from JulienIgnace-Unity August 24, 2021 07:22

JulienIgnace-Unity approved these changes Aug 24, 2021

View reviewed changes

sebastienlagarde requested review from a team and removed request for a team August 25, 2021 12:05

sebastienlagarde approved these changes Aug 25, 2021

View reviewed changes

sebastienlagarde removed the request for review from adrien-de-tocqueville August 25, 2021 12:07

erikabar requested a review from simon-engelbrecht-soerensen August 26, 2021 08:50

phi-lira approved these changes Aug 27, 2021

View reviewed changes

Edited the Rendering Debugger window description.

c91cb57

oleks-k approved these changes Aug 27, 2021

View reviewed changes

simon-engelbrecht-soerensen approved these changes Aug 31, 2021

View reviewed changes

arttu-peltonen removed the request for review from a team August 31, 2021 12:30

Verasl approved these changes Aug 31, 2021

View reviewed changes

oleks-k and others added 2 commits August 31, 2021 16:57

Merging the changes from Emily.

16811ac

Merge branch 'master' into srp/allow-disabling-runtime-debug-ui

66c88d0

# Conflicts: # com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Debug-Window.md

arttu-peltonen marked this pull request as ready for review August 31, 2021 17:05

RemyUnity self-requested a review August 31, 2021 17:21

RemyUnity approved these changes Aug 31, 2021

View reviewed changes

arttu-peltonen merged commit 4d09a54 into master Sep 1, 2021

arttu-peltonen deleted the srp/allow-disabling-runtime-debug-ui branch September 1, 2021 05:56

arttu-peltonen mentioned this pull request Oct 12, 2021

Add API to completely disable Runtime Debug UI (#5339) #5982

Merged

arttu-peltonen added the needs-backport-10.x label Oct 12, 2021

arttu-peltonen mentioned this pull request Oct 12, 2021

Add API to completely disable Runtime Debug UI (#5339) #5984

Merged

sebastienlagarde added backported-10.x and removed needs-backport-10.x labels Oct 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API to completely disable Runtime Debug UI #5339

Add API to completely disable Runtime Debug UI #5339

arttu-peltonen commented Aug 12, 2021 •

edited

github-actions bot commented Aug 12, 2021

alex-vazquez left a comment

JulienIgnace-Unity left a comment

phi-lira left a comment

phi-lira Aug 27, 2021

arttu-peltonen Aug 27, 2021

oleks-k Aug 27, 2021

oleks-k left a comment

simon-engelbrecht-soerensen left a comment

Verasl left a comment

RemyUnity commented Aug 31, 2021

Add API to completely disable Runtime Debug UI #5339

Add API to completely disable Runtime Debug UI #5339

Conversation

arttu-peltonen commented Aug 12, 2021 • edited

Purpose of this PR

Problem:

Solution:

Testing status

github-actions bot commented Aug 12, 2021

alex-vazquez left a comment

Choose a reason for hiding this comment

JulienIgnace-Unity left a comment

Choose a reason for hiding this comment

phi-lira left a comment

Choose a reason for hiding this comment

phi-lira Aug 27, 2021

Choose a reason for hiding this comment

arttu-peltonen Aug 27, 2021

Choose a reason for hiding this comment

oleks-k Aug 27, 2021

Choose a reason for hiding this comment

oleks-k left a comment

Choose a reason for hiding this comment

simon-engelbrecht-soerensen left a comment

Choose a reason for hiding this comment

Verasl left a comment

Choose a reason for hiding this comment

RemyUnity commented Aug 31, 2021

arttu-peltonen commented Aug 12, 2021 •

edited