Class LensDistortion | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class LensDistortion

    This class holds settings for the Lens Distortion effect.

    Inheritance
    System.Object
    PostProcessEffectSettings
    LensDistortion
    Inherited Members
    PostProcessEffectSettings.active
    PostProcessEffectSettings.enabled
    PostProcessEffectSettings.SetAllOverridesTo(Boolean, Boolean)
    PostProcessEffectSettings.GetHash()
    Namespace: UnityEngine.Rendering.PostProcessing
    Syntax
    [Serializable]
    public sealed class LensDistortion : PostProcessEffectSettings

    Fields

    centerX

    The center point for the distortion (x-axis).

    Declaration
    public FloatParameter centerX
    Field Value
    Type Description
    FloatParameter

    centerY

    The center point for the distortion (y-axis).

    Declaration
    public FloatParameter centerY
    Field Value
    Type Description
    FloatParameter

    intensity

    The total amount of distortion to apply.

    Declaration
    public FloatParameter intensity
    Field Value
    Type Description
    FloatParameter

    intensityX

    Multiplies the intensity value on the x-axis. Setting this value to 0 will disable distortion on this axis.

    Declaration
    [DisplayName("X Multiplier")]
    public FloatParameter intensityX
    Field Value
    Type Description
    FloatParameter

    intensityY

    Multiplies the intensity value on the y-axis. Setting this value to 0 will disable distortion on this axis.

    Declaration
    [DisplayName("Y Multiplier")]
    public FloatParameter intensityY
    Field Value
    Type Description
    FloatParameter

    scale

    A global screen scaling factor.

    Declaration
    public FloatParameter scale
    Field Value
    Type Description
    FloatParameter

    Methods

    IsEnabledAndSupported(PostProcessRenderContext)

    Returns true if the effect is currently enabled and supported.

    Declaration
    public override bool IsEnabledAndSupported(PostProcessRenderContext context)
    Parameters
    Type Name Description
    PostProcessRenderContext context

    The current post-processing render context

    Returns
    Type Description
    System.Boolean

    true if the effect is currently enabled and supported

    Overrides
    PostProcessEffectSettings.IsEnabledAndSupported(PostProcessRenderContext)
    In This Article
    • Fields
      • centerX
      • centerY
      • intensity
      • intensityX
      • intensityY
      • scale
    • Methods
      • IsEnabledAndSupported(PostProcessRenderContext)
    Back to top
    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