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 (view full)

Effect
- ToneMappingEffect

Constructors

constructor

new ToneMappingEffect(options?): ToneMappingEffect
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
Overrides Effect.constructor

Properties

`Readonly` blendMode

blendMode: BlendMode

The blend mode of this effect.

`Readonly` defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

`Readonly` extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.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 Effect.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

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
Inherited from Effect.inputColorSpace
set inputColorSpace(arg): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.inputColorSpace

mainCamera

set mainCamera(arg): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Effect.mainCamera

mainScene

set mainScene(arg): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Effect.mainScene

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
Inherited from Effect.outputColorSpace
set outputColorSpace(arg): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.outputColorSpace

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

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
Inherited from Effect.dispose

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.

Inherited from Effect.getAttributes

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.

Inherited from Effect.getBlendMode

getDefines

getDefines(): Map<string, string>
Returns the preprocessor macro definitions.

Returns Map<string, string>
The extensions.

Deprecated
Use defines instead.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

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.

Inherited from Effect.getName

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.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

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
Overrides Effect.initialize

`Protected` setAttributes

setAttributes(attributes): void
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
- attributes: EffectAttribute
  The attributes.
Returns void
Inherited from Effect.setAttributes

`Protected` setChanged

setChanged(): void
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
Inherited from Effect.setChanged

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.
- Optional depthPacking: DepthPackingStrategies
  The depth packing.
Returns void
Inherited from Effect.setDepthTexture

`Protected` setFragmentShader

setFragmentShader(fragmentShader): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  The fragment shader.
Returns void
Inherited from Effect.setFragmentShader

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
Inherited from Effect.setRenderer

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
Inherited from Effect.setSize

`Protected` setVertexShader

setVertexShader(vertexShader): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  The vertex shader.
Returns void
Inherited from Effect.setVertexShader

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.
- Optional deltaTime: number
  The time between the last frame and the current one in seconds.
Returns void
Overrides Effect.update

Class ToneMappingEffect

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

Optional adaptationRate?: number

Optional adaptive?: boolean

Optional averageLuminance?: number

Optional blendFunction?: BlendFunction

Optional maxLuminance?: number

Optional middleGrey?: number

Optional minLuminance?: number

Optional mode?: ToneMappingMode

Optional resolution?: number

Optional whitePoint?: number

Returns ToneMappingEffect

Properties

Readonly blendMode

Readonly defines

Readonly extensions

name

Protected renderer

Deprecated

Readonly uniforms

Accessors

adaptationRate

Returns number

Deprecated

Parameters

arg: number

Returns void

adaptive

Returns boolean

Deprecated

Parameters

arg: boolean

Returns void

adaptiveLuminanceMaterial

Returns AdaptiveLuminanceMaterial

averageLuminance

Returns number

distinction

Returns number

Deprecated

Parameters

arg: number

Returns void

inputColorSpace

Returns ColorSpace

Parameters

arg: ColorSpace

Returns void

mainCamera

Parameters

arg: Camera

Returns void

mainScene

Parameters

arg: Scene

Returns void

middleGrey

Returns number

mode

Returns ToneMappingMode

Parameters

arg: ToneMappingMode

Returns void

outputColorSpace

Returns ColorSpace

Parameters

arg: ColorSpace

Returns void

resolution

Returns number

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

`Optional` adaptationRate?: number

`Optional` adaptive?: boolean

`Optional` averageLuminance?: number

`Optional` blendFunction?: BlendFunction

`Optional` maxLuminance?: number

`Optional` middleGrey?: number

`Optional` minLuminance?: number

`Optional` mode?: ToneMappingMode

`Optional` resolution?: number

`Optional` whitePoint?: number

`Readonly` blendMode

`Readonly` defines

`Readonly` extensions

`Protected` renderer

`Readonly` uniforms

`Protected` setAttributes

`Protected` setChanged

`Optional` depthPacking: DepthPackingStrategies

`Protected` setFragmentShader