docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Vignette

    Inheritance
    object
    Object
    ScriptableObject
    VolumeComponent
    Vignette
    Implements
    IPostProcessComponent
    Inherited Members
    VolumeComponent.active
    VolumeComponent.Override(VolumeComponent, float)
    VolumeComponent.SetAllOverridesTo(bool)
    VolumeComponent.GetHashCode()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.Universal
    Assembly: Unity.RenderPipelines.Universal.Runtime.dll
    Syntax
    [Serializable]
    [VolumeComponentMenuForRenderPipeline("Post-processing/Vignette", new Type[] { typeof(UniversalRenderPipeline) })]
    public sealed class Vignette : VolumeComponent, IPostProcessComponent

    Fields

    center

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

    color

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

    intensity

    Declaration
    [Tooltip("Amount of vignetting on screen.")]
    public ClampedFloatParameter intensity
    Field Value
    Type Description
    ClampedFloatParameter

    rounded

    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

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

    Methods

    IsActive()

    Declaration
    public bool IsActive()
    Returns
    Type Description
    bool

    IsTileCompatible()

    Declaration
    public bool IsTileCompatible()
    Returns
    Type Description
    bool

    Implements

    IPostProcessComponent
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)