Class Vignette

A volume component that holds settings for the Vignette effect.

Inheritance
Object
Vignette
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
public sealed class Vignette : VolumeComponent, IPostProcessComponent

Fields

center

Sets the center point for the vignette.

Declaration
public Vector2Parameter center
Field Value
Type Description
Vector2Parameter

color

Specifies the color of the vignette.

Declaration
public ColorParameter color
Field Value
Type Description
ColorParameter

intensity

Controls the strength of the vignette effect.

Declaration
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter

mask

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

Declaration
public TextureParameter mask
Field Value
Type Description
TextureParameter

mode

Specifies the mode HDRP uses to display the vignette effect.

Declaration
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
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
public BoolParameter rounded
Field Value
Type Description
BoolParameter

roundness

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

Declaration
public ClampedFloatParameter roundness
Field Value
Type Description
ClampedFloatParameter

smoothness

Controls the smoothness of the vignette borders.

Declaration
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
Boolean

true if the effect should be rendered, false otherwise.
Implements