Viewer
    Preparing search index...

    Class SelectiveBloomEffect

    A selective bloom effect.

    This effect applies bloom to selected objects only.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    blendMode blurPass defines extensions luminancePass 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

    • Constructs a new selective bloom effect.

      Parameters

      • Optionalscene: Scene

        The main scene.

      • Optionalcamera: Camera

        The main camera.

      • Optionaloptions: BloomEffectOptions

        The options. See BloomEffect for details.

      Returns SelectiveBloomEffect

    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.

    selection: Selection

    A selection of objects.

    The default layer of this selection is 11.

    uniforms: Map<string, Uniform<any>>

    Shader uniforms.

    Call Effect.setChanged after adding or removing uniforms.

    Accessors

    • get distinction(): number

      Returns number

      Use luminanceMaterial instead.

    • set distinction(arg: number): void

      Parameters

      • arg: number

      Returns void

    • get dithering(): boolean

      Indicates whether dithering is enabled.

      Returns boolean

      Use EffectPass.fullscreenMaterial.dithering instead.

    • set dithering(arg: boolean): void

      Parameters

      • arg: boolean

      Returns void

    • get height(): number

      The current height of the internal render targets.

      Returns number

      Use resolution.height instead.

    • set height(arg: number): void

      Parameters

      • arg: number

      Returns void

    • get ignoreBackground(): boolean

      Indicates whether the background colors will be ignored.

      Returns boolean

    • set ignoreBackground(arg: boolean): void

      Parameters

      • arg: boolean

      Returns void

    • get inputColorSpace(): ColorSpace
      Experimental

      The input color space.

      Returns ColorSpace

    • set inputColorSpace(arg: ColorSpace): void
      Protected Experimental

      Parameters

      • arg: ColorSpace

      Returns void

    • get intensity(): number

      The bloom intensity.

      Returns number

    • set intensity(arg: number): void

      Parameters

      • arg: number

      Returns void

    • get inverted(): boolean

      Indicates whether the selection should be considered inverted.

      Returns boolean

    • set inverted(arg: boolean): void

      Parameters

      • arg: boolean

      Returns void

    • get kernelSize(): KernelSize

      The blur kernel size.

      Returns KernelSize

      Use blurPass.kernelSize instead.

    • set kernelSize(arg: KernelSize): void

      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
      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: ColorSpace): void
      Protected Experimental

      Parameters

      • arg: ColorSpace

      Returns void

    • get resolution(): Resolution

      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

      The current width of the internal render targets.

      Returns number

      Use resolution.width instead.

    • set width(arg: number): void

      Parameters

      • arg: number

      Returns void

    Methods

    • 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

    • Adds a listener to an event type.

      Type Parameters

      • T extends string

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{}, T, SelectiveBloomEffect>

        The function that gets called when the event is fired.

      Returns 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

    • 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

    • Returns the effect attributes.

      Returns EffectAttribute

      The attributes.

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

      Use blendMode instead.

    • Returns the blur pass.

      Returns KawaseBlurPass

      The blur pass.

      Use blurPass instead.

    • Returns the preprocessor macro definitions.

      Returns Map<string, string>

      The extensions.

      Use defines instead.

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

      Returns Set<WebGLExtension>

      The extensions.

      Use extensions instead.

    • The bloom intensity.

      Returns number

      The intensity.

      Use intensity instead.

    • Returns the luminance material.

      Returns LuminanceMaterial

      The material.

      Use luminanceMaterial instead.

    • Returns the luminance pass.

      Returns LuminancePass

      The luminance pass.

      Use luminancePass instead.

    • Returns the name of this effect.

      Returns string

      The name.

      Use name instead.

    • Returns the current resolution scale.

      Returns number

      The resolution scale.

      Use resolution instead.

    • Returns the selection.

      Returns Selection

      The selection.

      Use selection instead.

    • Returns the generated bloom texture.

      Returns Texture

      The texture.

      Use texture instead.

    • Returns the uniforms of this effect.

      Returns Map<string, Uniform<any>>

      The extensions.

      Use uniforms instead.

    • 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

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends string

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<{}, T, SelectiveBloomEffect>

        The function that gets called when the event is fired.

      Returns boolean

    • 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

    • Indicates whether the background is disabled.

      Returns boolean

      Whether the background is disabled.

      Use ignoreBackground instead.

    • Indicates whether the mask is inverted.

      Returns boolean

      Whether the mask is inverted.

      Use inverted instead.

    • 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

    • Removes a listener from an event type.

      Type Parameters

      • T extends string

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<{}, T, SelectiveBloomEffect>

        The listener function that gets removed.

      Returns 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

      • attributes: EffectAttribute

        The attributes.

      Returns void

    • Enables or disables the background.

      Parameters

      • value: boolean

        Whether the background should be disabled.

      Returns void

      Use ignoreBackground instead.

    • 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

    • Sets the depth texture.

      Parameters

      • depthTexture: Texture

        A depth texture.

      • OptionaldepthPacking: DepthPackingStrategies

        The depth packing.

      Returns void

    • Protected

      Sets the fragment shader.

      Parameters

      • fragmentShader: string

        The fragment shader.

      Returns void

    • Sets the bloom intensity.

      Parameters

      • value: number

        The intensity.

      Returns void

      Use intensity instead.

    • Enables or disable mask inversion.

      Parameters

      • value: boolean

        Whether the mask should be inverted.

      Returns void

      Use inverted instead.

    • Sets the renderer.

      Parameters

      • renderer: WebGLRenderer

        The renderer.

      Returns void

    • Sets the resolution scale.

      Parameters

      • scale: number

        The new resolution scale.

      Returns void

      Use resolution instead.

    • Updates the size of internal render targets.

      Parameters

      • width: number

        The width.

      • height: number

        The height.

      Returns void

    • Protected

      Sets the vertex shader.

      Parameters

      • vertexShader: string

        The vertex shader.

      Returns void

    • Updates this effect.

      Parameters

      • renderer: WebGLRenderer

        The renderer.

      • inputBuffer: WebGLRenderTarget

        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