NOTE: We have migrated reported issues to FogBugz. You can only log further issues via the Unity bug tracker. To see how, read this.
NOTE 2: We are rolling out changes to how we develop the Graphics Packages. Development will move to an internal repo and changes will be mirrored to this public repo. You will continue to see changes at the PR level and pull in changes from this public repo. You can find more information and track our progress here.
NOTE 3: Some folders have been moved. Read more here on how to merge your custom branches with the new folder layout.
The Scriptable Render Pipeline (SRP) is a Unity feature designed to give artists and developers the tools they need to create modern, high-fidelity graphics in Unity. Unity provides two pre-built Scriptable Render Pipelines:
- The Universal Render Pipeline (URP) for use on all platforms.
- The High Definition Render Pipeline (HDRP) for use on compute shader compatible platforms.
Unity is committed to an open and transparent development process for SRP and the pre-built Render Pipelines. This means that you can browse this repository to see what features are currently in development.
For more information about the packages in this repository, see the following:
- Scriptable Render Pipeline Core
- High Definition Render Pipeline
- Universal Render Pipeline
- Shader Graph
- Visual Effect Graph
| Package Name | Latest CI Status |
|---|---|
| com.unity.render-pipelines.core | |
| com.unity.render-pipelines.universal | |
| com.unity.render-pipelines.high-definition | |
| com.unity.render-pipelines.high-definition-config | |
| com.unity.shadergraph | |
| com.unity.visualeffectgraph |
The packages in this repository are distributed as Core packages in the Unity editor. The package vendoring process happens multiple times in each Unity release. The vendoring happens from the latest changeset of the release branch for each Unity release. A tag is generated on the changeset used to vendor a specific Unity release.
Release branches are defined as follows:
- master branch is used for main developement and it always maps to the latest Unity Alpha release.
- {unity-version}/staging maps to beta and released Unity versions. f.ex, 2021.1/staging maps to Unity 2021.1.
- {package-major-version}.x.x/release is used for Unity 2020.x and below. f.ex, 10.x.x/release maps to Unity 2020.3 LTS.
If you need to find if a specific changeset is included in a specific Unity version, you can search tags for the Unity version.
On GitHub, you can do that by clicking on the Branch drop-down then clicking the Tags tab. Typing 2021.2 will list all changesets tagged to each Unity version.
You can download and install the packages of this repositories on your Unity project and modify the package source code. You can do that by one of the following methods:
- Clone this repository in any folder on your computer. Install them as local packages into your project.
- Clone this repository inside a
Packagesfolder in your Unity project.
- Open the GitHub Desktop App and click File > Clone repository.
- Click the URL tab and enter the following URL: https://github.com/Unity-Technologies/Graphics.
- Click the Choose… button and navigate to your Unity Project’s base folder.
- Click the Clone button.
Make sure you have Git LFS extension installed as that's required.
After you clone the repository, open your console application of choice in the Graphics folder and run the following console command:
\> git checkout 2021.1.16f1.2801 (or the latest tag)
Open your console application of choice and run the following console commands:
\> cd <Path to your Unity project>
\> git clone https://github.com/Unity-Technologies/Graphics
\> cd Graphics
\> git checkout 2021.1.16f1.2801 (or the latest tag)
Unity provides sample Scenes to use with SRP. You can find these Scenes in the Graphics GitHub repository. To add the Scenes to your Project, clone the repository into your Project's Assets folder.
On Unity 2020.3 LTS and below, the packages in this repository were not Core packages. Instead they were regular packages and different versions could be installed to different versions of Unity. The compatibility of Unity versions and package versions were as follows:
- Unity 2020.3 is compatible with SRP versions 10.x.x
- Unity 2020.2 is compatible with SRP versions 10.x.x
- Unity 2020.1 is compatible with SRP versions 8.x.x
- Unity 2019.3 is compatible with SRP versions 7.x.x
- Unity 2019.2 is compatible with SRP versions 6.x.x
- Unity 2019.1 is compatible with SRP vertsios 5.x.x
The above list is a guideline for major versions of SRP, but there are often multiple minor versions that you can use for a certain version of Unity. To determine which minor versions of SRP you can use:
- In your Unity Project, open the Package Manager window (menu: Window > Package Manager).
- In the list of packages, find Core RP Library. To find this package in older versions of Unity, you may need to expose preview packages. To do this, click the Advanced button at the top of the window then, in the context menu, click Show preview packages.
- Click the drop-down arrow to the left of the package entry then click See all versions. This shows a list that contains every package version compatible with your version of Unity.
After you decide which version of SRP to use:
- Go to the Unity Graphics repository.
- Click the Branch drop-down then click the Tags tab.
- Find the tag that corresponds to the version of SRP you want to use. When you clone the repository, you use this tag to check out the correct branch.