Class ScreenSpaceFogEffect

Screen space fog effect

Export

ScreenSpaceFogEffect

Date

2024.8.14

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

blendMode defines extensions name renderer uniforms

Accessors

directionalInscatteringColor directionalInscatteringExponent directionalInscatteringStartDistance fogColor fogHeight fogHeightFalloff fogMaxOpacity inputColorSpace inscatteringLightDirection mainCamera mainScene outputColorSpace startDistance

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

ReadonlyblendMode

blendMode: BlendMode

The blend mode of this effect.

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.

name

name: string

The name of this effect.

Protectedrenderer

renderer: WebGLRenderer

The renderer.

Deprecated

Readonlyuniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

directionalInscatteringColor

  • set directionalInscatteringColor(value): void

  • Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    ScreenSpaceFogEffect

directionalInscatteringExponent

  • set directionalInscatteringExponent(value): void

  • Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

directionalInscatteringStartDistance

  • set directionalInscatteringStartDistance(value): void

  • Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

fogColor

  • set fogColor(value): void

  • Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    ScreenSpaceFogEffect

fogHeight

  • set fogHeight(value): void

  • Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

fogHeightFalloff

  • set fogHeightFalloff(value): void

  • Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

fogMaxOpacity

  • set fogMaxOpacity(value): void

  • Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

inputColorSpace

  • get inputColorSpace(): ColorSpace
  • Experimental

    The input color space.

    Returns ColorSpace

  • set inputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

inscatteringLightDirection

  • set inscatteringLightDirection(value): void

  • Parameters

    • value: Vector3

    Returns void

    Memberof

    ScreenSpaceFogEffect

mainCamera

  • set mainCamera(value): void

  • Sets the main camera.

    Parameters

    • value: Camera

    Returns void

    Memberof

    ScreenSpaceFogEffect

mainScene

  • set mainScene(value): void

  • Sets the main scene.

    Parameters

    • value: Scene

    Returns void

    Memberof

    ScreenSpaceFogEffect

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

startDistance

  • set startDistance(value): void

  • Parameters

    • value: number

    Returns void

    Memberof

    ScreenSpaceFogEffect

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

      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.

getDefines

  • getDefines(): Map<string, string>

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

getExtensions

getFragmentShader

  • getFragmentShader(): string

  • Returns the fragment shader.

    Returns string

    The fragment shader.

getName

  • getName(): string

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

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

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

      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 or not.

    • frameBufferType: number

      The type of the main frame buffers.

    Returns void

    Memberof

    ScreenSpaceFogEffect

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

      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

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.

    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.

    • OptionaldepthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

ProtectedsetFragmentShader

  • setFragmentShader(fragmentShader): void
  • Protected

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setRenderer

  • setRenderer(renderer): void

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setSize

  • setSize(width, height): void

  • Updates the size of this effect.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

    Memberof

    ScreenSpaceFogEffect

ProtectedsetVertexShader

  • setVertexShader(vertexShader): void
  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

update

  • update(renderer, inputBuffer, deltaTime?): void

  • Update this effect.

    Parameters

    • renderer: WebGLRenderer

      The render.

    • 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

    Memberof

    ScreenSpaceFogEffect

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods