Rename Raytracing node to Raytracing quality node + update documentation #1479

sebastienlagarde · 2020-08-02T09:44:36Z

Purpose of this PR

Rename Raytracing node to Raytracing quality node + update documentation
Change low and high to Default and Raytraced as well for the inputs of this node
Now all raytrace effects but path tracer will use the raytracing input version while rendering from a shader graph

Testing status

Manual Tests: What did you do?

Opened test project + Run graphic tests locally
Built a player
Checked new UI names with UX convention
Tested UI multi-edition + Undo/Redo + Prefab overrides + Alignment in Preset
C# and shader warnings (supress shader cache to see them)
Checked new resources path for the reloader (in developer mode, you have a button at end of resources that check the paths)
Other:

Automated Tests: What did you setup? (Add a screenshot or the reference image of the test please)

Yamato: (Select your branch):
https://yamato.prd.cds.internal.unity3d.com/jobs/902-Graphics

Any test projects to go with this to help reviewers?

Comments to reviewers

Notes for the reviewers you have assigned.

github-actions · 2020-08-02T09:45:15Z

It appears that you made a non-draft PR!
Please convert your PR to draft (button on the right side of the page)
and cancel any jobs that started on Yamato.
See the PR template for more information.
Thank you!

sebastienlagarde · 2020-08-02T09:48:56Z

@remi-chapelain we will need to add a test to check that raytracing quality node works correctly for the given effect (which mean we need to validate that it doesn't change for recursive rendering for example or shadow (can be done with alpha test);
But we also need to add a test that Material Quality + Raytracing Quality work correctly together.
i.e need a test where we chain them.

JordanL8 · 2020-08-03T08:16:22Z

com.unity.render-pipelines.high-definition/Documentation~/SGNode-Raytracing-Quality.md

@@ -0,0 +1,17 @@
+# Raytracing Quality Node
+
+The Raytracing Quality Node allows you to provide a fast implementation of your Shader Graph to be use in GPU heavy raytraced effect to tradeoff accuracy for speed: [Ray-Traced Reflections](Ray-Traced-Reflections.md), [Ray-Traced-Global-Illumination](Ray-Traced-Global-Illumination.md) and [Ray-Traced-Subsurface-Scattering](Ray-Traced-Subsurface-Scattering.md).


The Raytracing Quality Node allows you to provide a fast implementation of your Shader Graph to use in GPU-intensive ray-traced effects to tradeoff accuracy for speed. The GPU-intensive effects are:
* [Ray-Traced Reflections](Ray-Traced-Reflections.md).
* [Ray-Traced-Global-Illumination](Ray-Traced-Global-Illumination.md).
* [Ray-Traced-Subsurface-Scattering](Ray-Traced-Subsurface-Scattering.md).

JordanL8 · 2020-08-03T08:24:45Z

com.unity.render-pipelines.high-definition/Documentation~/SGNode-Raytracing-Quality.md

+
+## Setup
+
+The Raytracing Quality Node is a builtin keyword and thus need to be created in the Dashboard **Keyword -> Raytracing Quality** of the shader graph then drag and dropped in the working area.


The Raytracing Quality Node represents a built-in keyword which means, to create one:

In the [Blackboard](https://docs.unity3d.com/Packages/com.unity.shadergraph@latest/index.html?subfolder=/manual/Blackboard.html), click the plus (**+**) button.

Select Keyword > Raytracing Quality. This creates the keyword and makes it visible on the Blackboard.

Now, to use the keyword in your graph, drag it from the Blackboard into the workspace.

JordanL8 · 2020-08-03T08:25:52Z

com.unity.render-pipelines.high-definition/Documentation~/SGNode-Raytracing-Quality.md

+
+| Name          | Direction | Type           | Description                                                  |
+| :------------ | :-------- | :------------- | :----------------------------------------------------------- |
+| **default**   | Input     | Vector4        | Sets the value to use for the normal shader graph. This is the default path use to render this shader graph. |


The value to use for the normal Shader Graph. This is the default path Unity uses to render this Shader Graph.

JordanL8 · 2020-08-03T08:26:33Z

com.unity.render-pipelines.high-definition/Documentation~/SGNode-Raytracing-Quality.md

+| Name          | Direction | Type           | Description                                                  |
+| :------------ | :-------- | :------------- | :----------------------------------------------------------- |
+| **default**   | Input     | Vector4        | Sets the value to use for the normal shader graph. This is the default path use to render this shader graph. |
+| **optimized** | Input     | Vector4        | Sets the value to use for the fast shader graph to use with the GPU heavy raytraced effect.|


The value to use for the fast Shader Graph to use with the GPU-intensive ray-traced effects.

JordanL8 · 2020-08-03T08:35:16Z

com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2020.1-to-2020.2.md

@@ -103,6 +103,9 @@ From Unity 2020.2,SHADERPASS for TransparentDepthPrepass and TransparentDepthPos
 Unity 2020.2 introduces a new multi-compile for Depth Prepass and Motion vector pass to allow for support of the Decal Layers feature. These passes now require you to add #pragma multi_compile _ WRITE_DECAL_BUFFER.

 From Unity 2020.2, the shader code for the Decal.shader has changed. Previously, the code used around 16 passes to handle the rendering of different decal attributes. It now only uses four passes: DBufferProjector, DecalProjectorForwardEmissive, DBufferMesh, DecalMeshForwardEmissive. Some pass names are also different. DBufferProjector and DBufferMesh now use a multi_compile DECALS_3RT DECALS_4RT to handle the differents variants and the shader stripper has been updated as well. Various Shader Decal Properties have been renamed/changed to match a new set of AffectXXX properties (_AlbedoMode, _MaskBlendMode, _MaskmapMetal, _MaskmapAO, _MaskmapSmoothness, _Emissive have been changed to _AffectAlbedo, _AffectNormal, _AffectAO, _AffectMetal, _AffectSmoothness, _AffectEmission - Keyword _ALBEDOCONTRIBUTION is now _MATERIAL_AFFECTS_ALBEDO and two new keywords, _MATERIAL_AFFECTS_NORMAL, _MATERIAL_AFFECTS_MASKMAP, have been added). These new properties now match with properties from the Decal Shader Graph which are now exposed in the Material. A Material upgrade process automatically upgrades all the Decal Materials. However, if your project includes any C# scripts that create or manipulate a Decal Material, you need to update the scripts to use the new properties and keyword; the migration does not work on procedurally generated Decal Materials.
+
+From Unity 2020.2, Raytracing Node for Raytracing in ShaderGraph have been rename Raytracing Quality Node and the define RAYTRACING_SHADER_GRAPH_LOW and RAYTRACING_SHADER_GRAPH_HIGH respectively rename RAYTRACING_SHADER_GRAPH_DEFAULT and RAYTRACING_SHADER_GRAPH_OPTIMIZED. Unless you have use those define in custom code, there is nothing to do and shader graph will automatically regenerate the shader with correct define at load.


From Unity 2020.2, the Raytracing keyword Node in Shader Graph has been renamed to Raytracing Quality Node and the RAYTRACING_SHADER_GRAPH_LOW and RAYTRACING_SHADER_GRAPH_HIGH defines are now RAYTRACING_SHADER_GRAPH_DEFAULT and RAYTRACING_SHADER_GRAPH_OPTIMIZED respectively. Unless you used these defines in custom Shader code, you do not need to do anything because Shader Graph automatically regenerates its Shaders with the correct defines when you load the Project.

JordanL8

Oops, meant to request changes. Just left a few comments.

alindmanUnity · 2020-08-05T15:25:13Z

i'm going to take an depth look at this today -- there's some inconsistencies with docs here that can create confusion when cross referencing with shader graph docs, and I want to try to identify the issues that seb had brought up on slack yesterday

alindmanUnity

please ping for review of these docs changes, but it's important to be clear on the distinction between available keywords and nodes.

com.unity.render-pipelines.high-definition/Documentation~/Scalability-Manual.md

com.unity.render-pipelines.high-definition/Documentation~/SGNode-Raytracing-Quality.md

com.unity.render-pipelines.high-definition/CHANGELOG.md

com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md

com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2020.1-to-2020.2.md

…ability-Manual.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

…de-Raytracing-Quality.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

…ading-from-2020.1-to-2020.2.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

…eOfContents.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

remi-chapelain

Doc and new naming is good for me.
But, this PR make the test 1000_RaytracingQualityKeyword_Indirect fail. (displays only the optimized version)
The old raytracing keyword is not upgraded properly with the new name and only work when deleting the keyword in the list and re-adding it.

I've commit the new SG that fix this test but the issue still persists in other projects that use raytracing keyword and want to update

anisunity · 2020-08-12T14:20:18Z

I was pointed to this discussion today, i wasn't aware of it. I don't think the ray tracing node should be named "optimized" vs default. Sure, optimization is the usage you would be going for if you were thinking about real-time constraint, but given that most the users that will be using ray tracing will not be in the game constraint, it should probably be named "rasterization" vs "ray tracing" or "default" vs "ray tracing". Also the ray tracing node can be useful in RTR, RTGI, RTAO and RTShadow (in case there is alpha testing that needs to be avoided due to performance reasons), Rercursive Rendering and NOT in RTSSS (The way it is implemented, the value is very low). The fact that the current shader graph code doesn't mimic this is just because during the recent upgrades of the shader graph pacakge no automatic tests were there to make sure that the behavior was not broken in the last months.

If you are using recursive rendering, you are clearly not in the real-time mindset and are aiming for high visual quality. Then it doesn't make any sense to have low quality reflections given the little that is going to save compared to the giant cost of the recursive rendering effect.

anisunity

Please check the comment above

* Raytracing quality test coverage update RR test, PT test, RT Shadow Test, Material Quality * Update Indirect scene + ref image * update test for new code Co-authored-by: sebastienlagarde <sebastien@unity3d.com>

- added emission to test RTGI - added refraction color to test RT color shadows - recreated graph

remi-chapelain · 2020-09-18T09:59:09Z

Updated the tests scene to increase coverage (RTGI, RT color shadow) and check rendergraph compatible

There might be an issue when switching to Unlit SG, on the test scene 1000_RaytracingQualityKeyword_MaterialQuality_Indirect, if you change the master node to UNLIT, the "default" version take the raytraced color.

Also, re-launched yamato : https://yamato.cds.internal.unity3d.com/jobs/902-Graphics/tree/HDRP%252Frename-raytracing-node/.yamato%252Fhdrp_dxr-win-dx12.yml%2523HDRP_DXR_Win_DX12_playmode_trunk/3494979/job

sebastienlagarde added 5 commits August 1, 2020 00:26

Rename Raytracing Node to Raytracing Quality

2149345

Update Upgrading-from-2020.1-to-2020.2.md

0eff4a7

Update documentation

0ba124a

Update TableOfContents.md

a14522d

Update SGNode-Raytracing-Quality.md

2dc8309

sebastienlagarde requested review from JordanL8 and remi-chapelain August 2, 2020 09:44

github-actions bot added the HDRP label Aug 2, 2020

Update CHANGELOG.md

b2ddbbc

JordanL8 reviewed Aug 3, 2020

View reviewed changes

JordanL8 approved these changes Aug 3, 2020

View reviewed changes

JordanL8 suggested changes Aug 3, 2020

View reviewed changes

sebastienlagarde added 3 commits August 3, 2020 11:21

adress feedback

f4c18ec

Rename files

cb6331a

Update RayTracingQualityNode.cs

971cfee

alindmanUnity self-requested a review August 5, 2020 15:24

alindmanUnity reviewed Aug 5, 2020

View reviewed changes

JordanL8 and others added 6 commits August 11, 2020 09:32

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

01cd1d2

…ability-Manual.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

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

fcdb3a4

…ability-Manual.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

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

9fdc5a5

…de-Raytracing-Quality.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

Update com.unity.render-pipelines.high-definition/CHANGELOG.md

3f9b1a0

Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

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

37560af

…ading-from-2020.1-to-2020.2.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

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

054d23b

…eOfContents.md Co-authored-by: Alex Lindman <39529353+alindmanUnity@users.noreply.github.com>

JordanL8 approved these changes Aug 11, 2020

View reviewed changes

remi-chapelain reviewed Aug 11, 2020

View reviewed changes

Updated raytracing node in 1000_Indirect

53a0070

remi-chapelain requested a review from anisunity August 12, 2020 13:42

anisunity suggested changes Aug 12, 2020

View reviewed changes

remi-chapelain mentioned this pull request Aug 12, 2020

Increase Raytracing Quality Keyword coverage for RT effects #1587

Merged

sebastienlagarde and others added 9 commits September 15, 2020 15:10

Merge branch 'HDRP/staging' into HDRP/rename-raytracing-node

153b071

renamed default/ optimized to default / raytraced

29d7595

fix compilation

cbb95f4

update doc and screenshot

77c933b

Update SGLit_RaytracingKeyword_Emission.shadergraph

d263a2a

update the code properly

3b6ca20

Merge branch 'HDRP/staging' into HDRP/rename-raytracing-node

c282384

update meta file

461618a

Increase Raytracing Quality Keyword coverage for RT effects (#1587)

9a242f6

* Raytracing quality test coverage update RR test, PT test, RT Shadow Test, Material Quality * Update Indirect scene + ref image * update test for new code Co-authored-by: sebastienlagarde <sebastien@unity3d.com>

anisunity approved these changes Sep 17, 2020

View reviewed changes

sebastienlagarde and others added 4 commits September 17, 2020 23:25

Merge branch 'HDRP/staging' into HDRP/rename-raytracing-node

8335aad

Update 1000_RaytracingQualityKeyword_PathTracer_Default.unity

7dd1c3d

Updated test scenes

7fd44ab

- added emission to test RTGI - added refraction color to test RT color shadows - recreated graph

Checked the test renderGraph Compatible

cd6c8c3

remi-chapelain self-requested a review September 18, 2020 09:50

sebastienlagarde added 5 commits September 21, 2020 12:04

Fix issue with unlit shader

6ede543

Update the test to add unlit case

916f21b

Update 1000_RaytracingQualityKeyword_MaterialQuality_Indirect.png

640d4b7

Update 803_SubSurfaceScatteringGlobalIllumination.unity

4f607b0

Merge branch 'HDRP/staging' into HDRP/rename-raytracing-node

e385ce9

sebastienlagarde merged commit b30de00 into HDRP/staging Sep 21, 2020

sebastienlagarde deleted the HDRP/rename-raytracing-node branch September 21, 2020 12:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename Raytracing node to Raytracing quality node + update documentation #1479

Rename Raytracing node to Raytracing quality node + update documentation #1479

sebastienlagarde commented Aug 2, 2020 •

edited

github-actions bot commented Aug 2, 2020

sebastienlagarde commented Aug 2, 2020

JordanL8 Aug 3, 2020 •

edited

JordanL8 Aug 3, 2020 •

edited

JordanL8 Aug 3, 2020

JordanL8 Aug 3, 2020 •

edited

JordanL8 Aug 3, 2020 •

edited

JordanL8 left a comment

alindmanUnity commented Aug 5, 2020

alindmanUnity left a comment

remi-chapelain left a comment

anisunity commented Aug 12, 2020 •

edited

anisunity left a comment

remi-chapelain commented Sep 18, 2020

		@@ -0,0 +1,17 @@
		# Raytracing Quality Node

		The Raytracing Quality Node allows you to provide a fast implementation of your Shader Graph to be use in GPU heavy raytraced effect to tradeoff accuracy for speed: [Ray-Traced Reflections](Ray-Traced-Reflections.md), [Ray-Traced-Global-Illumination](Ray-Traced-Global-Illumination.md) and [Ray-Traced-Subsurface-Scattering](Ray-Traced-Subsurface-Scattering.md).


		## Setup

		The Raytracing Quality Node is a builtin keyword and thus need to be created in the Dashboard Keyword -> Raytracing Quality of the shader graph then drag and dropped in the working area.

Rename Raytracing node to Raytracing quality node + update documentation #1479

Rename Raytracing node to Raytracing quality node + update documentation #1479

Conversation

sebastienlagarde commented Aug 2, 2020 • edited

Purpose of this PR

Testing status

Comments to reviewers

github-actions bot commented Aug 2, 2020

sebastienlagarde commented Aug 2, 2020

JordanL8 Aug 3, 2020 • edited

Choose a reason for hiding this comment

JordanL8 Aug 3, 2020 • edited

Choose a reason for hiding this comment

JordanL8 Aug 3, 2020

Choose a reason for hiding this comment

JordanL8 Aug 3, 2020 • edited

Choose a reason for hiding this comment

JordanL8 Aug 3, 2020 • edited

Choose a reason for hiding this comment

JordanL8 left a comment

Choose a reason for hiding this comment

alindmanUnity commented Aug 5, 2020

alindmanUnity left a comment

Choose a reason for hiding this comment

remi-chapelain left a comment

Choose a reason for hiding this comment

anisunity commented Aug 12, 2020 • edited

anisunity left a comment

Choose a reason for hiding this comment

remi-chapelain commented Sep 18, 2020

sebastienlagarde commented Aug 2, 2020 •

edited

JordanL8 Aug 3, 2020 •

edited

JordanL8 Aug 3, 2020 •

edited

JordanL8 Aug 3, 2020 •

edited

JordanL8 Aug 3, 2020 •

edited

anisunity commented Aug 12, 2020 •

edited