Class LensRenderingPipeline

BABYLON.JS Chromatic Aberration GLSL Shader Author: Olivier Guyot Separates very slightly R, G and B colors on the edges of the screen Inspired by Francois Tarlier & Martins Upitis

Hierarchy (View Summary)

PostProcessRenderPipeline
- LensRenderingPipeline

Constructors

constructor

new LensRenderingPipeline(
    name: string,
    parameters: any,
    scene: Scene,
    ratio?: number,
    cameras?: Camera[],
): LensRenderingPipeline
Parameters
- name: string
  The rendering pipeline name
- parameters: any
  An object containing all parameters (see above)
- scene: Scene
  The scene linked to this pipeline
- ratio: number = 1.0
  The size of the postprocesses (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
- Optionalcameras: Camera[]
  The array of cameras that the rendering pipeline will be attached to
Returns LensRenderingPipeline
Overrides PostProcessRenderPipeline.constructor
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:100

Properties

HighlightsEnhancingEffect

HighlightsEnhancingEffect: string = "HighlightsEnhancingEffect"

Ignore

The highlights enhancing PostProcess id in the pipeline

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

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

LensChromaticAberrationEffect

LensChromaticAberrationEffect: string = "LensChromaticAberrationEffect"

Ignore

The chromatic aberration PostProcess id in the pipeline

LensDepthOfFieldEffect

LensDepthOfFieldEffect: string = "LensDepthOfFieldEffect"

Ignore

The depth-of-field PostProcess id in the pipeline

`Readonly`uniqueId

uniqueId: any = UniqueIdGenerator.UniqueId

Gets the unique id of the post process rendering pipeline

Accessors

blurNoise

get blurNoise(): boolean
Gets or sets a boolean indicating if blur noise is enabled

Returns boolean
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:272
set blurNoise(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:276

cameras

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

Returns Camera[]
Inherited from PostProcessRenderPipeline.cameras
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/postProcessRenderPipeline.ts:50

chromaticAberration

get chromaticAberration(): number
Gets or sets the chromatic aberration amount

Returns number
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:217
set chromaticAberration(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:221

darkenOutOfFocus

get darkenOutOfFocus(): number
Gets or sets the darken out of focus amount

Returns number
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:261
set darkenOutOfFocus(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:265

dofAperture

get dofAperture(): number
Gets or sets the depth of field aperture

Returns number
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:228
set dofAperture(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:232

dofDistortion

get dofDistortion(): number
Gets or sets the depth of field distortion

Returns number
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:250
set dofDistortion(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:254

highlightsGain

get highlightsGain(): number
Gets or sets the highlight grain amount

Returns number
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:298
set highlightsGain(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:302

highlightsThreshold

get highlightsThreshold(): number
Gets or sets the highlight threshold

Returns number
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:309
set highlightsThreshold(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:313

isSupported

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

Returns boolean
Inherited from PostProcessRenderPipeline.isSupported
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/postProcessRenderPipeline.ts:90

name

get name(): string
Gets pipeline name

Returns string
Inherited from PostProcessRenderPipeline.name
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/postProcessRenderPipeline.ts:40

pentagonBokeh

get pentagonBokeh(): boolean
Gets or sets a boolean indicating if pentagon bokeh is enabled

Returns boolean
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:283
set pentagonBokeh(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:287

scene

get scene(): Scene
Gets associated scene

Returns Scene
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:188

Methods

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 packages/dev/core/src/PostProcesses/RenderPipeline/postProcessRenderPipeline.ts:106

disableChromaticAberration

disableChromaticAberration(): void
Sets chromatic aberration amount to 0

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:354

disableDepthOfField

disableDepthOfField(): void
Disables depth of field

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:380

disableEdgeBlur

disableEdgeBlur(): void
Sets edge blur to 0

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:328

disableEdgeDistortion

disableEdgeDistortion(): void
Sets edge distortion to 0

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:367

disableGrain

disableGrain(): void
Set grain amount to 0

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:341

disableHighlights

disableHighlights(): void
Disables highlights

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:445

disableNoiseBlur

disableNoiseBlur(): void
Disables noise blur

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:422

disablePentagonBokeh

disablePentagonBokeh(): void
Disables the pentagon bokeh effect

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:409

dispose

dispose(disableDepthRender?: boolean): void
Removes the internal pipeline assets and detaches the pipeline from the scene cameras
Parameters
- disableDepthRender: boolean = false
  If the scene's depth rendering should be disabled (default: false)
Returns void
Overrides PostProcessRenderPipeline.dispose
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:453

enableNoiseBlur

enableNoiseBlur(): void
Enables noise blur

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:416

enablePentagonBokeh

enablePentagonBokeh(): void
Creates a pentagon bokeh effect

Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:402

getClassName

getClassName(): string
Get the class name

Returns string
"LensRenderingPipeline"
Overrides PostProcessRenderPipeline.getClassName
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:179

setAperture

setAperture(amount: number): void
Sets the Aperture amount
Parameters
- amount: number
  amount of Aperture
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:387

setChromaticAberration

setChromaticAberration(amount: number): void
Sets the chromatic aberration amount
Parameters
- amount: number
  amount of chromatic aberration
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:348

setDarkenOutOfFocus

setDarkenOutOfFocus(amount: number): void
Sets the DarkenOutOfFocus amount
Parameters
- amount: number
  amount of DarkenOutOfFocus
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:394

setEdgeBlur

setEdgeBlur(amount: number): void
Sets the amount of blur at the edges
Parameters
- amount: number
  blur amount
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:322

setEdgeDistortion

setEdgeDistortion(amount: number): void
Sets the EdgeDistortion amount
Parameters
- amount: number
  amount of EdgeDistortion
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:361

setFocusDistance

setFocusDistance(amount: number): void
Sets the FocusDistance amount
Parameters
- amount: number
  amount of FocusDistance
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:374

setGrainAmount

setGrainAmount(amount: number): void
Sets the amount of grain
Parameters
- amount: number
  Amount of grain
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:335

setHighlightsGain

setHighlightsGain(amount: number): void
Sets the HighlightsGain amount
Parameters
- amount: number
  amount of HighlightsGain
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:429

setHighlightsThreshold

setHighlightsThreshold(amount: number): void
Sets the HighlightsThreshold amount
Parameters
- amount: number
  amount of HighlightsThreshold
Returns void
- Defined in packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline.pure.ts:436

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 packages/dev/core/src/PostProcesses/RenderPipeline/postProcessRenderPipeline.ts:277

Class LensRenderingPipeline

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LensRenderingPipeline

Properties

HighlightsEnhancingEffect

Ignore

inspectableCustomProperties

See

LensChromaticAberrationEffect

Ignore

LensDepthOfFieldEffect

Ignore

ReadonlyuniqueId

Accessors

blurNoise

Returns boolean

Parameters

Returns void

cameras

Returns Camera[]

chromaticAberration

Returns number

Parameters

Returns void

darkenOutOfFocus

Returns number

Parameters

Returns void

dofAperture

Returns number

Parameters

Returns void

dofDistortion

Returns number

Parameters

Returns void

edgeBlur

Returns number

Parameters

Returns void

edgeDistortion

Returns number

Parameters

Returns void

engine

Returns AbstractEngine

grainAmount

Returns number

Parameters

Returns void

highlightsGain

Returns number

Parameters

Returns void

highlightsThreshold

Returns number

Parameters

Returns void

isSupported

Returns boolean

name

Returns string

pentagonBokeh

Returns boolean

Parameters

Returns void

scene

Returns Scene

Methods

addEffect

Parameters

Returns void

`Readonly`uniqueId