Constructs a new outline effect.
Optional scene: SceneThe main scene.
Optional camera: CameraThe main camera.
Optional options: { The options.
Optional blendThe blend function. Use BlendFunction.ALPHA for dark outlines.
Optional blur?: booleanWhether the outline should be blurred.
Optional edgeThe edge strength.
Optional height?: numberDeprecated. Use resolutionY instead.
Optional hiddenThe color of hidden edges.
Optional kernelThe blur kernel size.
Optional multisampling?: numberThe number of samples used for multisample antialiasing. Requires WebGL 2.
Optional patternThe pattern scale.
Optional patternA pattern texture.
Optional pulseThe pulse speed. A value of zero disables the pulse effect.
Optional resolutionThe resolution scale.
Optional resolutionX?: numberThe horizontal resolution.
Optional resolutionY?: numberThe vertical resolution.
Optional visibleThe color of visible edges.
Optional width?: numberDeprecated. Use resolutionX instead.
Optional xWhether occluded parts of selected objects should be visible.
Readonly blendThe blend mode of this effect.
A blur pass.
Readonly definesPreprocessor macro definitions.
Call setChanged after changing macro definitions.
Readonly extensionsWebGL extensions that are required by this effect.
Call setChanged after adding or removing extensions.
The name of this effect.
The pulse speed. Set to 0 to disable.
Protected rendererThe renderer.
A selection of objects that will be outlined.
The default layer of this selection is 10.
Readonly uniformsShader uniforms.
Call setChanged after adding or removing uniforms.
Indicates whether the outlines should be blurred.
Use blurPass.enabled instead.
Indicates whether dithering is enabled.
The edge strength.
The current height of the internal render targets.
Use resolution.height instead.
The hidden edge color.
Experimental
The input color space.
Protected Experimental
The blur kernel size.
Use blurPass.kernelSize instead.
Sets the main camera.
Sets the main scene.
Experimental
The amount of MSAA samples.
Requires WebGL 2. Set to zero to disable multisampling.
Requires three >= r138.
Experimental
The output color space.
Should only be changed if this effect converts the input colors to a different color space.
Protected Experimental
The pattern scale.
The pattern texture. Set to null to disable.
The resolution of this effect.
The selection layer.
Use selection.layer instead.
The visible edge color.
The current width of the internal render targets.
Use resolution.width instead.
Indicates whether X-ray mode is enabled.
Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Clears the list of selected objects.
This pass.
Use selection.clear() instead.
Deselects an object.
The object that should no longer be outlined.
This pass.
Use selection.delete() instead.
Fire an event type.
The event that gets fired.
Performs a shallow search for properties that define a dispose method and deletes them.
The EffectComposer calls this method when it is being destroyed.
Returns the effect attributes.
The attributes.
Returns the blur pass.
The blur pass.
Use blurPass instead.
Returns the WebGL extensions that are required by this effect.
The extensions.
Use extensions instead.
Returns the resolution.
The resolution.
Checks if listener is added to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Selects an object.
The object that should be outlined.
This pass.
Use selection.add() instead.
Protected setProtected
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.
The attributes.
Protected setProtected
Informs the associated EffectPass that this effect requires a shader recompilation.
Should be called after changing macros or extensions and after adding/removing uniforms.
Sets the depth texture.
You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.
A depth texture.
Optional depthPacking: DepthPackingStrategiesThe depth packing.
Protected setClears the current selection and selects a list of objects.
The objects that should be outlined. This array will be copied.
This pass.
Use selection.set() instead.
Protected setUpdates this effect.
The renderer.
A frame buffer that contains the result of the previous pass.
Optional deltaTime: numberThe time between the last frame and the current one in seconds.
An outline effect.