API
API|
@babylonjs/core|
SSAO2RenderingPipeline

Class SSAO2RenderingPipeline

Render pipeline to produce ssao effect

Hierarchy (View Summary)

Index
constructor
inspectableCustomProperties SSAOBlurHRenderEffect SSAOBlurVRenderEffect SSAOCombineRenderEffect SSAOOriginalSceneColorEffect SSAORenderEffect uniqueId
base bilateralSamples bilateralSoften bilateralTolerance bypassBlur cameras engine epsilon expensiveBlur isSupported maxZ minZAspect name radius samples scene textureSamples totalStrength useViewportInCombineStage IsSupported
addEffect dispose getClassName isReady serialize setPrePassRenderer

  • Creates the SSAO2 rendering pipeline.

    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 }

    • Optionalcameras: Camera[]

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

    • forceGeometryBuffer: boolean | GeometryBufferRenderer = false

      Set to true if you want to use the legacy geometry buffer renderer. You can also pass an existing instance of GeometryBufferRenderer if you want to use your own geometry buffer renderer.

    • textureType: number = Constants.TEXTURETYPE_UNSIGNED_BYTE

      The texture type used by the different post processes created by SSAO (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)

    Returns SSAO2RenderingPipeline

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

SSAOBlurHRenderEffect: string = "SSAOBlurHRenderEffect"

The horizontal blur PostProcess id in the pipeline

SSAOBlurVRenderEffect: string = "SSAOBlurVRenderEffect"

The vertical blur PostProcess id in the pipeline

SSAOCombineRenderEffect: string = "SSAOCombineRenderEffect"

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

SSAOOriginalSceneColorEffect: string = "SSAOOriginalSceneColorEffect"

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

SSAORenderEffect: string = "SSAORenderEffect"

The SSAO PostProcess id in the pipeline

uniqueId: any = UniqueIdGenerator.UniqueId

Gets the unique id of the post process rendering pipeline

  • get bilateralSoften(): number

    Controls the shape of the denoising kernel used by the bilateral filter. Default value is 0.

    By default the bilateral filter acts like a box-filter, treating all samples on the same depth with equal weights. This is effective to maximize the denoising effect given a limited set of samples. However, it also often results in visible ghosting around sharp shadow regions and can spread out lines over large areas so they are no longer visible.

    Increasing this setting will make the filter pay less attention to samples further away from the center sample, reducing many artifacts but at the same time increasing noise.

    Useful value range is [0..1].

    Returns number

  • set bilateralSoften(n: number): void

    Parameters

    • n: number

    Returns void