Class BloomEffect

A bloom effect.

Hierarchy (view full)

Constructors

constructor

Properties

blendMode blurPass defines extensions luminancePass name renderer uniforms

Accessors

distinction dithering height inputColorSpace intensity kernelSize luminanceMaterial mainCamera mainScene outputColorSpace resolution texture width

Methods

dispose getAttributes getBlendMode getBlurPass getDefines getExtensions getFragmentShader getIntensity getLuminanceMaterial getLuminancePass getName getResolution getResolutionScale getTexture getUniforms getVertexShader initialize setAttributes setChanged setDepthTexture setFragmentShader setIntensity setRenderer setResolutionScale setSize setVertexShader update

Constructors

constructor

Properties

Readonly blendMode

blendMode: BlendMode

The blend mode of this effect.

blurPass

blurPass: KawaseBlurPass

A blur pass.

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.

luminancePass

luminancePass: LuminancePass

A luminance shader pass.

This pass can be disabled to skip luminance filtering.

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

distinction

  • get distinction(): number

  • Returns number

    Deprecated

    Use luminanceMaterial instead.

  • set distinction(arg): void

  • Parameters

    • arg: number

    Returns void

dithering

  • get dithering(): boolean

  • Indicates whether dithering is enabled.

    Returns boolean

    Deprecated

    Use EffectPass.fullscreenMaterial.dithering instead.

  • set dithering(arg): void

  • Parameters

    • arg: boolean

    Returns void

height

  • get height(): number

  • The current height of the internal render targets.

    Returns number

    Deprecated

    Use resolution.height instead.

  • set height(arg): void

  • Parameters

    • arg: number

    Returns void

inputColorSpace

  • get inputColorSpace(): ColorSpace
  • Experimental

    The input color space.

    Returns ColorSpace

  • set inputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

intensity

  • get intensity(): number

  • The bloom intensity.

    Returns number

  • set intensity(arg): void

  • Parameters

    • arg: number

    Returns void

kernelSize

  • get kernelSize(): KernelSize

  • The blur kernel size.

    Returns KernelSize

    Deprecated

    Use blurPass.kernelSize instead.

  • set kernelSize(arg): void

  • Parameters

    Returns void

luminanceMaterial

  • get luminanceMaterial(): LuminanceMaterial

  • The luminance material.

    Returns LuminanceMaterial

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

resolution

  • get resolution(): Resolution

  • The resolution of this effect.

    Returns Resolution

texture

  • get texture(): Texture

  • A texture that contains the intermediate result of this effect.

    Returns Texture

width

  • get width(): number

  • The current width of the internal render targets.

    Returns number

    Deprecated

    Use resolution.width instead.

  • set width(arg): void

  • Parameters

    • arg: number

    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.

getBlurPass

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.

getIntensity

  • getIntensity(): number

  • The bloom intensity.

    Returns number

    The intensity.

    Deprecated

    Use intensity instead.

getLuminanceMaterial

  • getLuminanceMaterial(): LuminanceMaterial

  • Returns the luminance material.

    Returns LuminanceMaterial

    The material.

    Deprecated

    Use luminanceMaterial instead.

getLuminancePass

  • getLuminancePass(): LuminancePass

  • Returns the luminance pass.

    Returns LuminancePass

    The luminance pass.

    Deprecated

    Use luminancePass instead.

getName

  • getName(): string

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

getResolution

  • getResolution(): Resolution

  • Returns the resolution settings.

    Returns Resolution

    The resolution.

    Deprecated

    Use resolution instead.

getResolutionScale

  • getResolutionScale(): number

  • Returns the current resolution scale.

    Returns number

    The resolution scale.

    Deprecated

    Use resolution instead.

getTexture

  • getTexture(): Texture

  • Returns the generated bloom texture.

    Returns Texture

    The texture.

    Deprecated

    Use texture 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.

    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

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

setIntensity

  • setIntensity(value): void

  • Sets the bloom intensity.

    Parameters

    • value: number

      The intensity.

    Returns void

    Deprecated

    Use intensity instead.

setRenderer

  • setRenderer(renderer): void

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setResolutionScale

  • setResolutionScale(scale): void

  • Sets the resolution scale.

    Parameters

    • scale: number

      The new resolution scale.

    Returns void

    Deprecated

    Use resolution instead.

setSize

  • setSize(width, height): void

  • Updates the size of internal render targets.

    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.

    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