Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BloomEffect

A bloom effect.

Hierarchy

Index

Constructors

  • new BloomEffect([options]?: BloomEffectOptions): BloomEffect
  • Constructs a new bloom effect.

    Parameters

    • Optional [options]: BloomEffectOptions

      The options.

    Returns BloomEffect

Properties

blendMode: BlendMode

The blend mode of this effect.

blurPass: KawaseBlurPass

A blur pass.

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

luminancePass: LuminancePass

A luminance shader pass.

This pass can be disabled to skip luminance filtering.

name: string

The name of this effect.

renderer: WebGLRenderer

The renderer.

deprecated
uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

  • get distinction(): number
  • set distinction(arg: number): void
  • deprecated

    Use luminanceMaterial instead.

    Returns number

  • Parameters

    • arg: number

    Returns void

  • get dithering(): boolean
  • set dithering(arg: boolean): void
  • Indicates whether dithering is enabled.

    deprecated

    Use EffectPass.fullscreenMaterial.dithering instead.

    Returns boolean

  • Parameters

    • arg: boolean

    Returns void

  • get height(): number
  • set height(arg: number): void
  • The current height of the internal render targets.

    deprecated

    Use resolution.height instead.

    Returns number

  • Parameters

    • arg: number

    Returns void

  • get inputColorSpace(): ColorSpace
  • set inputColorSpace(arg: ColorSpace): void
  • The input color space.

    experimental

    Returns ColorSpace

  • The input color space.

    experimental

    Parameters

    • arg: ColorSpace

    Returns void

  • get intensity(): number
  • set intensity(arg: number): void
  • The bloom intensity.

    Returns number

  • Parameters

    • arg: number

    Returns void

  • The blur kernel size.

    deprecated

    Use blurPass.kernelSize instead.

    Returns KernelSize

  • Parameters

    Returns void

  • get luminanceMaterial(): LuminanceMaterial
  • The luminance material.

    Returns LuminanceMaterial

  • set mainCamera(arg: Camera): void
  • Sets the main camera.

    Parameters

    • arg: Camera

    Returns void

  • set mainScene(arg: Scene): void
  • Sets the main scene.

    Parameters

    • arg: Scene

    Returns void

  • get outputColorSpace(): ColorSpace
  • set outputColorSpace(arg: ColorSpace): void
  • The output color space.

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

    experimental

    Returns ColorSpace

  • The output color space.

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

    experimental

    Parameters

    • arg: ColorSpace

    Returns void

  • The resolution of this effect.

    Returns Resolution

  • get texture(): Texture
  • A texture that contains the intermediate result of this effect.

    Returns Texture

  • get width(): number
  • set width(arg: number): void
  • The current width of the internal render targets.

    deprecated

    Use resolution.width instead.

    Returns number

  • Parameters

    • arg: number

    Returns void

Methods

  • addEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, BloomEffect>): void
  • addEventListener<T>(type: T, listener: EventListener<{}, T, BloomEffect>): 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, BloomEffect>

      The function that gets called when the event is fired.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

  • dispatchEvent<T>(event: BaseEvent<T> & Event<string, unknown>[T]): 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(): 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(): EffectAttribute
  • Returns the effect attributes.

    Returns EffectAttribute

    The attributes.

  • 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.

    deprecated

    Use blendMode instead.

    Returns BlendMode

    The blend mode.

  • getBlurPass(): KawaseBlurPass
  • Returns the blur pass.

    deprecated

    Use blurPass instead.

    Returns KawaseBlurPass

    The blur pass.

  • getDefines(): Map<string, string>
  • Returns the preprocessor macro definitions.

    deprecated

    Use defines instead.

    Returns Map<string, string>

    The extensions.

  • getExtensions(): Set<WebGLExtension>
  • Returns the WebGL extensions that are required by this effect.

    deprecated

    Use extensions instead.

    Returns Set<WebGLExtension>

    The extensions.

  • getFragmentShader(): string
  • getIntensity(): number
  • The bloom intensity.

    deprecated

    Use intensity instead.

    Returns number

    The intensity.

  • getLuminanceMaterial(): LuminanceMaterial
  • Returns the luminance material.

    deprecated

    Use luminanceMaterial instead.

    Returns LuminanceMaterial

    The material.

  • getLuminancePass(): LuminancePass
  • Returns the luminance pass.

    deprecated

    Use luminancePass instead.

    Returns LuminancePass

    The luminance pass.

  • getName(): string
  • Returns the name of this effect.

    deprecated

    Use name instead.

    Returns string

    The name.

  • Returns the resolution settings.

    deprecated

    Use resolution instead.

    Returns Resolution

    The resolution.

  • getResolutionScale(): number
  • Returns the current resolution scale.

    deprecated

    Use resolution instead.

    Returns number

    The resolution scale.

  • getTexture(): Texture
  • Returns the generated bloom texture.

    deprecated

    Use texture instead.

    Returns Texture

    The texture.

  • getUniforms(): Map<string, Uniform<any>>
  • Returns the uniforms of this effect.

    deprecated

    Use uniforms instead.

    Returns Map<string, Uniform<any>>

    The extensions.

  • getVertexShader(): string
  • hasEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, BloomEffect>): boolean
  • hasEventListener<T>(type: T, listener: EventListener<{}, T, BloomEffect>): 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, BloomEffect>

      The function that gets called when the event is fired.

    Returns boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

  • initialize(renderer: WebGLRenderer, alpha: boolean, frameBufferType: number): void
  • Performs initialization tasks.

    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

  • removeEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, BloomEffect>): void
  • removeEventListener<T>(type: T, listener: EventListener<{}, T, BloomEffect>): 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, BloomEffect>

      The listener function that gets removed.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

  • setAttributes(attributes: EffectAttribute): void
  • 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

    • attributes: EffectAttribute

      The attributes.

    Returns void

  • setChanged(): void
  • Informs the associated {@link EffectPass} that this effect requires a shader recompilation.

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

    Returns void

  • setDepthTexture(depthTexture: Texture, depthPacking?: DepthPackingStrategies): 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 {@link EffectPass}.

    Parameters

    • depthTexture: Texture

      A depth texture.

    • Optional depthPacking: DepthPackingStrategies

    Returns void

  • setFragmentShader(fragmentShader: string): void
  • Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

  • setIntensity(value: number): void
  • Sets the bloom intensity.

    deprecated

    Use intensity instead.

    Parameters

    • value: number

      The intensity.

    Returns void

  • setRenderer(renderer: WebGLRenderer): void
  • Sets the renderer.

    deprecated

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

  • setResolutionScale(scale: number): void
  • Sets the resolution scale.

    deprecated

    Use resolution instead.

    Parameters

    • scale: number

      The new resolution scale.

    Returns void

  • setSize(width: number, height: number): void
  • Updates the size of internal render targets.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

  • setVertexShader(vertexShader: string): void
  • Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

  • update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget<Texture>, deltaTime?: number): void
  • Updates this effect.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • inputBuffer: WebGLRenderTarget<Texture>

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

    • Optional deltaTime: number

    Returns void