[Serializable]
[VolumeComponentMenu("Post-processing/Lens Distortion")]
[HelpURL("https://docs.unity.cn/Packages/com.unity.render-pipelines.high-definition@11.0/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
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()