API
Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • name: string

      The rendering pipeline name

    • parameters: any

      An object containing all parameters (see above)

    • scene: Scene

      The scene linked to this pipeline

    • Optional ratio: number

      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)

    • Optional cameras: Camera[]

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

    Returns LensRenderingPipeline

Properties

inspectableCustomPropertiesSearch playground for inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

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

Accessors

blurNoise

  • get blurNoise(): boolean
  • set blurNoise(value: boolean): void

  • Gets or sets a boolean indicating if blur noise is enabled

    Returns boolean

  • Gets or sets a boolean indicating if blur noise is enabled

    Parameters

    • value: boolean

    Returns void

cameras

  • Gets the list of attached cameras

    Returns Camera[]

chromaticAberration

  • get chromaticAberration(): number
  • set chromaticAberration(value: number): void

  • Gets or sets the chromatic aberration amount

    Returns number

  • Gets or sets the chromatic aberration amount

    Parameters

    • value: number

    Returns void

darkenOutOfFocus

  • get darkenOutOfFocus(): number
  • set darkenOutOfFocus(value: number): void

  • Gets or sets the darken out of focus amount

    Returns number

  • Gets or sets the darken out of focus amount

    Parameters

    • value: number

    Returns void

dofAperture

  • get dofAperture(): number
  • set dofAperture(value: number): void

  • Gets or sets the depth of field aperture

    Returns number

  • Gets or sets the depth of field aperture

    Parameters

    • value: number

    Returns void

dofDistortion

  • get dofDistortion(): number
  • set dofDistortion(value: number): void

  • Gets or sets the depth of field distortion

    Returns number

  • Gets or sets the depth of field distortion

    Parameters

    • value: number

    Returns void

edgeBlur

  • get edgeBlur(): number
  • set edgeBlur(value: number): void

  • Gets or sets the edge blur

    Returns number

  • Gets or sets the edge blur

    Parameters

    • value: number

    Returns void

edgeDistortion

  • get edgeDistortion(): number
  • set edgeDistortion(value: number): void

  • Gets or sets the edge distortion

    Returns number

  • Gets or sets the edge distortion

    Parameters

    • value: number

    Returns void

grainAmount

  • get grainAmount(): number
  • set grainAmount(value: number): void

  • Gets or sets the grain amount

    Returns number

  • Gets or sets the grain amount

    Parameters

    • value: number

    Returns void

highlightsGain

  • get highlightsGain(): number
  • set highlightsGain(value: number): void

  • Gets or sets the highlight grain amount

    Returns number

  • Gets or sets the highlight grain amount

    Parameters

    • value: number

    Returns void

highlightsThreshold

  • get highlightsThreshold(): number
  • set highlightsThreshold(value: number): void

  • Gets or sets the highlight threshold

    Returns number

  • Gets or sets the highlight threshold

    Parameters

    • value: number

    Returns void

isSupported

  • get isSupported(): boolean

  • If all the render effects in the pipeline are supported

    Returns boolean

name

  • get name(): string

  • Gets pipeline name

    Returns string

pentagonBokeh

  • get pentagonBokeh(): boolean
  • set pentagonBokeh(value: boolean): void

  • Gets or sets a boolean indicating if pentagon bokeh is enabled

    Returns boolean

  • Gets or sets a boolean indicating if pentagon bokeh is enabled

    Parameters

    • value: boolean

    Returns void

scene

  • Gets associated scene

    Returns Scene

Methods

addEffectSearch playground for addEffect

disableChromaticAberrationSearch playground for disableChromaticAberration

  • disableChromaticAberration(): void

  • Sets chromatic aberration amount to 0

    Returns void

disableDepthOfFieldSearch playground for disableDepthOfField

  • disableDepthOfField(): void

  • Disables depth of field

    Returns void

disableEdgeBlurSearch playground for disableEdgeBlur

  • disableEdgeBlur(): void

  • Sets edge blur to 0

    Returns void

disableEdgeDistortionSearch playground for disableEdgeDistortion

  • disableEdgeDistortion(): void

  • Sets edge distortion to 0

    Returns void

disableGrainSearch playground for disableGrain

  • disableGrain(): void

  • Set grain amount to 0

    Returns void

disableHighlightsSearch playground for disableHighlights

  • disableHighlights(): void

  • Disables highlights

    Returns void

disableNoiseBlurSearch playground for disableNoiseBlur

  • disableNoiseBlur(): void

  • Disables noise blur

    Returns void

disablePentagonBokehSearch playground for disablePentagonBokeh

  • disablePentagonBokeh(): void

  • Disables the pentagon bokeh effect

    Returns void

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

      If the scene's depth rendering should be disabled (default: false)

    Returns void

enableNoiseBlurSearch playground for enableNoiseBlur

  • enableNoiseBlur(): void

  • Enables noise blur

    Returns void

enablePentagonBokehSearch playground for enablePentagonBokeh

  • enablePentagonBokeh(): void

  • Creates a pentagon bokeh effect

    Returns void

getClassNameSearch playground for getClassName

  • getClassName(): string

setApertureSearch playground for setAperture

  • setAperture(amount: number): void

  • Sets the Aperture amount

    Parameters

    • amount: number

      amount of Aperture

    Returns void

setChromaticAberrationSearch playground for setChromaticAberration

  • setChromaticAberration(amount: number): void

  • Sets the chromatic aberration amount

    Parameters

    • amount: number

      amount of chromatic aberration

    Returns void

setDarkenOutOfFocusSearch playground for setDarkenOutOfFocus

  • setDarkenOutOfFocus(amount: number): void

  • Sets the DarkenOutOfFocus amount

    Parameters

    • amount: number

      amount of DarkenOutOfFocus

    Returns void

setEdgeBlurSearch playground for setEdgeBlur

  • setEdgeBlur(amount: number): void

  • Sets the amount of blur at the edges

    Parameters

    • amount: number

      blur amount

    Returns void

setEdgeDistortionSearch playground for setEdgeDistortion

  • setEdgeDistortion(amount: number): void

  • Sets the EdgeDistortion amount

    Parameters

    • amount: number

      amount of EdgeDistortion

    Returns void

setFocusDistanceSearch playground for setFocusDistance

  • setFocusDistance(amount: number): void

  • Sets the FocusDistance amount

    Parameters

    • amount: number

      amount of FocusDistance

    Returns void

setGrainAmountSearch playground for setGrainAmount

  • setGrainAmount(amount: number): void

  • Sets the amount of grain

    Parameters

    • amount: number

      Amount of grain

    Returns void

setHighlightsGainSearch playground for setHighlightsGain

  • setHighlightsGain(amount: number): void

  • Sets the HighlightsGain amount

    Parameters

    • amount: number

      amount of HighlightsGain

    Returns void

setHighlightsThresholdSearch playground for setHighlightsThreshold

  • setHighlightsThreshold(amount: number): void

  • Sets the HighlightsThreshold amount

    Parameters

    • amount: number

      amount of HighlightsThreshold

    Returns void

setPrePassRendererSearch playground for setPrePassRenderer

Legend

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

Settings

Theme