9092858a58
I updated everything to the latest Unity Editor. Also realized I had the wrong shaders on my hairs, those are fixed and the hairs look MUCH better!
100 lines
5.9 KiB
Markdown
100 lines
5.9 KiB
Markdown
# Upgrading from the Lightweight Render Pipeline to the Universal Render Pipeline
|
|
The Universal Render Pipeline (URP) replaces the Lightweight Render Pipeline (LWRP) in Unity 2019.3. If your Project uses LWRP, you must upgrade it to use URP to use Unity 2019.3.
|
|
|
|
Unity upgrades some things automatically, and you must make some manual changes. Follow the steps in this guide to transition from using LWRP to using URP.
|
|
|
|
## Before upgrading
|
|
### Update Assembly Definition Assets
|
|
URP uses GUIDs instead of Assembly Definition string names. If you are using Assembly Definition Assets (ASMDefs) in your Project, you should ensure that **Use GUIDs** is enabled on each of them.
|
|
|
|
Unity upgrades any existing string references to LWRP automatically as part of the upgrade process, but it is best practice to use GUIDs on your Assembly Definition Assets for future proofing.
|
|
|
|
For each Assembly Definition Asset in your Project:
|
|
|
|
* Select the Assembly Defintion Asset
|
|
* In the Inspector, enable **Use GUIDs**
|
|
|
|
For information on using Assembly Definition files, see the [documentation on Assembly Definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html).
|
|
|
|
## Upgrade process
|
|
### Upgrading your version of LWRP
|
|
To start the upgrade process:
|
|
|
|
* Open the Project you want to upgrade in Unity 2019.3
|
|
|
|
Unity automatically updates LWRP to a 7.x.x version, and pulls in the URP package as a dependency of the updated LWRP package. The Unity script updater automatically upgrades your script files. When the script updater has finished, all of your scripts should compile properly.
|
|
|
|
### Upgrading the Shader search path
|
|
If your LWRP Project uses `Shader.Find` to search for LWRP Shaders, you need to change the search path.
|
|
|
|
To do this:
|
|
* Change all instances of `Shader.Find` that search for `Lightweight` to search for `Universal`.
|
|
|
|
### Upgrading custom shaders
|
|
#### Upgrading tags
|
|
URP uses its own scripting tags. If your Shaders use the LWRP `LightMode` tags, they will work in your URP Project, because Unity uses an internal alias for this. However, you should change the tags manually to future-proof your Project.
|
|
|
|
To do this:
|
|
|
|
* Change all instances of `Lightweight2D` tag to `Universal2D`.
|
|
* Change all instances of `LightweightForward` tag to `UniversalForward`.
|
|
|
|
In addition to this, URP also uses a different RenderPipeline tag to LWRP. If your own Shaders include this tag, you need to change it manually for the Shaders to work:
|
|
|
|
* Change all instances of `LightweightPipeline` tag to `UniversalPipeline`.
|
|
|
|
#### Upgrading Shader names
|
|
The following Shader names have been changed for URP, so you need to manually update your Shader files:
|
|
* Change all instances of `UsePass 'Lightweight Render Pipeline/...'` to `UsePass 'Universal Render Pipeline/...'`
|
|
|
|
#### Upgrading include paths
|
|
URP uses different include paths to LWRP. LWRP 7.x.x contains forwarding includes, so your custom Shaders will upgrade from LWRP to URP. However, URP 7.x.x does not contain forwarding includes, so you must then manually update the include paths.
|
|
|
|
* Change all instances of `#include 'Packages/com.unity.render-pipelines.lightweight/xxx'` to `#include 'Packages/com.unity.render-pipelines.universal/xxx'`
|
|
|
|
### Upgrading namespaces
|
|
In the .cs files in your Project, find and replace references to the LWRP namespace with the new Universal namespace.
|
|
|
|
* Change all instances of `UnityEditor.Rendering.LWRP.xxx` to now `UnityEditor.Rendering.Universal.xxx`
|
|
|
|
## Upgrading post-processing effects
|
|
|
|
URP version 7.x supports both [Post Processing Stack v2 (PPv2) and its own integrated post-processing solution](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@7.4/manual/integration-with-post-processing.html). If you have the Post Processing Version 2 package installed in your Project and you want to use URP's integrated post-processing solution, you need to delete the Post Processing Stack v2 package before you install URP into your Project. When you have installed URP, you can then recreate your post-processing effects.
|
|
|
|
Upgrading post-processing effects from LWRP to URP is a manual process. You must manually recreate each Post-Processing Profile in your Project, using URP's post-processing implementation.
|
|
|
|
URP's integrated post-processing solution does not currently support custom post-processing effects. If your Project uses custom post-processing effects, these cannot currently be recreated in URP's integrated post-processing solution. Custom post-processing effects will be supported in a forthcoming release of URP.
|
|
|
|
## Installing URP and removing LWRP
|
|
As part of the automatic upgrade process, Unity installed URP as a dependency of LWRP. You must now install URP as a dependency of the Project itself, so that when you remove LWRP, Unity does not automatically remove URP.
|
|
|
|
To install URP as a dependency of the Project:
|
|
|
|
* Go to menu: **Window** > **Package Manager**.
|
|
* Locate the **Universal RP** package, and note the version number to the right of its name. This is the version of URP that has been added to your Project.
|
|
* Close Unity.
|
|
* In your file explorer, open the root folder of your Unity Project.
|
|
* Open the Packages folder, and locate *manifest.json*. This is your Project's Project Manifest file.
|
|
* Open the Project Manifest file using a text editor.
|
|
* At the top of the dependencies section, add the following entry:
|
|
|
|
```json
|
|
"com.unity.render-pipelines.universal": "[Version number you noted earlier]"
|
|
```
|
|
|
|
So, for example, if the version of URP was 7.1.1, your dependencies section would look like this:
|
|
|
|
```json
|
|
"dependencies": {
|
|
"com.unity.render-pipelines.universal": "7.1.1",
|
|
...
|
|
}
|
|
```
|
|
|
|
This marks the version of URP that you have installed as a dependency of the Project. You can now safely remove LWRP.
|
|
|
|
* Open your Project in Unity.
|
|
* Open the Package Manager Window.
|
|
* Locate **Lightweight RP** and select it.
|
|
* In the bottom right of the Package Manager window, click Remove. Unity completely removes the LWRP package from the Project.
|