Class SSAO2

constructor

• new SSAO2(composer, renderer, scene, camera, params?): SSAO2

• Parameters

  • composer: EffectComposer

  • renderer: WebGLRenderer

  • scene: Scene

  • camera: Camera

  • Optional params: SSAO2Params

  Returns SSAO2

effect

bias

• set bias(value): void

• An occlusion bias. Eliminates artifacts caused by depth discontinuities.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

color

• set color(value): void

• The color of the ambient occlusion.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

depthAwareUpsampling

• set depthAwareUpsampling(value): void

• Enables or disables depth-aware upsampling. Has no effect if WebGL 2 is not supported.

  Parameters

  • value: boolean

  Returns void

  Memberof

  SSAO2

distanceScaling

• set distanceScaling(value): void

• Enables or disables distance-based radius scaling.

  Parameters

  • value: boolean

  Returns void

  Memberof

  SSAO2

fade

• set fade(value): void

• Influences the smoothness of the shadows. A lower value results in higher contrast.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

intensity

• set intensity(value): void

• The intensity of the ambient occlusion.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

luminanceInfluence

• set luminanceInfluence(value): void

• Determines how much the luminance of the scene influences the ambient occlusion.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

minRadiusScale

• set minRadiusScale(value): void

• The minimum radius scale. Has no effect if distance scaling is disabled.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

radius

• set radius(value): void

• The occlusion sampling radius, expressed as a scale relative to the resolution. Range [1e-6, 1.0].

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

resolution

• set resolution(value): void

• The resolution scale.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

rings

• set rings(value): void

• The amount of spiral turns in the occlusion sampling pattern. Should be a prime number.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

samples

• set samples(value): void

• The amount of samples per pixel. Should not be a multiple of the ring count.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

worldDistanceFalloff

• set worldDistanceFalloff(value): void

• The world distance falloff. Influences the smoothness of the occlusion cutoff.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

worldDistanceThreshold

• set worldDistanceThreshold(value): void

• The world distance threshold at which the occlusion effect starts to fade out.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

worldProximityFalloff

• set worldProximityFalloff(value): void

• The world proximity falloff. Influences the smoothness of the proximity cutoff.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2

worldProximityThreshold

• set worldProximityThreshold(value): void

• The world proximity threshold at which the occlusion starts to fade out.

  Parameters

  • value: number

  Returns void

  Memberof

  SSAO2