Viewer
    Preparing search index...

    Interface ISSAOEffectDefinition

    interface ISSAOEffectDefinition {
        type: SSAO;
        properties?: {
            color?: Color;
            depthPhi?: number;
            distance?: number;
            distanceIntensity?: number;
            intensity?: number;
            iterations?: number;
            lumaPhi?: number;
            normalPhi?: number;
            radius?: number;
            resolutionScale?: number;
            rings?: number;
            samples?: number;
            spp?: number;
        };
        token?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    type properties? token?

    Properties

    type: SSAO

    The type of this effect.

    properties?: {
        color?: Color;
        depthPhi?: number;
        distance?: number;
        distanceIntensity?: number;
        intensity?: number;
        iterations?: number;
        lumaPhi?: number;
        normalPhi?: number;
        radius?: number;
        resolutionScale?: number;
        rings?: number;
        samples?: number;
        spp?: number;
    }

    Type Declaration

    • Optionalcolor?: Color

      The color of the ambient occlusion. (default: black)

    • OptionaldepthPhi?: number

      Allows to adjust the influence of the depth difference in the denoising pass. (default: 2)

    • Optionaldistance?: number

      Controls the radius/size of the ambient occlusion in world units. (default: 1)

    • OptionaldistanceIntensity?: number

      Controls how fast the ambient occlusion fades away with distance in world units. (default: 1)

    • Optionalintensity?: number

      A purely artistic control for the intensity of the AO - runs the ao through the function pow(ao, intensity), which has the effect of darkening areas with more ambient occlusion. (default: 2.5)

    • Optionaliterations?: number

      The number of iterations of the denoising pass. (default: 1)

    • OptionallumaPhi?: number

      Allows to adjust the influence of the luma difference in the denoising pass. (default: 10)

    • OptionalnormalPhi?: number

      Allows to adjust the influence of the normal difference in the denoising pass. (default: 3.25)

    • Optionalradius?: number

      The radius of the poisson disk. (default: 12)

    • OptionalresolutionScale?: number

      The resolution scale of the ambient occlusion. (default: 1)

    • Optionalrings?: number

      The rings of the poisson disk. (default: 11)

    • Optionalsamples?: number

      The samples that are used in the poisson disk. (default: 16)

    • Optionalspp?: number

      The samples that are taken per pixel to compute the ambient occlusion. (default: 16)

    token?: string

    The token of the effect, is only returned by the viewer, but ignored as an input.

    Settings

    Member Visibility

    On This Page

    Properties