Home Reference Source
import {GodRaysEffect} from 'postprocessing'
public class | source

GodRaysEffect

Extends:

three~EventDispatcherEffect → GodRaysEffect

Indirect Implements:

A god rays effect.

Constructor Summary

Public Constructor
public

constructor(camera: Camera, lightSource: Mesh | Points, options: Object)

Constructs a new god rays effect.

Member Summary

Public Members
public get

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

public set
public

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

public get
this get was deprecated. Set the frameBufferType of the EffectComposer to HalfFloatType instead.

Indicates whether dithering is enabled.

public set
this set was deprecated. Set the frameBufferType of the EffectComposer to HalfFloatType instead.

Enables or disables dithering.

public get

The internal god rays material.

public get
this get was deprecated. Use resolution.height instead.

The current height of the internal render targets.

public set
this set was deprecated. Use resolution.height instead.

Sets the render height.

public get
this get was deprecated. Use blurPass.kernelSize instead.

The blur kernel size.

public set
this set was deprecated. Use blurPass.kernelSize instead.

Sets the blur kernel size.

public get

The resolution of this effect.

public get

The number of samples per pixel.

public set

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

public get

texture: Texture

A texture that contains the intermediate result of this effect.

public get
this get was deprecated. Use resolution.width instead.

The current width of the internal render targets.

public set
this set was deprecated. Use resolution.width instead.

Sets the render width.

Method Summary

Public Methods
public
this method was deprecated. Adjust the fixed resolution width or height instead.

Returns the current resolution scale.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public
this method was deprecated. Adjust the fixed resolution width or height instead.

Sets the resolution scale.

public

setSize(width: Number, height: Number)

Updates the size of internal render targets.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number)

Updates this effect.

Inherited Summary

From class Effect
public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

public

Performs a shallow search for properties that define a dispose method and deletes them.

public

Returns the effect attributes.

public

Returns the fragment shader.

public

Returns the vertex shader.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number)

Updates the effect by performing supporting operations.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect has changed in a way that requires a shader recompilation.

protected

setFragmentShader(fragmentShader: String)

Sets the fragment shader.

protected

setVertexShader(vertexShader: String)

Sets the vertex shader.

Public Constructors

public constructor(camera: Camera, lightSource: Mesh | Points, options: Object) source

Constructs a new god rays effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
camera Camera

The main camera.

lightSource Mesh | Points

The light source. Must not write depth and has to be flagged as transparent.

options Object
  • optional

The options.

options.blendFunction BlendFunction
  • optional
  • default: BlendFunction.SCREEN

The blend function of this effect.

options.samples Number
  • optional
  • default: 60.0

The number of samples per pixel.

options.density Number
  • optional
  • default: 0.96

The density of the light rays.

options.decay Number
  • optional
  • default: 0.9

An illumination decay factor.

options.weight Number
  • optional
  • default: 0.4

A light ray weight factor.

options.exposure Number
  • optional
  • default: 0.6

A constant attenuation coefficient.

options.clampMax Number
  • optional
  • default: 1.0

An upper bound for the saturation of the overall effect.

options.resolutionScale Number
  • optional
  • default: 0.5

Deprecated. Use height or width instead.

options.width Number
  • optional
  • default: Resizer.AUTO_SIZE

The render width.

options.height Number
  • optional
  • default: Resizer.AUTO_SIZE

The render height.

options.kernelSize KernelSize
  • optional
  • default: KernelSize.SMALL

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

options.blur Boolean
  • optional
  • default: true

Whether the god rays should be blurred to reduce artifacts.

Public Members

public get blur: Boolean source

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

public set blur: Boolean source

public blurPass: BlurPass source

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

Disable this pass to improve performance.

public get dithering: Boolean source

this get was deprecated. Set the frameBufferType of the EffectComposer to HalfFloatType instead.

Indicates whether dithering is enabled.

public set dithering: Boolean source

this set was deprecated. Set the frameBufferType of the EffectComposer to HalfFloatType instead.

Enables or disables dithering.

public get godRaysMaterial: GodRaysMaterial source

The internal god rays material.

public get height: Number source

this get was deprecated. Use resolution.height instead.

The current height of the internal render targets.

public set height: Number source

this set was deprecated. Use resolution.height instead.

Sets the render height.

public get kernelSize: KernelSize source

this get was deprecated. Use blurPass.kernelSize instead.

The blur kernel size.

public set kernelSize: KernelSize source

this set was deprecated. Use blurPass.kernelSize instead.

Sets the blur kernel size.

public get resolution: Resizer source

The resolution of this effect.

public get samples: Number source

The number of samples per pixel.

public set samples: Number source

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

public get texture: Texture source

A texture that contains the intermediate result of this effect.

This texture will be applied to the scene colors unless the blend function is set to SKIP.

public get width: Number source

this get was deprecated. Use resolution.width instead.

The current width of the internal render targets.

public set width: Number source

this set was deprecated. Use resolution.width instead.

Sets the render width.

Public Methods

public getResolutionScale(): Number source

this method was deprecated. Adjust the fixed resolution width or height instead.

Returns the current resolution scale.

Return:

Number

The resolution scale.

public initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) source

Performs initialization tasks.

Override:

Effect#initialize

Params:

NameTypeAttributeDescription
renderer WebGLRenderer

The renderer.

alpha Boolean

Whether the renderer uses the alpha channel or not.

frameBufferType Number

The type of the main frame buffers.

public setDepthTexture(depthTexture: Texture, depthPacking: Number) source

Sets the depth texture.

Override:

Effect#setDepthTexture

Params:

NameTypeAttributeDescription
depthTexture Texture

A depth texture.

depthPacking Number
  • optional
  • default: BasicDepthPacking

The depth packing.

public setResolutionScale(scale: Number) source

this method was deprecated. Adjust the fixed resolution width or height instead.

Sets the resolution scale.

Params:

NameTypeAttributeDescription
scale Number

The new resolution scale.

public setSize(width: Number, height: Number) source

Updates the size of internal render targets.

Override:

Effect#setSize

Params:

NameTypeAttributeDescription
width Number

The width.

height Number

The height.

public update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) source

Updates this effect.

Override:

Effect#update

Params:

NameTypeAttributeDescription
renderer WebGLRenderer

The renderer.

inputBuffer WebGLRenderTarget

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

deltaTime Number
  • optional

The time between the last frame and the current one in seconds.