Class Effect

constructor

• new Effect(name, fragmentShader, options?): Effect

• Constructs a new effect.

  Parameters

  • name: string

    The name of this effect. Doesn't have to be unique.
  • fragmentShader: string

    The fragment shader. This shader is required.
  • Optionaloptions: {
        attributes?: EffectAttribute;
        blendFunction?: BlendFunction;
        defines?: Map<string, string>;
        extensions?: Set<WebGLExtension>;
        uniforms?: Map<string, Uniform<any>>;
        vertexShader?: string;
    }

    Additional options.

    • Optionalattributes?: EffectAttribute

      The effect attributes that determine the execution priority and resource requirements.

    • OptionalblendFunction?: BlendFunction

      The blend function of this effect.

    • Optionaldefines?: Map<string, string>

      Custom preprocessor macro definitions. Keys are names and values are code.

    • Optionalextensions?: Set<WebGLExtension>

      WebGL extensions.

    • Optionaluniforms?: Map<string, Uniform<any>>

      Custom shader uniforms. Keys are names and values are uniforms.

    • OptionalvertexShader?: string

      The vertex shader. Most effects don't need one.

  Returns Effect

ReadonlyblendMode

Readonlydefines

Readonlyextensions

name

Readonlyuniforms

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

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

addEventListener

• addEventListener<T>(type, listener): void

• Adds a listener to an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<Event<string, unknown>[T], T, Effect>

    The function that gets called when the event is fired.

  Returns void

dispatchEvent

• dispatchEvent<T>(event): void

• Fire an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • event: BaseEvent<T> & Event<string, unknown>[T]

    The event that gets fired.

  Returns void

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

• getAttributes(): EffectAttribute

• Returns the effect attributes.

  Returns EffectAttribute

  The attributes.

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.

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.

hasEventListener

• hasEventListener<T>(type, listener): boolean

• Checks if listener is added to an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<Event<string, unknown>[T], T, Effect>

    The function that gets called when the event is fired.

  Returns boolean

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; }
  Copy

removeEventListener

• removeEventListener<T>(type, listener): void

• Removes a listener from an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of the listener that gets removed.
  • listener: EventListener<Event<string, unknown>[T], T, Effect>

    The listener function that gets removed.

  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.
  • OptionaldepthPacking: DepthPackingStrategies

    The depth packing.

  Returns void

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

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.
  • OptionaldeltaTime: number

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

  Returns void