From 2c5213a42762a291766dec3f35dd0de89e7f9f27 Mon Sep 17 00:00:00 2001 From: emilybrown1 Date: Thu, 27 Jan 2022 10:29:34 +0000 Subject: [PATCH] clarified how to change mode --- .../Documentation~/Custom-Pass-Volume-Workflow.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Volume-Workflow.md b/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Volume-Workflow.md index 0eb38af32f7..3a8c6fefb3f 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Volume-Workflow.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Volume-Workflow.md @@ -6,22 +6,27 @@ The workflow for Custom Pass Volumes is similar to the HDRP [Volumes](https://do - Unity stores Custom Pass data on a GameObject rather than an asset in your project. - If you have more than one Custom Pass Volume in your scene with the same injection point, Unity executes the Volume in order of [Priority](Custom-Pass-Creating.md#Custom-Pass-Volume). -To create a Custom Pass Volume that affects every camera in the scene, set the Custom Pass Volume component’s **Mode** to **Global**. To create a Custom Pass Volume that only affects cameras within the boundaries of the Volume, set the Custom Pass Volume component’s **Mode** to **Local**. +You can choose whether a Custom Pass Volume affects every camera in the scene or only affects cameras within the boundaries of the Volume. To do this: + +1. Go to the Inspector window for your Custom Pass. +2. Go to **Custom Pass Volume (Script)** > **Mode** + * To create a Custom Pass Volume that affects every camera in the scene, set the **Mode** to **Global**. + * To create a Custom Pass Volume that only affects cameras within the boundaries of the Volume, set the **Mode** to **Local**. You can use the **Priority** field to determine the execution order of multiple Custom Pass Volumes in your scene. If two Custom Pass Volumes have the same priority, Unity executes them in one of the following ways: - When both Custom Pass Volumes are **Global**, the execution order is undefined. -- When both Custom Pass Volumes are **Local**, Unity executes the Volume with the smallest collider first (ignoring the fade radius). If both Volumes have the same collider size, the order is undefined. +- When both Custom Pass Volumes are **Local**, Unity executes the Volume with the smallest Collider first (ignoring the fade radius). If both Volumes have the same Collider size, the order is undefined. - When one Custom Pass Volume is **Local** and the other is **Global**, Unity executes the **Local** Volume first, then the **Global** Volume. -If the **Mode** of your Custom Pass Volume is set to **Local**, you can use the **Fade Radius** property in the [Custom Pass Volume Component](Custom-Pass-Creating.md#Custom-Pass-Volume) to smooth the transition between your normal rendering and the Custom Pass. The fade radius value is measured in meters and does not scale when you transform the object it is assigned to. +If you set the **Mode** of your Custom Pass Volume to **Local**, you can use the **Fade Radius** property in the [Custom Pass Volume Component](Custom-Pass-Creating.md#Custom-Pass-Volume) to smooth the transition between your normal rendering and the Custom Pass. The fade radius value is measured in meters and doesn't scale when you transform the object it's assigned to. The image below visualises the outer bounds of the fade radius as a wireframe box. The Custom Pass Volume in this image has a [Box Collider](https://docs.unity3d.com/Manual/class-BoxCollider.html) component which visualises the Volume. ![A Custom Pass Volume visualised using a Box Collider, with its fade radius visualised as a wireframe box.](images/CustomPassVolumeBox_Collider.png) -When a Custom Pass Volume's **Mode** is set to **Camera**, HDRP only executes the custom pass volume in its **Target Camera**. To make sure HDRP always executes the custom pass volume, it ignores the Camera's volume layer mask when a **Target Camera** is set. +When you set a Custom Pass Volume's **Mode** to **Camera**, HDRP only executes the custom pass volume in its **Target Camera**. To make sure HDRP always executes the custom pass volume, it ignores the Camera's volume layer mask when you set a **Target Camera**. ## Using C# to change the fade radius -To change the fade radius in code, you can use the built in `_FadeValue` variable in the shader, and `CustomPass.fadeValue` in your C# script. These variables operate on a 0 - 1 scale that represents how far the Camera is from the collider bounding Volume. To learn more, see [Scripting your own Custom Pass in C#](Custom-Pass-Scripting.md). +To change the fade radius in code, you can use the built in `_FadeValue` variable in the shader, and `CustomPass.fadeValue` in your C# script. These variables operate on a 0 to 1 scale that represents how far the Camera is from the Collider bounding Volume. To learn more, see [Scripting your own Custom Pass in C#](Custom-Pass-Scripting.md).