Interface DepthOfFieldParams

Parameters for a DepthOfField.

interface DepthOfFieldParams {
    farBlur?: number;
    focalRange?: number;
    focusDistance?: number;
    intensity?: number;
    nearBlur?: number;
    radius?: number;
    renderModes?: number[];
}

Properties

farBlur? focalRange? focusDistance? intensity? nearBlur? radius? renderModes?

Properties

OptionalfarBlur

farBlur?: number

Blur multiplier for geometry farther than focusDistance.

Default is 1.0.

OptionalfocalRange

focalRange?: number

Distance band around DepthOfFieldParams.focusDistance that remains mostly sharp. Smaller values create a shallower focus region.

Default is 20.

OptionalfocusDistance

focusDistance?: number

View-space distance, in world units, that remains sharp.

Default is 50.

Optionalintensity

intensity?: number

Overall blend strength for the blurred result.

Default is 0.75.

OptionalnearBlur

nearBlur?: number

Blur multiplier for geometry nearer than focusDistance.

Default is 0.25 so foreground geometry stays more legible.

Optionalradius

radius?: number

Maximum blur radius in scene pixels.

Default is 4.

OptionalrenderModes

renderModes?: number[]

Which rendering modes in which to apply depth of field.

Default value is [RealisticRender] when this effect is explicitly configured. Omitted EffectsParams.depthOfField leaves the effect inactive.

Settings

Member Visibility

On This Page

Properties