Options
All
  • Public
  • Public/Protected
  • All
Menu

Render pipeline to produce ssao effect

Hierarchy

Index

Constructors

  • 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: 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

base: number

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

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

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

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

radius: number

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

totalStrength: number

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

Accessors

  • Gets the list of attached cameras

    Returns Camera[]

  • get isSupported(): boolean
  • If all the render effects in the pipeline are supported

    Returns boolean

  • get name(): string
  • Gets pipeline name

    Returns string

  • Gets active scene

    Returns Scene

Methods

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

    Parameters

    • Optional disableDepthRender: boolean

    Returns void

  • getClassName(): string

Legend

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

Settings

Theme