Class DepthOfField
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
bladeCount
Declaration
[Tooltip("The number of aperture blades.")]
public ClampedIntParameter bladeCount
Field Value
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
bladeRotation
Declaration
[Tooltip("The rotation of aperture blades in degrees.")]
public ClampedFloatParameter bladeRotation
Field Value
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
focusDistance
Declaration
[Tooltip("The distance to the point of focus.")]
public MinFloatParameter focusDistance
Field Value
gaussianEnd
Declaration
[Tooltip("The distance at which the blurring will reach its maximum radius.")]
public MinFloatParameter gaussianEnd
Field Value
gaussianMaxRadius
Declaration
[Tooltip("The maximum radius of the gaussian blur. Values above 1 may show under-sampling artifacts.")]
public ClampedFloatParameter gaussianMaxRadius
Field Value
gaussianStart
Declaration
[Tooltip("The distance at which the blurring will start.")]
public MinFloatParameter gaussianStart
Field Value
highQualitySampling
Declaration
[Tooltip("Use higher quality sampling to reduce flickering and improve the overall blur smoothness.")]
public BoolParameter highQualitySampling
Field Value
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
Methods
IsActive()
Declaration
Returns
Implements
IsTileCompatible()
Declaration
public bool IsTileCompatible()
Returns
Implements
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.