Class ScreenSpaceRainEffect

屏幕空间雨后处理效果

Export

Date

2025.10.23

Author

lyx

Hierarchy

Constructors

constructor

Properties

blendMode defines extensions name renderer uniforms

Accessors

inputColorSpace mainCamera mainScene outputColorSpace

Methods

addEventListener dispatchEvent dispose getAttributes getBlendMode getDefines getExtensions getFragmentShader getName getUniforms getVertexShader hasEventListener initialize removeEventListener setAttributes setChanged setDepthTexture setFragmentShader setRenderer setSize setVertexShader update

Constructors

constructor

Properties

Readonly blendMode

blendMode: BlendMode

The blend mode of this effect.

Readonly defines

defines: Map<string, string>

Preprocessor macro definitions.

Call setChanged after changing macro definitions.

Readonly extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call setChanged after adding or removing extensions.

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 setChanged after adding or removing uniforms.

Accessors

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<Object3DEventMap>

    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

Methods

addEventListener

  • Adds a listener to an event type.

    Type Parameters

    • T extends "change"

    Parameters

    Returns void

dispatchEvent

  • Fire an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • event: BaseEvent<T> & BaseEventMap[T]

      The event that gets fired.

    Returns void

dispose

  • 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

  • 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

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

getExtensions

getFragmentShader

  • Returns the fragment shader.

    Returns string

    The fragment shader.

getName

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

getUniforms

  • Returns the uniforms of this effect.

    Returns Map<string, Uniform<any>>

    The extensions.

    Deprecated

    Use uniforms instead.

getVertexShader

  • Returns the vertex shader.

    Returns string

    The vertex shader.

hasEventListener

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends "change"

    Parameters

    Returns boolean

initialize

  • 初始化效果

    Parameters

    • renderer: WebGLRenderer

      渲染器

    • alpha: boolean

      是否使用透明通道

    • frameBufferType: number

      帧缓冲区类型

    Returns void

    Memberof

    ScreenSpaceRainEffect

removeEventListener

  • Removes a listener from an event type.

    Type Parameters

    • T extends "change"

    Parameters

    Returns void

Protected setAttributes

  • 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

  • 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

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

      A depth texture.

    • Optional depthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

Protected setFragmentShader

  • Protected

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setRenderer

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setSize

  • 设置效果尺寸

    Parameters

    • width: number

      宽度（单位：像素）

    • height: number

      高度（单位：像素）

    Returns void

    Memberof

    ScreenSpaceRainEffect

Protected setVertexShader

  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

update

  • 更新效果

    Parameters

    • renderer: WebGLRenderer

      渲染器

    • inputBuffer: WebGLRenderTarget<Texture<unknown>>

      输入缓冲

    • Optional deltaTime: number

      距离上一帧的时间间隔（单位：秒）

    Returns void

    Memberof

    ScreenSpaceRainEffect

Settings

Member Visibility

Theme

On This Page