Home Reference Source
import {ColorEdgesMaterial} from 'postprocessing/src/materials/ColorEdgesMaterial.js'
public class | source

ColorEdgesMaterial

Extends:

three~ShaderMaterial → ColorEdgesMaterial

A material that detects edges in a color texture.

Mainly used for Subpixel Morphological Antialiasing.

Constructor Summary

Public Constructor
public

constructor(texelSize: Vector2)

Constructs a new color edges material.

Member Summary

Public Members
public

Method Summary

Public Methods
public

Sets the edge detection sensitivity.

Public Constructors

public constructor(texelSize: Vector2) source

Constructs a new color edges material.

Params:

NameTypeAttributeDescription
texelSize Vector2
  • optional

The absolute screen texel size.

Public Members

public needsUpdate: boolean source

Public Methods

public setEdgeDetectionThreshold(threshold: Number) source

Sets the edge detection sensitivity.

A lower value results in more edges being detected at the expense of performance.

0.1 is a reasonable value, and allows to catch most visible edges. 0.05 is a rather overkill value, that allows to catch 'em all.

If temporal supersampling is used, 0.2 could be a reasonable value, as low contrast edges are properly filtered by just 2x.

Params:

NameTypeAttributeDescription
threshold Number

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