Class AmbientOcclusionSettings

Settings that control screen space ambient occlusion.

Constructors

  • Parameters

    • OptionalisEnabled: boolean
    • Optionalradius: number
    • Optionalbias: number
    • OptionalfadeDistance: number
    • OptionalfadeRange: number
    • Optionalintensity: number
    • Optionalpower: number
    • Optionalquality: number
    • OptionaldownscaleFactor: number
    • OptionaldirectDiffuseLightingContribution: number

    Returns AmbientOcclusionSettings

Properties

_bias: number
_directDiffuseLightingContribution: number
_downscaleFactor: number
_fadeDistance: number
_fadeRange: number
_intensity: number
_isEnabled: boolean
_power: number
_quality: number
_radius: number

Accessors

  • get bias(): number
  • Bias used to reduce false occlusion artifacts. Higher values reduce the amount of artifacts but will cause details to be lost in areas where occlusion isn't high. Valid range is roughly [0, 50].

    Returns number

  • set bias(value): void
  • Parameters

    • value: number

    Returns void

  • get directDiffuseLightingContribution(): number
  • Determines how much does ambient occlusion affect direct diffuse lighting. A value of 0 means AO has no effect on direct diffuse, while a value of 1 means the full intensity of AO is applied to it.

    Returns number

  • set directDiffuseLightingContribution(value): void
  • Parameters

    • value: number

    Returns void

  • get downscaleFactor(): number
  • Factor that scales down input render targets used for generating SSAO. This can result in major performance increase at a cost of quality. It is especially useful for high-DPI resolutions as SSAO can be cost prohibitive to run at full resolution in that case.

    Factor of 1 means the effect will run at full resolution. Each further increase of the factor halves the resolution. i.e. 2 means half-resolution and 3 means quarter-resolution.

    Returns number

  • set downscaleFactor(value): void
  • Parameters

    • value: number

    Returns void

  • get fadeDistance(): number
  • Distance (in view space, in meters) after which AO starts fading out. The fade process will happen over the range as specified by FadeRange.

    Returns number

  • set fadeDistance(value): void
  • Parameters

    • value: number

    Returns void

  • get fadeRange(): number
  • Range (in view space, in meters) in which AO fades out from 100% to 0%. AO starts fading out after the distance specified in FadeDistance.

    Returns number

  • set fadeRange(value): void
  • Parameters

    • value: number

    Returns void

  • get intensity(): number
  • Linearly scales the intensity of the AO effect. Values less than 1 make the AO effect less pronounced, and vice versa. Valid range is roughly [0.2, 2].

    Returns number

  • set intensity(value): void
  • Parameters

    • value: number

    Returns void

  • get isEnabled(): boolean
  • Enables or disables the screen space ambient occlusion effect.

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get power(): number
  • Controls how quickly the AO fall-off. A higher value means, more darkening in occluded areas, and less in open areas. The valid range is roughly [1, 4], where 1 means no extra darkening will occur.

    Returns number

  • set power(value): void
  • Parameters

    • value: number

    Returns void

  • get quality(): number
  • Quality level of generated ambient occlusion. In range [0, 4]. Higher levels yield higher quality AO at the cost of performance.

    Returns number

  • set quality(value): void
  • Parameters

    • value: number

    Returns void

  • get radius(): number
  • Radius (in world space, in meters) over which occluders are searched for. Smaller radius ensures better sampling precision but can miss occluders. Larger radius ensures far away occluders are considered but can yield lower quality or noise because of low sampling precision. Usually best to keep at around a 2m, valid range is roughly [0.05, 10.0].

    Returns number

  • set radius(value): void
  • Parameters

    • value: number

    Returns void

Methods