Class LensDistortion

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

Inheritance
Object
VolumeComponent
LensDistortion
Inherited Members
UnityEngine.Rendering.VolumeComponent.TryGetRevertMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceTerm()
UnityEngine.Rendering.VolumeComponent.TryGetApplyMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceName(UnityEngine.Component)
Namespace: UnityEngine.Rendering.Universal
Syntax
[Serializable]
[VolumeComponentMenu("Post-processing/Lens Distortion")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
public sealed class LensDistortion : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

center

Distortion center point. 0.5,0.5 is center of the screen

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

intensity

Total distortion amount.

Declaration
[Tooltip("Total distortion amount.")]
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 high &quot;Intensity.&quot;

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

xMultiplier

Intensity multiplier on X axis. Set it to 0 to disable distortion on this axis.

Declaration
[Tooltip("Intensity multiplier on X axis. Set it to 0 to disable distortion on this axis.")]
public ClampedFloatParameter xMultiplier
Field Value
Type Description
ClampedFloatParameter

yMultiplier

Intensity multiplier on Y axis. Set it to 0 to disable distortion on this axis.

Declaration
[Tooltip("Intensity multiplier on Y axis. Set it to 0 to disable distortion on this axis.")]
public ClampedFloatParameter yMultiplier
Field Value
Type Description
ClampedFloatParameter

Methods

IsActive()

Declaration
public bool IsActive()
Returns
Type Description
Boolean
Implements