/Graphics

Unity Graphics - Including Scriptable Render Pipeline

Primary LanguageC#OtherNOASSERTION

NOTE: We have migrated reported issues to FogBugz. You can only log further issues via the Unity bug tracker. To see how, read this.

Unity Scriptable Render Pipeline

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 so 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:

Package CI Summary

Package Name Latest CI Status
com.unity.render-pipelines.core ReleaseBadge ReleaseBadge
com.unity.render-pipelines.universal ReleaseBadge ReleaseBadge
com.unity.render-pipelines.high-definition ReleaseBadge ReleaseBadge
com.unity.render-pipelines.high-definition-config ReleaseBadge ReleaseBadge
com.unity.shadergraph ReleaseBadge ReleaseBadge
com.unity.visualeffectgraph ReleaseBadge ReleaseBadge
com.unity.render-pipelines.lightweight ReleaseBadge ReleaseBadge

Using the latest version

This repository uses the master branch for main development. Development on this branch is based on the latest internal version of Unity so it may not work on the latest publicly available version of Unity. The following list contains Unity version/major SRP version pairs which you can use as a guideline as to which major SRP version you can use in your Unity Project:

  • Unity 2019.1 is compatible with SRP version 5.x
  • Unity 2019.2 is compatible with SRP version 6.x
  • Unity 2019.3 is compatible with SRP version 7.x
  • Unity 2020.1 is compatible with SRP version 8.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:

  1. In your Unity Project, open the Package Manager window (menu: Window > Package Manager).
  2. 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.
  3. 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:

  1. Go to the Unity Graphics repository.
  2. Click the Branch drop-down then click the Tags tab.
  3. 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.

To clone the repository, you can use a visual client, like GitHub Desktop, or use console commands. When you clone the repository, make sure to clone it outside of your Unity Project's Asset folder.

After you clone the repository, you can install the package into your Unity Project. To do this, see Installing a local package.

Cloning the repository using the GitHub Desktop App:

  1. Open the GitHub Desktop App and click File > Clone repository.
  2. Click the URL tab and enter the following URL: https://github.com/Unity-Technologies/Graphics.
  3. Click the Choose… button and navigate to your Unity Project’s base folder.
  4. Click the Clone button.

After you clone the repository, open your console application of choice in the Graphics folder and run the following console command:

\> git checkout v7.1.8 (or the latest tag)

Cloning the repository using console commands:

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 v7.1.8 (or the latest tag)

Sample Scenes in Graphics

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.