Documentation

Class: LightProbe

LightProbe

LightProbe provides functionality to store global illumination information and apply it to the scene lighting. Only providing a simple specularTexture will behave like environment mapping, but diffuse convolution can be applied for global diffuse illumination.

new LightProbe(diffuseSH, specularTexture)

Parameters:
Name Type Description
diffuseSH SphericalHarmonicsRGB

A spherical harmonics representation of the diffuse global illumination
specularTexture TextureCube

A cube map texture containing specular global illumination information
Properties:
Name Type Description
diffuseSH SphericalHarmonicsRGB

A spherical harmonics representation of the diffuse global illumination
specularTexture TextureCube

A cube map texture containing specular global illumination information
intensity number

Defines the intensity of the environment map.
size number

Defines the virtual size of the environment map box. Useful for local reflections. Leave undefined for a traditional environment map "at infinity"
Author:
  • derschmale <http://www.derschmale.com>
See:

Extends

Methods

_bindSkeleton()

Inherited From:

addComponent()

Adds a single Component object to the Entity.

Inherited From:

addComponents(components)

Adds multiple Component objects to the Entity.

Parameters:
Name Type Description
components Array

An array of components to add.
Inherited From:

clone()

Inherited From:
Overrides:

destroy()

Inherited From:

getComponentByName()

Returns the Component with a given name.

Inherited From:

invalidateBounds()

Marks the bounds as invalid, causing them to be recalculated when next queried.

Inherited From:

removeComponent()

Removes a single Component from the Entity.

Inherited From:

removeComponents(components)

Removes multiple Component objects from the Entity.

Parameters:
Name Type Description
components Array

A list of components to remove.
Inherited From: