Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SSAO2RenderingPipeline

Render pipeline to produce ssao effect

Hierarchy

Index

Constructors

constructor

  • new SSAO2RenderingPipeline(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean, textureType?: number): SSAO2RenderingPipeline
  • 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 }

    • Optional cameras: Camera[]

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

    • Optional forceGeometryBuffer: boolean

      Set to true if you want to use the legacy geometry buffer renderer

    • Optional textureType: number

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

    Returns SSAO2RenderingPipeline

Properties

baseSearch playground for base

base: number

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

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

maxZSearch playground for maxZ

maxZ: number

Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.

minZAspectSearch playground for minZAspect

minZAspect: number

In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much

radiusSearch playground for radius

radius: number

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

totalStrengthSearch playground for totalStrength

totalStrength: number

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

Accessors

cameras

expensiveBlur

  • get expensiveBlur(): boolean
  • set expensiveBlur(b: boolean): any
  • If bilateral blur should be used

    Returns boolean

  • If bilateral blur should be used

    Parameters

    • b: boolean

    Returns any

isSupported

  • get isSupported(): boolean

name

  • get name(): string

samples

  • get samples(): number
  • set samples(n: number): any
  • Number of samples used for the SSAO calculations. Default value is 8

    Returns number

  • Number of samples used for the SSAO calculations. Default value is 8

    Parameters

    • n: number

    Returns any

scene

  • Gets active scene

    Returns Scene

textureSamples

  • get textureSamples(): number
  • set textureSamples(n: number): any
  • Number of samples to use for antialiasing

    Returns number

  • Number of samples to use for antialiasing

    Parameters

    • n: number

    Returns any

Static IsSupported

  • get IsSupported(): boolean
  • Support test.

    Returns boolean

Methods

addEffectSearch playground for addEffect

disposeSearch playground for dispose

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

    Parameters

    • Optional disableGeometryBufferRenderer: boolean

    Returns void

getClassNameSearch playground for getClassName

  • getClassName(): string

serializeSearch playground for serialize

  • serialize(): any
  • Serialize the rendering pipeline (Used when exporting)

    Returns any

    the serialized object

setPrePassRendererSearch playground for setPrePassRenderer

  • Sets the required values to the prepass renderer.

    Parameters

    Returns boolean

    true if the pre pass is needed.

Static ParseSearch playground for Parse

  • Parse the serialized pipeline

    Parameters

    • source: any

      Source pipeline.

    • scene: Scene

      The scene to load the pipeline to.

    • rootUrl: string

      The URL of the serialized pipeline.

    Returns SSAO2RenderingPipeline

    An instantiated pipeline from the serialized object.

Legend

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