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

ChromaticAberrationEffect

Extends:

three~EventDispatcherEffect → ChromaticAberrationEffect

Indirect Implements:

A chromatic aberration effect.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new chromatic aberration effect.

Member Summary

Public Members
public get

The modulation offset.

public set
public get

offset: Vector2

The color offset.

public set
public get

Indicates whether radial modulation is enabled.

public set

Method Summary

Public Methods
public

getOffset(): Vector2

this method was deprecated. Use offset instead.

Returns the color offset vector.

public

setOffset(value: Vector2)

this method was deprecated. Use offset instead.

Sets the color offset vector.

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 chromatic aberration effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.offset Vector2
  • optional

The color offset.

options.radialModulation Boolean
  • optional
  • default: false

Whether the effect should be modulated with a radial gradient.

options.modulationOffset Number
  • optional
  • default: 0.15

The modulation offset. Only applies if radialModulation is enabled.

Public Members

public get modulationOffset: Number source

The modulation offset.

public set modulationOffset source

public get offset: Vector2 source

The color offset.

public set offset source

public get radialModulation: Boolean source

Indicates whether radial modulation is enabled.

When enabled, the effect will be weaker in the middle and stronger towards the screen edges.

public set radialModulation source

Public Methods

public getOffset(): Vector2 source

this method was deprecated. Use offset instead.

Returns the color offset vector.

Return:

Vector2

The offset.

public setOffset(value: Vector2) source

this method was deprecated. Use offset instead.

Sets the color offset vector.

Params:

NameTypeAttributeDescription
value Vector2

The offset.