import {AdaptiveLuminancePass} from 'postprocessing'

public class | source

AdaptiveLuminancePass

Extends:

Pass → AdaptiveLuminancePass

Indirect Implements:

A pass that renders an adaptive luminance map.

Constructor Summary

Public Constructor
public	constructor(luminanceBuffer: Texture, options: Object) Constructs a new adaptive luminance pass.

Member Summary

Public Members
public get	adaptationRate: Number this get was deprecated. Use fullscreenMaterial.adaptationRate instead. The luminance adaptation rate.
public set	adaptationRate: Number this set was deprecated. Use fullscreenMaterial.adaptationRate instead.
public	fullscreenMaterial: *
public set	mipLevel1x1: Number this set was deprecated. Use fullscreenMaterial.mipLevel1x1 instead. Sets the 1x1 mipmap level.
public	needsSwap: boolean
public get	texture: Texture The adaptive luminance texture.

Method Summary

Public Methods
public	getTexture(): Texture this method was deprecated. Use texture instead. Returns the adaptive 1x1 luminance texture.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the scene normals.

Inherited Summary

From class Pass
public static get	fullscreenGeometry: BufferGeometry A shared fullscreen triangle.
public get	fullscreenMaterial: Material The fullscreen material.
public set	fullscreenMaterial
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	renderToScreen: Boolean Sets the render to screen flag.
public set	renderToScreen
public	enabled: Boolean Indicates whether this pass is enabled.
public	name: String The name of this pass.
public	needsDepthTexture: Boolean Only relevant for subclassing.
public	needsSwap: Boolean Only relevant for subclassing.
protected	camera: Camera The camera.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
protected	scene: Scene The scene to render.
public	dispose() Performs a shallow search for disposable properties and deletes them.
public	getDepthTexture(): Texture Returns the current depth texture.
public	getFullscreenMaterial(): Material this method was deprecated. Use fullscreenMaterial instead. Returns the current fullscreen material.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	isEnabled(): Boolean this method was deprecated. Use enabled instead. Indicates whether this pass is enabled.
public abstract	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders this pass.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy) Sets the depth texture.
public	setEnabled(value: Boolean) this method was deprecated. Use enabled instead. Enables or disables this pass.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer
public	setSize(width: Number, height: Number) Sets the size.
protected	setFullscreenMaterial(value: Material) this method was deprecated. Use fullscreenMaterial instead. Sets the fullscreen material.

Public Constructors

public constructor(luminanceBuffer: Texture, options: Object) source

Constructs a new adaptive luminance pass.

Override:

Pass#constructor

Params:

Name	Type	Attribute	Description
luminanceBuffer	Texture		A buffer that contains the current scene luminance.
options	Object	optional	The options.
options.minLuminance	Number	optional default: 0.01	The minimum luminance.
options.adaptationRate	Number	optional default: 1.0	The luminance adaptation rate.

Public Members

public get adaptationRate: Number source

this get was deprecated. Use fullscreenMaterial.adaptationRate instead.

The luminance adaptation rate.

public set adaptationRate: Number source

this set was deprecated. Use fullscreenMaterial.adaptationRate instead.

public fullscreenMaterial: * source

The fullscreen material.

Override:

Pass#fullscreenMaterial

public set mipLevel1x1: Number source

this set was deprecated. Use fullscreenMaterial.mipLevel1x1 instead.

Sets the 1x1 mipmap level.

This level is used to identify the smallest mipmap of the main luminance texture which contains the downsampled average scene luminance.

public needsSwap: boolean source

Only relevant for subclassing.

Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering. Set this to false if this pass doesn't render to the output buffer or the screen. Otherwise, the contents of the input buffer will be lost.

Override:

Pass#needsSwap

public get texture: Texture source

The adaptive luminance texture.

Public Methods

public getTexture(): Texture source

this method was deprecated. Use texture instead.

Returns the adaptive 1x1 luminance texture.

Return:

Texture

The texture.

public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source

Renders the scene normals.

Override:

Pass#render

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
inputBuffer	WebGLRenderTarget		A frame buffer that contains the result of the previous pass.
outputBuffer	WebGLRenderTarget		A frame buffer that serves as the output render target unless this pass renders to screen.
deltaTime	Number	optional	The time between the last frame and the current one in seconds.
stencilTest	Boolean	optional	Indicates whether a stencil mask is active.