Class LensRenderingPipeline
Hierarchy
-
PostProcessRenderPipeline
- LensRenderingPipeline
Index
Constructors
Properties
Accessors
Methods
- add
Effect - disable
Chromatic Aberration - disable
Depth OfField - disable
Edge Blur - disable
Edge Distortion - disable
Grain - disable
Highlights - disable
Noise Blur - disable
Pentagon Bokeh - dispose
- enable
Noise Blur - enable
Pentagon Bokeh - get
Class Name - set
Aperture - set
Chromatic Aberration - set
Darken Out OfFocus - set
Edge Blur - set
Edge Distortion - set
Focus Distance - set
Grain Amount - set
Highlights Gain - set
Highlights Threshold - set
Pre Pass Renderer
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
inspectable Custom PropertiesSearch playground for inspectableCustomProperties
List of inspectable custom properties (used by the Inspector)
Accessors
blur Noise
-
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 any
-
cameras
-
Gets the list of attached cameras
Returns Camera[]
chromatic Aberration
-
Gets or sets the chromatic aberration amount
Returns number
-
Gets or sets the chromatic aberration amount
Parameters
-
value: number
Returns any
-
darken Out OfFocus
-
Gets or sets the darken out of focus amount
Returns number
-
Gets or sets the darken out of focus amount
Parameters
-
value: number
Returns any
-
dof Aperture
-
Gets or sets the depth of field aperture
Returns number
-
Gets or sets the depth of field aperture
Parameters
-
value: number
Returns any
-
dof Distortion
-
Gets or sets the depth of field distortion
Returns number
-
Gets or sets the depth of field distortion
Parameters
-
value: number
Returns any
-
edge Blur
-
Gets or sets the edge blur
Returns number
-
Gets or sets the edge blur
Parameters
-
value: number
Returns any
-
edge Distortion
-
Gets or sets the edge distortion
Returns number
-
Gets or sets the edge distortion
Parameters
-
value: number
Returns any
-
grain Amount
-
Gets or sets the grain amount
Returns number
-
Gets or sets the grain amount
Parameters
-
value: number
Returns any
-
highlights Gain
-
Gets or sets the highlight grain amount
Returns number
-
Gets or sets the highlight grain amount
Parameters
-
value: number
Returns any
-
highlights Threshold
-
Gets or sets the highlight threshold
Returns number
-
Gets or sets the highlight threshold
Parameters
-
value: number
Returns any
-
is Supported
-
If all the render effects in the pipeline are supported
Returns boolean
name
-
Gets pipeline name
Returns string
pentagon Bokeh
-
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 any
-
scene
-
Gets associated scene
Returns Scene
Methods
add EffectSearch playground for addEffect
-
Adds an effect to the pipeline
Parameters
-
renderEffect: PostProcessRenderEffect
the effect to add
Returns void
-
disable Chromatic AberrationSearch playground for disableChromaticAberration
-
Sets chromatic aberration amount to 0
Returns void
disable Depth OfFieldSearch playground for disableDepthOfField
-
Disables depth of field
Returns void
disable Edge BlurSearch playground for disableEdgeBlur
-
Sets edge blur to 0
Returns void
disable Edge DistortionSearch playground for disableEdgeDistortion
-
Sets edge distortion to 0
Returns void
disable GrainSearch playground for disableGrain
-
Set grain amount to 0
Returns void
disable HighlightsSearch playground for disableHighlights
-
Disables highlights
Returns void
disable Noise BlurSearch playground for disableNoiseBlur
-
Disables noise blur
Returns void
disable Pentagon BokehSearch playground for disablePentagonBokeh
-
Disables the pentagon bokeh effect
Returns void
disposeSearch playground for dispose
-
Removes the internal pipeline assets and detaches the pipeline from the scene cameras
Parameters
-
Optional disableDepthRender: boolean
If the scens depth rendering should be disabled (default: false)
Returns void
-
enable Noise BlurSearch playground for enableNoiseBlur
-
Enables noise blur
Returns void
enable Pentagon BokehSearch playground for enablePentagonBokeh
-
Creates a pentagon bokeh effect
Returns void
get Class NameSearch playground for getClassName
-
Get the class name
Returns string
"LensRenderingPipeline"
set ApertureSearch playground for setAperture
-
Sets the Aperture amount
Parameters
-
amount: number
amount of Aperture
Returns void
-
set Chromatic AberrationSearch playground for setChromaticAberration
-
Sets the chromatic aberration amount
Parameters
-
amount: number
amount of chromatic aberration
Returns void
-
set Darken Out OfFocusSearch playground for setDarkenOutOfFocus
-
Sets the DarkenOutOfFocus amount
Parameters
-
amount: number
amount of DarkenOutOfFocus
Returns void
-
set Edge BlurSearch playground for setEdgeBlur
-
Sets the amount of blur at the edges
Parameters
-
amount: number
blur amount
Returns void
-
set Edge DistortionSearch playground for setEdgeDistortion
-
Sets the EdgeDistortion amount
Parameters
-
amount: number
amount of EdgeDistortion
Returns void
-
set Focus DistanceSearch playground for setFocusDistance
-
Sets the FocusDistance amount
Parameters
-
amount: number
amount of FocusDistance
Returns void
-
set Grain AmountSearch playground for setGrainAmount
-
Sets the amout of grain
Parameters
-
amount: number
Amount of grain
Returns void
-
set Highlights GainSearch playground for setHighlightsGain
-
Sets the HighlightsGain amount
Parameters
-
amount: number
amount of HighlightsGain
Returns void
-
set Highlights ThresholdSearch playground for setHighlightsThreshold
-
Sets the HighlightsThreshold amount
Parameters
-
amount: number
amount of HighlightsThreshold
Returns void
-
set Pre Pass RendererSearch playground for setPrePassRenderer
-
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.
-
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