SSAORenderingPipeline

Hierarchy

Index

Constructors

constructor

  • 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

SSAOBlurHRenderEffect

SSAOBlurHRenderEffect: string

The horizontal blur PostProcess id in the pipeline

SSAOBlurVRenderEffect

SSAOBlurVRenderEffect: string

The vertical blur PostProcess id in the pipeline

SSAOCombineRenderEffect

SSAOCombineRenderEffect: string

The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)

SSAOOriginalSceneColorEffect

SSAOOriginalSceneColorEffect: string

The PassPostProcess id in the pipeline that contains the original scene color

SSAORenderEffect

SSAORenderEffect: string

The SSAO PostProcess id in the pipeline

area

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

base: number

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

fallOff

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

isSupported: boolean

radius

radius: number

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

totalStrength

totalStrength: number

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

Methods

addEffect

dispose

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

    Parameters

    • Optional disableDepthRender: boolean

    Returns void

getClassName

  • getClassName(): string

Generated using TypeDoc