delt06 / toon-rp

🌔 A Scriptable Render Pipeline (SRP) designed for toon/stylized visuals. Features custom lighting pipeline, multiple shadow algorithms, tiled lighting, Shader Graph support, and more.

Toon Render Pipeline (Unity SRP)

A Scriptable Render Pipeline (SRP) designed specifically for toon/stylized visuals.

🚧 The project is in its early stages and has not been tested in production.

⚠️ The project only supports Linear color space.

Unity Version

🔨 Developed and verified with Unity 2022.3.12f1 LTS and Core RP Library v14.0.9.

Verified Platforms

• Windows (DirectX 11, DirectX 12, Vulkan, OpenGL)
• Android (OpenGL ES 3.0+, Vulkan)
• WebGL 2.0
• XR (see XR Wiki page for full info)

⚠️ Other platforms may work but have not been tested yet.

Table of Contents

• Features
• Installation
• References
• Used Assets

Features

See the project Wiki for the full feature list.

• Full customization of the lighting ramp: arbitrary threshold, smoothness, and number of steps.

• Shadows: multiple options for soft shadows and stylization.

Crisp Shadows	Soft Shadows	Blob Shadows

• Optional Tiled Lighting (Forward+): render many realtime lights.

• Shader Graph support.

• Screen-Space and Inverted Hull Outlines.

• Stylized post-processing effects: bloom, SSAO, etc.

Installation

📝 Note: to install the package for an older Unity version, refer to the Installation page.

1. Add the package

Option 1

• Open Package Manager through Window/Package Manager
• Click "+" and choose "Add package from git URL..."
• Insert the URL:

https://github.com/Delt06/toon-rp.git?path=Packages/com.deltation.toon-rp

Option 2

Add the following line to Packages/manifest.json:

"com.deltation.toon-rp": "https://github.com/Delt06/toon-rp.git?path=Packages/com.deltation.toon-rp",

2. Create a pipeline asset

Inside the Project window, right click and select Create/Rendering/Toon Render Pipeline Asset.

3. Set the pipeline asset

Go to Edit/Project Settings/Graphics and set the field Scriptable Render Pipeline Settings with the newly created pipeline asset.

References

• Catlike Coding

Used Assets

• Quaternius - Animated Mech Pack
• Quaternius - Ultimate Stylized Nature Pack
• Quaternius - Ultimate Space Kit
• Quaternius - Toon Shooter Game Kit
• Quaternius - Cube World Kit
• Quaternius - Cyberpunk Game Kit
• Aika: Sailor Uniform
• Stone
• nidorx/matcaps: A huge library of MatCap textures in PNG and ZMT.

toon-rp's Issues

Blob Shadows: pattern

Make a pattern similar to SSAO appear on low values of blob shadows
Reference:

Vegetation

• Vegetation shader
  • https://youtu.be/iASMFba7GeI
• Grass system

Incorrect shadows on OpenGLES 3

Disable render to RT when only inverted hull outlines are used

Make inverted hull outline pass name visible in Frame Debugger

Also handle the case when the name is null/empty.

Shadow cascades

Per-Material Ramp Override

Add an option to specify a ramp override for each material (make it a shader_feature)

Clarify `SV_ClipDistance` support on all platforms in Inverted Hull Outline

Used in ToonRPInvertedHullOutline.hlsl
Implement conditional compilation based on the platform.

Or remove completely if it only decreases the performance

Turn into a package

Upgrade to Unity 2021.3.X

This will allow removing the _HAS_OUTLINES_STENCIL_LAYER workaround

Fog is broken when VSM is disabled

Material editor foldout

Make sure to handle multi-material editing

Fix SSAO requiring render to RT

This is definitely not necessary and was made as a quick fix.

SSAO was upside-down when not rendering to an RT

Make TBN matrix multiplication use `half`s

Environment lighting

Transparency

Shaded wireframe mode does not work

Shadow artifact when close to the shadow caster

Particles

Extension mechanism

Add an ability for extending the renderer at different points in its pipeline.

• Post-processing
• Other stages
  • Convert Inverted Hull Outlines
  • Convert SSAO

Shader Graph support

• Unlit
• Default
  • Shadows
  • Blob Shadows (general keyword and receive tickbox)
  • Additional Lighting: Vertex
  • Additional Lighting: Pixel
  • Additional Lighting: Pixel Tiled Lighting
  • Global vs override ramp
  • Toggle Specular and Rim
  • Toggle Environment Lighting
  • Toggle Fog
  • Outlines Stencil
  • Emission
  • SSAO
• ParticlesUnlit
  • Quad Preview
  • Soft Particles
• Move matcaps to a shader graph
• Material Override - moved to #138
• Queue Offset and Queue Control
• Receive Shadows Off (TODO) - implemented
• Check the need for ComputeMaterialNeedsUpdateHash (TODO) - removed
• Test on Android
• Test all GAPIs
• Wiki page
  • 3 targets, all their parameters and blocks
  • Built-in nodes: matcaps

Screen-Space Outlines

Implement outlines as a post-processing effect. Make sure to implement fog support.

Custom normals for the inverted hull outlines do not match the default Unity mesh importer behavior

See the difference in the antennas of the robot.

Black screen on Android OpenGLES 3

Alpha clipping

• Forward
• ShadowCaster
• DepthOnly
• DepthNormals

Camera- and World-space UI

Make all material/global property access use cached IDs

Lightweight blob shadows

Incorrect lighting when the main light is missing

Emission Color

Unlit shader

Force depth or depth-normals if certain passes are enabled

e.g. SSAO

Or issue a warning in these passes

Normal shadows (not VSM)

First feature set

• Basic Toon Shader with Global Ramp
• Crisp Anti-Aliased Ramp
• Variance Shadow Mapping
• MSAA
• VSM Blur: add a multi-compile option for simpler blur
• Fix preview lighting
• Change _buffer.SetGlobalVector(DirectionalLightColorId, Vector4.one); back to zero
• Shadows: normals bias
• Crisp AA for shadows
• HDR
• Bloom
• Stylized Bloom
• Outline (inverted hull)
• Custom normals for the inverted hull outlines
• SSAO
• Stylized SSAO (cross-hatching)
• fog: both for forward and inverted hull outline
• MSAA: depth "resolve" via a depth-only pass
• Optimize shadow coords computation (bake transformations into the matrix)

Shader Graph: Alpha to coverage

Check whether we can set this per material
https://bgolus.medium.com/anti-aliased-alpha-test-the-esoteric-alpha-to-coverage-8b177335ae4f

Non-matching Profiler.EndSample

Appeared in debug build:

Non-matching Profiler.EndSample (Every EndSample call must have a preceding BeginSample call within the same frame): Default
Previous 5 samples:
	Outline (Inverted Hull)
	GfxDeviceD3D12Base
	Default
	Outline (Inverted Hull)
	Clear Render Targets
In the scope:
	Outline (Inverted Hull)
	Main Camera
	Render Thread

Incorrect inverted hull outlines on OpenGLES 3 inside editor window

Rim lighting

Shaders only used by render passes might get stripped

Normal maps

• Forward
• Depth Normals

Instancing

`cmd.SetKeyword` does not work

We use material.SetKeyword as a workaround.

FXAA

Get rid of the second matrix multiplication in `TransformWorldToShadowCoords`

Only used for computing shadowCoords.z. Can bake everything into one matrix?

SSAO artifacts for transparents

Incorrect SSAO on OpenGLES 3

Render Scale

Shadows blink when interacting with material editor

Happens only with VSM

Pixel Art Effect

Transparent geometry flickers in material preview