Class Vignette

A volume component that holds settings for the Vignette effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
Vignette
Implements
Inherited Members
VolumeComponent.active
VolumeComponent.displayName
VolumeComponent.parameters
VolumeComponent.GetHashCode()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.Release()
VolumeComponent.GetSourceTerm()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Scene)
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.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenuForRenderPipeline("Post-processing/Vignette", new Type[] { typeof(HDRenderPipeline) })]
public sealed class Vignette : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

center

Sets the center point for the vignette.

Declaration
[Tooltip("Sets the center point for the vignette.")]
public Vector2Parameter center
Field Value
Type Description
Vector2Parameter

color

Specifies the color of the vignette.

Declaration
[Tooltip("Specifies the color of the vignette.")]
public ColorParameter color
Field Value
Type Description
ColorParameter

intensity

Controls the strength of the vignette effect.

Declaration
[Tooltip("Controls the strength of the vignette effect.")]
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter

mask

Specifies a black and white mask Texture to use as a vignette.

Declaration
[Tooltip("Specifies a black and white mask Texture to use as a vignette.")]
public Texture2DParameter mask
Field Value
Type Description
Texture2DParameter

mode

Specifies the mode HDRP uses to display the vignette effect.

Declaration
[Tooltip("Specifies the mode HDRP uses to display the vignette effect.")]
public VignetteModeParameter mode
Field Value
Type Description
VignetteModeParameter
See Also

opacity

Controls the opacity of the mask vignette. Lower values result in a more transparent vignette.

Declaration
[Range(0, 1)]
[Tooltip("Controls the opacity of the mask vignette. Lower values result in a more transparent vignette.")]
public ClampedFloatParameter opacity
Field Value
Type Description
ClampedFloatParameter

rounded

When enabled, the vignette is perfectly round. When disabled, the vignette matches shape with the current aspect ratio.

Declaration
[Tooltip("When enabled, the vignette is perfectly round. When disabled, the vignette matches shape with the current aspect ratio.")]
public BoolParameter rounded
Field Value
Type Description
BoolParameter

roundness

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

Declaration
[Tooltip("Controls how round the vignette is, lower values result in a more square vignette.")]
public ClampedFloatParameter roundness
Field Value
Type Description
ClampedFloatParameter

smoothness

Controls the smoothness of the vignette borders.

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

Methods

IsActive()

Tells if the effect needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
bool

true if the effect should be rendered, false otherwise.

Implements