ColinLeung-NiloCat / UnityURPUnlitScreenSpaceDecalShader

Unity unlit screen space decal shader for URP. Just create a new material using this shader, then assign it to a new unity cube GameObject = DONE, now you have unlit decal working in URP
MIT License
1.22k stars 130 forks source link
decal graphics screenspace shader srp unity unity3d urp

UnityURP-Unlit ScreenSpaceDecal Shader(SRP batcher compatible)

Before adding decal screenshot

After adding decal screenshot

Before adding decal screenshot

After adding decal(multiply blend mode) screenshot

Each decal is just a unity cube GameObject, using material of this shader, nothing else. screenshot

Before adding decal screenshot

After adding decal: (alpha blending) screenshot (additive) screenshot (multiply) screenshot (alpha blending, tint to HDR red, extra multiply alpha to rgb in shader) screenshot (opaque) screenshot (each decal is just a unity cube GameObject) screenshot (multiply) screenshot (additive, blue tint) screenshot

(no tiling) screenshot (add 4x4 tiling) screenshot (add 4x4 tiling , alpha 2 - 1) screenshot (add 4x4 tiling , alpha 4 - 3) screenshot (add 4x4 tiling , alpha * 10 - 9) screenshot

When should I use this shader?

if you need to render bullet holes, dirt/logo on wall, 3D projected UI, explosion dirt mark, blood splat, projected texture fake shadow(blob shadow) ..... and the receiver surface is not flat(can't use a flat transparent quad to finish the job), try using this shader.

How to use this shader in my project?

  1. clone the shader to your project
  2. First, you must enable depth texture in URP's setting (search UniversalRP-HighQuality in your project)
  3. First, you must enable depth texture in URP's setting (search UniversalRP-HighQuality in your project)
  4. First, you must enable depth texture in URP's setting (search UniversalRP-HighQuality in your project)
  5. First, you must enable depth texture in URP's setting (search UniversalRP-HighQuality in your project)
  6. First, you must enable depth texture in URP's setting (search UniversalRP-HighQuality in your project) screenshot
  7. create a new material using that shader (right click on the shader->Create->Material)
  8. assign any texture to material's Texture slot
  9. create a new unity default cube GameObject in scene (in Hierarchy window, click +/3D Object/Cube)
  10. apply that material to Cube Gameobject's MeshRenderer component's material slot (drag material on the cube)
  11. edit the GameObject's transform so the local forward vector (blue Z arrow) is pointing to scene objects, and the cube is intersecting scene objects
  12. you should now see your new decal cube is rendering correctly(projecting alpha blending texture to scene objects correctly)
  13. (optional)edit _Color / BlendingOption, according to your needs
  14. (optional)finally make the cube as thin/small as possible to improve GPU rendering performance

Requirement when using this shader

Editor System Requirements

I can see decal in scene window, but not in game window

you must enable depth texture in URP's setting (search UniversalRP-HighQuality in your project)
If it still doesn't work, try adding an empty renderer feature.

I can see decal in editor(both scene and game window), but not in mobile build

search "UniversalRP-MediumQuality" and "UniversalRP-LowQuality" in your project, turn on depth texture. screenshot

My Game use orthographic camera, but the decal shader doesn't work

enable toggle "_SupportOrthographicCamera" in material

I can see decal renders correctly, but which BlendMode should I use in the material inspector?

Blend SrcAlpha OneMinusSrcAlpha // Traditional transparency

Blend One OneMinusSrcAlpha // Premultiplied transparency

Blend One One // Additive

Blend OneMinusDstColor One // Soft Additive

Blend DstColor Zero // Multiplicative

Blend DstColor SrcColor // 2x Multiplicative

https://docs.unity3d.com/Manual/SL-Blend.html

Is this shader optimized for mobile?

This screen space decal shader is SRP batcher compatible, so you can put lots of decals in scene without hurting CPU performance too much(even all decals use different materials).

Also, this shader moved all matrix mul() inside the fragment shader to vertex shader, so you can put lots of decals in scene without hurting GPU performance too much, as long as they are thin, small and don't overlap(overdraw).

I need LOTs of decals in my game, is there performance best practice?

if you do every optimzations listed above, and your game is still slow due to this decal shader, please send me an issue, I will treat it as bug.

Implementation Reference

Low Complexity, High Fidelity: The Rendering of INSIDE's optimized decal shader

https://youtu.be/RdN06E6Xn9E?t=2153

Screen Space Decals in Warhammer 40,000: Space Marine

https://www.slideshare.net/blindrenderer/screen-space-decals-in-warhammer-40000-space-marine-14699854?fbclid=IwAR2X6yYeWmDiz1Ho4labx3zA3GATpC7fi5qNkzjEj-MYTOBpXnkIsnA3T-A