Class DepthOfField

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

Inheritance

object

Object

ScriptableObject

VolumeComponent

VolumeComponentWithQuality

DepthOfField

Implements

IApplyRevertPropertyContextMenuItemProvider

IPostProcessComponent

Inherited Members

VolumeComponentWithQuality.quality

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

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

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.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

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

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.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[VolumeComponentMenu("Post-processing/Depth Of Field")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class DepthOfField : VolumeComponentWithQuality, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

Name	Description
farFocusEnd	Sets the distance from the Camera at which the far field blur reaches its maximum blur radius.
farFocusStart	Sets the distance from the Camera at which the far field starts blurring.
focusDistance	The distance to the focus plane from the Camera.
focusDistanceMode	Specifies where to read the focus distance from.
focusMode	Specifies the mode that HDRP uses to set the focus for the depth of field effect.
nearFocusEnd	Sets the distance from the Camera at which the near field does not blur anymore.
nearFocusStart	Sets the distance from the Camera at which the near field blur begins to decrease in intensity.

Properties

Name	Description
farMaxBlur	Sets the maximum radius the far blur can reach.
farSampleCount	Sets the number of samples to use for the far field.
highQualityFiltering	When enabled, HDRP uses bicubic filtering instead of bilinear filtering for the depth of field effect.
limitManualRangeNearBlur	Adjust near blur CoC based on depth distance when manual, non-physical mode is used.
nearMaxBlur	Sets the maximum radius the near blur can reach.
nearSampleCount	Sets the number of samples to use for the near field.
physicallyBased	When enabled, HDRP uses a more accurate but slower physically based method to compute the depth of field effect.
resolution	Specifies the resolution at which HDRP processes the depth of field effect.

Methods

Name	Description
IsActive()	Tells if the effect needs to be rendered or not.
IsFarLayerActive()	Returns the state of the far field blur. This is only relevant when Manual is set.
IsNearLayerActive()	Returns the state of the near field blur. This is only relevant when Manual is set.