Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions .github/workflows/draft.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
name: Draft reminder

on:
pull_request:
types: [opened]
pull_request:
types: [opened]

jobs:
draft_reminder:
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false && github.event.pull_request.ready_for_review == false
steps:
- uses: thollander/actions-comment-pull-request@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
message: |
It appears that you made a non-draft PR!
Please convert your PR to draft (button on the right side of the page)
and cancel any jobs that started on Yamato.
See the PR template for more information.
Thank you!
draft_reminder:
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false && github.event.pull_request.ready_for_review == false
steps:
- uses: thollander/actions-comment-pull-request@v1.0.4
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
message: |
It appears that you made a non-draft PR!
Please convert your PR to draft (button on the right side of the page)
and cancel any jobs that started on Yamato.
See the PR template for more information.
Thank you!
4 changes: 4 additions & 0 deletions .yamato/_abv.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ all_project_ci_nightly_2020.3:
rerun: on_new_revision
- path: .yamato/all-shadergraph.yml#Nightly_ShaderGraph_2020.3
rerun: on_new_revision
- path: .yamato/_templates.yml#all_template_ci_2020.3
rerun: on_new_revision
- path: .yamato/_abv.yml#General_Checks_2020.3
rerun: on_new_revision
General_Checks_2020.3:
Expand Down Expand Up @@ -126,6 +128,8 @@ all_project_ci_nightly_CUSTOM-REVISION:
rerun: on_new_revision
- path: .yamato/all-shadergraph.yml#Nightly_ShaderGraph_CUSTOM-REVISION
rerun: on_new_revision
- path: .yamato/_templates.yml#all_template_ci_CUSTOM-REVISION
rerun: on_new_revision
- path: .yamato/_abv.yml#General_Checks_CUSTOM-REVISION
rerun: on_new_revision
General_Checks_CUSTOM-REVISION:
Expand Down
1 change: 1 addition & 0 deletions .yamato/config/abv.metafile
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ jobs:
- .yamato/all-vfx.yml#Nightly_VFX_<TRACK>
- .yamato/all-urp.yml#Nightly_URP_<TRACK>
- .yamato/all-shadergraph.yml#Nightly_ShaderGraph_<TRACK>
- .yamato/_templates.yml#all_template_ci_<TRACK>
- <PROJECT_ALL_YML_FILE>#General_Checks_<TRACK>
triggers:
recurring:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
name: postprocessing
test_editors:
- trunk
- 2021.1
- 2021.2
- 2020.3
- 2019.4
- 2018.4
Expand Down
66 changes: 41 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Scriptable Render Pipeline (SRP) is a Unity feature designed to give artists
* 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.
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:

Expand All @@ -26,34 +26,23 @@ com.unity.render-pipelines.high-definition | [![](https://badge-proxy.cds.intern
com.unity.render-pipelines.high-definition-config | [![](https://badge-proxy.cds.internal.unity3d.com/89664583-2f3c-4a61-a1fa-a9daea037b2e)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.high-definition-config/build-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/3ed117a7-740c-4ef1-a280-c97221742a1e)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.high-definition-config/dependencies-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/ab12a6a1-17e5-478f-9916-7cfe77f2dbbb)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.high-definition-config/dependants-info) [![](https://badge-proxy.cds.internal.unity3d.com/2421fdd2-bda0-492f-bcdf-ce764b64d58e)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.high-definition-config/warnings-info?branch=master) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/59fd14b1-3fc2-49e4-bf24-950f1482323f) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/d0fb96fc-6ff8-45a8-a317-ec19f30894cc)
com.unity.shadergraph | [![](https://badge-proxy.cds.internal.unity3d.com/ad6f7b2b-97ec-46c5-8539-9b70e8c30bb5)](https://badges.cds.internal.unity3d.com/packages/com.unity.shadergraph/build-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/067b8f44-3f3a-4925-8462-996ffbe41662)](https://badges.cds.internal.unity3d.com/packages/com.unity.shadergraph/dependencies-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/7e1ee3c6-0477-4076-a2af-3376ead10421)](https://badges.cds.internal.unity3d.com/packages/com.unity.shadergraph/dependants-info) [![](https://badge-proxy.cds.internal.unity3d.com/9ce9cc97-b89d-4a2a-98c2-d1a1d2d0277e)](https://badges.cds.internal.unity3d.com/packages/com.unity.shadergraph/warnings-info?branch=master) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/e2171d56-50c8-4803-964c-a63dcc728355) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/30fe71f1-5838-4bf9-84eb-26a42320e4a2)
com.unity.visualeffectgraph | [![](https://badge-proxy.cds.internal.unity3d.com/0fbfa6fc-2faf-4689-a3e7-fca736ab23cb)](https://badges.cds.internal.unity3d.com/packages/com.unity.visualeffectgraph/build-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/6606630d-31a9-4af5-b63c-25272411c381)](https://badges.cds.internal.unity3d.com/packages/com.unity.visualeffectgraph/dependencies-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/c10f50c2-2a79-4d0a-a763-54dcb40d027f)](https://badges.cds.internal.unity3d.com/packages/com.unity.visualeffectgraph/dependants-info) [![](https://badge-proxy.cds.internal.unity3d.com/823df233-071e-4ceb-a39f-b810d7fe6fe1)](https://badges.cds.internal.unity3d.com/packages/com.unity.visualeffectgraph/warnings-info?branch=master) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/59b6ec9b-c477-4767-82ba-d2390e70cede) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/ae2fb4f5-43dc-4ad2-8c94-7190dbcdc132)
com.unity.render-pipelines.lightweight | [![](https://badge-proxy.cds.internal.unity3d.com/dabba5ea-621a-45b4-98e5-eecd6e3026a8)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.lightweight/build-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/3af4fced-c82d-4737-b37f-654c3d960b76)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.lightweight/dependencies-info?branch=master) [![](https://badge-proxy.cds.internal.unity3d.com/7e4aae95-2a9a-471c-a5f8-e8faf3675454)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.lightweight/dependants-info) [![](https://badge-proxy.cds.internal.unity3d.com/87242c39-da1e-49df-bcd5-c3aa8665b9f4)](https://badges.cds.internal.unity3d.com/packages/com.unity.render-pipelines.lightweight/warnings-info?branch=master) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/679931b4-d19f-4788-90af-be45f40f3a11) ![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/a11f872a-60e4-4a16-a3f7-4ac888bcd879)

## Using the latest version
## Branches and package releases

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

- **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**
If you need to find if a specific changeset is included in a specific Unity version, you can search tags for the Unity version.

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:
## Modifying package source

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

After you decide which version of SRP to use:

1. Go to the [Unity Graphics repository](https://github.com/Unity-Technologies/Graphics).
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](#GitHubDesktop), or use [console commands](#ConsoleCommands). 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](https://docs.unity3d.com/Manual/upm-ui-local.html).

<a name="GitHubDesktop"></a>
1. Clone this repository in any folder on your computer. [Install them as local packages](https://docs.unity3d.com/Manual/upm-ui-local.html) into your project.
2. Clone this repository inside a `Packages` folder in your Unity project.

### Cloning the repository using the GitHub Desktop App:

Expand All @@ -62,9 +51,11 @@ After you clone the repository, you can install the package into your Unity Proj
3. Click the **Choose…** button and navigate to your Unity Project’s base folder.
4. 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 v7.1.8 (or the latest tag)`
`\> git checkout v10.7.0 (or the latest tag)`

<a name="ConsoleCommands"></a>

Expand All @@ -79,9 +70,34 @@ Open your console application of choice and run the following console commands:

\> cd Graphics

\> git checkout v7.1.8 (or the latest tag)
\> git checkout v10.7.0 (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](https://github.com/Unity-Technologies/Graphics). To add the Scenes to your Project, clone the repository into your Project's Assets folder.


## Package versions on Unity 2020.3 LTS and below

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:

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](https://github.com/Unity-Technologies/Graphics).
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.
9 changes: 0 additions & 9 deletions issue_template.md

This file was deleted.