docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DepthOfField

    Inheritance
    object
    Object
    ScriptableObject
    VolumeComponent
    DepthOfField
    Implements
    IPostProcessComponent
    Inherited Members
    VolumeComponent.active
    VolumeComponent.Override(VolumeComponent, float)
    VolumeComponent.SetAllOverridesTo(bool)
    VolumeComponent.GetHashCode()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    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.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, IPostProcessComponent

    Fields

    aperture

    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

    Declaration
    [Tooltip("The number of aperture blades.")]
    public ClampedIntParameter bladeCount
    Field Value
    Type Description
    ClampedIntParameter

    bladeCurvature

    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

    Declaration
    [Tooltip("The rotation of aperture blades in degrees.")]
    public ClampedFloatParameter bladeRotation
    Field Value
    Type Description
    ClampedFloatParameter

    focalLength

    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

    Declaration
    [Tooltip("The distance to the point of focus.")]
    public MinFloatParameter focusDistance
    Field Value
    Type Description
    MinFloatParameter

    gaussianEnd

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

    gaussianMaxRadius

    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

    Declaration
    [Tooltip("The distance at which the blurring will start.")]
    public MinFloatParameter gaussianStart
    Field Value
    Type Description
    MinFloatParameter

    highQualitySampling

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

    mode

    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
    bool

    IsTileCompatible()

    Declaration
    public bool IsTileCompatible()
    Returns
    Type Description
    bool

    Implements

    IPostProcessComponent
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)