Class SMAAEffect

constructor

• new SMAAEffect(options?): SMAAEffect

• Constructs a new SMAA effect.

  Parameters

  • Optionaloptions: {
        edgeDetectionMode?: EdgeDetectionMode;
        predicationMode?: PredicationMode;
        preset?: SMAAPreset;
    }

    The options.

    • OptionaledgeDetectionMode?: EdgeDetectionMode

      The edge detection mode.

    • OptionalpredicationMode?: PredicationMode

      The predication mode.

    • Optionalpreset?: SMAAPreset

      The quality preset.

  Returns SMAAEffect

ReadonlyblendMode

Readonlydefines

Readonlyextensions

name

Readonlyuniforms

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

StaticareaImageDataURL

• get areaImageDataURL(): string

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

  Returns string

  Deprecated

StaticsearchImageDataURL

• get searchImageDataURL(): string

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

  Returns string

  Deprecated

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, SMAAEffect>

    The function that gets called when the event is fired.

  Returns void

applyPreset

• applyPreset(preset): void

• Applies the given quality preset.

  Parameters

  • preset: SMAAPreset

    The preset.

  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

• Deletes internal render targets and textures.

  Returns void

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.

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.

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, SMAAEffect>

    The function that gets called when the event is fired.

  Returns boolean

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; }
  Copy

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, SMAAEffect>

    The listener function that gets removed.

  Returns void

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): void

• Sets the depth texture.

  Parameters

  • depthTexture: Texture

    A depth texture.
  • OptionaldepthPacking: 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.

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

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