Class GodRaysEffect

A god rays effect.

Hierarchy (View Summary)

Effect
- GodRaysEffect

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
- 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
Overrides Effect.constructor

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
Indicates whether the god rays should be blurred to reduce artifacts.

Returns boolean
Deprecated
Use blurPass.enabled instead.
set blur(arg: boolean): 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: boolean): 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: number): void
Parameters
- arg: number
Returns void

inputColorSpace

get inputColorSpace(): ColorSpace
Experimental
The input color space.

Returns ColorSpace
Inherited from Effect.inputColorSpace
set inputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.inputColorSpace

kernelSize

get kernelSize(): KernelSize
The blur kernel size.

Returns KernelSize
Deprecated
Use blurPass.kernelSize instead.
set kernelSize(arg: KernelSize): void
Parameters
- arg: KernelSize
Returns void

lightSource

get lightSource(): | Mesh<
    BufferGeometry<NormalBufferAttributes>,
    Material | Material[],
    Object3DEventMap,
>
| Points<
    BufferGeometry<NormalBufferAttributes>,
    Material | Material[],
    Object3DEventMap,
>
| null
Sets the light source.

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

mainCamera

set mainCamera(arg: Camera): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Effect.mainCamera

mainScene

set mainScene(arg: Scene): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Effect.mainScene

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
Inherited from Effect.outputColorSpace
set outputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.outputColorSpace

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: number): 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: number): void
Parameters
- arg: number
Returns void

Methods

addEventListener

addEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], 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
Inherited from Effect.addEventListener
addEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, GodRaysEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, GodRaysEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener

dispatchEvent

dispatchEvent<T extends keyof Event<string, unknown>>(
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
Inherited from Effect.dispatchEvent

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
Inherited from Effect.dispose

getAttributes

getAttributes(): EffectAttribute
Returns the effect attributes.

Returns EffectAttribute
The attributes.

Inherited from Effect.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.

Inherited from Effect.getBlendMode

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.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

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.

Inherited from Effect.getName

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.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

hasEventListener

hasEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], 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
Inherited from Effect.hasEventListener
hasEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, GodRaysEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, GodRaysEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener

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
Overrides Effect.initialize

removeEventListener

removeEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], 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
Inherited from Effect.removeEventListener
removeEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, GodRaysEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{}, T, GodRaysEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener

`Protected`setAttributes

setAttributes(attributes: EffectAttribute): 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
- attributes: EffectAttribute
  The attributes.
Returns void
Inherited from Effect.setAttributes

`Protected`setChanged

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
Inherited from Effect.setChanged

setDepthTexture

setDepthTexture(depthTexture: Texture, depthPacking?: number): void
Sets the depth texture.
Parameters
- depthTexture: Texture
  A depth texture.
- OptionaldepthPacking: number
  The depth packing.
Returns void
Overrides Effect.setDepthTexture

`Protected`setFragmentShader

setFragmentShader(fragmentShader: string): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  The fragment shader.
Returns void
Inherited from Effect.setFragmentShader

setRenderer

setRenderer(renderer: WebGLRenderer): void
Sets the renderer.
Parameters
- renderer: WebGLRenderer
  The renderer.
Returns void
Deprecated
Inherited from Effect.setRenderer

setResolutionScale

setResolutionScale(scale: number): void
Sets the resolution scale.
Parameters
- scale: number
  The new resolution scale.
Returns void
Deprecated
Use resolution instead.

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
Overrides Effect.setSize

`Protected`setVertexShader

setVertexShader(vertexShader: string): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  The vertex shader.
Returns void
Inherited from Effect.setVertexShader

update

update(
    renderer: WebGLRenderer,
    inputBuffer: WebGLRenderTarget,
    deltaTime?: number,
): void
Updates this effect.
Parameters
- renderer: WebGLRenderer
  The renderer.
- inputBuffer: WebGLRenderTarget
  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
Overrides Effect.update

Class GodRaysEffect

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalblendFunction?: BlendFunction

Optionalblur?: boolean

OptionalclampMax?: number

Optionaldecay?: number

Optionaldensity?: number

Optionalexposure?: number

Optionalheight?: number

OptionalkernelSize?: KernelSize

OptionalresolutionScale?: number

OptionalresolutionX?: number

OptionalresolutionY?: number

Optionalsamples?: number

Optionalweight?: number

Optionalwidth?: number

Returns GodRaysEffect

Properties

ReadonlyblendMode

blurPass

Readonlydefines

Readonlyextensions

name

Protectedrenderer

Deprecated

Readonlyuniforms

Accessors

blur

Returns boolean

Deprecated

Parameters

Returns void

depthMaskMaterial

Returns DepthMaskMaterial

dithering

Returns boolean

Deprecated

Parameters

Returns void

godRaysMaterial

Returns GodRaysMaterial

height

Returns number

Deprecated

Parameters

Returns void

inputColorSpace

Returns ColorSpace

Parameters

Returns void

kernelSize

Returns KernelSize

Deprecated

Parameters

Returns void

lightSource

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

Parameters

Returns void

mainCamera

Parameters

Returns void

mainScene

Parameters

Returns void

outputColorSpace

Returns ColorSpace

Parameters

Returns void

resolution

Returns Resolution

samples

`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

`Readonly`blendMode

`Readonly`defines

`Readonly`extensions

`Protected`renderer

`Readonly`uniforms

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