Home Reference Source
import {ScanlineEffect} from 'postprocessing'
public class | source

ScanlineEffect

Extends:

three~EventDispatcherEffect → ScanlineEffect

Indirect Implements:

A scanline effect.

Based on an implementation by Georg 'Leviathan' Steinrohder (CC BY 3.0): http://www.truevision3d.com/forums/showcase/staticnoise_colorblackwhite_scanline_shaders-t18698.0.html

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new scanline effect.

Member Summary

Public Members
public get

The scanline density.

public set
public get

The scanline scroll speed.

public set

Method Summary

Public Methods
public
this method was deprecated. Use density instead.

Returns the current scanline density.

public

setDensity(value: Number)

this method was deprecated. Use density instead.

Sets the scanline density.

public

setSize(width: Number, height: Number)

Updates the size of this pass.

Inherited Summary

From class Effect
public get

inputColorSpace: ColorSpace

this get is experimental.

The input color space.

public set

mainCamera: Camera

Sets the main camera.

public set

mainScene: Scene

Sets the main scene.

public get

outputColorSpace: ColorSpace

this get is experimental.

The output color space.

protected set

inputColorSpace: ColorSpace

this set is experimental.
protected set

outputColorSpace: ColorSpace

this set is experimental.
public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

protected

renderer: WebGLRenderer

this member was deprecated.

The renderer.

public

Performs a shallow search for properties that define a dispose method and deletes them.

public

Returns the effect attributes.

public
this method was deprecated. Use blendMode instead.

Returns the blend mode.

public
this method was deprecated. Use defines instead.

Returns the preprocessor macro definitions.

public
this method was deprecated. Use extensions instead.

Returns the WebGL extensions that are required by this effect.

public

Returns the fragment shader.

public
this method was deprecated. Use name instead.

Returns the name of this effect.

public

getUniforms(): Map<String, Uniform>

this method was deprecated. Use uniforms instead.

Returns the uniforms of this effect.

public

Returns the vertex shader.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies)

Sets the depth texture.

public

setRenderer(renderer: WebGLRenderer)

this method was deprecated.

Sets the renderer.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number)

Updates this effect by performing supporting operations.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect requires a shader recompilation.

protected

setFragmentShader(fragmentShader: String)

Sets the fragment shader.

protected

setVertexShader(vertexShader: String)

Sets the vertex shader.

Public Constructors

public constructor(options: Object) source

Constructs a new scanline effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.blendFunction BlendFunction
  • optional
  • default: BlendFunction.OVERLAY

The blend function of this effect.

options.density Number
  • optional
  • default: 1.25

The scanline density.

options.scrollSpeed Number
  • optional
  • default: 0.0

The scanline scroll speed.

Public Members

public get density: Number source

The scanline density.

public set density source

public get scrollSpeed: Number source

The scanline scroll speed. Default is 0 (disabled).

public set scrollSpeed source

Public Methods

public getDensity(): Number source

this method was deprecated. Use density instead.

Returns the current scanline density.

Return:

Number

The scanline density.

public setDensity(value: Number) source

this method was deprecated. Use density instead.

Sets the scanline density.

Params:

NameTypeAttributeDescription
value Number

The new scanline density.

public setSize(width: Number, height: Number) source

Updates the size of this pass.

Override:

Effect#setSize

Params:

NameTypeAttributeDescription
width Number

The width.

height Number

The height.