SSAO2RenderingPipeline

Render pipeline to produce ssao effect

Hierarchy

Index

Constructors

constructor

Find examples in Playground
  • constructor

    Parameters

    • name: string

      The rendering pipeline name

    • scene: Scene

      The scene linked to this pipeline

    • ratio: any

      The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, blurRatio: 1.0 }

    • Optional cameras: Camera[]

      The array of cameras that the rendering pipeline will be attached to

    Returns SSAO2RenderingPipeline

Properties

base

Find examples in Playground
base: number

The base color of the SSAO post-process The final result is "base + ssao" between [0, 1]

expensiveBlur

Find examples in Playground
expensiveBlur: boolean

If bilateral blur should be used

isSupported

Find examples in Playground
isSupported: boolean

If all the render effects in the pipeline are support

maxZ

Find examples in Playground
maxZ: number

Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.

minZAspect

Find examples in Playground
minZAspect: number

In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much

radius

Find examples in Playground
radius: number

The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0

samples

Find examples in Playground
samples: number

Number of samples used for the SSAO calculations. Default value is 8

textureSamples

Find examples in Playground
textureSamples: number

Number of samples to use for antialiasing

totalStrength

Find examples in Playground
totalStrength: number

The output strength of the SSAO post-process. Default value is 1.0.

Static IsSupported

Find examples in Playground
IsSupported: boolean

Support test.

Methods

addEffect

Find examples in Playground

dispose

Find examples in Playground
  • dispose(disableGeometryBufferRenderer?: boolean): void
  • Removes the internal pipeline assets and detatches the pipeline from the scene cameras

    Parameters

    • Optional disableGeometryBufferRenderer: boolean

    Returns void

getClassName

Find examples in Playground
  • getClassName(): string

serialize

Find examples in Playground
  • serialize(): any
  • Serialize the rendering pipeline (Used when exporting)

    Returns any

    the serialized object

Static Parse

Find examples in Playground
  • Parse the serialized pipeline

    Parameters

    • source: any

      Source pipeline.

    • scene: Scene

      The scene to load the pipeline to.

    • rootUrl: string

      The URL of the serialized pipeline.

    Returns SSAO2RenderingPipeline

    An instantiated pipeline from the serialized object.

Generated using TypeDoc