Changing parameters through scripting on Unity’s post processing stack V2.

For my PhD thesis I need to write an image effect that lets me configure a lens on a screen, but honestly, I can’t stop playing Archery Pro. In the calibration phase I need to modify the Image effect values through scripting.

To my surprise; there is a tutorial for doing changes in V1 that you can check here or in a forum post here but for V2 there where no guides.

Luckily enough, the forum post gave helped me out getting started to modify values on the Post Processing stack V2.

So lets say you have an image effect called “PitchTestImgEffect.cs”

using System;
using UnityEngine;
using UnityEngine.Rendering.PostProcessing;

[Serializable]
[PostProcess(typeof(PitchTestRenderer), PostProcessEvent.AfterStack, "Hidden/PitchTest", false)]
public sealed class PitchTestImgEffect : PostProcessEffectSettings {
    public FloatParameter pitch = new FloatParameter { value = 2.5f };
    [Range(0f, 90f), Tooltip("Lens rotation angle")]
    public FloatParameter rotationAngle = new FloatParameter { value = 0 };
    public TextureParameter pitchTex = new TextureParameter();
}

//This class stores the rendering part (All the logic the img effect has).
public class PitchTestRenderer : PostProcessEffectRenderer<PitchTestImgEffect> {
    public override void Render(PostProcessRenderContext context) {
        PropertySheet sheet = context.propertySheets.Get(Shader.Find("Hidden/PitchTest"));
        try{
            sheet.properties.SetFloat("_Pitch", settings.rotationAngle);
            sheet.properties.SetFloat("_RotationAngle", settings.rotationAngle);
            sheet.properties.SetTexture("_PitchTestPattern", settings.pitchTex);

            context.command.BlitFullscreenTriangle(context.source, context.destination, sheet, 0);
        }
    }
}

using System;

using UnityEngine;

using UnityEngine.Rendering.PostProcessing;

[Serializable]

[PostProcess(typeof(PitchTestRenderer), PostProcessEvent.AfterStack, "Hidden/PitchTest", false)]

public sealed class PitchTestImgEffect : PostProcessEffectSettings {

public FloatParameter pitch = new FloatParameter { value = 2.5f };

[Range(0f, 90f), Tooltip("Lens rotation angle")]

public FloatParameter rotationAngle = new FloatParameter { value = 0 };

public TextureParameter pitchTex = new TextureParameter();

}

//This class stores the rendering part (All the logic the img effect has).

public class PitchTestRenderer : PostProcessEffectRenderer<PitchTestImgEffect> {

public override void Render(PostProcessRenderContext context) {

PropertySheet sheet = context.propertySheets.Get(Shader.Find("Hidden/PitchTest"));

try{

sheet.properties.SetFloat("_Pitch", settings.rotationAngle);

sheet.properties.SetFloat("_RotationAngle", settings.rotationAngle);

sheet.properties.SetTexture("_PitchTestPattern", settings.pitchTex);

context.command.BlitFullscreenTriangle(context.source, context.destination, sheet, 0);

}

Easy enough, my image effect has 2 float values and a texture as you can see here:

What we need to do is to access the PostProcessVolume and get the PostProcessEffectSettings that contains our “PitchTestImgEffect” class, then we can modify its settings :-).

So with this script we can access the value of the pitch and set a value to it:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Rendering.PostProcessing;

public class PitchTestController : MonoBehaviour {

    private PitchTestImgEffect pitchTestSettings;

    void OnEnable () {
        PostProcessVolume volume = GetComponent<PostProcessVolume>();
        if(volume.profile == null) {
            enabled = false;
            Debug.Log("Cant load PostProcess volume");
            return;
        }

        bool foundEffectSettings = volume.profile.TryGetSettings<PitchTestImgEffect>(out pitchTestSettings);
        if(!foundEffectSettings) {
            enabled = false;
            Debug.Log("Cant load PitchTest settings");
            return;
        }

        Debug.Log("Got value: " + pitchTestSettings.pitch.GetValue<float>());//get current value
        Debug.Log("Setting value to 5");
        pitchTestSettings.pitch.SetValue(new FloatParameter() { value = 5});//<- modify the value on the img effect
    }
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.Rendering.PostProcessing;

public class PitchTestController : MonoBehaviour {

private PitchTestImgEffect pitchTestSettings;

void OnEnable () {

PostProcessVolume volume = GetComponent<PostProcessVolume>();

if(volume.profile == null) {

enabled = false;

Debug.Log("Cant load PostProcess volume");

return;

}

bool foundEffectSettings = volume.profile.TryGetSettings<PitchTestImgEffect>(out pitchTestSettings);

if(!foundEffectSettings) {

enabled = false;

Debug.Log("Cant load PitchTest settings");

return;

}

Debug.Log("Got value: " + pitchTestSettings.pitch.GetValue<float>());//get current value

Debug.Log("Setting value to 5");

pitchTestSettings.pitch.SetValue(new FloatParameter() { value = 5});//<- modify the value on the img effect

}

Hopefully this helps you out :). If it helped you, drop me a line and let me know.

Basic connections for nutrient solution system done. Now to the covers https://t.co/rLFnwISEU3

Pencil Square

blog

Changing parameters through scripting on Unity’s post processing stack V2.

5 Responses to “Changing parameters through scripting on Unity’s post processing stack V2.”

Pages

Archives

Categories

Pencil Square

Twitter: jmunozar