Class DepthOfField

A volume component that holds settings for the Depth Of Field effect.

Inheritance

object

Object

ScriptableObject

VolumeComponent

DepthOfField

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, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

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.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

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]
[VolumeComponentMenuForRenderPipeline("Post-processing/Depth Of Field", new Type[] { typeof(UniversalRenderPipeline) })]
public sealed class DepthOfField : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

aperture

The ratio of aperture (known as f-stop or f-number). The smaller the value is, the shallower the depth of field is.

Declaration

[Tooltip("The ratio of aperture (known as f-stop or f-number). The smaller the value is, the shallower the depth of field is.")]
public ClampedFloatParameter aperture

Field Value

Type	Description
ClampedFloatParameter

bladeCount

The number of aperture blades.

Declaration

[Tooltip("The number of aperture blades.")]
public ClampedIntParameter bladeCount

Field Value

Type	Description
ClampedIntParameter

bladeCurvature

The curvature of aperture blades. The smaller the value is, the more visible aperture blades are. A value of 1 will make the bokeh perfectly circular.

Declaration

[Tooltip("The curvature of aperture blades. The smaller the value is, the more visible aperture blades are. A value of 1 will make the bokeh perfectly circular.")]
public ClampedFloatParameter bladeCurvature

Field Value

Type	Description
ClampedFloatParameter

bladeRotation

The rotation of aperture blades in degrees.

Declaration

[Tooltip("The rotation of aperture blades in degrees.")]
public ClampedFloatParameter bladeRotation

Field Value

Type	Description
ClampedFloatParameter

focalLength

The distance between the lens and the film. The larger the value is, the shallower the depth of field is.

Declaration

[Tooltip("The distance between the lens and the film. The larger the value is, the shallower the depth of field is.")]
public ClampedFloatParameter focalLength

Field Value

Type	Description
ClampedFloatParameter

focusDistance

The distance to the point of focus.

Declaration

[Tooltip("The distance to the point of focus.")]
public MinFloatParameter focusDistance

Field Value

Type	Description
MinFloatParameter

gaussianEnd

The distance at which the blurring will reach its maximum radius.

Declaration

[Tooltip("The distance at which the blurring will reach its maximum radius.")]
public MinFloatParameter gaussianEnd

Field Value

Type	Description
MinFloatParameter

gaussianMaxRadius

The maximum radius of the gaussian blur. Values above 1 may show under-sampling artifacts.

Declaration

[Tooltip("The maximum radius of the gaussian blur. Values above 1 may show under-sampling artifacts.")]
public ClampedFloatParameter gaussianMaxRadius

Field Value

Type	Description
ClampedFloatParameter

gaussianStart

The distance at which the blurring will start.

Declaration

[Tooltip("The distance at which the blurring will start.")]
public MinFloatParameter gaussianStart

Field Value

Type	Description
MinFloatParameter

highQualitySampling

Use higher quality sampling to reduce flickering and improve the overall blur smoothness.

Declaration

[Tooltip("Use higher quality sampling to reduce flickering and improve the overall blur smoothness.")]
public BoolParameter highQualitySampling

Field Value

Type	Description
BoolParameter

mode

Use this to select Focusing modes for the depth of field effect.

Declaration

[Tooltip("Use \"Gaussian\" for a faster but non physical depth of field; \"Bokeh\" for a more realistic but slower depth of field.")]
public DepthOfFieldModeParameter mode

Field Value

Type	Description
DepthOfFieldModeParameter

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

IApplyRevertPropertyContextMenuItemProvider

IPostProcessComponent