Class Vignette

A volume component that holds settings for the Vignette effect.

Inheritance
Object
VolumeComponent
Vignette
Inherited Members
UnityEngine.Rendering.VolumeComponent.TryGetRevertMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceTerm()
UnityEngine.Rendering.VolumeComponent.TryGetApplyMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceName(UnityEngine.Component)
Namespace: UnityEngine.Rendering.Universal
Syntax
[Serializable]
[VolumeComponentMenu("Post-processing/Vignette")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
public sealed class Vignette : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

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

color

Specifies the color of the vignette.

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

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

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

smoothness

Controls the smoothness of the vignette borders.

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

Methods

IsActive()

Declaration
public bool IsActive()
Returns
Type Description
Boolean
Implements