Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GodRaysEffect

A god rays effect.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new GodRaysEffect(camera?: Camera, lightSource?: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>, [options]?: { 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 }): GodRaysEffect

  • Constructs a new god rays effect.

    Parameters

    • Optional camera: Camera
    • Optional lightSource: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
    • Optional [options]: { 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.

      • Optional blendFunction?: BlendFunction
      • Optional blur?: boolean
      • Optional clampMax?: number
      • Optional decay?: number
      • Optional density?: number
      • Optional exposure?: number
      • Optional height?: number
      • Optional kernelSize?: KernelSize
      • Optional resolutionScale?: number
      • Optional resolutionX?: number
      • Optional resolutionY?: number
      • Optional samples?: number
      • Optional weight?: number
      • Optional width?: number

    Returns GodRaysEffect

Properties

Readonly blendMode

blendMode: BlendMode

The blend mode of this effect.

blurPass

blurPass: KawaseBlurPass

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

This pass can be disabled to improve performance.

Readonly defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

Readonly extensions

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.

Protected renderer

renderer: WebGLRenderer

The renderer.

deprecated

Readonly uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

blur

  • get blur(): boolean
  • set blur(arg: boolean): void

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

    deprecated

    Use blurPass.enabled instead.

    Returns boolean

  • Parameters

    • arg: boolean

    Returns void

depthMaskMaterial

  • get depthMaskMaterial(): DepthMaskMaterial

  • The depth mask material.

    Returns DepthMaskMaterial

dithering

  • get dithering(): boolean
  • set dithering(arg: boolean): void

  • Indicates whether dithering is enabled.

    deprecated

    Returns boolean

  • Parameters

    • arg: boolean

    Returns void

godRaysMaterial

  • get godRaysMaterial(): GodRaysMaterial

  • The internal god rays material.

    Returns GodRaysMaterial

height

  • get height(): number
  • set height(arg: number): void

  • The current height of the internal render targets.

    deprecated

    Use resolution.height instead.

    Returns number

  • Parameters

    • arg: number

    Returns void

inputColorSpace

  • get inputColorSpace(): ColorSpace
  • set inputColorSpace(arg: ColorSpace): void

  • The input color space.

    experimental

    Returns ColorSpace

  • The input color space.

    experimental

    Parameters

    • arg: ColorSpace

    Returns void

kernelSize

  • The blur kernel size.

    deprecated

    Use blurPass.kernelSize instead.

    Returns KernelSize

  • Parameters

    Returns void

lightSource

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

  • Sets the light source.

    Returns null | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

  • Sets the light source.

    Parameters

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

    Returns void

mainCamera

  • set mainCamera(arg: Camera): void

  • Sets the main camera.

    Parameters

    • arg: Camera

    Returns void

mainScene

  • set mainScene(arg: Scene): void

  • Sets the main scene.

    Parameters

    • arg: Scene

    Returns void

outputColorSpace

  • get outputColorSpace(): ColorSpace
  • set outputColorSpace(arg: ColorSpace): void

  • The output color space.

    Should only be changed if this effect converts the input colors to a different color space.

    experimental

    Returns ColorSpace

  • The output color space.

    Should only be changed if this effect converts the input colors to a different color space.

    experimental

    Parameters

    • arg: ColorSpace

    Returns void

resolution

  • The resolution of this effect.

    Returns Resolution

samples

  • get samples(): number
  • set samples(arg: number): void

  • The number of samples per pixel.

    deprecated

    Use godRaysMaterial.samples instead.

    Returns number

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

    deprecated

    Use godRaysMaterial.samples instead.

    Parameters

    • arg: number

    Returns void

texture

  • get texture(): Texture

  • A texture that contains the intermediate result of this effect.

    Returns Texture

width

  • get width(): number
  • set width(arg: number): void

  • The current width of the internal render targets.

    deprecated

    Use resolution.width instead.

    Returns number

  • Parameters

    • arg: number

    Returns void

Methods

addEventListener

  • addEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, GodRaysEffect>): void
  • addEventListener<T>(type: T, listener: EventListener<{}, T, GodRaysEffect>): 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

  • Type Parameters

    • T extends string

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent<T>(event: BaseEvent<T> & Event<string, unknown>[T]): 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.

    deprecated

    Use blendMode instead.

    Returns BlendMode

    The blend mode.

getBlurPass

  • getBlurPass(): KawaseBlurPass

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

    deprecated

    Use blurPass instead.

    Returns KawaseBlurPass

    The blur pass.

getDefines

  • getDefines(): Map<string, string>

  • Returns the preprocessor macro definitions.

    deprecated

    Use defines instead.

    Returns Map<string, string>

    The extensions.

getExtensions

  • getExtensions(): Set<WebGLExtension>

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

    deprecated

    Use extensions instead.

    Returns Set<WebGLExtension>

    The extensions.

getFragmentShader

  • getFragmentShader(): string

getGodRaysMaterial

  • getGodRaysMaterial(): GodRaysMaterial

  • Returns the god rays material.

    deprecated

    Use godRaysMaterial instead.

    Returns GodRaysMaterial

    The material.

getName

  • getName(): string

  • Returns the name of this effect.

    deprecated

    Use name instead.

    Returns string

    The name.

getResolution

  • getResolution(): GodRaysMaterial

  • Returns the resolution of this effect.

    deprecated

    Use resolution instead.

    Returns GodRaysMaterial

    The material.

getResolutionScale

  • getResolutionScale(): number

  • Returns the current resolution scale.

    deprecated

    Use resolution instead.

    Returns number

    The resolution scale.

getTexture

  • getTexture(): Texture

  • Returns the god rays texture.

    deprecated

    Use texture instead.

    Returns Texture

    The texture.

getUniforms

  • getUniforms(): Map<string, Uniform<any>>

  • Returns the uniforms of this effect.

    deprecated

    Use uniforms instead.

    Returns Map<string, Uniform<any>>

    The extensions.

getVertexShader

  • getVertexShader(): string

hasEventListener

  • hasEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, GodRaysEffect>): boolean
  • hasEventListener<T>(type: T, listener: EventListener<{}, T, GodRaysEffect>): 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

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

initialize

  • initialize(renderer: WebGLRenderer, alpha: boolean, frameBufferType: number): 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: T, listener: EventListener<Event<string, unknown>[T], T, GodRaysEffect>): void
  • removeEventListener<T>(type: T, listener: EventListener<{}, T, GodRaysEffect>): 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

  • Type Parameters

    • T extends string

    Parameters

    Returns void

Protected setAttributes

  • setAttributes(attributes: EffectAttribute): void

  • 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

Protected setChanged

  • setChanged(): void

  • Informs the associated {@link 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: Texture, depthPacking?: number): void

  • Sets the depth texture.

    Parameters

    • depthTexture: Texture

      A depth texture.

    • Optional depthPacking: number

    Returns void

Protected setFragmentShader

  • setFragmentShader(fragmentShader: string): void

  • Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setRenderer

  • setRenderer(renderer: WebGLRenderer): void

  • Sets the renderer.

    deprecated

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

setResolutionScale

  • setResolutionScale(scale: number): void

  • Sets the resolution scale.

    deprecated

    Use resolution instead.

    Parameters

    • scale: number

      The new resolution scale.

    Returns void

setSize

  • setSize(width: number, height: number): void

  • Updates the size of internal render targets.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

Protected setVertexShader

  • setVertexShader(vertexShader: string): void

  • Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

update

  • update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget<Texture>, deltaTime?: number): void

  • Updates this effect.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • inputBuffer: WebGLRenderTarget<Texture>

      A frame buffer that contains the result of the previous pass.

    • Optional deltaTime: number

    Returns void