Skip to content

File tree

6 files changed

+64
-10
lines changed

6 files changed

+64
-10
lines changed
313 KB
Loading

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* [Feature list](urp-feature-list.md)
77
* [Feature Comparison with the Built-in Render Pipeline](universalrp-builtin-feature-comparison.md)
88
* [Getting started](InstallingAndConfiguringURP.md)
9-
* [Create a Project from a Template](creating-a-new-project-with-urp.md)
9+
* [Create a Project with 3D Sample Scenes](creating-a-new-project-with-urp.md)
1010
* [Install URP into an existing Project](InstallURPIntoAProject.md)
1111
* [Package samples](package-samples.md)
1212
* [URP Package Samples](package-sample-urp-package-samples.md)
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Using the Universal Render Pipeline in a new Project
1+
# Create a project with 3D Sample Scenes
22

3-
![URP Template](Images/AssetShots/Beauty/Template.png)
3+
![URP 3D Sample](Images/AssetShots/Beauty/Template.png)
44

5-
If you want to use the Universal Render Pipeline (URP) in a new Project, you can create a new Project using a Template.
6-
7-
To create a URP Project using a Template:
5+
To explore various features of the Universal Render Pipeline (URP), create a new Project with 3D Sample Scenes.
86

97
1. Open the Unity Hub.
10-
2. On the Home page, click **New** to start a new Project. The Templates popup appears.
11-
3. Select the Universal Render Pipeline Template.
12-
4. Click **Create**. Unity creates a new Project for you. The new Project has URP installed and configured, and includes some example content that demonstrates URP's functionality.
13-
5. In the Project window, navigate to the _Assets_ folder, and select the **Readme** Asset. Unity will show information about the Project in the Inspector window.
8+
9+
2. On the Home page, click **New project** to start a new Project.
10+
11+
3. In the **Sample** tab, select **3D Sample Scenes (URP)**.
12+
13+
4. Click **Create project**. Unity creates a new project with URP installed and configured, and includes example content that demonstrates URP features.

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
This page contains information on known issues you may encounter when using URP.
44

5+
## Long build times when using the Forward+ Rendering Path
6+
7+
Due to the wide variety of use cases, target platforms, renderers, and features used in projects, certain URP configurations can result in a large number of shader variants. That can lead to long compilation times.
8+
9+
Long shader compilation time affects both player build time and the time for a scene to render in the Editor.
10+
11+
The per-camera visible light limit value affects the compilation time for each **Lit** and **Complex Lit** shader variant. In the Forward+ Rendering Path, on desktop platforms, that limit is 256.
12+
13+
Refer to the following page to learn how to reduce the build time in the Forward+ Rendering Path by reducing the maximum number of visible lights:
14+
15+
* [Reduce build time in Forward+ Rendering Path](rendering/forward-plus-rendering-path.md#reduce-build-time)
16+
517
## When importing the URP package samples, Unity does not set the necessary URP asset in Quality > Render Pipeline Asset<a name="urp-samples-known-issue-1"></a>
618

719
When importing the URP package samples, Unity does not set the necessary URP asset in **Quality** > **Render Pipeline Asset**, and certain sample rendering effects do not work.

Packages/com.unity.render-pipelines.universal/Documentation~/rendering/forward-plus-rendering-path.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,39 @@ When you set the Rendering Path to Forward+, Unity ignores the values in the fol
3232
## Limitations
3333

3434
The Forward+ Rendering Path has no limitations compared with the Forward Rendering Path.
35+
36+
## Reduce build time
37+
38+
Due to the wide variety of use cases, target platforms, renderers, and features used in projects, certain URP configurations can result in a large number of shader variants. That can lead to long compilation times.
39+
40+
Long shader compilation time affects both player build time and the time for a scene to render in the Editor.
41+
42+
The per-camera visible light limit value affects the compilation time for each **Lit** and **Complex Lit** shader variant. In the Forward+ Rendering Path, on desktop platforms, that limit is 256.
43+
44+
This section describes how to reduce the shader compilation time by changing the default maximum per-camera visible light count.
45+
46+
### Change the maximum number of visible lights
47+
48+
> [!NOTE]
49+
> This instruction describes a workaround for a limitation in the URP design. This limitation will be mitigated in one of the future Unity versions.
50+
51+
The [Universal Render Pipeline Config package](../URP-Config-Package.md) contains the settings that define the number of maximum visible light. The following instructions describe how to change those settings.
52+
53+
> [!NOTE]
54+
> If you upgrade the Unity version of your project, repeat this procedure.
55+
56+
1. In your project folder, copy the **URP Config Package** folder from `/Library/PackageCache/com.unity.render-pipelines.universal-config` to `/Packages/com.unity.render-pipelines.universal-config`.
57+
58+
2. Open the file `/com.unity.render-pipelines.universal-config/Runtime/ShaderConfig.cs.hlsl`.
59+
60+
The file contains multiple definitions that start with `MAX_VISIBLE_LIGHT_COUNT` and end with the target platform name. Change the value in brackets to a suitable maximum in-frustum per-camera light count for your project, for example, `MAX_VISIBLE_LIGHT_COUNT_DESKTOP (32)`.
61+
62+
For the **Forward+** Rendering Path, the value includes the Main Light. For the **Forward** Rendering Path, the value does not include the Main Light.
63+
64+
3. Open the file `/com.unity.render-pipelines.universal-config/Runtime/ShaderConfig.cs`.
65+
66+
The file contains multiple definitions that start with `k_MaxVisibleLightCount` and end with the platform name. Change the value so that it matches the value set in the `ShaderConfig.cs.hlsl` file, for example `k_MaxVisibleLightCountDesktop = 32;`.
67+
68+
4. Save the edited files and restart the Unity Editor. Unity automatically configures your project and shaders to use the new configuration.
69+
70+
Now the Player build time should be shorter due to the reduced compilation time for each shader variant.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ This section contains information related to optimization and debugging.
55
This section contains the following topics:
66

77
* [Rendering Debugger](features/rendering-debugger.md)
8+
9+
* [Add controls to the Rendering Debugger](features/rendering-debugger-add-controls.md)
10+
11+
* [Optimize for better performance](optimize-for-better-performance.md)
12+
13+
* [Update Quality Setting Presets for URP](birp-onboarding/quality-presets.md)

0 commit comments

Comments
 (0)