Engine API Reference - v2.7.4
    Preparing search index...

    Interface Dof

    Properties related to Depth of Field (DOF), a technique used to simulate the optical effect where objects at certain distances appear sharp while others are blurred, enhancing the perception of focus and depth in the rendered scene.

    interface Dof {
        blurRadius: number;
        blurRingPoints: number;
        blurRings: number;
        enabled: boolean;
        focusDistance: number;
        focusRange: number;
        highQuality: boolean;
        nearBlur: boolean;
    }
    Index

    Properties

    blurRadius: number

    The radius of the blur effect, typically 2-10 range. Defaults to 3.

    blurRingPoints: number

    The number of points in each ring of the blur effect, typically 3-8 range. Defaults to 5.

    blurRings: number

    The number of rings in the blur effect, typically 3-8 range. Defaults to 4.

    enabled: boolean

    Whether DoF is enabled. Defaults to false.

    focusDistance: number

    The distance at which the focus is set. Defaults to 100.

    focusRange: number

    The range around the focus distance where the focus is sharp. Defaults to 10.

    highQuality: boolean

    Whether the high quality implementation is used. This will have a higher performance cost, but will produce better quality results. Defaults to true.

    nearBlur: boolean

    Whether the near blur is enabled. Defaults to false.