Class SelectiveBloomEffect

A selective bloom effect.

This effect applies bloom to selected objects only.

Hierarchy (view full)

Constructors

constructor

Properties

blendMode blurPass defines extensions luminancePass mipmapBlurPass name renderer selection uniforms

Accessors

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

Methods

addEventListener dispatchEvent dispose getAttributes getBlendMode getBlurPass getDefines getExtensions getFragmentShader getIntensity getLuminanceMaterial getLuminancePass getName getResolution getResolutionScale getSelection getTexture getUniforms getVertexShader hasEventListener initialize isBackgroundDisabled isInverted removeEventListener setAttributes setBackgroundDisabled setChanged setDepthTexture setFragmentShader setIntensity setInverted setRenderer setResolutionScale setSize setVertexShader update

Constructors

constructor

Properties

ReadonlyblendMode

blendMode: BlendMode

The blend mode of this effect.

ReadonlyblurPass

blurPass: KawaseBlurPass

A blur pass.

Deprecated

Use mipmapBlurPass instead.

Readonlydefines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

Readonlyextensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

ReadonlyluminancePass

luminancePass: LuminancePass

A luminance shader pass.

This pass can be disabled to skip luminance filtering.

ReadonlymipmapBlurPass

mipmapBlurPass: MipmapBlurPass

A mipmap blur pass.

name

name: string

The name of this effect.

Protectedrenderer

renderer: WebGLRenderer

The renderer.

Deprecated

selection

selection: Selection

A selection of objects.

The default layer of this selection is 11.

Readonlyuniforms

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

ignoreBackground

  • get ignoreBackground(): boolean

  • Indicates whether the background colors will be ignored.

    Returns boolean

  • set ignoreBackground(arg): void

  • Parameters

    • arg: boolean

    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

inverted

  • get inverted(): boolean

  • Indicates whether the selection should be considered inverted.

    Returns boolean

  • set inverted(arg): void

  • Parameters

    • arg: boolean

    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

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

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, SelectiveBloomEffect>

      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

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

getFragmentShader

getIntensity

  • getIntensity(): number

  • The bloom intensity.

    Returns number

    The intensity.

    Deprecated

    Use intensity instead.

getLuminanceMaterial

getLuminancePass

getName

  • getName(): string

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

getResolution

getResolutionScale

  • getResolutionScale(): number

  • Returns the current resolution scale.

    Returns number

    The resolution scale.

    Deprecated

    Use resolution instead.

getSelection

  • getSelection(): Selection

  • Returns the selection.

    Returns Selection

    The selection.

    Deprecated

    Use selection 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

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, SelectiveBloomEffect>

      The function that gets called when the event is fired.

    Returns boolean

initialize

  • initialize(renderer, alpha, frameBufferType): void

  • Performs initialization tasks.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • alpha: boolean

      Whether the renderer uses the alpha channel.

    • frameBufferType: number

      The type of the main frame buffers.

    Returns void

isBackgroundDisabled

  • isBackgroundDisabled(): boolean

  • Indicates whether the background is disabled.

    Returns boolean

    Whether the background is disabled.

    Deprecated

    Use ignoreBackground instead.

isInverted

  • isInverted(): boolean

  • Indicates whether the mask is inverted.

    Returns boolean

    Whether the mask is inverted.

    Deprecated

    Use inverted instead.

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, SelectiveBloomEffect>

      The listener function that gets removed.

    Returns void

ProtectedsetAttributes

  • 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

setBackgroundDisabled

  • setBackgroundDisabled(value): void

  • Enables or disables the background.

    Parameters

    • value: boolean

      Whether the background should be disabled.

    Returns void

    Deprecated

    Use ignoreBackground instead.

ProtectedsetChanged

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

    Parameters

    • depthTexture: Texture

      A depth texture.

    • OptionaldepthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

ProtectedsetFragmentShader

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

setInverted

  • setInverted(value): void

  • Enables or disable mask inversion.

    Parameters

    • value: boolean

      Whether the mask should be inverted.

    Returns void

    Deprecated

    Use inverted 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

ProtectedsetVertexShader

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

    • OptionaldeltaTime: number

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

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods