Skip to content

Commit 2be6fb1

Browse files
committed
Reordered sections in README.
Added Badges :D Added a section about issues.
1 parent 73a2dfc commit 2be6fb1

1 file changed

Lines changed: 31 additions & 22 deletions

File tree

README.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
11
# Customizable Post-processing Stack for Universal Render Pipeline
22

3+
![GitHub issues](https://img.shields.io/github/issues/yahiaetman/urp-custom-pps)
4+
![GitHub pull requests](https://img.shields.io/github/issues-pr/yahiaetman/urp-custom-pps)
5+
![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fyahiaetman%2Furp-custom-pps)
6+
![Twitter Follow](https://img.shields.io/twitter/follow/yetmania?style=social)
7+
38
This package adds the ability to create custom post-processing effects for the universal render pipeline in a manner similar to [PPSv2](https://github.com/Unity-Technologies/PostProcessing) and [HDRP's Custom Post Process](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@8.2/manual/Custom-Post-Process.html). It is supposed to be a replacement for Unity's **PPSv2** till URP internally supports custom post-processing effects.
49

510
**Note:** You can already add you custom effects to URP by inheriting from the `ScriptableRendererFeature` and `ScriptableRenderPass` classes. I personally find this to be a hassle and that is why I wrote this package merely for convenience. I also took it as a chance to pick up the features I like from every post-processing solution I used in Unity.
611

7-
## System Requirements
8-
9-
* Unity 2020.1+
10-
* URP 8.2.0+
11-
12-
## Features
13-
14-
* Conveniently add custom post processing effects similar to [PPSv2](https://github.com/Unity-Technologies/PostProcessing) (at least more convenient that writing a renderer feature and a render pass for every effect).
15-
* Reorder effects from the editor similar to HDRP's [Custom Post Process Orders Settings](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@8.2/manual/Custom-Post-Process.html#effect-ordering).
16-
* Use legacy image effect shaders and unlit shader graphs if you wish (To be honest I didn't do anything, it worked out of the box so I added it to the features list).
17-
* Use it with Camera Stacking.
18-
* Use the `SceneNormals` feature (adapted from [Outline Study](https://github.com/chrisloop/outlinestudy) by [Christopher Sims](https://github.com/chrisloop)) to grab the scene normals onto a texture.
19-
20-
Features that are almost untested:
21-
* It should be compatible with MultiPass XR but it is tested with Mock HMD Loader only so I can't guarantee that it works on an actual headset.
22-
* 2D renderers don't support renderer features yet. However, you can use camera stacking and stack a camera with a forward renderer on top of the camera with the 2D renderer. The forward renderer will apply the post processing to the result of the 2D renderer. I tried it and it worked but I didn't heavily test it yet.
23-
24-
## Known Issues
25-
26-
* It failed to work with Single-Pass Instanced Stereo Rendering. Actually, all of URP didn't work for me in this mode so I don't the reason behind this issue.
27-
* The `SceneNormals` renderer feature uses the override material in the drawing settings. This means that it does not copy the parameters of the original material such as normal maps and alpha clipping. This should be solved in URP 10.0 with the release of the `DepthNormalsPass` made for the SSAO feature.
28-
2912
## Screenshots
3013

3114
![Scene-Screenshot-1](Documentation~/scene-screenshot-1.png)
@@ -49,6 +32,28 @@ Other custom effects in samples but not used in screenshots:
4932
* Grayscale.
5033
* Invert.
5134

35+
## System Requirements
36+
37+
* Unity 2020.1+
38+
* URP 8.2.0+
39+
40+
## Features
41+
42+
* Conveniently add custom post processing effects similar to [PPSv2](https://github.com/Unity-Technologies/PostProcessing) (at least more convenient that writing a renderer feature and a render pass for every effect).
43+
* Reorder effects from the editor similar to HDRP's [Custom Post Process Orders Settings](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@8.2/manual/Custom-Post-Process.html#effect-ordering).
44+
* Use legacy image effect shaders and unlit shader graphs if you wish (To be honest I didn't do anything, it worked out of the box so I added it to the features list).
45+
* Use it with Camera Stacking.
46+
* Use the `SceneNormals` feature (adapted from [Outline Study](https://github.com/chrisloop/outlinestudy) by [Christopher Sims](https://github.com/chrisloop)) to grab the scene normals onto a texture.
47+
48+
Features that are almost untested:
49+
* It should be compatible with MultiPass XR but it is tested with Mock HMD Loader only so I can't guarantee that it works on an actual headset.
50+
* 2D renderers don't support renderer features yet. However, you can use camera stacking and stack a camera with a forward renderer on top of the camera with the 2D renderer. The forward renderer will apply the post processing to the result of the 2D renderer. I tried it and it worked but I didn't heavily test it yet.
51+
52+
## Known Issues
53+
54+
* It failed to work with Single-Pass Instanced Stereo Rendering. Actually, all of URP didn't work for me in this mode so I don't the reason behind this issue.
55+
* The `SceneNormals` renderer feature uses the override material in the drawing settings. This means that it does not copy the parameters of the original material such as normal maps and alpha clipping. This should be solved in URP 10.0 with the release of the `DepthNormalsPass` made for the SSAO feature.
56+
5257
## How To Install
5358

5459
Follow the instructions from the Unity manual on [Installing from a Git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html) and insert the url: https://github.com/yahiaetman/urp-custom-pps.git then wait for the package to be downloaded and installed into the project.
@@ -218,5 +223,9 @@ Other stuff we didn't explain but can be seen in the samples:
218223
* Create persistent render targets inside the renderer (see [AfterImageEffect.cs](Samples~/Examples/Scripts/PostProcessing/AfterImageEffect.cs)).
219224
* Use a shader graph `Unlit shader` to create a post processing effect (see [GlitchEffect.cs](Samples~/Examples/Scripts/PostProcessing/GlitchEffect.cs)).
220225

226+
## Issues & Pull Requests
227+
228+
Don't hesitate to [open an issue](https://github.com/yahiaetman/urp-custom-pps/issues/new/choose) if you find any bugs or have any feature requests. I can't promise to quickly reply but I will do it as soon as I can. [Pull requests](https://github.com/yahiaetman/urp-custom-pps/compare) are also very welcome.
229+
221230
## License
222231
[MIT License](LICENSE.md)

0 commit comments

Comments
 (0)