Class ToneMappingEffect

constructor

• new ToneMappingEffect(options?): ToneMappingEffect

• Constructs a new tone mapping effect.

  The additional parameters only affect the Reinhard2 operator.

  Parameters

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

    The options.

    • OptionaladaptationRate?: number

      The luminance adaptation rate.

    • Optionaladaptive?: boolean

      Deprecated. Use mode instead.

    • OptionalaverageLuminance?: number

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

    • OptionalblendFunction?: BlendFunction

      The blend function of this effect.

    • OptionalmaxLuminance?: number

      Deprecated. Same as whitePoint.

    • OptionalmiddleGrey?: number

      The middle grey factor.

    • OptionalminLuminance?: number

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

    • Optionalmode?: ToneMappingMode

      The tone mapping mode.

    • Optionalresolution?: number

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

    • OptionalwhitePoint?: number

      The white point.

  Returns ToneMappingEffect

ReadonlyblendMode

Readonlydefines

Readonlyextensions

name

Readonlyuniforms

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

• get adaptiveLuminanceMaterial(): AdaptiveLuminanceMaterial

• The adaptive luminance material.

  Returns 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

• get mode(): ToneMappingMode

• The tone mapping mode.

  Returns ToneMappingMode
• set mode(arg): void

• Parameters

  • arg: ToneMappingMode

  Returns void

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

addEventListener

• addEventListener<T>(type, listener): void

• Adds a listener to an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<Event<string, unknown>[T], T, ToneMappingEffect>

    The function that gets called when the event is fired.

  Returns void

dispatchEvent

• dispatchEvent<T>(event): void

• Fire an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • event: BaseEvent<T> & Event<string, unknown>[T]

    The event that gets fired.

  Returns void

dispose

• dispose(): void

• 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

• getAdaptiveLuminanceMaterial(): AdaptiveLuminanceMaterial

• Returns the adaptive luminance material.

  Returns AdaptiveLuminanceMaterial

  The material.

  Deprecated

  Use adaptiveLuminanceMaterial instead.

getAttributes

• getAttributes(): EffectAttribute

• Returns the effect attributes.

  Returns EffectAttribute

  The attributes.

getBlendMode

• getBlendMode(): BlendMode

• 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

• getDefines(): Map<string, string>

• Returns the preprocessor macro definitions.

  Returns Map<string, string>

  The extensions.

  Deprecated

  Use defines instead.

getExtensions

• getExtensions(): Set<WebGLExtension>

• Returns the WebGL extensions that are required by this effect.

  Returns Set<WebGLExtension>

  The extensions.

  Deprecated

  Use extensions instead.

getFragmentShader

• getFragmentShader(): string

• Returns the fragment shader.

  Returns string

  The fragment shader.

getMode

• getMode(): ToneMappingMode

• Returns the current tone mapping mode.

  Returns ToneMappingMode

  The tone mapping mode.

  Deprecated

  Use mode instead.

getName

• getName(): string

• Returns the name of this effect.

  Returns string

  The name.

  Deprecated

  Use name instead.

getResolution

• getResolution(): number

• Returns the resolution of the luminance texture.

  Returns number

  The resolution.

  Deprecated

  Use resolution instead.

getUniforms

• getUniforms(): Map<string, Uniform<any>>

• Returns the uniforms of this effect.

  Returns Map<string, Uniform<any>>

  The extensions.

  Deprecated

  Use uniforms instead.

getVertexShader

• getVertexShader(): string

• Returns the vertex shader.

  Returns string

  The vertex shader.

hasEventListener

• hasEventListener<T>(type, listener): boolean

• Checks if listener is added to an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<Event<string, unknown>[T], T, ToneMappingEffect>

    The function that gets called when the event is fired.

  Returns boolean

initialize

• initialize(renderer, alpha, frameBufferType): void

• 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

• removeEventListener<T>(type, listener): void

• Removes a listener from an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of the listener that gets removed.
  • listener: EventListener<Event<string, unknown>[T], T, ToneMappingEffect>

    The listener function that gets removed.

  Returns void

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): void

• 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.
  • OptionaldepthPacking: DepthPackingStrategies

    The depth packing.

  Returns void

setMode

• setMode(value): void

• Sets the tone mapping mode.

  Parameters

  • value: ToneMappingMode

    The tone mapping mode.

  Returns void

  Deprecated

  Use mode instead.

setRenderer

• setRenderer(renderer): void

• Sets the renderer.

  Parameters

  • renderer: WebGLRenderer

    The renderer.

  Returns void

  Deprecated

setResolution

• setResolution(value): void

• 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

• setSize(width, height): void

• 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

update

• update(renderer, inputBuffer, deltaTime?): void

• Updates this effect.

  Parameters

  • renderer: WebGLRenderer

    The renderer.
  • inputBuffer: WebGLRenderTarget<Texture>

    A frame buffer that contains the result of the previous pass.
  • OptionaldeltaTime: number

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

  Returns void