Skip to content

Commit a55b816

Browse files
markg-unityEvergreen
authored andcommitted

File tree

8 files changed

+24
-41
lines changed

8 files changed

+24
-41
lines changed

Packages/com.unity.render-pipelines.universal/Documentation~/2d-customlit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can now make your own 2D Lighting model.
1111

1212
## Sprite Custom Lit Shader Graph
1313

14-
The new Shader Graph target "Custom Lit Shader Graph" provides a great starting point to create a custom lithing model shader. It does not sample the Light Textures but it does have a Normal pass and a fallback Forward pass for use in non 2D Renderer.
14+
The new Shader Graph target "Custom Lit Shader Graph" provides a great starting point to create a custom lighting model shader. It does not sample the Light Textures but it does have a Normal pass and a fallback Forward pass for use in non 2D Renderer.
1515

1616
## 2D Light Texture
1717

Packages/com.unity.render-pipelines.universal/Documentation~/InstallURPIntoAProject.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The [Universal Render Pipeline Asset](universalrp-asset.md) (URP Asset) contains
3030
To create a Universal Render Pipeline Asset:
3131

3232
1. In the Editor, go to the Project window.
33-
2. Right-click in the Project window, and select **Create** > **Rendering** > **URP Asset**. Alternatively, navigate to the menu bar at the top, and select **Assets** > **Create** > **Rendering** > **URP Asset**.
33+
2. Right-click in the Project window, and select **Create** > **Rendering** > **URP Asset (with Universal Renderer)**. Alternatively, navigate to the menu bar at the top, and select **Assets** > **Create** > **Rendering** > **URP Asset (with Universal Renderer)**.
3434

3535
You can either leave the default name for the new Universal Render Pipeline Asset, or type a new one.
3636

@@ -63,5 +63,5 @@ When you upgrade a project from the Built-in Render Pipeline (BiRP) to the Unive
6363
* [Converting your shaders](upgrading-your-shaders.md)
6464
* [Render Pipeline Converter](features/rp-converter.md)
6565
* [Upgrade custom shaders for URP compatibility](urp-shaders/birp-urp-custom-shader-upgrade-guide.md)
66-
* [Find graphics quality settings in URP](quality-settings-location.md)
66+
* [Find graphics quality settings in URP](birp-onboarding/quality-settings-location.md)
6767
* [Update graphics quality levels for URP](quality-presets.md)

Packages/com.unity.render-pipelines.universal/Documentation~/camera-component-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ The **Physical Camera** property adds additional properties to the camera to sim
5656
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Quality (SMAA)** | Select the quality of SMAA. The difference in resource intensity is fairly small between **Low** and **High**.<br/><br/>Available options:<ul><li>**Low**</li><li>**Medium**</li><li>**High**</li></ul>This property only appears when you select **Subpixel Morphological Anti-aliasing (SMAA)** from the **Anti-aliasing** drop-down. |
5757
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Quality (TAA)** | Select the quality of TAA.<br/><br/>Available options:<ul><li>**Very Low**</li><li>**Low**</li><li>**Medium**</li><li>**High**</li><li>**Very High**</li></ul>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down. |
5858
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Contrast Adaptive Sharpening** | Enable high quality post sharpening to reduce TAA blur.<br/><br/>This setting is overridden when you enable either [AMD FidelityFX Super Resolution (FSR) or Scalable Temporal Post-Processing (STP)](universalrp-asset.md#quality) upscaling in the URP Asset as they both handle sharpening as part of the upscaling process. <br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down. |
59-
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Base Blend Factor** | Set how much the history buffer blends with the current frame result. Higher values mean more history contribution, which improves the anti-aliasing, but also increases the chance of ghosting.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Show Additional Properties** in the Inspector. |
60-
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Jitter Scale** | Set the scale of the jitter applied when TAA is enabled. A lower value reduces visible flickering and jittering, but also reduces the effectiveness of the anti-aliasing.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Show Additional Properties** in the Inspector. |
61-
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Mip Bias** | Set how much texture mipmap selection is biased when rendering.<br/><br/>A positive bias makes a texture appear more blurry, while a negative bias sharpens the texture. However, a lower value also has a negative impact on performance.<br/><br/>**Note**: Requires mipmaps in textures.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Show Additional Properties** in the Inspector. |
62-
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Variance Clamp Scale** | Set the size of the color volume Unity uses to find nearby pixels when the color history is incorrect or unavailable. The clamp limits how much a pixel's color can vary from the color of the surrounding pixels.<br/><br/>Lower values can reduce ghosting, but produce more flickering. Higher values reduce flickering, but are prone to blur and ghosting.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Show Additional Properties** in the Inspector. |
59+
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Base Blend Factor** | Set how much the history buffer blends with the current frame result. Higher values mean more history contribution, which improves the anti-aliasing, but also increases the chance of ghosting.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Advanced Properties** in the Inspector. |
60+
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Jitter Scale** | Set the scale of the jitter applied when TAA is enabled. A lower value reduces visible flickering and jittering, but also reduces the effectiveness of the anti-aliasing.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Advanced Properties** in the Inspector. |
61+
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Mip Bias** | Set how much texture mipmap selection is biased when rendering.<br/><br/>A positive bias makes a texture appear more blurry, while a negative bias sharpens the texture. However, a lower value also has a negative impact on performance.<br/><br/>**Note**: Requires mipmaps in textures.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Advanced Properties** in the Inspector. |
62+
| &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;**Variance Clamp Scale** | Set the size of the color volume Unity uses to find nearby pixels when the color history is incorrect or unavailable. The clamp limits how much a pixel's color can vary from the color of the surrounding pixels.<br/><br/>Lower values can reduce ghosting, but produce more flickering. Higher values reduce flickering, but are prone to blur and ghosting.<br/><br/>This property only appears when you select **Temporal Anti-aliasing (TAA)** from the **Anti-aliasing** drop-down and enable **Advanced Properties** in the Inspector. |
6363
| **Stop NaNs** | Replaces Not a Number (NaN) values with a black pixel for the camera. This stops certain effects from breaking, but is a resource-intensive process which causes a negative performance impact. Only enable this feature if you experience NaN issues you can't fix.<br/><br/>The Stop NaNs pass executes at the start of the post-processing passes. You must enable **Post Processing** for the camera to use **Stop NaNs**.<br/><br/>Only available when **Render Type** is set to **Base**. |
6464
| **Dithering** | Enable to apply 8-bit dithering to the final render to help reduce banding on wide gradients and low light areas.<br/><br/>This property is only visible when **Render Type** is set to **Base**. |
6565
| **Clear Depth** | Enable to clear depth from previous camera on rendering.<br/><br/>This property is only visible when **Render Type** is set to **Overlay**. |

Packages/com.unity.render-pipelines.universal/Documentation~/features/rendering-layers.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,19 @@ To read how to implement this example, refer to [How to use Rendering Layers](#h
1515

1616
To enable Rendering Layers for Lights in your project:
1717

18-
1. In the [URP Asset](../universalrp-asset.md), in the **Lighting** section, click the vertical ellipsis icon (&vellip;) and select **Show Additional Properties**
19-
20-
![Show Additional Properties](../Images/settings-general/show-additional-properties.png)
18+
1. In the [URP Asset](../universalrp-asset.md), in the **Lighting** section, open the **More** (⋮) menu and select **Advanced Properties**.
2119

2220
2. In the [URP Asset](../universalrp-asset.md), in the **Lighting** section, select **Use Rendering Layers**.
2321

24-
![URP Asset > Lighting > Use Rendering Layers](../Images/lighting/rendering-layers/rendering-layers-enable.png)<br/>*URP Asset > Lighting > Use Rendering Layers*
25-
2622
## <a name="enable-decals"></a>Enable Rendering Layers for Decals
2723

2824
To enable Rendering Layers for decals in your project:
2925

30-
1. In the [Decal Renderer Feature](../renderer-feature-decal.md#decal-renderer-feature-properties), enable **Use Rendering Layers**.
26+
1. In the **Project** window, select a Renderer asset with a [Decal Renderer Feature](../renderer-feature-decal.md#decal-renderer-feature-properties).
3127

32-
![Decal Renderer Feature, Inspector view.](../Images/decal/decal-rf-inspector.png)<br/>*Decal Renderer Feature, Inspector view.*
28+
2. In the Decal Renderer Feature, enable **Use Rendering Layers**.
3329

34-
When you enable Rendering Layers for Decals, Unity shows the **Rendering Layers** property on each Decal Projector:
35-
36-
![Rendering Layers property on a Decal Projector.](../Images/lighting/rendering-layers/decal-projector-rendering-layers.png)
30+
When you enable Rendering Layers for Decals, Unity shows the **Rendering Layers** property on each Decal Projector.
3731

3832
## How to edit Rendering Layer names
3933

@@ -69,9 +63,9 @@ To implement the example:
6963

7064
5. Make the following settings on Lights and Spheres:
7165

72-
Light `A`: in the property **Light > General > Rendering Layers**, clear all options, and select `Green`.
66+
Light `A`: in the property **Light > Rendering > Rendering Layers**, clear all options, and select `Green`.
7367

74-
Light `B`: in the property **Light > General > Rendering Layers**, clear all options, and select `Red`.
68+
Light `B`: in the property **Light > Rendering > Rendering Layers**, clear all options, and select `Red`.
7569

7670
Sphere `C`: in the property **Mesh Renderer > Additional Settings > Rendering Layer Mask**, select all options, clear `Green`.
7771

@@ -123,8 +117,6 @@ To implement the example:
123117

124118
4. Select the Decal Projector. In the Rendering Layers property, select `Receive decals`.
125119

126-
![Rendering Layers property on a Decal Projector.](../Images/lighting/rendering-layers/decal-projector-rendering-layers.png)
127-
128120
5. Select the paint bucket GameObject. In the **Rendering Layer Mask** field, clear the `Receive decals` layer. Now the Decal Projector does not affect this GameObject.
129121

130122
## Limitations

Packages/com.unity.render-pipelines.universal/Documentation~/post-processing/hdr-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ URP provides two **Tonemapping** modes: **Neutral** and **ACES**. Each tone mapp
9292

9393
| Property | Description |
9494
| -------- | ----------- |
95-
| **Neutral HDR Range Reduction Mode** | The curve that the Player uses for tone mapping. The options are:<ul><li>**BT2390**: The default. Defined by the [BT.2390](https://www.itu.int/pub/R-REP-BT.2390) broadcasting recommendations.</li><li>**Reinhard**: A simple Tone Mapping operator.</li></ul>This option is only available when you enable **Show Additional Properties**. |
95+
| **Neutral HDR Range Reduction Mode** | The curve that the Player uses for tone mapping. The options are:<ul><li>**BT2390**: The default. Defined by the [BT.2390](https://www.itu.int/pub/R-REP-BT.2390) broadcasting recommendations.</li><li>**Reinhard**: A simple Tone Mapping operator.</li></ul>This option is only available when you enable **Advanced Properties**. |
9696
| **Hue Shift Amount** | The value determines the extent to which your content retains its original hue after you apply HDR settings. When this value is 0, the tonemapper attempts to preserve the hue of your content as much as possible by only tonemapping luminance. |
9797
| **Detect Paper White** | Enable this property if you want URP to use the Paper White value that the display communicates to the Unity Engine. In some cases, the value the display communicates may not be accurate. Implement a calibration menu for your application so that users can display your content correctly on displays that communicate inaccurate values. |
9898
| **Paper White** | The Paper White value of the display. If you do not enable **Detect Paper White**, you must specify a value here. |

Packages/com.unity.render-pipelines.universal/Documentation~/renderer-features/renderer-feature-full-screen-pass.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ The Full Screen Pass Renderer Feature contains the following properties.
2727
| **Pass Material** | The Material the Renderer Feature uses to render the effect. |
2828
| **Injection Point** | Select when the effect is rendered:<ul><li>**Before Rendering Transparents**: Add the effect after the skybox pass and before the transparents pass.</li><li>**Before Rendering Post Processing**: Add the effect after the transparents pass and before the post-processing pass.</li><li>**After Rendering Post Processing**: Add the effect after the post-processing pass and before AfterRendering pass.</li></ul>**After Rendering Post Processing** is the default setting. |
2929
| **Requirements** | Select one or more of the following passes for the Renderer Feature to use:<ul><li>**None**: Add no additional passes.</li><li>**Everything**: Adds all additional passes available (Depth, Normal, Color, and Motion).</li><li>**Depth**: Adds a depth prepass to enable the use of depth values.</li><li>**Normal**: Enables the use of normal vector data.</li><li>**Color**: Copies color data of a screen to the _BlitTexture texture inside the shader.</li><li>**Motion**: Enables the use of motion vectors.</li></ul>**Color** is the default setting. |
30-
| **Pass Index** | Select a specific pass inside the Pass Material's shader for the Pass Material to use.<br/><br/>This option is hidden by default. To access this option, click &#8942; in the Renderer Feature section of the Inspector and select **Show Additional Properties**. |
30+
| **Pass Index** | Select a specific pass inside the Pass Material's shader for the Pass Material to use.<br/><br/>This option is hidden by default. To access this option, click &#8942; in the Renderer Feature section of the Inspector and select **Advanced Properties**. |

Packages/com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/reference-screen-space-lens-flare.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Refer to [Add screen space lens flares](post-processing-screen-space-lens-flare.
1111
| - | - |
1212
| **Intensity** | Set the strength of all the types of lens flares. If the value is 0, URP doesn't calculate or render any lens flares. The default is 0. |
1313
| **Tint Color** | Set the color URP uses to tint all the types of lens flares. The default is white. |
14-
| **Bloom Mip Bias** | Set the mipmap level URP uses to sample the Bloom pyramid and create the lens flares. The higher the mipmap level, the smaller and more pixelated the sample source, and the blurrier the result. The range is 0 through 5. 0 is the full-resolution mipmap level. The default is 1. Refer to [Mipmaps introduction](https://docs.unity3d.com/2023.1/Documentation/Manual/texture-mipmaps-introduction.html) for more information. This property only appears if you open the **More** (⋮) menu and select **Show Additional Properties**. |
14+
| **Bloom Mip Bias** | Set the mipmap level URP uses to sample the Bloom pyramid and create the lens flares. The higher the mipmap level, the smaller and more pixelated the sample source, and the blurrier the result. The range is 0 through 5. 0 is the full-resolution mipmap level. The default is 1. Refer to [Mipmaps introduction](https://docs.unity3d.com/2023.1/Documentation/Manual/texture-mipmaps-introduction.html) for more information. This property only appears if you open the **More** (⋮) menu and select **Advanced Properties**. |
1515

1616
### Flares
1717

@@ -22,9 +22,9 @@ Use the **Flares** settings to control regular flares, reversed flares and warpe
2222
| **Regular Multiplier** || Set the strength of regular flares. If the value is 0, URP doesn't calculate or render regular flares. The default is 1. |
2323
| **Reversed Multiplier** || Set the strength of reversed flares. If the value is 0, URP doesn't calculate or render reversed flares. The default is 1. |
2424
| **Warped Multipler** || Set the strength of warped flares. If the value is 0, URP doesn't calculate or render warped flares. The default is 1. |
25-
|| **Scale** | Scale the width (**x**) and height (**y**) of warped flares. The defaults are 1. This property only appears if you open the **More** (⋮) menu and select **Show Additional Properties**. |
25+
|| **Scale** | Scale the width (**x**) and height (**y**) of warped flares. The defaults are 1. This property only appears if you open the **More** (⋮) menu and select **Advanced Properties**. |
2626
| **Samples** || Set the number of times URP repeats the regular, reversed and warped flares. The range is 1 through 3. The default is 1. Increasing **Samples** has a big impact on performance. |
27-
|| **Sample Dimmer** | Set the strength of the lens flares URP adds if you set **Samples** to 2 or 3. The higher the value, the less intense the flares. This property only appears if you open the **More** (⋮) menu and select **Show Additional Properties**. |
27+
|| **Sample Dimmer** | Set the strength of the lens flares URP adds if you set **Samples** to 2 or 3. The higher the value, the less intense the flares. This property only appears if you open the **More** (⋮) menu and select **Advanced Properties**. |
2828
| **Vignette Effect** || Set the strength of the regular, reversed and warped flares in a circular area in the center of the screen. Use **Vignette Effect** to avoid lens flare obscuring the scene too much. The default value is 1, which means URP doesn't render flares at the center of the screen. |
2929
| **Starting Position** || Control how far the position of the regular, reversed and warped flares differ from the bright area they're sampled from, in metres. If the value is 0, URP places the lens flares at the same position as the bright areas they're sampled from. The range is 1 through 3. The default is 1.25. |
3030
| **Scale** || Set the size of regular, reversed and warped lens flares. The range is 1 through 4. The default is 1.5. |
@@ -39,7 +39,7 @@ Use the **Streaks** settings to control flares stretched in one direction.
3939
|| **Length** | Set the length of streaks. The range is 0 through 1. 1 is the approximate width of the screen. The default value is 0.5. |
4040
|| **Orientation** | Set the angle of streaks, in degrees. The default value is 0, which creates horizontal streaks. |
4141
|| **Threshold** | Control how localized the streak effect is. The higher the **Threshold**, the more localized the effect. The range is 0 through 1. The default value is 0.25. |
42-
|| **Resolution** | Control the resolution detail of streaks. URP renders lower-resolution streaks faster. The options are **Half**, **Quarter** and **Eighth** full resolution. This property only appears if you open the **More** (⋮) menu and select **Show Additional Properties**. |
42+
|| **Resolution** | Control the resolution detail of streaks. URP renders lower-resolution streaks faster. The options are **Half**, **Quarter** and **Eighth** full resolution. This property only appears if you open the **More** (⋮) menu and select **Advanced Properties**. |
4343

4444
![](../../Images/shared/lens-flare/screenspacelensflares-threshold.gif)<br/>
4545
The effect of changing **Threshold** from 0 (a larger flare effect) to 1 (a smaller flare effect).

0 commit comments

Comments
 (0)