Class DepthOfFieldSettings

Contains settings for Depth Of Field effect rendering.

System.Object
DepthOfFieldSettings
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class DepthOfFieldSettings : ValueType

Fields

BlurStrength

The blur intensity in the out-of-focus areas. Allows reducing the blur amount by scaling down the Gaussian Blur radius. Normalized to range 0-1.

Declaration
[Limit(0F, 1F, 0.01F)]
[EditorOrder(1)]
public float BlurStrength
Field Value
System.Single

BokehBlurThreshold

Depth of Field bokeh shape blur threshold.

Declaration
[Limit(0F, 1F, 0.001F)]
[EditorOrder(13)]
public float BokehBlurThreshold
Field Value
System.Single

BokehBrightness

Controls brightness of the bokeh shapes. Can be used to fade them or make more intense.

Declaration
[Limit(0F, 10F, 0.01F)]
[EditorOrder(9)]
public float BokehBrightness
Field Value
System.Single

BokehBrightnessThreshold

The minimum pixel brightness to create the bokeh. Pixels with lower brightness will be skipped.

Declaration
[Limit(0F, 10000F, 0.01F)]
[EditorOrder(12)]
public float BokehBrightnessThreshold
Field Value
System.Single

BokehDepthCutoff

Controls bokeh shape generation for depth discontinuities.

Declaration
[Limit(0F, 5F, 0.001F)]
[EditorOrder(15)]
public float BokehDepthCutoff
Field Value
System.Single

BokehEnabled

If checked, bokeh shapes will be rendered.

Declaration
[EditorOrder(7)]
public bool BokehEnabled
Field Value
System.Boolean

BokehFalloff

Controls bokeh shape brightness falloff. Higher values reduce bokeh visibility.

Declaration
[Limit(0F, 2F, 0.001F)]
[EditorOrder(14)]
public float BokehFalloff
Field Value
System.Single

BokehShape

Defines the type of the bokeh shapes.

Declaration
[EditorOrder(10)]
public BokehShapeType BokehShape
Field Value
BokehShapeType

BokehShapeCustom

If BokehShape is set to Custom, then this texture will be used for the bokeh shapes. For best performance, use small, compressed, grayscale textures (for instance 32px).

Declaration
[EditorOrder(11)]
public Texture BokehShapeCustom
Field Value
Texture

BokehSize

Controls size of the bokeh shapes.

Declaration
[Limit(0F, 200F, 0.1F)]
[EditorOrder(8)]
public float BokehSize
Field Value
System.Single

DepthLimit

The distance in World Units which describes border after that there is no blur (useful to disable DoF on sky). Use 0 to disable that feature.

Declaration
[Limit(0F, 3.40282347E+38F, 2F)]
[EditorOrder(6)]
public float DepthLimit
Field Value
System.Single

Enabled

If checked, the depth of field effect will be visible.

Declaration
[EditorOrder(0)]
public bool Enabled
Field Value
System.Boolean

FarTransitionRange

The distance in World Units from the focal region on the side farther from the camera over which the scene transitions from focused to blurred.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorOrder(5)]
public float FarTransitionRange
Field Value
System.Single

FocalDistance

The distance in World Units from the camera that acts as the center of the region where the scene is perfectly in focus and no blurring occurs.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorOrder(2)]
public float FocalDistance
Field Value
System.Single

FocalRegion

The distance in World Units beyond the focal distance where the scene is perfectly in focus and no blurring occurs.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorOrder(3)]
public float FocalRegion
Field Value
System.Single

NearTransitionRange

The distance in World Units from the focal region on the side nearer to the camera over which the scene transitions from focused to blurred.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorOrder(4)]
public float NearTransitionRange
Field Value
System.Single

Properties

Default

The default DepthOfFieldSettings.

Declaration
public static DepthOfFieldSettings Default { get; }
Property Value
DepthOfFieldSettings

Extension Methods