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

GridEffect

Extends:

three~EventDispatcherEffect → GridEffect

Indirect Implements:

A grid effect.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new grid effect.

Method Summary

Public Methods
public

Returns the current grid line width.

public

Returns the current grid scale.

public

setLineWidth(lineWidth: Number)

Sets the grid line width.

public

setScale(scale: Number)

Sets the grid scale.

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 grid 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.scale Number
  • optional
  • default: 1.0

The scale of the grid pattern.

options.lineWidth Number
  • optional
  • default: 0.0

The line width of the grid pattern.

Public Methods

public getLineWidth(): Number source

Returns the current grid line width.

Return:

Number

The grid line width.

public getScale(): Number source

Returns the current grid scale.

Return:

Number

The grid scale.

public setLineWidth(lineWidth: Number) source

Sets the grid line width.

Params:

NameTypeAttributeDescription
lineWidth Number

The new grid line width.

public setScale(scale: Number) source

Sets the grid scale.

Params:

NameTypeAttributeDescription
scale Number

The new grid scale.

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.