Class DepthOfField

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

Inheritance
Object
VolumeComponent
DepthOfField
Inherited Members
UnityEngine.Rendering.VolumeComponent.TryGetRevertMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceTerm()
UnityEngine.Rendering.VolumeComponent.TryGetApplyMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceName(UnityEngine.Component)
Namespace: UnityEngine.Rendering.Universal
Syntax
[Serializable]
[VolumeComponentMenu("Post-processing/Depth Of Field")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
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()

Declaration
public bool IsActive()
Returns
Type Description
Boolean
Implements