Skip to content

Commit fb210e2

Browse files
JordanL8sebastienlagarde
authored andcommitted
HDRP docs bugfixes #2993
1 parent ca8afd3 commit fb210e2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+381
-329
lines changed

com.unity.render-pipelines.high-definition/Documentation~/Camera-Relative-Rendering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Absolute precision of floating point numbers decreases as numbers become larger.
66

77
## Using Camera-relative rendering
88

9-
Camera-relative rendering is enabled by default in the ShaderConfig.cs file (in your Project window go to **Packages > Runtime > ShaderLibrary** and click on **ShaderConfig.cs**). To disable this feature, set `CameraRelativeRendering` to `0`, and then generate Shader includes to update the ShaderConfig.cs.hlsl file (menu: **Edit > Render Pipeline** and click **Generate Shader Includes)**.
9+
Camera-relative rendering is enabled by default in the ShaderConfig.cs file (in your Project window go to **Packages > High Definition RP Config > Runtime > ShaderLibrary** and click on **ShaderConfig.cs**). To disable this feature, set `CameraRelativeRendering` to `0`, and then generate Shader includes to update the ShaderConfig.cs.hlsl file (menu: **Edit > Render Pipeline** and click **Generate Shader Includes)**.
1010

1111
## How Camera-relative rendering works
1212

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

Lines changed: 242 additions & 242 deletions
Large diffs are not rendered by default.

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# The High Definition Render Pipeline Asset
22

3-
The High Definition Render Pipeline (HDRP) Asset controls the global rendering settings of your Project and creates an instance of the rendering pipeline. A rendering pipeline instance contains intermediate resources and an implementation of the render pipeline.
3+
The High Definition Render Pipeline (HDRP) Asset controls the global rendering settings of your Project and creates an instance of the render pipeline.
44

5-
Unity does not allocate memory or build Shader variants for disabled features in your HDRP Asset. This means that you can disable settings that you are not using to save memory, but you can not enable disabled features at runtime. You can toggle enabled features at runtime on a per-Camera basis using [Frame-Settings](Frame-Settings.md).
5+
Unity only allocates memory and builds shader variants for features you enable in the HDRP Asset. This means that you can disable features your project does not use to save memory. Since certain features require shader variants or other resources when Unity builds your project, you can only enable and disable features at edit time. However, it is possible to toggle the rendering of particular features at runtime, just not using the HDRP Asset. Instead, [Frame-Settings](Frame-Settings.md) control the features that cameras in the scene render. Frame Settings can only toggle features that are enabled in the HDRP Asset; they cannot enable features that are disabled.
66

77
<a name="CreatingAnHDRPAsset"></a>
88

@@ -26,9 +26,9 @@ Unity now uses the High Definition Render Pipeline (HDRP) in your Unity Project.
2626
1. Navigate to **Edit > Project Settings > Player > Other Settings** and locate the **Color Space** property.
2727
2. Select **Linear** from the **Color Space** drop-down.
2828

29-
You can create multiple HDRP Assets containing different settings. This is useful for Project that support multiple platforms, such as PC, Xbox One and PlayStation 4. In each HDRP Asset, you can change settings to suite the hardware of each platform and then assign the relevant one when building your Project for each platform.
29+
You can create multiple HDRP Assets containing different settings. This is useful for Project that support multiple platforms, such as PC, Xbox One and PlayStation 4. In each HDRP Asset, you can change settings to suite the hardware of each platform and then assign the relevant one when building your Project for each platform. For more information on using creating HDRP Assets to target different platforms, see [Scalability in HDRP](Scalability-Manual.md).
3030

31-
To change the HDRP Asset your render pipeline uses, either manually select an HDRP Asset in the Graphics Settings window (as shown above), or use the GraphicsSettings.renderPipelineAsset property via script.
31+
To change which HDRP Asset your render pipeline uses, either manually select an HDRP Asset in the Graphics Settings window (as shown above), or use the GraphicsSettings.renderPipelineAsset property via script.
3232

3333
When you create an HDRP Asset, open it in the Inspector to edit its properties.
3434

@@ -110,16 +110,16 @@ Use the Reflection settings to configure the max number and resolution of the pr
110110
| **Property** | **Description** |
111111
| ---------------------------------------- | ------------------------------------------------------------ |
112112
| **Screen Space Reflection** | Enable the checkbox to make HDRP support [screen space reflection](https://docs.unity3d.com/Manual/PostProcessing-ScreenSpaceReflection.html). SSR is a technique for calculating reflections by reusing screen space data. |
113-
| **- Transparent** | Enable the checkbox to make HDRP support [screen space reflection](https://docs.unity3d.com/Manual/PostProcessing-ScreenSpaceReflection.html) on transparent materials.|
114-
| **Reflection and Planar Probes Format** | Color format used for reflection and planar probes. |
113+
| **- Transparent** | Enable the checkbox to make HDRP support [screen space reflection](https://docs.unity3d.com/Manual/PostProcessing-ScreenSpaceReflection.html) on transparent materials. |
114+
| **Reflection and Planar Probes Format** | Color format used for reflection and planar probes. |
115115
| **Compress Reflection Probe Cache** | Enable the checkbox to compress the [Reflection Probe](Reflection-Probe.md) cache in order to save space on disk. |
116116
| **Reflection Cubemap Size** | Use the drop-down to select the maximum resolution of individual Reflection Probe[ ](https://docs.unity3d.com/Manual/class-Cubemap.html)[cubemaps](https://docs.unity3d.com/Manual/class-Cubemap.html). |
117117
| **Probe Cache Size** | The maximum size of the Probe Cache. Defines how many Probe cube maps HDRP can save in cache. |
118118
| **Planar Reflection Atlas Size** | Use the drop-down to select the resolution of the planar probe atlas. It defines how many reflection probe you'll be able to render at once and at which resolution. |
119-
| ****Planar Resolution Tiers**** | |
120-
| **- L** | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their **Resolution** set to **Low** use this resolution for their planar reflection. |
121-
| **- M** | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their **Resolution** set to **Medium** use this resolution for their planar reflection. |
122-
| **- H** | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their **Resolution** set to **High** use this resolution for their planar reflection. |
119+
| ***Planar Resolution Tiers*** | |
120+
| **- L** | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their **Resolution** set to **Low** use this resolution for their planar reflection. |
121+
| **- M** | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their **Resolution** set to **Medium** use this resolution for their planar reflection. |
122+
| **- H** | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their **Resolution** set to **High** use this resolution for their planar reflection. |
123123
| **Max Planar Reflection On Screen** | The maximum number of planar reflections on screen at once. |
124124
| **Maximum Environment Lights on Screen** | The maximum number of environment Lights HDRP can manage on screen at once. |
125125

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# HD Camera
1+
# HDRP Camera
22

3-
Cameras capture and display your world to the user. Customize and manipulate your Cameras to present your Unity Project however you like. You can use an unlimited number of Cameras in a Scene and set them to render in any order, at any position on the screen.
4-
5-
The High Definition Render Pipeline (HDRP) includes an HD Camera that uses the HDAdditionalCameraData component. If you use a script to interact with the Camera, some properties that are inside the HDAdditionalCameraData component are displayed inside the Camera component.
3+
The High Definition Render Pipeline (HDRP) adds extra properties and methods to Unity's [standard Camera](https://docs.unity3d.com/ScriptReference/Camera.html) to control HDRP features, such as [Frame Settings](Frame-Settings.md). Although HDRP displays these extra properties in the Camera component Inspector, HDRP stores them in the [HDAdditionalCameraData](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest?subfolder=/api/UnityEngine.Rendering.HighDefinition.HDAdditionalCameraData.html) component. This means if you use a script to access properties or methods for the Camera, be aware that they may be inside the HDAdditionalCameraData component. For the full list of properties and methods HDRP stores in the HDAdditionalCameraData component, see the [scripting API](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest?subfolder=/api/UnityEngine.Rendering.HighDefinition.HDAdditionalCameraData.html).
64

75
## Properties
86

9-
The HDRP Camera shares many properties with the [Standard Unity Camera](https://docs.unity3d.com/Manual/class-Camera.html).
7+
The HDRP Camera shares many properties with the Unity's [standard Camera](https://docs.unity3d.com/Manual/class-Camera.html).
108

119
### General
1210

com.unity.render-pipelines.high-definition/Documentation~/Images/PlanarReflectionProbe1.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

com.unity.render-pipelines.high-definition/Documentation~/Images/PlanarReflectionProbes1.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

com.unity.render-pipelines.high-definition/Documentation~/Images/ReflectionProbe1.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

com.unity.render-pipelines.high-definition/Documentation~/Mask-Map-and-Detail-Map.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Mask and detail maps
22

3-
The High Definition Render Pipeline (HDRP) uses [channel-packed](Glossary.md#ChannelPacking) Textures to store multiple Material maps in a single Texture. Channel packing is efficient because it allows the renderer to sample up to four grayscale maps that use the same UV coordinates with a single Texture fetch. HDRP uses two types of channel-packed Textures: the [Mask Map](#MaskMap), and the [Detail Map](#DetailMap). They can use a different set of UV coordinates, or a different UV tiling value, giving you more creative freedom.
3+
The High Definition Render Pipeline (HDRP) uses [channel-packed](Glossary.md#ChannelPacking) textures to store multiple Material maps in a single texture. Channel packing is efficient because it allows the renderer to sample up to four grayscale maps that use the same UV coordinates with a single texture fetch. HDRP uses two types of channel-packed textures: the [Mask Map](#MaskMap), and the [Detail Map](#DetailMap). They can use a different set of UV coordinates, or a different UV tiling value, giving you more creative freedom.
44

55
This document describes the format of the mask map and detail map so that you can author your own to use in HDRP.
66

77
To create a mask map:
88

99
1. Open image editing software that supports channel editing (such as Adobe Photoshop).
10-
2. Drag your grayscale Textures into their respective color channel. For information about which Texture belongs in which channel, see [mask map](#MaskMap) and [detail map](#DetailMap).<br />![](Images/MaskMapAndDetailMap1.png)
10+
2. Drag your grayscale textures into their respective color channel. For information about which texture belongs in which channel, see [mask map](#MaskMap) and [detail map](#DetailMap).<br />![](Images/MaskMapAndDetailMap1.png)
1111
3. Export your image.
1212
4. When you import the image into Unity, make sure that it uses linear color space.
1313

1414
<a name="MaskMap"></a>
1515

1616
## Mask map
1717

18-
The mask map contains four grayscale Textures, one in each of its color channels.
18+
The mask map contains four grayscale textures, one in each color channel. HDRP uses the mask map to store the metallic map, occlusion map, detail mask, and smoothness map for the material. The mask map stores these textures in the following channels:
1919

2020
| **Color channel** | **Map** |
2121
| ----------------- | ----------- |
@@ -32,9 +32,7 @@ The following example image demonstrates the individual components of a full mas
3232

3333
## Detail map
3434

35-
The detail map allow you to overlay a second set of textures on top of the base surface information. Typically, the detail map would be scaled several times across the object’s surface to add small details to a material.
36-
The detail map contains two grayscale Textures and one two-component Texture, which is the Material's detail normal map.
37-
When you import the detail map, make sure to disable the **sRGB** checkbox in the Import Settings.
35+
The detail map enables you to overlay a second set of textures on top of the base surface information. Typically, the detail map scales several times across the object’s surface to add small details to a material. The detail map contains two grayscale textures and one two-component texture, which is the Material's detail normal map. When you import the detail map, disable the **sRGB** checkbox in the **Import Settings** window to make it work as expected.
3836

3937
| **Color channel** | **Map** |
4038
| ----------------- | ------------------ |
@@ -49,15 +47,15 @@ The following example image demonstrates the individual components of a full det
4947

5048
### Desaturated albedo (red channel)
5149

52-
The red channel represents the albedo variation. It can make the underlying material's albedo gradually darken down to black when going from `0.5` to `0` or brighten up to white when going from `0.5` to `1`. A value of `0.5` is neutral, which means the detail map does not modify the albedo.
50+
The red channel represents the albedo variation. It makes the underlying material's albedo gradually darken down to black when going from `0.5` to `0` or brighten up to white when going from `0.5` to `1`. A value of `0.5` is neutral, which means the detail map does not modify the albedo.
5351

54-
The image below shows the impact of the detail albedo on the final color. As you can see, HDRP calculates color interpolation in sRGB space.
52+
The image below shows the impact of the detail albedo on the final color. HDRP calculates color interpolation in sRGB space.
5553

5654
![](Images/DetailMap-red.png)
5755

5856
### Smoothness (blue channel)
5957

60-
The blue channel represents the smoothness variation and HDRP computes it the same way as the albedo variation. The underlying material's smoothness gradually decreases if the detail smoothness is below `0.5` or increases if it is above `0.5`. A value of `0.5` is neutral, which means the detail map does not modify the smoothness.
58+
The blue channel represents the smoothness variation and HDRP calculates it the same way as the albedo variation. The underlying material's smoothness gradually decreases if the detail smoothness is below `0.5` or increases if it is above `0.5`. A value of `0.5` is neutral, which means the detail map does not modify the smoothness.
6159

6260
The image below shows the impact of the detail smoothness on the final color.
6361

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,19 @@ MatCap mode preserves the normal maps and you can use the original Material albe
2424
HDRP provides neutral and metallic default MatCaps. You can change the MatCap in your [HDRP Asset's](HDRP-Asset.md) **HDRenderPipelineResources**. To do this:
2525

2626
1. Select the HDRP Asset in the Project window to view it in the Inspector.
27-
2. Go to the **General** section and double-click on the Asset assigned to the **Render Pipeline Resources** property to view that in the Inspector.
28-
3. Go to the **Textures** section and assign your custom MatCap Texture to the **MatCap Tex** property.
27+
2. Enter [Debug mode](https://docs.unity3d.com/Manual/InspectorOptions.html) then find the **Render Pipeline Resources** property.
28+
3. Double-click the asset assigned to the **Render Pipeline Resources** property to view it in the Inspector.
29+
4. Go to the **Textures** section and assign your custom MatCap Texture to the **MatCap Tex** property.
2930

3031
You can also activate MatCap view as a **Lighting Debug Mode** in the [Render Pipeline Debugger](Render-Pipeline-Debug-Window.md).
3132

3233
## MatCap examples
3334

34-
**MatCap off:**
35-
35+
MatCap off:
3636
![](Images/MatCap2.png)
3737

38-
**MatCap on:**
39-
38+
MatCap on:
4039
![](Images/MatCap3.png)
4140

42-
**MatCap on with albedo:**
43-
44-
![](Images/MatCap4.png)
41+
MatCap on with albedo:
42+
![](Images/MatCap4.png)

com.unity.render-pipelines.high-definition/Documentation~/Override-Ambient-Occlusion.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The property to enable in your Frame Settings is: **Lighting > Screen Space Ambi
2222
2. In the Inspector, navigate to **Add Override > Lighting** and click on **Ambient Occlusion**.
2323
HDRP now applies **Ambient Occlusion** to any Camera this Volume affects.
2424

25+
[!include[](snippets/volume-override-api.md)]
26+
2527
## Properties
2628

2729
[!include[](snippets/Volume-Override-Enable-Properties.md)]

0 commit comments

Comments
 (0)