Interface SAOParams

Parameters for an SAO.

interface SAOParams {
    bias?: number;
    blendCutoff?: number;
    blendFactor?: number;
    blur?: boolean;
    debug?: SAODebugMode;
    enabled?: boolean;
    intensity?: number;
    kernelRadius?: number;
    minResolution?: number;
    numSamples?: number;
    scale?: number;
}

Properties

bias? blendCutoff? blendFactor? blur? debug? enabled? intensity? kernelRadius? minResolution? numSamples? scale?

Properties

Optionalbias

bias?: number

The SAO bias.

Default value is 0.5.

OptionalblendCutoff

blendCutoff?: number

The SAO blend cutoff.

Default value is 0.3.

OptionalblendFactor

blendFactor?: number

The SAO blend scale.

Default value is 1.0.

Optionalblur

blur?: boolean

Whether the SAO Guassian blur is enabled.

Default value is true.

Optionaldebug

debug?: SAODebugMode

Debug output mode for inspecting SAO sampling.

  • false disables debug output.
  • true or "finalFactor" shows the final post-blend SAO multiplier.
  • "linearDepth" shows normalized reconstructed view depth for visible surfaces.
  • "normal" shows a scalar encoding of the reconstructed view normal.
  • "rawOcclusion" shows the pre-blur occlusion term.
  • "blurredOcclusion" shows the post-blur occlusion term.

Default value is false.

Optionalenabled

enabled?: boolean

Whether this component is enabled. Default is false.

Optionalintensity

intensity?: number

The degree of darkening (ambient obscurance) produced by the SAO effect.

Default value is 0.15.

OptionalkernelRadius

kernelRadius?: number

Sets the maximum area that SAO takes into account when checking for possible occlusion for each fragment.

Default value is 100.0.

OptionalminResolution

minResolution?: number

The SAO minimum resolution.

Default value is 0.0.

OptionalnumSamples

numSamples?: number

The number of SAO samples.

Default value is 10.

Optionalscale

scale?: number

The SAO occlusion scale.

Default value is 1.0.

Settings

Member Visibility

On This Page

Properties