Class GodRaysEffect

constructor

• new GodRaysEffect(camera?, lightSource?, options?): GodRaysEffect

• Constructs a new god rays effect.

  Parameters

  • Optionalcamera: Camera

    The main camera.
  • OptionallightSource: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    The light source. Must not write depth and has to be flagged as transparent.
  • Optionaloptions: {
        blendFunction?: BlendFunction;
        blur?: boolean;
        clampMax?: number;
        decay?: number;
        density?: number;
        exposure?: number;
        height?: number;
        kernelSize?: KernelSize;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        samples?: number;
        weight?: number;
        width?: number;
    }

    The options.

    • OptionalblendFunction?: BlendFunction

      The blend function of this effect.

    • Optionalblur?: boolean

      Whether the god rays should be blurred to reduce artifacts.

    • OptionalclampMax?: number

      An upper bound for the saturation of the overall effect.

    • Optionaldecay?: number

      An illumination decay factor.

    • Optionaldensity?: number

      The density of the light rays.

    • Optionalexposure?: number

      A constant attenuation coefficient.

    • Optionalheight?: number

      Deprecated. Use resolutionY instead.

    • OptionalkernelSize?: KernelSize

      The blur kernel size. Has no effect if blur is disabled.

    • OptionalresolutionScale?: number

      The resolution scale.

    • OptionalresolutionX?: number

      The horizontal resolution.

    • OptionalresolutionY?: number

      The vertical resolution.

    • Optionalsamples?: number

      The number of samples per pixel.

    • Optionalweight?: number

      A light ray weight factor.

    • Optionalwidth?: number

      Deprecated. Use resolutionX instead.

  Returns GodRaysEffect

ReadonlyblendMode

blurPass

Readonlydefines

Readonlyextensions

name

Readonlyuniforms

blur

• get blur(): boolean

• Indicates whether the god rays should be blurred to reduce artifacts.

  Returns boolean

  Deprecated

  Use blurPass.enabled instead.

• set blur(arg): void

• Parameters

  • arg: boolean

  Returns void

depthMaskMaterial

• get depthMaskMaterial(): DepthMaskMaterial

• The depth mask material.

  Returns DepthMaskMaterial

dithering

• get dithering(): boolean

• Indicates whether dithering is enabled.

  Returns boolean

  Deprecated

• set dithering(arg): void

• Parameters

  • arg: boolean

  Returns void

godRaysMaterial

• get godRaysMaterial(): GodRaysMaterial

• The internal god rays material.

  Returns GodRaysMaterial

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

inputColorSpace

• get inputColorSpace(): ColorSpace
• Experimental

  The input color space.

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

  Parameters

  • arg: ColorSpace

  Returns void

kernelSize

• get kernelSize(): KernelSize

• The blur kernel size.

  Returns KernelSize

  Deprecated

  Use blurPass.kernelSize instead.

• set kernelSize(arg): void

• Parameters

  • arg: KernelSize

  Returns void

lightSource

• get lightSource(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

• Sets the light source.

  Returns Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
• set lightSource(value): void

• Parameters

  • value: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

  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

  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

samples

• get samples(): number

• The number of samples per pixel.

  Returns number

  Deprecated

  Use godRaysMaterial.samples instead.

• set samples(arg): void

• A higher sample count improves quality at the cost of performance.

  Parameters

  • arg: number

  Returns void

  Deprecated

  Use godRaysMaterial.samples instead.

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

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

    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

• getAttributes(): EffectAttribute

• Returns the effect attributes.

  Returns EffectAttribute

  The attributes.

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

• getBlurPass(): KawaseBlurPass

• Returns the blur pass that reduces aliasing artifacts and makes the light softer.

  Returns KawaseBlurPass

  The blur pass.

  Deprecated

  Use blurPass instead.

getDefines

• getDefines(): Map<string, string>

• Returns the preprocessor macro definitions.

  Returns Map<string, string>

  The extensions.

  Deprecated

  Use defines instead.

getExtensions

• getExtensions(): Set<WebGLExtension>

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

  Returns Set<WebGLExtension>

  The extensions.

  Deprecated

  Use extensions instead.

getFragmentShader

• getFragmentShader(): string

• Returns the fragment shader.

  Returns string

  The fragment shader.

getGodRaysMaterial

• getGodRaysMaterial(): GodRaysMaterial

• Returns the god rays material.

  Returns GodRaysMaterial

  The material.

  Deprecated

  Use godRaysMaterial instead.

getName

• getName(): string

• Returns the name of this effect.

  Returns string

  The name.

  Deprecated

  Use name instead.

getResolution

• getResolution(): GodRaysMaterial

• Returns the resolution of this effect.

  Returns GodRaysMaterial

  The material.

  Deprecated

  Use resolution instead.

getResolutionScale

• getResolutionScale(): number

• Returns the current resolution scale.

  Returns number

  The resolution scale.

  Deprecated

  Use resolution instead.

getTexture

• getTexture(): Texture

• Returns the god rays 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

• 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, GodRaysEffect>

    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

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

    The listener function that gets removed.

  Returns void

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): void

• Sets the depth texture.

  Parameters

  • depthTexture: Texture

    A depth texture.
  • OptionaldepthPacking: number

    The depth packing.

  Returns void

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

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