Class SMAAEffect

Subpixel Morphological Antialiasing (SMAA).

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

Hierarchy (view full)

Constructors

constructor

Properties

blendMode defines extensions name renderer uniforms

Accessors

colorEdgesMaterial edgeDetectionMaterial edgesTexture inputColorSpace mainCamera mainScene outputColorSpace weightsMaterial weightsTexture areaImageDataURL searchImageDataURL

Methods

applyPreset dispose getAttributes getBlendMode getDefines getEdgeDetectionMaterial getEdgesTexture getExtensions getFragmentShader getName getUniforms getVertexShader getWeightsMaterial getWeightsTexture initialize setAttributes setChanged setDepthTexture setEdgeDetectionThreshold setFragmentShader setOrthogonalSearchSteps setRenderer setSize setVertexShader update

Constructors

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

colorEdgesMaterial

  • get colorEdgesMaterial(): EdgeDetectionMaterial

  • The edge detection material.

    Returns EdgeDetectionMaterial

    Deprecated

    Use edgeDetectionMaterial instead.

edgeDetectionMaterial

  • get edgeDetectionMaterial(): EdgeDetectionMaterial

  • The edge detection material.

    Returns EdgeDetectionMaterial

edgesTexture

  • get edgesTexture(): Texture

  • The edges texture.

    Returns Texture

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

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

weightsMaterial

  • get weightsMaterial(): SMAAWeightsMaterial

  • The edge weights material.

    Returns SMAAWeightsMaterial

weightsTexture

  • get weightsTexture(): Texture

  • The edge weights texture.

    Returns Texture

Static areaImageDataURL

  • get areaImageDataURL(): string

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

    Returns string

    Deprecated

Static searchImageDataURL

  • get searchImageDataURL(): string

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

    Returns string

    Deprecated

Methods

applyPreset

  • applyPreset(preset): void

  • Applies the given quality preset.

    Parameters

    Returns void

dispose

  • dispose(): void

  • Deletes internal render targets and textures.

    Returns void

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.

getDefines

  • getDefines(): Map<string, string>

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

getEdgeDetectionMaterial

  • getEdgeDetectionMaterial(): EdgeDetectionMaterial

  • Returns the edge detection material.

    Returns EdgeDetectionMaterial

    The material.

    Deprecated

    Use edgeDetectionMaterial instead.

getEdgesTexture

  • getEdgesTexture(): Texture

  • Returns the edges texture.

    Returns Texture

    The texture.

    Deprecated

    Use edgesTexture 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.

getName

  • getName(): string

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name 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.

getWeightsMaterial

  • getWeightsMaterial(): SMAAWeightsMaterial

  • Returns the edge weights material.

    Returns SMAAWeightsMaterial

    The material.

    Deprecated

    Use weightsMaterial instead.

getWeightsTexture

  • getWeightsTexture(): Texture

  • Returns the edge weights texture.

    Returns Texture

    The texture.

    Deprecated

    Use weightsTexture instead.

initialize

  • initialize(renderer, alpha, frameBufferType): void

  • Performs initialization tasks.

    This method is called when the associated EffectPass is added to an EffectComposer.

    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

    Example

    if(!alpha && frameBufferType === UnsignedByteType) { this.myRenderTarget.texture.format = RGBFormat; }

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

    Returns void

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

setDepthTexture

  • setDepthTexture(depthTexture, depthPacking?): void

  • Sets the depth texture.

    Parameters

    • depthTexture: Texture

      A depth texture.

    • Optional depthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

setEdgeDetectionThreshold

  • setEdgeDetectionThreshold(threshold): void

  • Sets the edge detection sensitivity.

    See EdgeDetectionMaterial#setEdgeDetectionThreshold for more details.

    Parameters

    • threshold: number

      The edge detection sensitivity. Range: [0.05, 0.5].

    Returns void

    Deprecated

    Use edgeDetectionMaterial instead.

Protected setFragmentShader

  • setFragmentShader(fragmentShader): void
  • Protected

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setOrthogonalSearchSteps

  • setOrthogonalSearchSteps(steps): void

  • Sets the maximum amount of horizontal/vertical search steps.

    See SMAAWeightsMaterial#setOrthogonalSearchSteps for more details.

    Parameters

    • steps: number

      The search steps. Range: [0, 112].

    Returns void

    Deprecated

    Use weightsMaterial instead.

setRenderer

  • setRenderer(renderer): void

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setSize

  • setSize(width, height): void

  • Updates the size of internal render targets.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

Protected setVertexShader

  • setVertexShader(vertexShader): void
  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    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.

    • Optional deltaTime: number

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

    Returns void

Settings

Member Visibility

Theme

On This Page