Class LensDistortion

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

Inheritance
Object
UnityEngine.Rendering.VolumeComponent
LensDistortion
Inherited Members
UnityEngine.Rendering.VolumeComponent.active
UnityEngine.Rendering.VolumeComponent.OnEnable()
UnityEngine.Rendering.VolumeComponent.OnDisable()
UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)
UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)
UnityEngine.Rendering.VolumeComponent.GetHashCode()
UnityEngine.Rendering.VolumeComponent.OnDestroy()
UnityEngine.Rendering.VolumeComponent.Release()
UnityEngine.Rendering.VolumeComponent.displayName
UnityEngine.Rendering.VolumeComponent.parameters
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@10.3/manual/Post-Processing-Lens-Distortion.html")]
public sealed class LensDistortion : VolumeComponent, IPostProcessComponent

Fields

center

Sets the center point for the distortion.

Declaration
[Tooltip("Sets the center point for the distortion.")]
public Vector2Parameter center
Field Value
Type Description
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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