docs.unity3d.com
    Show / Hide Table of Contents

    Class ChromaticAberration

    A volume component that holds settings for the Chromatic Aberration effect.

    Inheritance
    Object
    VolumeComponent
    VolumeComponentWithQuality
    ChromaticAberration
    Inherited Members
    VolumeComponentWithQuality.quality
    VolumeComponentWithQuality.UsesQualitySettings()
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    [VolumeComponentMenu("Post-processing/Chromatic Aberration")]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@11.0/manual/Post-Processing-Chromatic-Aberration.html")]
    public sealed class ChromaticAberration : VolumeComponentWithQuality, IPostProcessComponent

    Fields

    intensity

    Controls the strength of the chromatic aberration effect.

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

    spectralLut

    Specifies a Texture which HDRP uses to shift the hue of chromatic aberrations.

    Declaration
    [Tooltip("Specifies a Texture which HDRP uses to shift the hue of chromatic aberrations.")]
    public TextureParameter spectralLut
    Field Value
    Type Description
    TextureParameter

    Properties

    maxSamples

    Controls the maximum number of samples HDRP uses to render the effect. A lower sample number results in better performance.

    Declaration
    public int maxSamples { get; set; }
    Property Value
    Type Description
    Int32

    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
    IPostProcessComponent.IsActive()
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 18 October 2021