import {SMAAEffect} from 'postprocessing'

public class | source

SMAAEffect

Extends:

three~EventDispatcher → Effect → SMAAEffect

Indirect Implements:

Subpixel Morphological Antialiasing (SMAA).

https://github.com/iryoku/smaa/releases/tag/v2.8

Static Member Summary

Static Public Members
public static get	areaImageDataURL: String this get was deprecated. The SMAA area image, encoded as a base64 data URL.
public static get	searchImageDataURL: String this get was deprecated. The SMAA search image, encoded as a base64 data URL.

Constructor Summary

Public Constructor
public	constructor(options: Object) Constructs a new SMAA effect.

Member Summary

Public Members
public get	colorEdgesMaterial: EdgeDetectionMaterial this get was deprecated. Use edgeDetectionMaterial instead. The edge detection material.
public get	edgeDetectionMaterial: EdgeDetectionMaterial The edge detection material.
public get	edgesTexture: Texture The edges texture.
public get	weightsMaterial: SMAAWeightsMaterial The edge weights material.
public get	weightsTexture: Texture The edge weights texture.

Method Summary

Public Methods
public	applyPreset(preset: SMAAPreset) Applies the given quality preset.
public	dispose() Deletes internal render targets and textures.
public	getEdgeDetectionMaterial(): EdgeDetectionMaterial this method was deprecated. Use edgeDetectionMaterial instead. Returns the edge detection material.
public	getEdgesTexture(): Texture this method was deprecated. Use edgesTexture instead. Returns the edges texture.
public	getWeightsMaterial(): SMAAWeightsMaterial this method was deprecated. Use weightsMaterial instead. Returns the edge weights material.
public	getWeightsTexture(): Texture this method was deprecated. Use weightsTexture instead. Returns the edge weights texture.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setEdgeDetectionThreshold(threshold: Number) this method was deprecated. Use edgeDetectionMaterial instead. Sets the edge detection sensitivity.
public	setOrthogonalSearchSteps(steps: Number) this method was deprecated. Use weightsMaterial instead. Sets the maximum amount of horizontal/vertical search steps.
public	setSize(width: Number, height: Number) Updates the size of internal render targets.
public	update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) Updates this effect.

Inherited Summary

From class Effect
public get	inputColorSpace: ColorSpace this get is experimental. The input color space.
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	outputColorSpace: ColorSpace this get is experimental. The output color space.
protected set	inputColorSpace: ColorSpace this set is experimental.
protected set	outputColorSpace: ColorSpace this set is experimental.
public	blendMode: BlendMode The blend mode of this effect.
public	defines: Map<String, String> Preprocessor macro definitions.
public	extensions: Set<WebGLExtension> WebGL extensions that are required by this effect.
public	name: String The name of this effect.
public	uniforms: Map<String, Uniform> Shader uniforms.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
public	dispose() Performs a shallow search for properties that define a dispose method and deletes them.
public	getAttributes(): EffectAttribute Returns the effect attributes.
public	getBlendMode(): BlendMode this method was deprecated. Use blendMode instead. Returns the blend mode.
public	getDefines(): Map<String, String> this method was deprecated. Use defines instead. Returns the preprocessor macro definitions.
public	getExtensions(): Set<WebGLExtension> this method was deprecated. Use extensions instead. Returns the WebGL extensions that are required by this effect.
public	getFragmentShader(): String Returns the fragment shader.
public	getName(): String this method was deprecated. Use name instead. Returns the name of this effect.
public	getUniforms(): Map<String, Uniform> this method was deprecated. Use uniforms instead. Returns the uniforms of this effect.
public	getVertexShader(): String Returns the vertex shader.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer.
public	setSize(width: Number, height: Number) Updates the size of this effect.
public	update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) Updates this effect by performing supporting operations.
protected	setAttributes(attributes: EffectAttribute) Sets the effect attributes.
protected	setChanged() Informs the associated EffectPass that this effect requires a shader recompilation.
protected	setFragmentShader(fragmentShader: String) Sets the fragment shader.
protected	setVertexShader(vertexShader: String) Sets the vertex shader.

Static Public Members

public static get areaImageDataURL: String source

this get was deprecated.

The SMAA area image, encoded as a base64 data URL.

public static get searchImageDataURL: String source

this get was deprecated.

The SMAA search image, encoded as a base64 data URL.

Public Constructors

public constructor(options: Object) source

Constructs a new SMAA effect.

Override:

Effect#constructor

Params:

Name	Type	Attribute	Description
options	Object	optional	The options.
options.blendFunction	BlendFunction	optional default: BlendFunction.SRC	The blend function of this effect.
options.preset	SMAAPreset	optional default: SMAAPreset.MEDIUM	The quality preset.
options.edgeDetectionMode	EdgeDetectionMode	optional default: EdgeDetectionMode.COLOR	The edge detection mode.
options.predicationMode	PredicationMode	optional default: PredicationMode.DISABLED	The predication mode.

Public Members

public get colorEdgesMaterial: EdgeDetectionMaterial source

this get was deprecated. Use edgeDetectionMaterial instead.

The edge detection material.

public get edgeDetectionMaterial: EdgeDetectionMaterial source

The edge detection material.

public get edgesTexture: Texture source

The edges texture.

public get weightsMaterial: SMAAWeightsMaterial source

The edge weights material.

public get weightsTexture: Texture source

The edge weights texture.

Public Methods

public applyPreset(preset: SMAAPreset) source

Applies the given quality preset.

Params:

Name	Type	Attribute	Description
preset	SMAAPreset		The preset.

public dispose() source

Deletes internal render targets and textures.

Override:

Effect#dispose

public getEdgeDetectionMaterial(): EdgeDetectionMaterial source

this method was deprecated. Use edgeDetectionMaterial instead.

Returns the edge detection material.

Return:

EdgeDetectionMaterial

The material.

public getEdgesTexture(): Texture source

this method was deprecated. Use edgesTexture instead.

Returns the edges texture.

Return:

Texture

The texture.

public getWeightsMaterial(): SMAAWeightsMaterial source

this method was deprecated. Use weightsMaterial instead.

Returns the edge weights material.

Return:

SMAAWeightsMaterial

The material.

public getWeightsTexture(): Texture source

this method was deprecated. Use weightsTexture instead.

Returns the edge weights texture.

Return:

Texture

The texture.

public setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) source

Sets the depth texture.

Override:

Effect#setDepthTexture

Params:

Name	Type	Attribute	Description
depthTexture	Texture		A depth texture.
depthPacking	DepthPackingStrategies	optional default: BasicDepthPacking	The depth packing.

public setEdgeDetectionThreshold(threshold: Number) source

this method was deprecated. Use edgeDetectionMaterial instead.

Sets the edge detection sensitivity.

See EdgeDetectionMaterial#setEdgeDetectionThreshold for more details.

Params:

Name	Type	Attribute	Description
threshold	Number		The edge detection sensitivity. Range: [0.05, 0.5].

public setOrthogonalSearchSteps(steps: Number) source

this method was deprecated. Use weightsMaterial instead.

Sets the maximum amount of horizontal/vertical search steps.

See SMAAWeightsMaterial#setOrthogonalSearchSteps for more details.

Params:

Name	Type	Attribute	Description
steps	Number		The search steps. Range: [0, 112].

public setSize(width: Number, height: Number) source

Updates the size of internal render targets.

Override:

Effect#setSize

Params:

Name	Type	Attribute	Description
width	Number		The width.
height	Number		The height.

public update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) source

Updates this effect.

Override:

Effect#update

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
inputBuffer	WebGLRenderTarget		A frame buffer that contains the result of the previous pass.
deltaTime	Number	optional	The time between the last frame and the current one in seconds.