SSRRenderingPipeline | Babylon.js API documentation

Class SSRRenderingPipeline

Render pipeline to produce Screen Space Reflections (SSR) effect

References: Screen Space Ray Tracing: - http://casual-effects.blogspot.com/2014/08/screen-space-ray-tracing.html - https://sourceforge.net/p/g3d/code/HEAD/tree/G3D10/data-files/shader/screenSpaceRayTrace.glsl - https://github.com/kode80/kode80SSR SSR: - general tips: https://sakibsaikia.github.io/graphics/2016/12/26/Screen-Space-Reflection-in-Killing-Floor-2.html - computation of blur radius from roughness and distance: https://github.com/godotengine/godot/blob/master/servers/rendering/renderer_rd/shaders/effects/screen_space_reflection.glsl - blur and usage of back depth buffer: https://github.com/kode80/kode80SSR

Hierarchy (View Summary)

PostProcessRenderPipeline
- SSRRenderingPipeline

Index

Constructors

constructor

new SSRRenderingPipeline(
    name: string,
    scene: Scene,
    cameras?: Camera[],
    forceGeometryBuffer?: boolean,
    textureType?: number,
    useScreenspaceDepth?: boolean,
): SSRRenderingPipeline
Constructor of the SSR rendering pipeline
Parameters
- name: string
  The rendering pipeline name
- scene: Scene
  The scene linked to this pipeline
- Optionalcameras: Camera[]
  The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
- OptionalforceGeometryBuffer: boolean
  Set to true if you want to use the legacy geometry buffer renderer (default: false)
- OptionaltextureType: number
  The texture type used by the different post processes created by SSR (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)
- OptionaluseScreenspaceDepth: boolean
  Indicates if the depth buffer should be linear or screenspace (default: false). This allows sharing the buffer with other effect pipelines that may require the depth to be in screenspace.
Returns SSRRenderingPipeline
Overrides PostProcessRenderPipeline.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25042

Properties

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

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

SSRBlurRenderEffect

SSRBlurRenderEffect: string

The blur PostProcess effect id in the pipeline

SSRCombineRenderEffect

SSRCombineRenderEffect: string

The PostProcess effect id in the pipeline that combines the SSR-Blur output with the original scene color

SSRRenderEffect

SSRRenderEffect: string

The SSR PostProcess effect id in the pipeline

Accessors

attenuateBackfaceReflection

get attenuateBackfaceReflection(): boolean
Gets or sets a boolean indicating if the backface reflections should be attenuated (default: false).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24936
set attenuateBackfaceReflection(attenuate: boolean): void
Parameters
- attenuate: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24937

attenuateFacingCamera

get attenuateFacingCamera(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated when the reflection ray is facing the camera (the view direction) (default: false).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24931
set attenuateFacingCamera(attenuate: boolean): void
Parameters
- attenuate: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24932

attenuateIntersectionDistance

get attenuateIntersectionDistance(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated according to the distance of the intersection (default: true).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24921
set attenuateIntersectionDistance(attenuate: boolean): void
Parameters
- attenuate: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24922

attenuateIntersectionIterations

get attenuateIntersectionIterations(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated according to the number of iterations performed to find the intersection (default: true).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24926
set attenuateIntersectionIterations(attenuate: boolean): void
Parameters
- attenuate: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24927

attenuateScreenBorders

get attenuateScreenBorders(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated at the screen borders (default: true).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24916
set attenuateScreenBorders(attenuate: boolean): void
Parameters
- attenuate: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24917

backfaceDepthRenderer

get backfaceDepthRenderer(): Nullable<DepthRenderer>
Gets the depth renderer used to render the back faces of the scene to a depth texture.

Returns Nullable<DepthRenderer>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24962

backfaceDepthTextureDownsample

get backfaceDepthTextureDownsample(): number
Gets or sets the downsample factor (default: 0) used to create the backface depth texture - used only if enableAutomaticThicknessComputation = true. Use 0 to render the depth at full resolution, 1 to render at half resolution, 2 to render at 1/4 resolution, etc. Note that you will get rendering artefacts when using a value different from 0: it's a tradeoff between image quality and performances.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24969
set backfaceDepthTextureDownsample(factor: number): void
Parameters
- factor: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24970

backfaceForceDepthWriteTransparentMeshes

get backfaceForceDepthWriteTransparentMeshes(): boolean
Gets or sets a boolean (default: true) indicating if the depth of transparent meshes should be written to the backface depth texture (when automatic thickness computation is enabled).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24975
set backfaceForceDepthWriteTransparentMeshes(force: boolean): void
Parameters
- force: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24976

blurDispersionStrength

get blurDispersionStrength(): number
Gets or sets the blur dispersion strength. Set this value to 0 to disable blurring (default: 0.03) The reflections are blurred based on the roughness of the surface and the distance between the pixel shaded and the reflected pixel: the higher the distance the more blurry the reflection is. blurDispersionStrength allows to increase or decrease this effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24885
set blurDispersionStrength(strength: number): void
Parameters
- strength: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24886

blurDownsample

get blurDownsample(): number
Gets or sets the downsample factor used to reduce the size of the textures used to blur the reflection effect (default: 0). Use 0 to blur at full resolution, 1 to render at half resolution, 2 to render at 1/3 resolution, etc.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24892
set blurDownsample(downsample: number): void
Parameters
- downsample: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24893

cameras

get cameras(): Camera[]
Gets the list of attached cameras

Returns Camera[]
Inherited from PostProcessRenderPipeline.cameras
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23935

clipToFrustum

get clipToFrustum(): boolean
Gets or sets a boolean indicating if the ray should be clipped to the frustum (default: true). You can try to set this parameter to false to save some performances: it may produce some artefacts in some cases, but generally they won't really be visible

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24942
set clipToFrustum(clip: boolean): void
Parameters
- clip: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24943

debug

get debug(): boolean
Gets or sets a boolean indicating if the effect should be rendered in debug mode (default: false). In this mode, colors have this meaning:
- blue: the ray hit the max distance (we reached maxDistance)
- red: the ray ran out of steps (we reached maxSteps)
- yellow: the ray went off screen
- green: the ray hit a surface. The brightness of the green color is proportional to the distance between the ray origin and the intersection point: A brighter green means more computation than a darker green. In the first 3 cases, the final color is calculated by mixing the skybox color with the pixel color (if environmentTexture is defined), otherwise the pixel color is not modified You should try to get as few blue/red/yellow pixels as possible, as this means that the ray has gone further than if it had hit a surface.
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25005
set debug(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25006

enableAutomaticThicknessComputation

get enableAutomaticThicknessComputation(): boolean
Gets or sets a boolean defining if geometry thickness should be computed automatically (default: false). When enabled, a depth renderer is created which will render the back faces of the scene to a depth texture (meaning additional work for the GPU). In that mode, the "thickness" property is still used as an offset to compute the ray intersection, but you can typically use a much lower value than when enableAutomaticThicknessComputation is false (it's even possible to use a value of 0 when using low values for "step") Note that for performance reasons, this option will only apply to the first camera to which the rendering pipeline is attached!

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24957
set enableAutomaticThicknessComputation(automatic: boolean): void
Parameters
- automatic: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24958

enableSmoothReflections

get enableSmoothReflections(): boolean
Gets or sets whether or not smoothing reflections is enabled (default: false) Enabling smoothing will require more GPU power. Note that this setting has no effect if step = 1: it's only used if step > 1.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24899
set enableSmoothReflections(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24900

engine

get engine(): AbstractEngine
Gets the active engine

Returns AbstractEngine
Inherited from PostProcessRenderPipeline.engine
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23939

environmentTexture

get environmentTexture(): Nullable<CubeTexture>
Gets or sets the environment cube texture used to define the reflection when the reflected rays of SSR leave the view space or when the maxDistance/maxSteps is reached.

Returns Nullable<CubeTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24905
set environmentTexture(texture: Nullable<CubeTexture>): void
Parameters
- texture: Nullable<CubeTexture>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24906

environmentTextureIsProbe

get environmentTextureIsProbe(): boolean
Gets or sets the boolean defining if the environment texture is a standard cubemap (false) or a probe (true). Default value is false. Note: a probe cube texture is treated differently than an ordinary cube texture because the Y axis is reversed.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24911
set environmentTextureIsProbe(isProbe: boolean): void
Parameters
- isProbe: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24912

generateOutputInGammaSpace

get generateOutputInGammaSpace(): boolean
Gets or sets a boolean defining if the output color texture generated by the SSR pipeline should be in gamma space (default: true) If you have a post-process that comes after the SSR and that post-process needs the input to be in a linear space, you must disable generateOutputInGammaSpace

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24993
set generateOutputInGammaSpace(gammaSpace: boolean): void
Parameters
- gammaSpace: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24994

inputTextureColorIsInGammaSpace

get inputTextureColorIsInGammaSpace(): boolean
Gets or sets a boolean defining if the input color texture is in gamma space (default: true) The SSR effect works in linear space, so if the input texture is in gamma space, we must convert the texture to linear space before applying the effect

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24987
set inputTextureColorIsInGammaSpace(gammaSpace: boolean): void
Parameters
- gammaSpace: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24988

isEnabled

get isEnabled(): boolean
Gets or sets a boolean indicating if the effect is enabled (default: true).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24981
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24982

isSupported

get isSupported(): boolean
Returns true if SSR is supported by the running hardware

Returns boolean
Overrides PostProcessRenderPipeline.isSupported
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25032

maxDistance

get maxDistance(): number
Gets or sets the maxDistance used to define how far we look for reflection during the ray-marching on the reflected ray (default: 1000). Note that this value is a view (camera) space distance (not pixels!).

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24823
set maxDistance(distance: number): void
Parameters
- distance: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24824

maxSteps

get maxSteps(): number
Maximum number of steps during the ray marching process after which we consider an intersection could not be found (default: 1000). Should be an integer value.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24852
set maxSteps(steps: number): void
Parameters
- steps: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24853

name

get name(): string
Gets pipeline name

Returns string
Inherited from PostProcessRenderPipeline.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23933

reflectionSpecularFalloffExponent

get reflectionSpecularFalloffExponent(): number
Gets or sets the falloff exponent used to compute the reflection strength. Higher values lead to fainter reflections (default: 1).

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24846
set reflectionSpecularFalloffExponent(exponent: number): void
Parameters
- exponent: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24847

reflectivityThreshold

get reflectivityThreshold(): number
Gets or sets the minimum value for one of the reflectivity component of the material to consider it for SSR (default: 0.04). If all r/g/b components of the reflectivity is below or equal this value, the pixel will not be considered reflective and SSR won't be applied.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24871
set reflectivityThreshold(threshold: number): void
Parameters
- threshold: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24872

roughnessFactor

get roughnessFactor(): number
Gets or sets the factor applied when computing roughness. Default value is 0.2. When blurring based on roughness is enabled (meaning blurDispersionStrength > 0), roughnessFactor is used as a global roughness factor applied on all objects. If you want to disable this global roughness set it to 0.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24859
set roughnessFactor(factor: number): void
Parameters
- factor: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24860

samples

get samples(): number
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24818
set samples(sampleCount: number): void
MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
Parameters
- sampleCount: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24817

scene

get scene(): Scene
Gets active scene

Returns Scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25028

selfCollisionNumSkip

get selfCollisionNumSkip(): number
Number of steps to skip at start when marching the ray to avoid self collisions (default: 1) 1 should normally be a good value, depending on the scene you may need to use a higher value (2 or 3)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24865
set selfCollisionNumSkip(skip: number): void
Parameters
- skip: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24866

ssrDownsample

get ssrDownsample(): number
Gets or sets the downsample factor used to reduce the size of the texture used to compute the SSR contribution (default: 0). Use 0 to render the SSR contribution at full resolution, 1 to render at half resolution, 2 to render at 1/3 resolution, etc. Note that it is used only when blurring is enabled (blurDispersionStrength > 0), because in that mode the SSR contribution is generated in a separate texture.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24878
set ssrDownsample(downsample: number): void
Parameters
- downsample: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24879

step

get step(): number
Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel. Should be an integer >= 1 as it is the number of pixels we advance at each step (default: 1). Use higher values to improve performances (but at the expense of quality).

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24829
set step(step: number): void
Parameters
- step: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24830

strength

get strength(): number
Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results (default: 1).

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24841
set strength(strength: number): void
Parameters
- strength: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24842

thickness

get thickness(): number
Gets or sets the thickness value used as tolerance when computing the intersection between the reflected ray and the scene (default: 0.5). If setting "enableAutomaticThicknessComputation" to true, you can use lower values for "thickness" (even 0), as the geometry thickness is automatically computed thank to the regular depth buffer + the backface depth buffer

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24836
set thickness(thickness: number): void
Parameters
- thickness: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24837

useFresnel

get useFresnel(): boolean
Gets or sets a boolean indicating whether the blending between the current color pixel and the reflection color should be done with a Fresnel coefficient (default: false). It is more physically accurate to use the Fresnel coefficient (otherwise it uses the reflectivity of the material for blending), but it is also more expensive when you use blur (when blurDispersionStrength > 0).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24948
set useFresnel(fresnel: boolean): void
Parameters
- fresnel: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:24949

Methods

addCamera

addCamera(camera: Camera): void
Adds a camera to the pipeline
Parameters
- camera: Camera
  the camera to be added
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25052

addEffect

addEffect(renderEffect: PostProcessRenderEffect): void
Adds an effect to the pipeline
Parameters
- renderEffect: PostProcessRenderEffect
  the effect to add
Returns void
Inherited from PostProcessRenderPipeline.addEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23959

dispose

dispose(disableGeometryBufferRenderer?: boolean): void
Removes the internal pipeline assets and detaches the pipeline from the scene cameras
Parameters
- OptionaldisableGeometryBufferRenderer: boolean
  if the geometry buffer renderer should be disabled
Returns void
Overrides PostProcessRenderPipeline.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25062

getClassName

getClassName(): string
Get the class name

Returns string
"SSRRenderingPipeline"
Overrides PostProcessRenderPipeline.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25047

getScene

getScene(): Scene
Gets the scene the effect belongs to.

Returns Scene
the scene the effect belongs to.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25011

removeCamera

removeCamera(camera: Camera): void
Removes a camera from the pipeline
Parameters
- camera: Camera
  the camera to remove
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25057

serialize

serialize(): any
Serializes the rendering pipeline (Used when exporting)

Returns any
the serialized object
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25075

setPrePassRenderer

setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean
Sets the required values to the prepass renderer.
Parameters
- prePassRenderer: PrePassRenderer
  defines the prepass renderer to setup.
Returns boolean
true if the pre pass is needed.
Inherited from PostProcessRenderPipeline.setPrePassRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23993

`Static`Parse

Parse(source: any, scene: Scene, rootUrl: string): SSRRenderingPipeline
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 SSRRenderingPipeline
An instantiated pipeline from the serialized object.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:25083

Class SSRRenderingPipeline

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSRRenderingPipeline

Properties

inspectableCustomProperties

See

SSRBlurRenderEffect

SSRCombineRenderEffect

SSRRenderEffect

Accessors

attenuateBackfaceReflection

Returns boolean

Parameters

Returns void

attenuateFacingCamera

Returns boolean

Parameters

Returns void

attenuateIntersectionDistance

Returns boolean

Parameters

Returns void

attenuateIntersectionIterations

Returns boolean

Parameters

Returns void

attenuateScreenBorders

Returns boolean

Parameters

Returns void

backfaceDepthRenderer

Returns Nullable<DepthRenderer>

backfaceDepthTextureDownsample

Returns number

Parameters

Returns void

backfaceForceDepthWriteTransparentMeshes

Returns boolean

Parameters

Returns void

blurDispersionStrength

Returns number

Parameters

Returns void

blurDownsample

Returns number

Parameters

Returns void

cameras

Returns Camera[]

clipToFrustum

Returns boolean

Parameters

Returns void

debug

Returns boolean

Parameters

Returns void

enableAutomaticThicknessComputation

Returns boolean

Parameters

Returns void

enableSmoothReflections

Returns boolean

Parameters

Returns void

engine

Returns AbstractEngine

environmentTexture

Returns Nullable<CubeTexture>

Parameters

Returns void