屏幕空间雾后处理效果(移植自Fantasy3D)

Export

Date

2025.10.18

Author

lyx

Hierarchy

Constructors

Properties

blendMode: BlendMode

The blend mode of this effect.

defines: Map<string, string>

Preprocessor macro definitions.

Call setChanged after changing macro definitions.

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call setChanged after adding or removing extensions.

name: string

The name of this effect.

renderer: WebGLRenderer

The renderer.

Deprecated

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call setChanged after adding or removing uniforms.

Accessors

  • set directionalInscatteringColor(value): void
  • 设置散射光的颜色。

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set directionalInscatteringExponent(value): void
  • 设置散射光束的聚焦指数。

    控制光束的锐利程度。值越大,光束越集中、越锐利。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set directionalInscatteringStartDistance(value): void
  • 设置散射光束开始计算的距离。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set fogColor(value): void
  • 设置雾气的颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set fogDensity(value): void
  • 设置雾气的基础密度。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set fogHeight(value): void
  • 设置雾气层的基准高度。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set fogHeightFalloff(value): void
  • 设置雾气的高度衰减系数。

    控制雾气密度随 Y 轴升高而衰减的速度。值越大,雾层越薄,边界越清晰。通常在 0.05 到 1.0 之间。0.05 适合厚厚的、缓慢过渡的大气,0.5 适合贴地面的薄雾。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set fogMaxOpacity(value): void
  • 设置雾气的最大不透明度。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set fogStartDistance(value): void
  • 设置雾效开始计算的距离。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • get inputColorSpace(): ColorSpace
  • Experimental

    The input color space.

    Returns ColorSpace

  • set inputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

  • set inscatteringLightDirection(value): void
  • 设置定向光的反向方向向量,必须归一化 (normalize)。

    Parameters

    • value: Vector3

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set mainCamera(value): void
  • 设置主相机

    Parameters

    • value: Camera

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set mainScene(value): void
  • 设置主场景

    Parameters

    • value: Scene

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set noiseScale(value): void
  • 设置噪声在世界空间中的频率。

    控制雾气团块的大小。值越小,团块越大越平缓;值越大,团块越小越密集。大型云海推荐 0.005 到 0.05。地面团状雾推荐 0.05 到 0.15。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set noiseSpeed(value): void
  • 设置雾气扰动在世界空间 X 轴和 Z 轴上的流动速度。

    Parameters

    • value: Vector2

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • set noiseStrength(value): void
  • 设置噪声对雾气基准高度的最大扰动幅度。

    控制雾气基准面上下波动的最大高度(米)。通常设置为一个世界高度值,如 5.0 (轻微波动) 到 50.0 (明显起伏)。这个值决定了雾气团块的垂直对比度。

    Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • 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

  • Adds a listener to an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<BaseEventMap[T], T, ScreenSpaceFogEffect>

      The function that gets called when the event is fired.

    Returns void

  • Fire an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • event: BaseEvent<T> & BaseEventMap[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 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.

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

  • Returns the fragment shader.

    Returns string

    The fragment shader.

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

  • Returns the uniforms of this effect.

    Returns Map<string, Uniform<any>>

    The extensions.

    Deprecated

    Use uniforms instead.

  • Returns the vertex shader.

    Returns string

    The vertex shader.

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<BaseEventMap[T], T, ScreenSpaceFogEffect>

      The function that gets called when the event is fired.

    Returns boolean

  • 初始化效果

    Parameters

    • renderer: WebGLRenderer

      渲染器

    • alpha: boolean

      是否使用透明通道

    • frameBufferType: number

      帧缓冲区类型

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • Removes a listener from an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<BaseEventMap[T], T, ScreenSpaceFogEffect>

      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

    Returns 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

  • 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

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

  • 设置效果尺寸

    Parameters

    • width: number

      宽度(单位:像素)

    • height: number

      高度(单位:像素)

    Returns void

    Memberof

    ScreenSpaceFogEffect

  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

  • 更新效果

    Parameters

    • renderer: WebGLRenderer

      渲染器

    • inputBuffer: WebGLRenderTarget<Texture>

      输入缓冲

    • Optional deltaTime: number

      距离上一帧的时间间隔(单位:秒)

    Returns void

    Memberof

    ScreenSpaceFogEffect