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

LensDistortionEffect

Extends:

three~EventDispatcherEffect → LensDistortionEffect

Indirect Implements:

A lens distortion effect.

Original shader ported from https://github.com/ycw/three-lens-distortion

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new lens distortion effect.

Member Summary

Public Members
public get

distortion: Vector2

The radial distortion coefficients.

public set
public get

focalLength: Vector2

The focal length.

public set
public get

principalPoint: Vector2

The principal point.

public set
public get

The skew factor in radians.

public set

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 lens distortion effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.distortion Vector2
  • optional

The distortion value.

options.principalPoint Vector2
  • optional

The center point.

options.focalLength Vector2
  • optional

The focal length.

options.skew Number
  • optional
  • default: 0

The skew value.

Public Members

public get distortion: Vector2 source

The radial distortion coefficients. Default is (0, 0).

public set distortion source

public get focalLength: Vector2 source

The focal length. Default is (1, 1).

public set focalLength source

public get principalPoint: Vector2 source

The principal point. Default is (0, 0).

public set principalPoint source

public get skew: Number source

The skew factor in radians.

public set skew source