Class Vignette
A volume component that holds settings for the Vignette effect.
Inheritance
VolumeComponent
Vignette
Implements
IPostProcessComponent
Inherited Members
VolumeComponent.active
VolumeComponent.displayName
VolumeComponent.parameters
VolumeComponent.GetHashCode()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.Release()
VolumeComponent.GetSourceTerm()
ScriptableObject.CreateInstance<T>()
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)
Assembly: Unity.RenderPipelines.Universal.Runtime.dll
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()
Tells if the post process needs to be rendered or not.
Declaration
Returns
Type |
Description |
bool |
true if the effect should be rendered, false otherwise.
|
Implements
UnityEngine.Rendering.IPostProcessComponent
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.