Class ToneMappingEffect

A tone mapping effect.

Note: ToneMappingMode.REINHARD2_ADAPTIVE requires support for EXT_shader_texture_lod.

Reference: GDC2007 - Wolfgang Engel, Post-Processing Pipeline http://perso.univ-lyon1.fr/jean-claude.iehl/Public/educ/GAMA/2007/gdc07/Post-Processing_Pipeline.pdf

Hierarchy

Constructors

constructor

Properties

blendMode defines extensions name renderer uniforms

Accessors

adaptationRate adaptive adaptiveLuminanceMaterial averageLuminance distinction inputColorSpace mainCamera mainScene middleGrey mode outputColorSpace resolution whitePoint

Methods

addEventListener dispatchEvent dispose getAdaptiveLuminanceMaterial getAttributes getBlendMode getDefines getExtensions getFragmentShader getMode getName getResolution getUniforms getVertexShader hasEventListener initialize removeEventListener setAttributes setChanged setDepthTexture setFragmentShader setMode setRenderer setResolution setSize setVertexShader update

Constructors

constructor

  • Constructs a new tone mapping effect.

    The additional parameters only affect the Reinhard2 operator.

    Parameters

    • Optional options: {
          adaptationRate?: number;
          adaptive?: boolean;
          averageLuminance?: number;
          blendFunction?: BlendFunction;
          maxLuminance?: number;
          middleGrey?: number;
          minLuminance?: number;
          mode?: ToneMappingMode;
          resolution?: number;
          whitePoint?: number;
      }

      The options.

      • Optional adaptationRate?: number

        The luminance adaptation rate.

      • Optional adaptive?: boolean

        Deprecated. Use mode instead.

      • Optional averageLuminance?: number

        The average luminance. Used for the non-adaptive Reinhard operator.

      • Optional blendFunction?: BlendFunction

        The blend function of this effect.

      • Optional maxLuminance?: number

        Deprecated. Same as whitePoint.

      • Optional middleGrey?: number

        The middle grey factor.

      • Optional minLuminance?: number

        The minimum luminance. Prevents very high exposure in dark scenes.

      • Optional mode?: ToneMappingMode

        The tone mapping mode.

      • Optional resolution?: number

        The resolution of the luminance texture. Must be a power of two.

      • Optional whitePoint?: number

        The white point.

    Returns ToneMappingEffect

Properties

Readonly blendMode

blendMode: BlendMode

The blend mode of this effect.

Readonly defines

defines: Map<string, string>

Preprocessor macro definitions.

Call setChanged after changing macro definitions.

Readonly extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call setChanged after adding or removing extensions.

name

name: string

The name of this effect.

Protected renderer

renderer: WebGLRenderer

The renderer.

Deprecated

Readonly uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call setChanged after adding or removing uniforms.

Accessors

adaptationRate

  • get adaptationRate(): number

  • The luminance adaptation rate.

    Returns number

    Deprecated

    Use adaptiveLuminanceMaterial.adaptationRate instead.

  • set adaptationRate(arg): void

  • Parameters

    • arg: number

    Returns void

adaptive

  • get adaptive(): boolean

  • Indicates whether this pass uses adaptive luminance.

    Returns boolean

    Deprecated

    Use mode instead.

  • set adaptive(arg): void

  • Parameters

    • arg: boolean

    Returns void

adaptiveLuminanceMaterial

averageLuminance

  • get averageLuminance(): number

  • The average luminance.

    Only applies to Reinhard2 (Modified).

    Returns number

distinction

  • get distinction(): number

  • Returns number

    Deprecated

  • set distinction(arg): void

  • Parameters

    • arg: number

    Returns void

inputColorSpace

  • get inputColorSpace(): ColorSpace
  • Experimental

    The input color space.

    Returns ColorSpace

  • set inputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

mainCamera

  • set mainCamera(arg): void

  • Sets the main camera.

    Parameters

    • arg: Camera

    Returns void

mainScene

  • set mainScene(arg): void

  • Sets the main scene.

    Parameters

    • arg: Scene

    Returns void

middleGrey

  • get middleGrey(): number

  • The middle grey factor. Default is 0.6.

    Only applies to Reinhard2 (Modified & Adaptive).

    Returns number

mode

outputColorSpace

  • get outputColorSpace(): ColorSpace
  • Experimental

    The output color space.

    Should only be changed if this effect converts the input colors to a different color space.

    Returns ColorSpace

  • set outputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

resolution

  • get resolution(): number

  • The resolution of the luminance texture. Must be a power of two.

    Returns number

  • set resolution(arg): void

  • Parameters

    • arg: number

    Returns void

whitePoint

  • get whitePoint(): number

  • The white point. Default is 16.0.

    Only applies to Reinhard2 (Modified & Adaptive).

    Returns number

Methods

addEventListener

  • Adds a listener to an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<BaseEventMap[T], T, ToneMappingEffect>

      The function that gets called when the event is fired.

    Returns void

dispatchEvent

  • Fire an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • event: BaseEvent<T> & BaseEventMap[T]

      The event that gets fired.

    Returns void

dispose

  • Performs a shallow search for properties that define a dispose method and deletes them.

    The EffectComposer calls this method when it is being destroyed.

    Returns void

getAdaptiveLuminanceMaterial

getAttributes

getBlendMode

  • Returns the blend mode.

    The result of this effect will be blended with the result of the previous effect using this blend mode.

    Returns BlendMode

    The blend mode.

    Deprecated

    Use blendMode instead.

getDefines

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

getExtensions

getFragmentShader

  • Returns the fragment shader.

    Returns string

    The fragment shader.

getMode

getName

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

getResolution

  • Returns the resolution of the luminance texture.

    Returns number

    The resolution.

    Deprecated

    Use resolution instead.

getUniforms

  • Returns the uniforms of this effect.

    Returns Map<string, Uniform<any>>

    The extensions.

    Deprecated

    Use uniforms instead.

getVertexShader

  • Returns the vertex shader.

    Returns string

    The vertex shader.

hasEventListener

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<BaseEventMap[T], T, ToneMappingEffect>

      The function that gets called when the event is fired.

    Returns boolean

initialize

  • Performs initialization tasks.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • alpha: boolean

      Whether the renderer uses the alpha channel or not.

    • frameBufferType: number

      The type of the main frame buffers.

    Returns void

removeEventListener

  • Removes a listener from an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<BaseEventMap[T], T, ToneMappingEffect>

      The listener function that gets removed.

    Returns void

Protected setAttributes

  • Protected

    Sets the effect attributes.

    Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.

    Parameters

    Returns void

Protected setChanged

  • Protected

    Informs the associated EffectPass that this effect requires a shader recompilation.

    Should be called after changing macros or extensions and after adding/removing uniforms.

    Returns void

setDepthTexture

  • Sets the depth texture.

    You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.

    Parameters

    • depthTexture: Texture

      A depth texture.

    • Optional depthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

Protected setFragmentShader

  • Protected

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setMode

  • Sets the tone mapping mode.

    Parameters

    Returns void

    Deprecated

    Use mode instead.

setRenderer

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setResolution

  • Sets the resolution of the luminance texture. Must be a power of two.

    Parameters

    • value: number

      The resolution.

    Returns void

    Deprecated

    Use resolution instead.

setSize

  • Updates the size of this effect.

    You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

Protected setVertexShader

  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

update

  • Updates this effect.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • inputBuffer: WebGLRenderTarget<Texture>

      A frame buffer that contains the result of the previous pass.

    • Optional deltaTime: number

      The time between the last frame and the current one in seconds.

    Returns void

Settings

Member Visibility

Theme

On This Page