Skip to content

Removed reference to 3d with extras project #6781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2022
Merged

Removed reference to 3d with extras project #6781

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
393f521
Removed reference to 3d with extras project
emilybrown1 Jan 20, 2022
aacb73d
Merge branch 'master' into HDRP/docs/make-upgrade-page-generic
sebastienlagarde Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 18 additions & 39 deletions com.unity.render-pipelines.high-definition/Documentation~/Upgrading-To-HDRP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,13 @@

The High Definition Render Pipeline (HDRP) uses a new set of [Shaders](https://docs.unity3d.com/Manual/class-Shader.html) and [lighting units](Physical-Light-Units.md), both of which are incompatible with the Built-in Renderer. To upgrade a Unity Project to HDRP, you must first convert all your [Materials](#MaterialConversion) and Shaders, then adjust individual [Light](#LightAdjustment) settings accordingly.

This document explains how to convert the **3D With Extras** template Project to HDRP, but you can use the same workflow to convert your own Project. To follow this document and upgrade the **3D With Extras** Project, create a Project that uses the **3D With Extras** template. To do this:

1. Open the Unity Hub.

2. In the **Projects** tab, select **New**.

3. In the **Template** section, select **3D With Extras**.

4. Enter a **Project Name** and set the **Location** for Unity to save the Project to.

5. Click **Create**.

6. The Unity Editor opens and looks like this:

![](Images/UpgradingToHDRP1.png)
This document explains how to convert your Project to HDRP.

## Setting up HDRP

Firstly, to install HDRP, add the High Definition RP package to your Unity Project:

3. Open a Unity project.
3. Open your Unity project.
2. Open the __Package Manager__ window (__Window > Package Manager__).
3. In the __Package Manager__ window, in the **Packages:** field, select **Unity Registry**.
4. Select **High Definition RP** from the list of packages.
Expand All @@ -39,7 +25,7 @@ To set up HDRP, use the [HDRP Wizard](Render-Pipeline-Wizard.md).

HDRP is now set up inside your Project, but your Scene doesn't render correctly and uses the magenta error Shader to display GameObjects. This is because GameObjects in the Scene still use Shaders made for the Built-in Renderer. To find out how to upgrade Built-in Shaders to HDRP Shaders, see the [Upgrading Materials](#MaterialConversion) section.

HDRP includes its own [implementation for post-processing](Post-Processing-Main.md) and no longer supports the Post Processing package. If you are converting the **3D With Extras** Project, or if your own Project uses the Post Processing package, remove the Post Processing package from the Project. To do this:
HDRP includes its own [implementation for post-processing](Post-Processing-Main.md) and no longer supports the Post Processing package. If your Project uses the Post Processing package, remove the Post Processing package from the Project. To do this:

1. In the Unity Editor, open the Package Manager window (menu: **Window > Package Manager**).

Expand Down Expand Up @@ -113,20 +99,20 @@ To set up lighting in your HDRP Project:
2. Create a new Volume Profile for this Volume. To do this, open the Inspector for the Volume and click the **New** button.

3. Add a **Shadows** override (**Add Override > Shadowing > Shadows**), then enable **Max Distance** and set it to **50**.
4. On the Light that represents the Sun (which is the Light component on the **Directional Light** GameObject), set the **Intensity** to **100000** and the **Color** to white. Then, to see the sun in the sky, go to the **Shape** section and set the **Angular Diameter** to **3**.
5. The Scene is now over-exposed. To fix this, select the **Global Settings** GameObject you created in step **3a** and add an **Exposure** override to its Volume component (**Add Override > Exposure**). Then, set the **Mode** to **Automatic**.
4. On a Light component that represents the Sun, set the **Intensity** to **100000** and the **Color** to white. Then, to see the sun in the sky, go to the **Shape** section and set the **Angular Diameter** to **3**.
5. The Scene is now over-exposed. To fix this, select the **Global Settings** GameObject you created in step **3** and add an **Exposure** override to its Volume component (**Add Override > Exposure**). Then, set the **Mode** to **Automatic**.
6. To refresh the exposure, go to the Scene view and enable **Animate Materials**.
![](Images/UpgradingToHDRP2.png)
7. Correct the Light cookie, because HDRP supports colored light cookies, and the Built-in light cookies use a texture format that only contains alpha:
1. In the Project window, select **Assets > ExampleAssets> Textures > Light_Cookies > Spotlight_Cookie**.
1. In the Project window, select your Light cookie from your **Assets** folder.

2. In the Inspector, change the import type from **Cookie** to **Default**.

3. Set the **Wrap Mode** to **Clamp**. .
8. Correct the construction Light:
1. In the Hierarchy window, select **ExampleAssets > Props > ConstructionLight > Spot Light** and view the Light component in the Inspector.
8. Correct spot lights:
1. In the Hierarchy window, select a spot light and view the Light component in the Inspector.

2. Change the **Intensity** to **17000** **Lumen**. This is to represent two 8500 Lumen light bulbs.
2. Change the **Intensity** to **17000** **Lumen** to represent two 8500 Lumen light bulbs.

3. In the **Emission** section, enable [additional properties](More-Options.md).

Expand All @@ -135,21 +121,21 @@ To set up lighting in your HDRP Project:
1. In the Project window, select **Assets/ExampleAssets/Materials/Lightbulb_Mat.mat**.

2. In the **Emission Inputs** section of the Inspector, enable **Use Emission Intensity**, set **Emissive Color** to white, and set the **Emission Intensity** to **8500 Luminance**.
10. Finally, if you disabled **Auto Generate** in step **2d**, go to the Lighting window and press the **Generate Lighting** button. You can also re-enable **Auto Generate**.
10. Finally, if you disabled **Auto Generate** in step **2**, go to the Lighting window and press the **Generate Lighting** button. You can also re-enable **Auto Generate**.

<a name="Post-processing"></a>

## Post-processing

HDRP no longer supports the **Post Processing** package and instead includes its own [implementation for post-processing](Post-Processing-Main.md). To convert the Scene to HDRP post-processing:
HDRP no longer supports the **Post Processing** package and instead includes its own [implementation for post-processing](Post-Processing-Main.md). If your Project used the Post Processing package's Scripting API to edit post-processing effects, you need to update your scripts to work with the new post-processing effects. To convert the Scene to HDRP post-processing:

1. In the Hierarchy, delete the **Post-process Volume** GameObject.

1. If your Project used the Post Processing package's Scripting API to edit post-processing effects, you need to update your scripts to work with the new post-processing effects.
2. Create a new **Global Volume** GameObject (menu: **GameObject > Volume > Global Volume**) and name it "**Post-processes**". You can find all the post processes in the **Post-processing** sub-menu when you select **Add Override** in the Volume Inspector.
1. In the Hierarchy, delete your post-processing GameObject.
2. Create a new **Global Volume** GameObject (menu: **GameObject > Volume > Global Volume**) and name it "Post-processes". You can find all the post processes in the **Post-processing** sub-menu when you select **Add Override** in the Volume Inspector.
3. Add a **Tonemapping** override to the Volume (**Add Override > Post-processing > Tonemapping**) then enable **Mode** and set it to **ACES**.
4. Add a **Bloom** override to the Volume (**Add Override > Post-processing > Bloom**) then enable **Intensity** and set it to **0.2**.
Note that the result of the bloom isn't the same as the one in the Post Processing package. This is because HDRP's bloom effect is physically accurate, and mimics the quality of a camera lens.

**Note**: The result of the bloom isn't the same as the one in the Post Processing package. This is because HDRP's bloom effect is physically accurate, and mimics the quality of a camera lens.

5. Add a **Motion Blur** override to the Volume (**Add Override > Post-processing > Motion Blur**) then enable **Intensity** and set it to **0.1**.

6. Add a **Vignette** override to the Volume (**Add Override > Post-processing > Vignette**) then set the following property values.
Expand All @@ -163,12 +149,5 @@ HDRP no longer supports the **Post Processing** package and instead includes its

2. In the **Near Blur** section, enable **Start** and set it to **0** then enable **End** and set it to 0.5

3. In the **Far Blur** section, enable **Start** and set it to **2** then enable **End** and set it to **10**.
Note that this effect is only visible in the Game view.
8. Finally, select the **Global Settings** GameObject to view it in the Inspector. In the Volume component, add an **Ambient** **Occlusion** override (**Add Override > Lighting > Ambient Occlusion**), then enable **Intensity** and set it to **0.5**.

## Result

Now the Scene in the Game view should look like this:

![](Images/UpgradingToHDRP3.png)
3. In the **Far Blur** section, enable **Start** and set it to **2** then enable **End** and set it to **10**. This effect is only visible in the Game view.
8. Select the **Global Settings** GameObject to view it in the Inspector. In the Volume component, add an **Ambient** **Occlusion** override (**Add Override > Lighting > Ambient Occlusion**), then enable **Intensity** and set it to **0.5**.