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.

Method Summary

Public Methods
public

Returns the current scanline density.

public

setDensity(density: Number)

Sets the scanline density.

public

setSize(width: Number, height: Number)

Updates the size of this pass.

Inherited Summary

From class Effect
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.

public

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

public

Returns the effect attributes.

public

Returns the fragment shader.

public

Returns the vertex shader.

public

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

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

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

Updates the effect by performing supporting operations.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect has changed in a way that 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.

Public Methods

public getDensity(): Number source

Returns the current scanline density.

Return:

Number

The scanline density.

public setDensity(density: Number) source

Sets the scanline density.

Params:

NameTypeAttributeDescription
density 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.