Class ChromaticAberrationEffect

A chromatic aberration effect.

Hierarchy (view full)

  • Effect
    • ChromaticAberrationEffect

Constructors

constructor

Properties

blendMode defines extensions name renderer uniforms

Accessors

inputColorSpace mainCamera mainScene modulationOffset offset outputColorSpace radialModulation

Methods

dispose getAttributes getBlendMode getDefines getExtensions getFragmentShader getName getOffset getUniforms getVertexShader initialize setAttributes setChanged setDepthTexture setFragmentShader setOffset setRenderer setSize setVertexShader update

Constructors

constructor

  • new ChromaticAberrationEffect(options?): ChromaticAberrationEffect

  • Constructs a new chromatic aberration effect.

    Parameters

    • Optional options: {
          blendFunction?: BlendFunction;
          modulationOffset: number;
          offset?: Vector2;
          radialModulation: boolean;
      }

      The options.

      • Optional blendFunction?: BlendFunction

        The blend function of this effect.

      • modulationOffset: number

        The modulation offset. Only applies if radialModulation is enabled.

      • Optional offset?: Vector2

        The color offset.

      • radialModulation: boolean

        Whether the effect should be modulated with a radial gradient.

    Returns ChromaticAberrationEffect

Properties

Readonly blendMode

blendMode: BlendMode

The blend mode of this effect.

Readonly defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

Readonly extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

name

name: string

The name of this effect.

Protected renderer

renderer: WebGLRenderer

The renderer.

Deprecated

Readonly uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

inputColorSpace

  • get inputColorSpace(): ColorSpace
  • Experimental

    The input color space.

    Returns ColorSpace

  • set inputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

mainCamera

  • set mainCamera(arg): void

  • Sets the main camera.

    Parameters

    • arg: Camera

    Returns void

mainScene

  • set mainScene(arg): void

  • Sets the main scene.

    Parameters

    • arg: Scene

    Returns void

modulationOffset

  • get modulationOffset(): number

  • The modulation offset.

    Returns number

  • set modulationOffset(arg): void

  • Parameters

    • arg: number

    Returns void

offset

  • get offset(): Vector2

  • The color offset.

    Returns Vector2

  • set offset(arg): void

  • Parameters

    • arg: Vector2

    Returns void

outputColorSpace

  • get outputColorSpace(): ColorSpace
  • Experimental

    The output color space.

    Should only be changed if this effect converts the input colors to a different color space.

    Returns ColorSpace

  • set outputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

radialModulation

  • get radialModulation(): boolean

  • Indicates whether radial modulation is enabled.

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

    Returns boolean

  • set radialModulation(arg): void

  • Parameters

    • arg: boolean

    Returns void

Methods

dispose

  • dispose(): void

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

    The EffectComposer calls this method when it is being destroyed.

    Returns void

getAttributes

getBlendMode

  • getBlendMode(): BlendMode

  • Returns the blend mode.

    The result of this effect will be blended with the result of the previous effect using this blend mode.

    Returns BlendMode

    The blend mode.

    Deprecated

    Use blendMode instead.

getDefines

  • getDefines(): Map<string, string>

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

getExtensions

  • getExtensions(): Set<WebGLExtension>

  • Returns the WebGL extensions that are required by this effect.

    Returns Set<WebGLExtension>

    The extensions.

    Deprecated

    Use extensions instead.

getFragmentShader

  • getFragmentShader(): string

  • Returns the fragment shader.

    Returns string

    The fragment shader.

getName

  • getName(): string

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

getOffset

  • getOffset(): Vector2

  • Returns the color offset vector.

    Returns Vector2

    The offset.

    Deprecated

    Use offset instead.

getUniforms

  • getUniforms(): Map<string, Uniform<any>>

  • Returns the uniforms of this effect.

    Returns Map<string, Uniform<any>>

    The extensions.

    Deprecated

    Use uniforms instead.

getVertexShader

  • getVertexShader(): string

  • Returns the vertex shader.

    Returns string

    The vertex shader.

initialize

  • initialize(renderer, alpha, frameBufferType): void

  • Performs initialization tasks.

    This method is called when the associated EffectPass is added to an EffectComposer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • alpha: boolean

      Whether the renderer uses the alpha channel or not.

    • frameBufferType: number

      The type of the main frame buffers.

    Returns void

    Example

    if(!alpha && frameBufferType === UnsignedByteType) { this.myRenderTarget.texture.format = RGBFormat; }

Protected setAttributes

  • setAttributes(attributes): void
  • Protected

    Sets the effect attributes.

    Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.

    Parameters

    Returns void

Protected setChanged

  • setChanged(): void
  • Protected

    Informs the associated EffectPass that this effect requires a shader recompilation.

    Should be called after changing macros or extensions and after adding/removing uniforms.

    Returns void

setDepthTexture

  • setDepthTexture(depthTexture, depthPacking?): void

  • Sets the depth texture.

    You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.

    Parameters

    • depthTexture: Texture

      A depth texture.

    • Optional depthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

Protected setFragmentShader

  • setFragmentShader(fragmentShader): void
  • Protected

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setOffset

  • setOffset(value): void

  • Sets the color offset vector.

    Parameters

    • value: Vector2

      The offset.

    Returns void

    Deprecated

    Use offset instead.

setRenderer

  • setRenderer(renderer): void

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setSize

  • setSize(width, height): void

  • Updates the size of this effect.

    You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

Protected setVertexShader

  • setVertexShader(vertexShader): void
  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

update

  • update(renderer, inputBuffer, deltaTime?): void

  • Updates this effect by performing supporting operations.

    This method is called by the EffectPass right before the main fullscreen render operation, even if the blend function is set to SKIP.

    You may override this method if you need to update custom uniforms or render additional off-screen textures.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • inputBuffer: WebGLRenderTarget<Texture>

      A frame buffer that contains the result of the previous pass.

    • Optional deltaTime: number

      The time between the last frame and the current one in seconds.

    Returns void

Settings

Member Visibility

Theme

On This Page