import {GridEffect} from 'postprocessing'

public class | source

GridEffect

Extends:

three~EventDispatcher → Effect → GridEffect

Indirect Implements:

A grid effect.

Constructor Summary

Public Constructor
public	constructor(options: Object) Constructs a new grid effect.

Member Summary

Public Members
public get	lineWidth: Number The line width.
public set	lineWidth
public get	scale: Number The scale.
public set	scale

Method Summary

Public Methods
public	getLineWidth(): Number this method was deprecated. Use lineWidth instead. Returns the current grid line width.
public	getScale(): Number this method was deprecated. Use scale instead. Returns the current grid scale.
public	setLineWidth(value: Number) this method was deprecated. Use lineWidth instead. Sets the grid line width.
public	setScale(value: Number) this method was deprecated. Use scale instead. Sets the grid scale.
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	blendMode: BlendMode The blend mode of this effect.
public	defines: Map<String, String> Preprocessor macro definitions.
public	extensions: Set<WebGLExtension> WebGL extensions that are required by this effect.
public	name: String The name of this effect.
public	uniforms: Map<String, Uniform> Shader uniforms.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
public	dispose() Performs a shallow search for properties that define a dispose method and deletes them.
public	getAttributes(): EffectAttribute Returns the effect attributes.
public	getBlendMode(): BlendMode this method was deprecated. Use blendMode instead. Returns the blend mode.
public	getDefines(): Map<String, String> this method was deprecated. Use defines instead. Returns the preprocessor macro definitions.
public	getExtensions(): Set<WebGLExtension> this method was deprecated. Use extensions instead. Returns the WebGL extensions that are required by this effect.
public	getFragmentShader(): String Returns the fragment shader.
public	getName(): String 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	getVertexShader(): String 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	setAttributes(attributes: EffectAttribute) Sets the effect attributes.
protected	setChanged() 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 grid effect.

Override:

Effect#constructor

Params:

Name	Type	Attribute	Description
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 Members

public get lineWidth: Number source

The line width.

public set lineWidth source

public get scale: Number source

The scale.

public set scale source

Public Methods

public getLineWidth(): Number source

this method was deprecated. Use lineWidth instead.

Returns the current grid line width.

Return:

Number

The grid line width.

public getScale(): Number source

this method was deprecated. Use scale instead.

Returns the current grid scale.

Return:

Number

The grid scale.

public setLineWidth(value: Number) source

this method was deprecated. Use lineWidth instead.

Sets the grid line width.

Params:

Name	Type	Attribute	Description
value	Number		The new grid line width.

public setScale(value: Number) source

this method was deprecated. Use scale instead.

Sets the grid scale.

Params:

Name	Type	Attribute	Description
value	Number		The new grid scale.

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

Updates the size of this pass.

Override:

Effect#setSize

Params:

Name	Type	Attribute	Description
width	Number		The width.
height	Number		The height.