Class LensDistortion

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

Inheritance
object
VolumeComponent
LensDistortion
Implements
Inherited Members
VolumeComponent.active
VolumeComponent.Override(VolumeComponent, float)
VolumeComponent.SetAllOverridesTo(bool)
VolumeComponent.GetHashCode()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.Release()
VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)
VolumeComponent.GetSourceTerm()
VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)
VolumeComponent.GetSourceName(Component)
VolumeComponent.displayName
VolumeComponent.parameters
Namespace: UnityEngine.Rendering.Universal
Assembly: solution.dll
Syntax
public sealed class LensDistortion : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

center

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

Declaration
public Vector2Parameter center
Field Value
Type Description
Vector2Parameter

intensity

Total distortion amount.

Declaration
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter

scale

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

Declaration
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
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
public ClampedFloatParameter yMultiplier
Field Value
Type Description
ClampedFloatParameter

Methods

IsActive()

Tells if the post process needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
bool

True if the component is active, otherwise false.

IsTileCompatible()

Tells if the post process can run the effect on-tile or if it needs a full pass.

Declaration
public bool IsTileCompatible()
Returns
Type Description
bool

True if it can run on-tile, otherwise false.

Implements