Class EdgeDetectionMaterial

An edge detection material.

Mainly used for Subpixel Morphological Anti-Aliasing.

Implements

Hierarchy

ShaderMaterial
- EdgeDetectionMaterial

Implements

Resizable

Index

Constructors

constructor

Accessors

alphaTest depthBuffer depthPacking edgeDetectionMode edgeDetectionThreshold localContrastAdaptationFactor needsUpdate predicationBuffer predicationMode predicationScale predicationStrength predicationThreshold

Constructors

constructor

new EdgeDetectionMaterial(texelSize?, mode?): EdgeDetectionMaterial
Constructs a new edge detection material.

TODO Remove parameters.
Parameters
- Optional texelSize: Vector2
  
  The screen texel size.
- Optional mode: EdgeDetectionMode
  
  The edge detection mode.
Returns EdgeDetectionMaterial

Overrides ShaderMaterial.constructor

Properties

alphaHash

alphaHash: boolean

Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

alphaToCoverage

alphaToCoverage: boolean

Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts (meaning when the renderer was created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and alphaTest-clipped edges.

Default

false

blendAlpha

blendAlpha: number

Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

Default

blendColor

blendColor: Color

Represent the RGB values of the constant blend color. This property has only an effect when using custom blending with ConstantColorFactor or OneMinusConstantColorFactor.

Default

0x000000

blendDst

blendDst: BlendingDstFactor

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

Default

THREE.OneMinusSrcAlphaFactor

blendDstAlpha

blendDstAlpha: number

The tranparency of the .blendDst. Default is null.

Default

null

blendEquation

blendEquation: BlendingEquation

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

Default

THREE.AddEquation

blendEquationAlpha

blendEquationAlpha: number

The tranparency of the .blendEquation. Default is null.

Default

null

blendSrc

blendSrc: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 211 | 212 | 213 | 214 | 210

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

Default

THREE.SrcAlphaFactor

blendSrcAlpha

blendSrcAlpha: number

The tranparency of the .blendSrc. Default is null.

Default

null

blending

blending: Blending

Which blending to use when displaying objects with this material. Default is NormalBlending.

Default

THREE.NormalBlending

clipIntersection

clipIntersection: boolean

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

Default

false

clipShadows

clipShadows: boolean

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

Default

false

clipping

clipping: boolean

Default

false

clippingPlanes

clippingPlanes: Plane[]

User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). See the WebGL / clipping /intersection example. Default is null.

Default

null

colorWrite

colorWrite: boolean

Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

Default

true

defaultAttributeValues

defaultAttributeValues: any

Default

{ 'color': [ 1, 1, 1 ], 'uv': [ 0, 0 ], 'uv1': [ 0, 0 ] }

defines

defines: {
[key: string]: any;
}

Type declaration

[key: string]: any

Default

{}

depthFunc

depthFunc: DepthModes

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

Default

THREE.LessEqualDepth

depthTest

depthTest: boolean

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.

Default

true

depthWrite

depthWrite: boolean

Whether rendering this material has any effect on the depth buffer. Default is true. When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

Default

true

dithering

dithering: boolean

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

Default

false

extensions

extensions: {
clipCullDistance: boolean;
multiDraw: boolean;
}

Type declaration

clipCullDistance: boolean
multiDraw: boolean

Default

{
     *   clipCullDistance: false,
     *   multiDraw: false
     * }

fog

fog: boolean

Default

false

forceSinglePass

forceSinglePass: boolean

Default

false

fragmentShader

fragmentShader: string

glslVersion

glslVersion: GLSLVersion

Default

null

id

id: number

Unique number of this material instance.

index0AttributeName

index0AttributeName: string

Default

undefined

`Readonly` isMaterial

isMaterial: true

Read-only flag to check if a given object is of type Material.

Remarks

This is a constant value

Default Value

true

`Readonly` isShaderMaterial

isShaderMaterial: true

Read-only flag to check if a given object is of type ShaderMaterial.

Remarks

This is a constant value

Default Value

true

lights

lights: boolean

Default

false

linewidth

linewidth: number

Default

name

name: string

Material name. Default is an empty string.

Default

''

opacity

opacity: number

Opacity. Default is 1.

Default

polygonOffset

polygonOffset: boolean

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

Default

false

polygonOffsetFactor

polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

Default

polygonOffsetUnits

polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

Default

precision

precision: "highp" | "mediump" | "lowp"

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

Default

null

premultipliedAlpha

premultipliedAlpha: boolean

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

Default

false

shadowSide

shadowSide: Side

Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.

Default

null

side

side: Side

Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

Default

{@link THREE.FrontSide}

stencilFail

stencilFail: StencilOp

Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

stencilFunc

stencilFunc: StencilFunc

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

Default

THREE.AlwaysStencilFunc

stencilFuncMask

stencilFuncMask: number

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

Default

0xff

stencilRef

stencilRef: number

The value to use when performing stencil comparisons or stencil operations. Default is 0.

Default

stencilWrite

stencilWrite: boolean

Whether rendering this material has any effect on the stencil buffer. Default is false.

Default

false

stencilWriteMask

stencilWriteMask: number

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

Default

0xff

stencilZFail

stencilZFail: StencilOp

Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

stencilZPass

stencilZPass: StencilOp

Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

toneMapped

toneMapped: boolean

Defines whether this material is tone mapped according to the renderer's WebGLRenderer.toneMapping toneMapping setting. It is ignored when rendering to a render target or using post processing.

Default

true

transparent

transparent: boolean

Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.

Default

false

type

type: string

Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a scene.

uniforms

uniforms: {
[uniform: string]: IUniform;
}

Type declaration

[uniform: string]: IUniform

Default

{}

uniformsGroups

uniformsGroups: UniformsGroup[]

uniformsNeedUpdate

uniformsNeedUpdate: boolean

Default

false

userData

userData: Record<string, any>

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

Default

{}

uuid

uuid: string

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Default

vertexColors

vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

Default

false

vertexShader

vertexShader: string

visible

visible: boolean

Defines whether this material is visible. Default is true.

Default

true

wireframe

wireframe: boolean

Default

false

wireframeLinewidth

wireframeLinewidth: number

Default

Accessors

alphaTest

get alphaTest(): number
Gets the alpha value to be used when running an alpha test. Default is 0.

Returns number
Default
```
0
```
Inherited from ShaderMaterial.alphaTest
set alphaTest(value): void
Sets the alpha value to be used when running an alpha test. Default is 0.
Parameters
- value: number
Returns void
Default
```
0
```
Inherited from ShaderMaterial.alphaTest

depthBuffer

set depthBuffer(arg): void
The depth buffer.
Parameters
- arg: Texture
Returns void

depthPacking

set depthPacking(arg): void
The depth packing strategy.
Parameters
- arg: DepthPackingStrategies
Returns void

edgeDetectionMode

get edgeDetectionMode(): EdgeDetectionMode
The edge detection mode.

Returns EdgeDetectionMode
set edgeDetectionMode(arg): void
Parameters
- arg: EdgeDetectionMode
Returns void

edgeDetectionThreshold

get edgeDetectionThreshold(): number
The edge detection threshold. Range: [0.0, 0.5].

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

For luma- and chroma-based edge detection, 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. Darker scenes may require an even lower threshold.

If depth-based edge detection is used, the threshold will depend on the scene depth.

Returns number
set edgeDetectionThreshold(arg): void
Parameters
- arg: number
Returns void

localContrastAdaptationFactor

get localContrastAdaptationFactor(): number
The local contrast adaptation factor. Has no effect if the edge detection mode is set to DEPTH. Default is 2.0.

If a neighbor edge has factor times bigger contrast than the current edge, the edge will be discarded.

This allows to eliminate spurious crossing edges and is based on the fact that if there is too much contrast in a direction, the perceptual contrast in the other neighbors will be hidden.

Returns number
set localContrastAdaptationFactor(arg): void
Parameters
- arg: number
Returns void

needsUpdate

set needsUpdate(value): void
Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.
Parameters
- value: boolean
Returns void
Default
```
false
```
Inherited from ShaderMaterial.needsUpdate

predicationBuffer

set predicationBuffer(arg): void
The predication buffer.
Parameters
- arg: Texture
Returns void

predicationMode

get predicationMode(): PredicationMode
The predication mode.

Predicated thresholding allows to better preserve texture details and to improve edge detection using an additional buffer such as a light accumulation or depth buffer.

Returns PredicationMode
set predicationMode(arg): void
Parameters
- arg: PredicationMode
Returns void

predicationScale

get predicationScale(): number
The predication scale. Range: [1.0, 5.0].

Determines how much the edge detection threshold should be scaled when using predication.

Returns number
set predicationScale(arg): void
Parameters
- arg: number
Returns void

predicationStrength

get predicationStrength(): number
The predication strength. Range: [0.0, 1.0].

Determines how much the edge detection threshold should be decreased locally when using predication.

Returns number
set predicationStrength(arg): void
Parameters
- arg: number
Returns void

predicationThreshold

get predicationThreshold(): number
The predication threshold.

Returns number
set predicationThreshold(arg): void
Parameters
- arg: number
Returns void

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, EdgeDetectionMaterial>
  
  The function that gets called when the event is fired.
Returns void

Inherited from ShaderMaterial.addEventListener

clone

clone(): EdgeDetectionMaterial
Return a new material with the same parameters as this material.

Returns EdgeDetectionMaterial

Inherited from ShaderMaterial.clone

copy

copy(material): EdgeDetectionMaterial
Copy the parameters from the passed material into this material.
Parameters
- material: Material
Returns EdgeDetectionMaterial

Inherited from ShaderMaterial.copy

customProgramCacheKey

customProgramCacheKey(): string
In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

Returns string

Inherited from ShaderMaterial.customProgramCacheKey

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  
  The event that gets fired.
Returns void

Inherited from ShaderMaterial.dispatchEvent

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Material textures must be disposed of by the dispose() method of Texture.

Returns void

Inherited from ShaderMaterial.dispose

getEdgeDetectionMode

getEdgeDetectionMode(): EdgeDetectionMode
Returns the edge detection mode.

Returns EdgeDetectionMode
The mode.

Deprecated
Use edgeDetectionMode instead.

getEdgeDetectionThreshold

getEdgeDetectionThreshold(): number
Returns the edge detection threshold.

Returns number
The threshold.

Deprecated
Use edgeDetectionThreshold instead.

getLocalContrastAdaptationFactor

getLocalContrastAdaptationFactor(): number
Returns the local contrast adaptation factor.

Returns number
The factor.

Deprecated
Use localContrastAdaptationFactor instead.

getPredicationMode

getPredicationMode(): PredicationMode
Returns the predication mode.

Returns PredicationMode
The mode.

Deprecated
Use predicationMode instead.

getPredicationScale

getPredicationScale(): number
Returns the predication scale.

Returns number
The scale.

Deprecated
Use predicationScale instead.

getPredicationStrength

getPredicationStrength(): number
Returns the predication strength.

Returns number
The strength.

Deprecated
Use predicationStrength instead.

getPredicationThreshold

getPredicationThreshold(): number
Returns the predication threshold.

Returns number
The threshold.

Deprecated
Use predicationThreshold instead.

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, EdgeDetectionMaterial>
  
  The function that gets called when the event is fired.
Returns boolean

Inherited from ShaderMaterial.hasEventListener

onBeforeCompile

onBeforeCompile(parameters, renderer): void
An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials, but the recommended approach moving forward is to use WebGPURenderer with the new Node Material system and [TSL]https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- parameters: WebGLProgramParametersWithUniforms
  
  WebGL program parameters
- renderer: WebGLRenderer
  
  WebGLRenderer context that is initializing the material
Returns void

Inherited from ShaderMaterial.onBeforeCompile

onBeforeRender

onBeforeRender(renderer, scene, camera, geometry, object, group): void
An optional callback that is executed immediately before the material is used to render a 3D object. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- object: Object3D<Object3DEventMap>
- group: Group<Object3DEventMap>
Returns void

Inherited from ShaderMaterial.onBeforeRender

onBuild

onBuild(object, parameters, renderer): void
Parameters
- object: Object3D<Object3DEventMap>
- parameters: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
Returns void

Deprecated
onBuild() has been removed.

Inherited from ShaderMaterial.onBuild

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, EdgeDetectionMaterial>
  
  The listener function that gets removed.
Returns void

Inherited from ShaderMaterial.removeEventListener

setDepthBuffer

setDepthBuffer(buffer, depthPacking?): void
Sets the depth buffer.
Parameters
- buffer: Texture
  
  The depth texture.
- Optional depthPacking: DepthPackingStrategies
  
  The depth packing strategy.
Returns void

Deprecated
Use depthBuffer and depthPacking instead.

setEdgeDetectionMode

setEdgeDetectionMode(value): void
Sets the edge detection mode.
Parameters
- value: EdgeDetectionMode
  
  The edge detection mode.
Returns void

Deprecated
Use edgeDetectionMode instead.

setEdgeDetectionThreshold

setEdgeDetectionThreshold(value): void
Sets the edge detection threshold.
Parameters
- value: number
  
  The edge detection threshold. Range: [0.0, 0.5].
Returns void

Deprecated
Use edgeDetectionThreshold instead.

setLocalContrastAdaptationFactor

setLocalContrastAdaptationFactor(value): void
Sets the local contrast adaptation factor. Has no effect if the edge detection mode is set to DEPTH.
Parameters
- value: number
  
  The local contrast adaptation factor. Default is 2.0.
Returns void

Deprecated
Use localContrastAdaptationFactor instead.

setPredicationBuffer

setPredicationBuffer(value): void
Sets a custom predication buffer.
Parameters
- value: Texture
  
  The predication buffer.
Returns void

Deprecated
Use predicationBuffer instead.

setPredicationMode

setPredicationMode(value): void
Sets the predication mode.
Parameters
- value: PredicationMode
  
  The predication mode.
Returns void

Deprecated
Use predicationMode instead.

setPredicationScale

setPredicationScale(value): void
Sets the predication scale.
Parameters
- value: number
  
  The scale. Range: [1.0, 5.0].
Returns void

Deprecated
Use predicationScale instead.

setPredicationStrength

setPredicationStrength(value): void
Sets the predication strength.
Parameters
- value: number
  
  The strength. Range: [0.0, 1.0].
Returns void

Deprecated
Use predicationStrength instead.

setPredicationThreshold

setPredicationThreshold(value): void
Sets the predication threshold.
Parameters
- value: number
  
  The threshold.
Returns void

Deprecated
Use predicationThreshold instead.

setSize

setSize(width, height): void
Sets the size of this object.
Parameters
- width: number
  
  The width.
- height: number
  
  The height.
Returns void

Implementation of Resizable.setSize

setValues

setValues(parameters): void
Parameters
- parameters: ShaderMaterialParameters
Returns void

Inherited from ShaderMaterial.setValues

toJSON

toJSON(meta?): ShaderMaterialJSON
Parameters
- Optional meta: JSONMeta
Returns ShaderMaterialJSON

Inherited from ShaderMaterial.toJSON

Class EdgeDetectionMaterial

Implements

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional texelSize: Vector2

Optional mode: EdgeDetectionMode

Returns EdgeDetectionMaterial

Properties

alphaHash

alphaToCoverage

Default

blendAlpha

Default

blendColor

Default

blendDst

Default

blendDstAlpha

Default

blendEquation

Default

blendEquationAlpha

Default

blendSrc

Default

blendSrcAlpha

Default

blending

Default

clipIntersection

Default

clipShadows

Default

clipping

Default

clippingPlanes

Default

colorWrite

Default

defaultAttributeValues

Default

defines

Type declaration

[key: string]: any

Default

depthFunc

Default

depthTest

Default

depthWrite

Default

dithering

Default

extensions

Type declaration

clipCullDistance: boolean

multiDraw: boolean

Default

fog

Default

forceSinglePass

Default

fragmentShader

glslVersion

Default

id

index0AttributeName

Default

Readonly isMaterial

Remarks

Default Value

Readonly isShaderMaterial

`Optional` texelSize: Vector2

`Optional` mode: EdgeDetectionMode

`Readonly` isMaterial

`Readonly` isShaderMaterial