ImageProcessingConfiguration | Babylon.js API documentation

Class ImageProcessingConfiguration

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.

Constructors

constructor

new ImageProcessingConfiguration(): ImageProcessingConfiguration
Returns ImageProcessingConfiguration

Properties

colorCurves

colorCurves: Nullable<ColorCurves>

Color curves setup used in the effect if colorCurvesEnabled is set to true

onUpdateParameters

onUpdateParameters: Observable<ImageProcessingConfiguration>

An event triggered when the configuration changes and requires Shader to Update some parameters.

outputTextureHeight

outputTextureHeight: number

Height of the output texture used in the post process. If not provided, uses the height of the screen.

outputTextureWidth

outputTextureWidth: number

Width of the output texture used in the post process. If not provided, uses the width of the screen.

vignetteCameraFov

vignetteCameraFov: number

Camera field of view used by the Vignette effect.

vignetteCenterX

vignetteCenterX: number

Vignette center X Offset.

vignetteCenterY

vignetteCenterY: number

Vignette center Y Offset.

vignetteColor

vignetteColor: Color4

Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode) if vignetteEnabled is set to true.

vignetteStretch

vignetteStretch: number

Vignette stretch size.

vignetteWeight

vignetteWeight: number

Vignette weight or intensity of the vignette effect.

`Static`PrepareSamplers

PrepareSamplers: (
samplersList: string[],
defines: IImageProcessingConfigurationDefines,
) => void

Prepare the list of samplers associated with the Image Processing effects.

Type declaration

- (samplersList: string[], defines: IImageProcessingConfigurationDefines): void
- Parameters
  - samplersList: string[]
    The list of uniforms used in the effect
  - defines: IImageProcessingConfigurationDefines
    the list of defines currently in use
  Returns void

`Static`PrepareUniforms

PrepareUniforms: (
uniforms: string[],
defines: IImageProcessingConfigurationDefines,
) => void

Prepare the list of uniforms associated with the Image Processing effects.

Type declaration

- (uniforms: string[], defines: IImageProcessingConfigurationDefines): void
- Parameters
  - uniforms: string[]
    The list of uniforms used in the effect
  - defines: IImageProcessingConfigurationDefines
    the list of defines currently in use
  Returns void

`Static` `Readonly`TONEMAPPING_ACES

TONEMAPPING_ACES: 1

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_KHR_PBR_NEUTRAL

TONEMAPPING_KHR_PBR_NEUTRAL: 2

Neutral Tone mapping developped by the Khronos group in order to constrain values between 0 and 1 without shifting Hue.

`Static` `Readonly`TONEMAPPING_STANDARD

TONEMAPPING_STANDARD: 0

Default tone mapping applied in BabylonJS.

Accessors

applyByPostProcess

get applyByPostProcess(): boolean
Gets whether the image processing is applied through a post process or not.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74041
set applyByPostProcess(value: boolean): void
Sets whether the image processing is applied through a post process or not.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74045

colorCurvesEnabled

get colorCurvesEnabled(): boolean
Gets whether the color curves effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73871
set colorCurvesEnabled(value: boolean): void
Sets whether the color curves effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73875

colorGradingBGR

get colorGradingBGR(): boolean
Gets whether the color grading texture contains BGR values.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73907
set colorGradingBGR(value: boolean): void
Sets whether the color grading texture contains BGR values.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73911

colorGradingEnabled

get colorGradingEnabled(): boolean
Gets whether the color grading effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73889
set colorGradingEnabled(value: boolean): void
Sets whether the color grading effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73893

colorGradingTexture

get colorGradingTexture(): Nullable<BaseTexture>
Color grading LUT texture used in the effect if colorGradingEnabled is set to true

Returns Nullable<BaseTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73880
set colorGradingTexture(value: Nullable<BaseTexture>): void
Color grading LUT texture used in the effect if colorGradingEnabled is set to true
Parameters
- value: Nullable<BaseTexture>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73884

colorGradingWithGreenDepth

get colorGradingWithGreenDepth(): boolean
Gets whether the color grading effect is using a green depth for the 3d Texture.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73898
set colorGradingWithGreenDepth(value: boolean): void
Sets whether the color grading effect is using a green depth for the 3d Texture.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73902

contrast

get contrast(): number
Gets the contrast used in the effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73944
set contrast(value: number): void
Sets the contrast used in the effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73948

ditheringEnabled

get ditheringEnabled(): boolean
Gets whether the dithering effect is enabled. The dithering effect can be used to reduce banding.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74009
set ditheringEnabled(value: boolean): void
Sets whether the dithering effect is enabled. The dithering effect can be used to reduce banding.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74014

ditheringIntensity

get ditheringIntensity(): number
Gets the dithering intensity. 0 is no dithering. Default is 1.0 / 255.0.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74019
set ditheringIntensity(value: number): void
Sets the dithering intensity. 0 is no dithering. Default is 1.0 / 255.0.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74023

exposure

get exposure(): number
Gets the Exposure used in the effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73917
set exposure(value: number): void
Sets the Exposure used in the effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73921

isEnabled

get isEnabled(): boolean
Gets whether the image processing is enabled or not.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74050
set isEnabled(value: boolean): void
Sets whether the image processing is enabled or not.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74054

skipFinalColorClamp

get skipFinalColorClamp(): 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.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74030
set skipFinalColorClamp(value: boolean): void
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74035

toneMappingEnabled

get toneMappingEnabled(): boolean
Gets whether the tone mapping effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73926
set toneMappingEnabled(value: boolean): void
Sets whether the tone mapping effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73930

toneMappingType

get toneMappingType(): number
Gets the type of tone mapping effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73935
set toneMappingType(value: number): void
Sets the type of tone mapping effect used in BabylonJS.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73939

vignetteBlendMode

get vignetteBlendMode(): number
Gets the vignette blend mode allowing different kind of effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73990
set vignetteBlendMode(value: number): void
Sets the vignette blend mode allowing different kind of effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73994

vignetteCentreX

get vignetteCentreX(): number
Back Compat: Vignette center X Offset.

Returns number
Deprecated
use vignetteCenterX instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73971
set vignetteCentreX(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73972

vignetteCentreY

get vignetteCentreY(): number
Back Compat: Vignette center Y Offset.

Returns number
Deprecated
use vignetteCenterY instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73965
set vignetteCentreY(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73966

vignetteEnabled

get vignetteEnabled(): boolean
Gets whether the vignette effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73999
set vignetteEnabled(value: boolean): void
Sets whether the vignette effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74003

`Static`VIGNETTEMODE_MULTIPLY

get VIGNETTEMODE_MULTIPLY(): number
Used to apply the vignette as a mix with the pixel color.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74126

`Static`VIGNETTEMODE_OPAQUE

get VIGNETTEMODE_OPAQUE(): number
Used to apply the vignette as a replacement of the pixel color.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74130

Methods

bind

bind(effect: Effect, overrideAspectRatio?: number): void
Binds the image processing to the shader.
Parameters
- effect: Effect
  The effect to bind to
- OptionaloverrideAspectRatio: number
  Override the aspect ratio of the effect
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74104

clone

clone(): ImageProcessingConfiguration
Clones the current image processing instance.

Returns ImageProcessingConfiguration
The cloned image processing
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74109

getClassName

getClassName(): string
Gets the current class name.

Returns string
"ImageProcessingConfiguration"
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74075

isReady

isReady(): boolean
Returns true if all the image processing information are ready.

Returns boolean
True if ready, otherwise, false
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74098

prepareDefines

prepareDefines(
defines: IImageProcessingConfigurationDefines,
forPostProcess?: boolean,
): void
Prepare the list of defines associated to the shader.
Parameters
- defines: IImageProcessingConfigurationDefines
  the list of defines to complete
- OptionalforPostProcess: boolean
  Define if we are currently in post process mode or not
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74093

serialize

serialize(): any
Serializes the current image processing instance to a json representation.

Returns any
a JSON representation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74114

`Static`Parse

Parse(source: any): ImageProcessingConfiguration
Parses the image processing from a json representation.
Parameters
- source: any
  the JSON source to parse
Returns ImageProcessingConfiguration
The parsed image processing
- Defined in .temp/typedoc/docdirectory/doc.d.ts:74120

Class ImageProcessingConfiguration

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ImageProcessingConfiguration

Properties

colorCurves

onUpdateParameters

outputTextureHeight

outputTextureWidth

vignetteCameraFov

vignetteCenterX

vignetteCenterY

vignetteColor

vignetteStretch

vignetteWeight

StaticPrepareSamplers

Type declaration

Parameters

Returns void

StaticPrepareUniforms

Type declaration

Parameters

Returns void

Static ReadonlyTONEMAPPING_ACES

Static ReadonlyTONEMAPPING_KHR_PBR_NEUTRAL

Static ReadonlyTONEMAPPING_STANDARD

Accessors

applyByPostProcess

Returns boolean

Parameters

Returns void

colorCurvesEnabled

Returns boolean

Parameters

Returns void

colorGradingBGR

Returns boolean

Parameters

Returns void

colorGradingEnabled

Returns boolean

Parameters

Returns void

colorGradingTexture

Returns Nullable<BaseTexture>

Parameters

Returns void

colorGradingWithGreenDepth

Returns boolean

Parameters

Returns void

contrast

Returns number

Parameters

Returns void

ditheringEnabled

Returns boolean

Parameters

Returns void

ditheringIntensity

Returns number

Parameters

Returns void

exposure

Returns number

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

skipFinalColorClamp

Returns boolean

Parameters

Returns void

`Static`PrepareSamplers

`Static`PrepareUniforms

`Static` `Readonly`TONEMAPPING_ACES

`Static` `Readonly`TONEMAPPING_KHR_PBR_NEUTRAL

`Static` `Readonly`TONEMAPPING_STANDARD

`Static`VIGNETTEMODE_MULTIPLY

`Static`VIGNETTEMODE_OPAQUE

`Static`Parse