Class ImageProcessingConfiguration
Hierarchy
- ImageProcessingConfiguration
Index
Constructors
Properties
Accessors
- apply
By Post Process - color
Curves Enabled - color
GradingBGR - color
Grading Enabled - color
Grading Texture - color
Grading With Green Depth - contrast
- dithering
Enabled - dithering
Intensity - exposure
- is
Enabled - skip
Final Color Clamp - tone
Mapping Enabled - tone
Mapping Type - vignette
Blend Mode - vignette
CentreX - vignette
CentreY - vignette
Enabled - VIGNETTEMODE_
MULTIPLY - VIGNETTEMODE_
OPAQUE
Methods
Constructors
constructor
Returns ImageProcessingConfiguration
Properties
color CurvesSearch playground for colorCurves
Color curves setup used in the effect if colorCurvesEnabled is set to true
on Update ParametersSearch playground for onUpdateParameters
An event triggered when the configuration changes and requires Shader to Update some parameters.
vignette Camera FovSearch playground for vignetteCameraFov
Camera field of view used by the Vignette effect.
vignette CenterXSearch playground for vignetteCenterX
Vignette center X Offset.
vignette CenterYSearch playground for vignetteCenterY
Vignette center Y Offset.
vignette ColorSearch playground for vignetteColor
Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode) if vignetteEnabled is set to true.
vignette StretchSearch playground for vignetteStretch
Vignette stretch size.
vignette WeightSearch playground for vignetteWeight
Vignette weight or intensity of the vignette effect.
Static Readonly TONEMAPPING_ ACESSearch playground for TONEMAPPING_ACES
ACES Tone mapping (used by default in unreal and unity). This can help getting closer to other engines rendering to increase portability.
Static Readonly TONEMAPPING_ STANDARDSearch playground for TONEMAPPING_STANDARD
Default tone mapping applied in BabylonJS.
Accessors
apply By Post Process
Gets whether the image processing is applied through a post process or not.
Returns boolean
Sets whether the image processing is applied through a post process or not.
Parameters
value: boolean
Returns void
color Curves Enabled
Gets whether the color curves effect is enabled.
Returns boolean
Sets whether the color curves effect is enabled.
Parameters
value: boolean
Returns void
color GradingBGR
Gets whether the color grading texture contains BGR values.
Returns boolean
Sets whether the color grading texture contains BGR values.
Parameters
value: boolean
Returns void
color Grading Enabled
Gets whether the color grading effect is enabled.
Returns boolean
Sets whether the color grading effect is enabled.
Parameters
value: boolean
Returns void
color Grading Texture
Color grading LUT texture used in the effect if colorGradingEnabled is set to true
Returns Nullable<BaseTexture>
Color grading LUT texture used in the effect if colorGradingEnabled is set to true
Parameters
value: Nullable<BaseTexture>
Returns void
color Grading With Green Depth
Gets whether the color grading effect is using a green depth for the 3d Texture.
Returns boolean
Sets whether the color grading effect is using a green depth for the 3d Texture.
Parameters
value: boolean
Returns void
contrast
Gets the contrast used in the effect.
Returns number
Sets the contrast used in the effect.
Parameters
value: number
Returns void
dithering Enabled
Gets whether the dithering effect is enabled. The dithering effect can be used to reduce banding.
Returns boolean
Sets whether the dithering effect is enabled. The dithering effect can be used to reduce banding.
Parameters
value: boolean
Returns void
dithering Intensity
Gets the dithering intensity. 0 is no dithering. Default is 1.0 / 255.0.
Returns number
Sets the dithering intensity. 0 is no dithering. Default is 1.0 / 255.0.
Parameters
value: number
Returns void
exposure
Gets the Exposure used in the effect.
Returns number
Sets the Exposure used in the effect.
Parameters
value: number
Returns void
is Enabled
Gets whether the image processing is enabled or not.
Returns boolean
Sets whether the image processing is enabled or not.
Parameters
value: boolean
Returns void
skip Final Color Clamp
If apply by post process is set to true, setting this to true will skip the final color clamp step in the fragment shader Applies to PBR materials.
Returns boolean
If apply by post process is set to true, setting this to true will skip the final color clamp step in the fragment shader Applies to PBR materials.
Parameters
value: boolean
Returns void
tone Mapping Enabled
Gets whether the tone mapping effect is enabled.
Returns boolean
Sets whether the tone mapping effect is enabled.
Parameters
value: boolean
Returns void
tone Mapping Type
Gets the type of tone mapping effect.
Returns number
Sets the type of tone mapping effect used in BabylonJS.
Parameters
value: number
Returns void
vignette Blend Mode
Gets the vignette blend mode allowing different kind of effect.
Returns number
Sets the vignette blend mode allowing different kind of effect.
Parameters
value: number
Returns void
vignette CentreX
Back Compat: Vignette center X Offset.
Returns number
Back Compat: Vignette center X Offset.
Parameters
value: number
Returns void
vignette CentreY
Back Compat: Vignette center Y Offset.
Returns number
Back Compat: Vignette center Y Offset.
Parameters
value: number
Returns void
vignette Enabled
Gets whether the vignette effect is enabled.
Returns boolean
Sets whether the vignette effect is enabled.
Parameters
value: boolean
Returns void
Static VIGNETTEMODE_ MULTIPLY
Used to apply the vignette as a mix with the pixel color.
Returns number
Static VIGNETTEMODE_ OPAQUE
Used to apply the vignette as a replacement of the pixel color.
Returns number
Methods
bindSearch playground for bind
Binds the image processing to the shader.
Parameters
effect: Effect
The effect to bind to
Optional overrideAspectRatio: number
Override the aspect ratio of the effect
Returns void
cloneSearch playground for clone
Clones the current image processing instance.
Returns ImageProcessingConfiguration
The cloned image processing
get Class NameSearch playground for getClassName
Gets the current class name.
Returns string
"ImageProcessingConfiguration"
is ReadySearch playground for isReady
Returns true if all the image processing information are ready.
Returns boolean
True if ready, otherwise, false
prepare DefinesSearch playground for prepareDefines
Prepare the list of defines associated to the shader.
Parameters
defines: IImageProcessingConfigurationDefines
the list of defines to complete
Optional forPostProcess: boolean
Define if we are currently in post process mode or not
Returns void
serializeSearch playground for serialize
Serializes the current image processing instance to a json representation.
Returns any
a JSON representation
Static ParseSearch playground for Parse
Parses the image processing from a json representation.
Parameters
source: any
the JSON source to parse
Returns ImageProcessingConfiguration
The parsed image processing
Static Prepare SamplersSearch playground for PrepareSamplers
Prepare the list of samplers associated with the Image Processing effects.
Parameters
samplersList: string[]
The list of uniforms used in the effect
defines: IImageProcessingConfigurationDefines
the list of defines currently in use
Returns void
Static Prepare UniformsSearch playground for PrepareUniforms
Prepare the list of uniforms associated with the Image Processing effects.
Parameters
uniforms: string[]
The list of uniforms used in the effect
defines: IImageProcessingConfigurationDefines
the list of defines currently in use
Returns void
This groups together the common properties used for image processing either in direct forward pass or through post processing effect depending on the use of the image processing pipeline in your scene or not.