Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • ImageProcessingConfiguration

Index

Constructors

Properties

_applyByPostProcess: boolean
internal
_exposure: number
internal
_skipFinalColorClamp: boolean
internal
colorCurves: Nullable<ColorCurves>

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

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

vignetteCameraFov: number

Camera field of view used by the Vignette effect.

vignetteCentreX: number

Vignette centre X Offset.

vignetteCentreY: number

Vignette centre Y Offset.

vignetteColor: Color4

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

vignetteStretch: number

Vignette stretch size.

vignetteWeight: number

Vignette weight or intensity of the vignette effect.

TONEMAPPING_ACES: 1 = 1

ACES Tone mapping (used by default in unreal and unity). This can help getting closer to other engines rendering to increase portability.

TONEMAPPING_STANDARD: 0 = 0

Default tone mapping applied in BabylonJS.

Accessors

  • get applyByPostProcess(): boolean
  • set applyByPostProcess(value: boolean): void
  • 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

  • get colorCurvesEnabled(): boolean
  • set colorCurvesEnabled(value: boolean): void
  • Gets whether the color curves effect is enabled.

    Returns boolean

  • Sets whether the color curves effect is enabled.

    Parameters

    • value: boolean

    Returns void

  • get colorGradingBGR(): boolean
  • set colorGradingBGR(value: boolean): void
  • 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

  • get colorGradingEnabled(): boolean
  • set colorGradingEnabled(value: boolean): void
  • 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 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

    Returns void

  • get colorGradingWithGreenDepth(): boolean
  • set colorGradingWithGreenDepth(value: boolean): void
  • 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

  • get contrast(): number
  • set contrast(value: number): void
  • Gets the contrast used in the effect.

    Returns number

  • Sets the contrast used in the effect.

    Parameters

    • value: number

    Returns void

  • get ditheringEnabled(): boolean
  • set ditheringEnabled(value: boolean): void
  • 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

  • get ditheringIntensity(): number
  • set ditheringIntensity(value: number): void
  • 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

  • get exposure(): number
  • set exposure(value: number): void
  • Gets the Exposure used in the effect.

    Returns number

  • Sets the Exposure used in the effect.

    Parameters

    • value: number

    Returns void

  • get isEnabled(): boolean
  • set isEnabled(value: boolean): void
  • 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

  • get skipFinalColorClamp(): boolean
  • set skipFinalColorClamp(value: boolean): void
  • If apply by post process is set to true, setting this to true will skip the 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 the final color clamp step in the fragment shader Applies to PBR materials.

    Parameters

    • value: boolean

    Returns void

  • get toneMappingEnabled(): boolean
  • set toneMappingEnabled(value: boolean): void
  • Gets whether the tone mapping effect is enabled.

    Returns boolean

  • Sets whether the tone mapping effect is enabled.

    Parameters

    • value: boolean

    Returns void

  • get toneMappingType(): number
  • set toneMappingType(value: number): void
  • Gets the type of tone mapping effect.

    Returns number

  • Sets the type of tone mapping effect used in BabylonJS.

    Parameters

    • value: number

    Returns void

  • get vignetteBlendMode(): number
  • set vignetteBlendMode(value: number): void
  • 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

  • get vignetteEnabled(): boolean
  • set vignetteEnabled(value: boolean): void
  • Gets whether the vignette effect is enabled.

    Returns boolean

  • Sets whether the vignette effect is enabled.

    Parameters

    • value: boolean

    Returns void

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

    Returns number

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

    Returns number

Methods

  • bind(effect: Effect, overrideAspectRatio?: number): void
  • 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

  • Clones the current image processing instance.

    Returns ImageProcessingConfiguration

    The cloned image processing

  • getClassName(): string
  • Gets the current class name.

    Returns string

    "ImageProcessingConfiguration"

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

    Returns boolean

    True if ready, otherwise, false

  • Prepare the list of defines associated to the shader.

    Parameters

    Returns void

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

    Returns any

    a JSON representation

  • Parses the image processing from a json representation.

    Parameters

    • source: any

      the JSON source to parse

    Returns ImageProcessingConfiguration

    The parsed image processing

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

    Parameters

    Returns void

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

    Parameters

    Returns void

Legend

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

Settings

Theme