Class Vignette

A volume component that holds settings for the Vignette effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
Vignette
Implements
Inherited Members
ScriptableObject.CreateInstance<T>()
Object.GetEntityId()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.Universal
Assembly: Unity.RenderPipelines.Universal.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenu("Post-processing/Vignette")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
public sealed class Vignette : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent
Remarks

You can add VolumeComponent to a VolumeProfile in the Editor to apply a Vignette post-processing effect.

Examples

This sample code shows how settings can be retrieved and modified in runtime:

using System;
using UnityEngine;
using UnityEngine.Rendering;
using UnityEngine.Rendering.Universal;

public class ModifyVolumeComponent : MonoBehaviour
{
[SerializeField] VolumeProfile volumeProfile;
[SerializeField] VolumeSettings volumeSettings;


private bool m_HasRetrievedVolumeComponent;
private Vignette m_VolumeComponent;

[Serializable]
private struct VolumeSettings
{
    public bool active;
    public ColorParameter color;
    public Vector2Parameter center;
    public ClampedFloatParameter intensity;
    public ClampedFloatParameter smoothness;
    public BoolParameter rounded;


    public void SetVolumeComponentSettings(ref Vignette volumeComponent)
    {
        volumeComponent.active = active;
        volumeComponent.color = color;
        volumeComponent.center = center;
        volumeComponent.intensity = intensity;
        volumeComponent.smoothness = smoothness;
        volumeComponent.rounded = rounded;
    }

    public void GetVolumeComponentSettings(ref Vignette volumeComponent)
    {
        active = volumeComponent.active;
        color = volumeComponent.color;
        center = volumeComponent.center;
        intensity = volumeComponent.intensity;
        smoothness = volumeComponent.smoothness;
        rounded = volumeComponent.rounded;
    }
}

private void Start()
{
    m_HasRetrievedVolumeComponent = GetVolumeComponent(in volumeProfile, ref m_VolumeComponent);
    if (m_HasRetrievedVolumeComponent)
        volumeSettings.GetVolumeComponentSettings(ref m_VolumeComponent);
}

private void Update()
{
    if (!m_HasRetrievedVolumeComponent)
        return;

    volumeSettings.SetVolumeComponentSettings(ref m_VolumeComponent);
}

private static bool GetVolumeComponent(in VolumeProfile volumeProfile, ref Vignette volumeComponent)
{
    if (volumeComponent != null)
        return true;

    if (volumeProfile == null)
    {
        Debug.LogError("ModifyVolumeComponent.GetVolumeComponent():\nvolumeProfile has not been assigned.");
        return false;
    }

    volumeProfile.TryGet(out Vignette component);
    if (component == null)
    {
        Debug.LogError($"ModifyVolumeComponent.GetVolumeComponent():\nMissing component in the \"{volumeProfile.name}\" VolumeProfile ");
        return false;
    }

    volumeComponent = component;
    return true;
}



}

Fields

center

Sets the center point for the vignette.

Declaration
[Tooltip("Sets the vignette center point (screen center is [0.5,0.5]).")]
public Vector2Parameter center
Field Value
Type Description
Vector2Parameter
See Also

color

Specifies the color of the vignette.

Declaration
[Tooltip("Vignette color.")]
public ColorParameter color
Field Value
Type Description
ColorParameter
See Also

intensity

Controls the strength of the vignette effect.

Declaration
[Tooltip("Use the slider to set the strength of the Vignette effect.")]
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter
See Also

rounded

Controls how round the vignette is, lower values result in a more square vignette.

Declaration
[Tooltip("Should the vignette be perfectly round or be dependent on the current aspect ratio?")]
public BoolParameter rounded
Field Value
Type Description
BoolParameter
See Also

smoothness

Controls the smoothness of the vignette borders.

Declaration
[Tooltip("Smoothness of the vignette borders.")]
public ClampedFloatParameter smoothness
Field Value
Type Description
ClampedFloatParameter
See Also

Methods

IsActive()

Tells if the post process needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
bool

true if the effect should be rendered, false otherwise.
See Also

Implements

See Also