From 1e0c0b38172cac0f1bef70fdc25faab750f39367 Mon Sep 17 00:00:00 2001 From: Vic Cooper Date: Thu, 18 Nov 2021 16:54:48 +0000 Subject: [PATCH 1/2] Reviewed PR #6031 Also generally improved this doc, fixed typos and added screenshots. --- .../Documentation~/Default-Settings-Window.md | 45 +++++++++++-------- .../Images/HDRPgs_Custom_PP.png | 3 ++ .../HDRPgs_Diffusion_Profile_Assets.png | 3 ++ .../Images/HDRPgs_Layers_Names.png | 3 ++ .../Images/HDRPgs_Volume_Profiles.png | 3 ++ 5 files changed, 39 insertions(+), 18 deletions(-) create mode 100644 com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Custom_PP.png create mode 100644 com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Diffusion_Profile_Assets.png create mode 100644 com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Layers_Names.png create mode 100644 com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Volume_Profiles.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md b/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md index 67c32ce1d9c..387046c214a 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md @@ -1,6 +1,6 @@ # HDRP Global Settings Window -The High Definition Render Pipeline (HDRP) adds the HDRP Settings tab to Unity's Graphics Settings window. You can use this tab to set up default settings for certain features in your Project. You can: +The High Definition Render Pipeline (HDRP) adds the HDRP Settings tab to Unity's Graphics Settings window. Use this tab to set up default settings for certain features in your Project. You can: - Assign Render Pipeline Resources Assets for your HDRP Project. - Set the verboseness of Shader variant information that Unity writes to the Console window when you build your Project. @@ -11,19 +11,25 @@ The HDRP Settings tab is part of the Graphics Settings window. To get to this ta ## Volume Profiles -You can use this section to assign and edit a [Volume Profile](Volume-Profile.md) that [Volumes](Volumes.md) use by default in your Scenes. You do not need to create a Volume for this specific Volume Profile to be active, because HDRP always processes it as if it is assigned to a global Volume in the Scene, but with the lowest priority. This means that any Volume that you add to a Scene takes priority. +You can use the **Volume Profiles** section to assign and edit a [Volume Profile](Volume-Profile.md) that [Volumes](Volumes.md) use by default in your Scenes. You do not need to create a Volume for this specific Volume Profile to be active, because HDRP always processes it as if it's assigned to a global Volume in the Scene, but with the lowest priority. This means that any Volume that you add to a Scene takes priority. -The Default Volume Profile Asset references a Volume Profile in the HDRP Package folder called DefaultSettingsVolumeProfile by default. Below it, you can add [Volume overrides](Volume-Components.md), and edit their properties. You can also assign your own Volume Profile to this property field. Be aware that this property must always reference a Volume Profile. If you assign your own Volume Profile and then delete it, HDRP automatically re-assigns the DefaultSettingsVolumeProfile from the HDRP Package folder. +The **Default Volume Profile Asset** (A) references a Volume Profile in the HDRP package folder called `DefaultSettingsVolumeProfile` by default. Below it, you can add [Volume overrides](Volume-Components.md), and edit their properties. You can assign your own Volume Profile to this property field. Be aware that this property must always reference a Volume Profile. If you assign your own Volume Profile and then delete it, HDRP automatically re-assigns the `DefaultSettingsVolumeProfile` from the HDRP package folder. -The LookDev Volume Profile Asset references the Volume Profile HDRP uses in the [LookDev window](Look-Dev.md). This Asset works in almost the same way as the Default Volume Profile Asset, except that it overrides [Visual Environment Components](Override-Visual-Environment.md) and sky components. +The **LookDev Volume Profile Asset** (B) references the Volume Profile HDRP uses in the [LookDev window](Look-Dev.md). This Asset works in almost the same way as the Default Volume Profile Asset, except that it overrides [Visual Environment Components](Override-Visual-Environment.md) and sky components.![](Images/HDRPgs_Volume_Profiles.png) ## Diffusion Profile Assets Use this section to select which custom [Diffusion Profiles](Diffusion-Profile.md) can be in view at the same time. To use more than 15 custom Diffusion Profiles in a Scene, use the [Diffusion Profile Override](Override-Diffusion-Profile.md) inside a Volume. This allows you to specify which Diffusion Profiles to use in a certain area (or in the Scene if the Volume is global). -## Frame Settings +The following image shows the Diffusion Profile Assets section set up for HDRP's default scene: -The [Frame Settings](Frame-Settings.md) control the rendering passes that Cameras make at runtime. Use this section to set default values for the Frame Settings that all Cameras use if you do not enable their Custom Frame Settings checkbox. For information about what each property does, see [Frame Settings](Frame-Settings.md). +![](Images/HDRPgs_Diffusion_Profile_Assets.png) + +## Frame Settings (Default Values) + +The [Frame Settings](Frame-Settings.md) control the rendering passes that Cameras perform at runtime. + +Use this section to set default values for the Frame Settings that all Cameras use if you don't enable their Custom Frame Settings checkbox. For information about what each property does, see [Frame Settings](Frame-Settings.md). ## Layers Names @@ -34,26 +40,29 @@ The [Frame Settings](Frame-Settings.md) control the rendering passes that Camera ## Custom Post Process Orders -Use this section to select which custom post processing effect will be used in the project and in which order they will be executed. -You have one list per post processing injection point: `After Opaque And Sky`, `Before Post Process` and `After Post Process`. See the [Custom Post Process](Custom-Post-Process.md) documentation for more details. +Use this section to select which custom post processing effect HDRP uses in the project and at which stage in the render pipeline it executes them. + +HDRP provides one list for each post processing injection point. See the [Custom Post Process](Custom-Post-Process.md) documentation for more details. + +![](Images/HDRPgs_Custom_PP.png) ## Miscellaneous | **Property** | **Description** | | --------------------------| ------------------------------------------------------------ | -| Shader Variant Log Level | Use the drop-down to select what information HDRP logs about Shader variants when you build your Unity Project. • Disabled: HDRP doesn’t log any Shader variant information.• Only HDRP Shaders: Only log Shader variant information for HDRP Shaders.• All Shaders: Log Shader variant information for every Shader type. | -| Lens Attenuation Mode | Set the attenuation mode of the lens that is used to compute exposure. With imperfect lens some energy is lost when converting from EV100 to the exposure multiplier, while a perfect lens has no attenuation and no energy is lost. | -| Dynamic Render Pass Culling | When this option is enabled, HDRP will use the RendererList API to dynamically skip certain drawing passes based on the type of currently visible objects. For example if no objects with distortion are drawn, the Render Graph passes that draw the distortion effect (and their dependencies - like the color pyramid generation) will be skipped. -| Use DLSS Custom Project Id | Controls whether to use a custom project ID for the NVIDIA Deep Learning Super Sampling module. If you enable this property, you can use **DLSS Custom Project Id** to specify a custom project ID.
This property only appears if you enable the NVIDIA package (com.unity.modules.nvidia) in your Unity project. | -| DLSS Custom Project Id | Controls whether to use a custom project ID for the NVIDIA Deep Learning Super Sampling (DLSS) module. If you enable this property, you can use **DLSS Custom Project Id** to specify a custom project ID. If you disable this property, Unity generates a unique project ID.
This property only appears if you enable the NVIDIA package (com.unity.modules.nvidia) in your Unity project. | -| Runtime Debug Shaders | When enabled, Unity includes shader variants that let you use the Rendering Debugger window to debug your build. When disabled, Unity excludes ("strips") these variants. Enable this when you want to debug your shaders in the Rendering Debugger window, and disable it otherwise. | +| Shader Variant Log Level | Use the drop-down to select what information HDRP logs about Shader variants when you build your Unity Project.
• **Disabled**: HDRP doesn’t log any Shader variant information.
• **Only HDRP Shaders**: Only log Shader variant information for HDRP Shaders.
• **All Shaders**: Log Shader variant information for every Shader type. | +| Lens Attenuation Mode | Set the attenuation mode of the lens that HDRP uses to compute exposure.
•**Imperfect lens**: This mode loses some energy when HDRP converts from EV100 to the exposure multiplier.
•**Perfect lens**: This mode has no attenuation and doesn't lose any energy. | +| Dynamic Render Pass Culling | When you enable this option, HDRP uses the RendererList API to skip drawing passes based on the type of GameObjects visible in the current frame objects. For example, if HDRP doesn't draw an object with distortion, it skips the Render Graph passes that draw the distortion effect and their dependencies, like the color pyramid generation. | +| Use DLSS Custom Project ID | Controls whether to use a custom project ID for the NVIDIA Deep Learning Super Sampling module. If you enable this property, you can use **DLSS Custom Project ID** to specify a custom project ID.
This property only appears if you enable the NVIDIA package (com.unity.modules.nvidia) in your Unity project. | +| DLSS Custom Project ID | Controls whether to use a custom project ID for the NVIDIA Deep Learning Super Sampling (DLSS) module. If you enable this property, you can use **DLSS Custom Project ID** to specify a custom project ID. If you disable this property, Unity generates a unique project ID.
This property only appears if you enable the NVIDIA package (com.unity.modules.nvidia) in your Unity project. | +| Runtime Debug Shaders | When enabled, Unity includes shader variants that let you use the Rendering Debugger window to debug your build. When disabled, Unity excludes (strips) these variants. Enable this when you want to debug your shaders in the Rendering Debugger window, and disable it otherwise. | ## Resources -The Resources list includes the Shaders, Materials, Textures, and other Assets that the High Definition Render Pipeline (HDRP) uses. +The Resources list includes the Shaders, Materials, Textures, and other Assets that HDRP uses. | **Property** | **Description** | | ------------------------- | ------------------------------------------------------------ | -| **Player Resources** | Stores references to Shaders and Materials that HDRP uses. When you build your Unity Project, HDRP embeds all of the resources that this Asset references. It allows you to set up multiple render pipelines in a Unity Project and, when you build the Project, Unity only embeds Shaders and Materials relevant for that pipeline. This is the Scriptable Render Pipeline equivalent of Unity’s Resources folder mechanism. When you create a new HDRP Global Settings Asset, the HDRenderPipelineRuntimeResources from HDRP package is automatically referenced in it. | -| **Ray Tracing Resources** | Stores references to Shaders and Materials that HDRP uses for ray tracing. HDRP stores these resources in a separate Asset file from the main pipeline resources so that it can use less memory for applications that don't support ray tracing. When you create a new HDRP Global Settings Asset, the HDRenderPipelineRayTracingResources from HDRP package is automatically referenced in it if your project use ray tracing. | -| **Editor Resources** | Stores reference resources for the Editor only. Unity does not include these when you build your Unity Project. When you create a new HDRP Global Settings Asset, the HDRenderPipelineEditorResources from HDRP package is automatically referenced in it. | +| **Player Resources** | Stores references to Shaders and Materials that HDRP uses. When you build your Unity Project, HDRP embeds all the resources that this Asset references.

Use this property to set up multiple render pipelines in a Unity Project. When you build the Project Unity only embeds Shaders and Materials relevant for that pipeline. This is the Scriptable Render Pipeline equivalent of Unity’s Resources folder mechanism.
When you create a new HDRP Global Settings Asset, the `HDRenderPipelineRuntimeResources` from HDRP package is automatically referenced in it. | +| **Ray Tracing Resources** | Stores references to Shaders and Materials that HDRP uses for ray tracing.
HDRP stores these resources in a separate Asset file from the main pipeline resources so that it can use less memory for applications that don't support ray tracing. When you create a new HDRP Global Settings Asset, the `HDRenderPipelineRayTracingResources` from HDRP package is automatically referenced in it if your project use ray tracing. | +| **Editor Resources** | Stores reference resources for the Editor only.
Unity doesn't include these when you build your Unity Project. When you create a new HDRP Global Settings Asset, the `HDRenderPipelineEditorResources` from HDRP package is automatically referenced in it. | diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Custom_PP.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Custom_PP.png new file mode 100644 index 00000000000..b2679570df9 --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Custom_PP.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03c3d71ba6be538f6b1730124af5ad9382c3ac5c18ca247e0437c9a440fb9a22 +size 18954 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Diffusion_Profile_Assets.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Diffusion_Profile_Assets.png new file mode 100644 index 00000000000..36be2d28960 --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Diffusion_Profile_Assets.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:54de7d42ad74c852c159e38999c85c8df4675ac9430257dd4f644ff08f09c3c6 +size 36201 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Layers_Names.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Layers_Names.png new file mode 100644 index 00000000000..206457f5cb2 --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Layers_Names.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28b329deabcdc42beacc668cddc72aa1b9ecc4f13da86d6cce7a3c1947a47f25 +size 8205 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Volume_Profiles.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Volume_Profiles.png new file mode 100644 index 00000000000..05c9436b782 --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPgs_Volume_Profiles.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2c6ba57a6dacee3466067d24f4074816f9093b7d1e7e0e525bc832297cf7bb3 +size 117466 From b82c880d3802a07b3186a9c92f6703f798ec5574 Mon Sep 17 00:00:00 2001 From: "noreply@unity3d.com" Date: Thu, 25 Nov 2021 14:26:48 +0000 Subject: [PATCH 2/2] Apply formatting changes --- .../Documentation~/Default-Settings-Window.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md b/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md index 387046c214a..e664cef8a8a 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md @@ -21,13 +21,13 @@ The **LookDev Volume Profile Asset** (B) references the Volume Profile HDRP uses Use this section to select which custom [Diffusion Profiles](Diffusion-Profile.md) can be in view at the same time. To use more than 15 custom Diffusion Profiles in a Scene, use the [Diffusion Profile Override](Override-Diffusion-Profile.md) inside a Volume. This allows you to specify which Diffusion Profiles to use in a certain area (or in the Scene if the Volume is global). -The following image shows the Diffusion Profile Assets section set up for HDRP's default scene: +The following image shows the Diffusion Profile Assets section set up for HDRP's default scene: ![](Images/HDRPgs_Diffusion_Profile_Assets.png) ## Frame Settings (Default Values) -The [Frame Settings](Frame-Settings.md) control the rendering passes that Cameras perform at runtime. +The [Frame Settings](Frame-Settings.md) control the rendering passes that Cameras perform at runtime. Use this section to set default values for the Frame Settings that all Cameras use if you don't enable their Custom Frame Settings checkbox. For information about what each property does, see [Frame Settings](Frame-Settings.md). @@ -42,7 +42,7 @@ Use this section to set default values for the Frame Settings that all Cameras u Use this section to select which custom post processing effect HDRP uses in the project and at which stage in the render pipeline it executes them. -HDRP provides one list for each post processing injection point. See the [Custom Post Process](Custom-Post-Process.md) documentation for more details. +HDRP provides one list for each post processing injection point. See the [Custom Post Process](Custom-Post-Process.md) documentation for more details. ![](Images/HDRPgs_Custom_PP.png)