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(diffuseTexture, specularTexture)

Parameters:
Name Type Description
diffuseTexture TextureCube

A cube map texture containing diffuse global illumination information
specularTexture TextureCube

A cube map texture containing specular global illumination information
Properties:
Name Type Description
diffuseTexture TextureCube

A cube map texture containing diffuse global illumination information
specularTexture TextureCube

A cube map texture containing specular global illumination information
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

acceptVisitor()

ignore

Overrides:
  • Entity#acceptVisitor

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:

destroy()

Inherited From:

getComponentsByType()

Returns an array of all Components with a given type.

Inherited From:

hasComponentType()

Returns whether or not the Entity has a component of a given type assigned to it.

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: