Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SSAORenderingPipeline

Render pipeline to produce ssao effect

Hierarchy

Index

Constructors

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

areaSearch playground for 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.0075

baseSearch playground for base

base: number

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

fallOffSearch playground for 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.000001

inspectableCustomPropertiesSearch playground for inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

https://doc.babylonjs.com/how_to/debug_layer#extensibility

radiusSearch playground for radius

radius: number

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

totalStrengthSearch playground for totalStrength

totalStrength: number

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

Accessors

cameras

isSupported

  • get isSupported(): boolean

name

  • get name(): string

scene

  • Gets active scene

    Returns Scene

Methods

addEffectSearch playground for addEffect

disposeSearch playground for dispose

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

    Parameters

    • Optional disableDepthRender: boolean

    Returns void

getClassNameSearch playground for getClassName

  • getClassName(): string

setPrePassRendererSearch playground for setPrePassRenderer

  • Sets the required values to the prepass renderer.

    Parameters

    Returns boolean

    true if the pre pass is needed.

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method