Class LensDistortion

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

Inheritance

object

Object

ScriptableObject

VolumeComponent

LensDistortion

Implements

IApplyRevertPropertyContextMenuItemProvider

IPostProcessComponent

Inherited Members

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

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)

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.Universal

Assembly: Unity.RenderPipelines.Universal.Runtime.dll

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 "Intensity."

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()

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

Declaration

public bool IsActive()

Returns

Type	Description
bool	true if the effect should be rendered, false otherwise.

Implements

IApplyRevertPropertyContextMenuItemProvider

UnityEngine.Rendering.IPostProcessComponent