Custom Post Process

The High Definition Render Pipeline (HDRP) allows you to write your own post-processing effects that automatically integrate into Volume. A custom effect needs two files. A C# Custom Post Process(C# file) and an associated FullScreen Shader (HLSL file). You can generate a template of each:

  • C# Custom Post Process: Right click in the Assets folder and select Create > Rendering > C# Post Process Volume.

  • FullScreen Shader: Right click in the Assets folder and select Create > Shader > HDRP > Post Process.

Note that by default, your custom effect does not run if you just add it to a Volume. You also need to add the effect to your Project's list of supported effects. (it's the same list used to order the effect, see the Effect Ordering section).

Example

This example shows you how to create a grayscale effect. To get started:

  1. Create a C# Custom Post Process file (right click in the Assets folder: Create > Rendering > C# Post Process Volume) and call it GrayScale. Note that, because of how serialization works in Unity, the file name and the class name must be identical or Unity does not serialize it properly.

  2. Copy the example code from the GrayScale C# script section into your** C# Post Process Volume**.

  3. Create a full screen post-process Shader (right click in the Assets folder: Create > Shader > HDRP > Post Process) and call it GrayScale.

  4. Copy the example code from the GrayScale Shader section into your post-process Shader.

  5. Optionally, you can create a custom editor for your post-processing effect. For information on how to do this, see custom editor.

GrayScale C# script

This is the C# Custom Post Process file. Custom post-process effects store both configuration data and logic in the same class. To create the settings for the effect, you can either use a pre-existing class that inherits from VolumeParameter, or, if you want to use a property that the pre-existing classes do not include, create a new class that inherits from VolumeParameter.

using UnityEngine;

using UnityEngine.Rendering;

using UnityEngine.Rendering.HighDefinition;

using System;

[Serializable, VolumeComponentMenu("Post-processing/Custom/GrayScale")]

public sealed class GrayScale : CustomPostProcessVolumeComponent, IPostProcessComponent

{

    [Tooltip("Controls the intensity of the effect.")]

    public ClampedFloatParameter intensity = new ClampedFloatParameter(0f, 0f, 1f);

    Material m_Material;

    public bool IsActive() => m_Material != null && intensity.value > 0f;

    public override CustomPostProcessInjectionPoint injectionPoint => CustomPostProcessInjectionPoint.AfterPostProcess;

    public override void Setup()

    {

        if (Shader.Find("Hidden/Shader/GrayScale") != null)

            m_Material = new Material(Shader.Find("Hidden/Shader/GrayScale"));

    }

    public override void Render(CommandBuffer cmd, HDCamera camera, RTHandle source, RTHandle destination)

    {

        if (m_Material == null)

            return;

        m_Material.SetFloat("_Intensity", intensity.value);

        m_Material.SetTexture("_InputTexture", source);

        HDUtils.DrawFullScreen(cmd, m_Material, destination);

    }

    public override void Cleanup() => CoreUtils.Destroy(m_Material);

}

Firstly, the example code uses a ClampedFloatParameter which is a type that you may not be familiar with. This type is a float which you can clamp to a range. In the constructor:

  • The first parameter is the default value of the property.

  • The second parameter represents the minimum value to clamp the property to.

  • The third parameter represents the maximum value to clamp the property to.

Next, there is the IsActive() function. HDRP calls this function before the Render function make sure it is possible to process the effect. If this function returns false, HDRP does not process the effect. It is good practice to check every property configuration where the effect either breaks or does nothing. In this example, IsActive() makes sure that it can find the GrayScale.shader and that the intensity is greater than 0.

The injectionPoint override allows you to specify where in the pipeline HDRP executes the effect. There are currently three injection points:

  • AfterOpaqueAndSky.

  • BeforePostProcess.

  • AfterPostProcess.

For more detailed information on where HDRP injects the custom post-process passes, see the following diagram:

Now there are the Setup, Render, and Cleanup functions. These are here to respectively allocate, use, and release the resources that the effect needs. The only resource that the example uses is a single Material. The example creates the Material in Setup and, in Cleanup, uses CoreUtils.Destroy() to release the Material. In the Render function, you have access to a CommandBuffer which you can use to enqueue tasks for HDRP to execute. Here you can use HDUtils.DrawFullScreen to render a fullscreen quad. It uses the CommandBuffer and Material that you pass in then blits the result to the destination RTHandle.

GrayScale Shader

HDRP gives you total control over the vertex and fragment Shader so you can edit both of them to suit your needs. Note that there are a number of utility functions in Common.hlsl and Color.hlsl that the Shader includes by default. This means that you have access to these utility functions in your effect. For example, the GrayScale Shader uses the Luminance() function to convert a linear RGB value to its luminance equivalent.

Shader "Hidden/Shader/GrayScale"

{

    HLSLINCLUDE

    #pragma target 4.5

    #pragma only_renderers d3d11 ps4 xboxone vulkan metal switch

    #include "Packages/com.unity.render-pipelines.core/ShaderLibrary/Common.hlsl"

    #include "Packages/com.unity.render-pipelines.core/ShaderLibrary/Color.hlsl"

    #include "Packages/com.unity.render-pipelines.high-definition/Runtime/ShaderLibrary/ShaderVariables.hlsl"

    #include "Packages/com.unity.render-pipelines.high-definition/Runtime/PostProcessing/Shaders/FXAA.hlsl"

    #include "Packages/com.unity.render-pipelines.high-definition/Runtime/PostProcessing/Shaders/RTUpscale.hlsl"

    struct Attributes

    {

        uint vertexID : SV_VertexID;

        UNITY_VERTEX_INPUT_INSTANCE_ID

    };

    struct Varyings

    {

        float4 positionCS : SV_POSITION;

        float2 texcoord   : TEXCOORD0;

        UNITY_VERTEX_OUTPUT_STEREO

    };

    Varyings Vert(Attributes input)

    {

        Varyings output;

        UNITY_SETUP_INSTANCE_ID(input);

        UNITY_INITIALIZE_VERTEX_OUTPUT_STEREO(output);

        output.positionCS = GetFullScreenTriangleVertexPosition(input.vertexID);

        output.texcoord = GetFullScreenTriangleTexCoord(input.vertexID);

        return output;

    }

    // List of properties to control your post process effect

    float _Intensity;

    TEXTURE2D_X(_InputTexture);

    float4 CustomPostProcess(Varyings input) : SV_Target

    {

        UNITY_SETUP_STEREO_EYE_INDEX_POST_VERTEX(input);

        uint2 positionSS = input.texcoord * _ScreenSize.xy;

        float3 outColor = LOAD_TEXTURE2D_X(_InputTexture, positionSS).xyz;

        return float4(lerp(outColor, Luminance(outColor).xxx, _Intensity), 1);

    }

    ENDHLSL

    SubShader

    {

        Pass

        {

            Name "GrayScale"

            ZWrite Off

            ZTest Always

            Blend Off

            Cull Off

            HLSLPROGRAM

                #pragma fragment CustomPostProcess

                #pragma vertex Vert

            ENDHLSL

        }

    }

    Fallback Off

}

If none of your Scenes reference the Shader, Unity does not build the Shader and the effect does not work when you run your application outside of the Editor. To resolve this, either add the Shader to a Resources folder, or go to Edit > Project Settings > Graphics and add the Shader to the Always Included Shaders list.

Note that, if you use the clip() instruction in your Shader, your effect breaks.

Shader inputs

By default, the Shader template provides you with the following inputs:

Input description
positionCS The clip space position of the pixel. This value is between 0 and the current screen size.
texcoord The full screen UV coordinate. This value is between 0 and 1.
_InputTexture The source Texture. The GrayScale C# script passes this to the Shader.
_Intensity The intensity of the effect. The GrayScale C# script passes this to the Shader.

Effect ordering

HDRP allows you to customize the order of your custom post-processing effect at each injection point. To order your effects:

  1. Go to Edit > Project Settings and select the HDRP Default Settings tab.

  2. Scroll down until you find the Custom Post Process Orders section. This section contains three lists, one for each injection point.

  3. Add your custom effects to these lists so that HDRP can render them.

HDRP processes effects from the top of the list to the bottom and the order of execution for each list is:

  1. Before Transparent.

  2. Before Post Process.

  3. After Post Process.

Custom editor

By default, Unity automatically creates an editor for classes but, if you want more control over how Unity displays certain properties, you can create a custom editor. If you do create a custom editor script, make sure to put it in a folder named Editor.

The following is an example of a custom editor for the GrayScale effect:


using UnityEditor.Rendering;

using UnityEngine;

using UnityEngine.Rendering.HighDefinition;

using UnityEditor;

[VolumeComponentEditor(typeof(GrayScale))]

sealed class GrayScaleEditor : VolumeComponentEditor

{

    SerializedDataParameter m_Intensity;

    public override bool hasAdvancedMode => false;

    public override void OnEnable()

    {

        base.OnEnable();

        var o = new PropertyFetcher<GrayScale>(serializedObject);

        m_Intensity = Unpack(o.Find(x => x.intensity));

    }

    public override void OnInspectorGUI()

    {

        PropertyField(m_Intensity);

    }

}

This custom editor is not really useful as it produces the same result as the editor that Unity creates. Custom Volume component editors also support a more options button. To add it, you have to set hasAdvancedMode override to true. Then, inside the OnInspectorGUI, you can use the isInAdvancedMode boolean to display more properties.

TroubleShooting

If your effect does not display correctly:

  • In your Project Settings, make sure this effect is listed under one of the post process order lists (see Effect Ordering).

  • Check that your effect's Shader compiles and that the reference to the Material in your post process Volume is not null.

  • In the Volume that contains your post process, make sure that it has a high enough priority and that your Camera is inside its bounds.