Public API for URP DebugDisplaySettings #5682

arttu-peltonen · 2021-09-16T07:53:32Z

Purpose of this PR

This main point of this PR is to expose public DebugDisplaySettings API. This is useful for both internal and external users, who want to create custom UI for certain debug modes. This was the exact use case for Lookdev Studio team. This PR will bring URP to parity with HDRP, where an equivalent API is already public.

Public DebugDisplay API

Users can now control DebugDisplay from script. Example usage:

public void Update()
{
    var debugData = UniversalRenderPipelineDebugDisplaySettings.Instance;

    debugData.materialSettings.materialDebugMode = DebugMaterialMode.Albedo;
    debugData.lightingSettings.lightingDebugMode = DebugLightingMode.ShadowCascades;
    debugData.renderingSettings.wireframeMode = DebugWireframeMode.SolidWireframe;
}

The PR renames the now public properties to be consistent and use camelCase as described in coding standards.

Added AlbedoDebugValidationPreset.Custom

As an incidental change, a new preset has been added to Material Albedo validation presets: AlbedoDebugValidationPreset.Custom. This makes sense from API point of view, and also useful from user perspective: In the images above, the custom color has been set to yellowis-orange, which matches the albedo of helmet and power tool, and gives error colors for other albedos:

Testing status

Tested locally by creating a simple script (custom-debugui-v2.zip) that uses the public API. This simulates the usecase that users of the API would have.

This should demonstrate that the API works as intended - feel free to download the attached script and try it out.

In terms of other testing, please do a quick test for rendering debugger to see that nothing has been broken by the renaming.

- Made the settings API public - Renamed properties to be more uniform with each other and use camelCase - Added new Material Albedo validation preset: AlbedoDebugValidationPreset.Custom

github-actions · 2021-09-16T07:53:48Z

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://unity-ci.cds.internal.unity3d.com/project/902/
Search for your PR branch using the search bar at the top, 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
/jobDefinition/.yamato%2Fall-hdrp.yml%23HDRP_trunk
With changes to HDRP packages, you should also run
/jobDefinition/.yamato%252Fall-lightmapper.yml%2523PR_LightMapper_trunk

URP
/jobDefinition/.yamato%252Fall-urp.yml%2523PR_URP_trunk
With changes to URP packages, you should also run
/jobDefinition/.yamato%252Fall-lightmapper.yml%2523PR_LightMapper_trunk

Shader Graph
/jobDefinition/.yamato%252Fall-shadergraph.yml%2523PR_ShaderGraph_trunk
Depending on your PR, you may also want
/jobDefinition/.yamato%252Fall-shadergraph_builtin_foundation.yml%2523PR_ShaderGraph_BuiltIn_Foundation_trunk
/jobDefinition/.yamato%252Fall-shadergraph_builtin_lighting.yml%2523PR_ShaderGraph_BuiltIn_Lighting_trunk

VFX
/jobDefinition/.yamato%252Fall-vfx.yml%2523PR_VFX_trunk

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:
/jobDefinition/.yamato%252F_abv.yml%2523all_project_ci_trunk
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.universal/Runtime/Debug/DebugDisplaySettings.cs

…vidually. - Changed DebugDisplaySettingsCommon interface implementation because of this. The common settings now report everything as "not active" because the widgets are not owned by it.

simon-engelbrecht-soerensen

Seems to be working well, didn't discover any issues withthe rendering debugger.

# Conflicts: # com.unity.render-pipelines.universal/CHANGELOG.md # com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsCommon.cs # com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsRendering.cs # com.unity.render-pipelines.universal/Runtime/Debug/UniversalRenderPipelineDebugDisplaySettings.cs # com.unity.render-pipelines.universal/Runtime/ScriptableRenderer.cs

ellioman · 2021-10-04T14:43:47Z

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsCommon.cs

+        public bool AreAnySettingsActive => false;
+        public bool IsPostProcessingAllowed => true;
+        public bool IsLightingActive => true;


Feels a bit inconsistent that these properties are Upper Camel Case. But I guess this was already done before.

Yeah the reason here was that I didn't want to go through deprecation process just to change the first letter to be lowercase, as this is implementing an interface that was already public (even though this & other implementing classes have been internal up until now). If you'd prefer consistency here, I can do it. What do you think?

I personally think it's worth it as API consistency decreases the WTF! moment users will have.
If it's not too much trouble I would love to get that change but it can also be done in a followup PR.

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsMaterial.cs

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsRendering.cs

- Exposed public setters to albedoHueTolerance and albedoSaturationTolerance that were still private. - Fixed compile error in player build due to renamed symbol.

# Conflicts: # com.unity.render-pipelines.universal/CHANGELOG.md

Verasl

LGTM

commit c0c961d Merge: f6e204f b8c4896 Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Wed Oct 13 10:54:12 2021 +0300 Merge branch 'master' into srp/urp-debugdisplay-api # Conflicts: # com.unity.render-pipelines.universal/CHANGELOG.md commit f6e204f Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Tue Oct 5 12:06:17 2021 +0300 Change public fields into public properties. - Exposed public setters to albedoHueTolerance and albedoSaturationTolerance that were still private. - Fixed compile error in player build due to renamed symbol. commit 793e63f Merge: 945724e f0c1049 Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Mon Oct 4 16:09:35 2021 +0300 Merge branch 'master' into srp/urp-debugdisplay-api # Conflicts: # com.unity.render-pipelines.universal/CHANGELOG.md # com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsCommon.cs # com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsRendering.cs # com.unity.render-pipelines.universal/Runtime/Debug/UniversalRenderPipelineDebugDisplaySettings.cs # com.unity.render-pipelines.universal/Runtime/ScriptableRenderer.cs commit 945724e Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Thu Sep 16 14:26:26 2021 +0300 Iterate m_Settings array instead of calling each settings object individually. - Changed DebugDisplaySettingsCommon interface implementation because of this. The common settings now report everything as "not active" because the widgets are not owned by it. commit 17a8ef5 Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Thu Sep 16 10:46:41 2021 +0300 Fix casing to camelCase for settings properties commit df48fa1 Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Thu Sep 16 10:06:08 2021 +0300 Changelog commit 2971ab6 Author: Arttu Peltonen <arttu.peltonen@unity3d.com> Date: Thu Sep 16 09:15:36 2021 +0300 Public API for URP DebugDisplaySettings - Made the settings API public - Renamed properties to be more uniform with each other and use camelCase - Added new Material Albedo validation preset: AlbedoDebugValidationPreset.Custom

phi-lira · 2021-10-22T08:32:21Z

Merged onto staging branch. Staging branch landed onto master on #6085

arttu-peltonen added 3 commits September 16, 2021 09:57

Public API for URP DebugDisplaySettings

2971ab6

- Made the settings API public - Renamed properties to be more uniform with each other and use camelCase - Added new Material Albedo validation preset: AlbedoDebugValidationPreset.Custom

Changelog

df48fa1

Fix casing to camelCase for settings properties

17a8ef5

github-actions bot added the universal label Sep 16, 2021

arttu-peltonen marked this pull request as ready for review September 16, 2021 08:37

arttu-peltonen requested review from a team as code owners September 16, 2021 08:37

arttu-peltonen requested review from alex-vazquez, ellioman and lukaschod September 16, 2021 08:38

alex-vazquez approved these changes Sep 16, 2021

View reviewed changes

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettings.cs Outdated Show resolved Hide resolved

Iterate m_Settings array instead of calling each settings object indi…

945724e

…vidually. - Changed DebugDisplaySettingsCommon interface implementation because of this. The common settings now report everything as "not active" because the widgets are not owned by it.

simon-engelbrecht-soerensen approved these changes Sep 21, 2021

View reviewed changes

ellioman reviewed Oct 4, 2021

View reviewed changes

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsMaterial.cs Outdated Show resolved Hide resolved

ellioman reviewed Oct 4, 2021

View reviewed changes

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsMaterial.cs Show resolved Hide resolved

ellioman reviewed Oct 4, 2021

View reviewed changes

com.unity.render-pipelines.universal/Runtime/Debug/DebugDisplaySettingsRendering.cs Show resolved Hide resolved

Verasl self-requested a review October 4, 2021 15:06

Change public fields into public properties.

f6e204f

- Exposed public setters to albedoHueTolerance and albedoSaturationTolerance that were still private. - Fixed compile error in player build due to renamed symbol.

arttu-peltonen requested a review from ellioman October 5, 2021 09:09

ellioman approved these changes Oct 5, 2021

View reviewed changes

unity-cchu approved these changes Oct 7, 2021

View reviewed changes

lukaschod approved these changes Oct 8, 2021

View reviewed changes

phi-lira changed the base branch from master to 2021.2/staging October 12, 2021 09:44

phi-lira requested review from a team as code owners October 12, 2021 09:44

phi-lira changed the base branch from 2021.2/staging to universal/staging October 12, 2021 09:45

phi-lira removed request for a team October 12, 2021 09:46

phi-lira deleted the branch master October 12, 2021 14:07

phi-lira closed this Oct 12, 2021

phi-lira reopened this Oct 12, 2021

Merge branch 'master' into srp/urp-debugdisplay-api

c0c961d

# Conflicts: # com.unity.render-pipelines.universal/CHANGELOG.md

arttu-peltonen requested a review from a team as a code owner October 13, 2021 07:55

arttu-peltonen changed the base branch from universal/staging to master October 13, 2021 07:57

Verasl approved these changes Oct 19, 2021

View reviewed changes

phi-lira mentioned this pull request Oct 20, 2021

Universal Staging #6085

Merged

phi-lira closed this Oct 22, 2021

arttu-peltonen deleted the srp/urp-debugdisplay-api branch October 28, 2021 11:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Public API for URP DebugDisplaySettings #5682

Public API for URP DebugDisplaySettings #5682

Uh oh!

arttu-peltonen commented Sep 16, 2021 •

edited

Loading

Uh oh!

github-actions bot commented Sep 16, 2021 •

edited

Loading

Uh oh!

Uh oh!

simon-engelbrecht-soerensen left a comment

Uh oh!

ellioman Oct 4, 2021

Uh oh!

arttu-peltonen Oct 5, 2021

Uh oh!

ellioman Oct 5, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Verasl left a comment

Uh oh!

phi-lira commented Oct 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Public API for URP DebugDisplaySettings #5682

Public API for URP DebugDisplaySettings #5682

Uh oh!

Conversation

arttu-peltonen commented Sep 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this PR

Public DebugDisplay API

Added AlbedoDebugValidationPreset.Custom

Testing status

Uh oh!

github-actions bot commented Sep 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

simon-engelbrecht-soerensen left a comment

Choose a reason for hiding this comment

Uh oh!

ellioman Oct 4, 2021

Choose a reason for hiding this comment

Uh oh!

arttu-peltonen Oct 5, 2021

Choose a reason for hiding this comment

Uh oh!

ellioman Oct 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Verasl left a comment

Choose a reason for hiding this comment

Uh oh!

phi-lira commented Oct 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

arttu-peltonen commented Sep 16, 2021 •

edited

Loading

github-actions bot commented Sep 16, 2021 •

edited

Loading

ellioman Oct 5, 2021 •

edited

Loading