docs.unity3d.com
    Show / Hide Table of Contents

    Class LensDistortion

    A volume component that holds settings for the Lens Distortion effect.

    Inheritance
    Object
    VolumeComponent
    LensDistortion
    Inherited Members
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    [VolumeComponentMenuForRenderPipeline("Post-processing/Lens Distortion", new Type[]{typeof(HDRenderPipeline)})]
    public sealed class LensDistortion : VolumeComponent, IPostProcessComponent

    Fields

    center

    Sets the center point for the distortion.

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

    intensity

    Controls the overall strength of the distortion effect.

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

    scale

    Controls global screen scaling for the distortion effect. Use this to hide the screen borders when using a high intensity.

    Declaration
    [Tooltip("Controls global screen scaling for the distortion effect. Use this to hide the screen borders when using a high \"Intensity\".")]
    public ClampedFloatParameter scale
    Field Value
    Type Description
    ClampedFloatParameter

    xMultiplier

    Controls the distortion intensity on the x-axis. Acts as a multiplier.

    Declaration
    [Tooltip("Controls the distortion intensity on the x-axis. Acts as a multiplier.")]
    public ClampedFloatParameter xMultiplier
    Field Value
    Type Description
    ClampedFloatParameter

    yMultiplier

    Controls the distortion intensity on the x-axis. Acts as a multiplier.

    Declaration
    [Tooltip("Controls the distortion intensity on the x-axis. Acts as a multiplier.")]
    public ClampedFloatParameter yMultiplier
    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
    IPostProcessComponent.IsActive()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023