SSAORenderingPipeline

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, combineRatio: 1.0 }

    • Optional cameras: Camera[]

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

    Returns SSAORenderingPipeline

Properties

area

Find examples in Playground
area: number

Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel Must not be equal to fallOff and superior to fallOff. Default value is 0.975

base

Find examples in Playground
base: number

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

fallOff

Find examples in Playground
fallOff: number

Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel Must not be equal to area and inferior to area. Default value is 0.0

isSupported

Find examples in Playground
isSupported: boolean

If all the render effects in the pipeline are support

radius

Find examples in Playground
radius: number

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

totalStrength

Find examples in Playground
totalStrength: number

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

Methods

addEffect

Find examples in Playground

dispose

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

    Parameters

    • Optional disableDepthRender: boolean

    Returns void

getClassName

Find examples in Playground
  • getClassName(): string

Generated using TypeDoc