[page:Object3D] → [page:Light] →
[name]
Affects objects using [page:MeshLambertMaterial] or [page:MeshPhongMaterial].
Example
// White directional light at half intensity shining from the top.
var directionalLight = new THREE.DirectionalLight( 0xffffff, 0.5 );
directionalLight.position.set( 0, 1, 0 );
scene.add( directionalLight );
Constructor
[name]([page:Integer hex], [page:Float intensity])
[page:Integer hex] -- Numeric value of the RGB component of the color.
[page:Float intensity] -- Numeric value of the light's strength/intensity.
Creates a light that shines from a specific direction not from a specific position. This light will behave
as though it is infinitely far away and the rays produced from it are all parallel. The best
analogy would be a light source that acts like the sun: the sun is so far away that all sunlight
hitting objects comes from the same angle.
Properties
[property:Object3D target]
Target used for shadow camera orientation.
[property:Float intensity]
Light's intensity.
Default — *1.0*.
[property:Boolean onlyShadow]
If set to *true* light will only cast shadow but not contribute any lighting (as if *intensity* was 0 but cheaper to compute).
Default — *false*.
[property:Float shadowCameraNear]
Orthographic shadow camera frustum parameter.
Default — *50*.
[property:Float shadowCameraFar]
Orthographic shadow camera frustum parameter.
Default — *5000*.
[property:Float shadowCameraLeft]
Orthographic shadow camera frustum parameter.
Default — *-500*.
[property:Float shadowCameraRight]
Orthographic shadow camera frustum parameter.
Default — *500*.
[property:Float shadowCameraTop]
Orthographic shadow camera frustum parameter.
Default — *500*.
[property:Float shadowCameraBottom]
Orthographic shadow camera frustum parameter.
Default — *-500*.
[property:Boolean shadowCameraVisible]
Show debug shadow camera frustum.
Default — *false*.
[property:Float shadowBias]
Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.
Default — *0*.
[property:Float shadowDarkness]
Darkness of shadow casted by this light (from *0* to *1*).
Default — *0.5*.
[property:Integer shadowMapWidth]
Shadow map texture width in pixels.
Default — *512*.
[property:Integer shadowMapHeight]
Shadow map texture height in pixels.
Default — *512*.
[property:Boolean shadowCascade]
**Experimental** If true, use a series of shadow maps in a cascade. This can give better z-depth resolution for a directional light.
Default — *false*.
[property:Integer shadowCascadeCount]
Number of shadow maps to allocate in a cascade (one after another).
Default — *2*.
[property:Vector3 shadowCascadeOffset]
A relative position to real camera where virtual shadow cameras are attached. A magic vector; scene and light orientation dependent.
Default — *Three.Vector3( 0, 0, -1000 )*.
[property:Array shadowCascadeBias]
An array of shadowMapBias values for the corresponding shadow map in the cascade, near to far.
Default — [ 0, 0, 0 ].
[property:Array shadowCascadeWidth]
An array of shadowMapWidth values for the corresponding shadow map in the cascade, near to far.
Default — [ 512, 512, 512 ].
[property:Array shadowCascadeHeight]
An array of shadowMapHeight values for the corresponding shadow map in the cascade, near to far.
Default — [ 512, 512, 512 ].
[property:Array shadowCascadeNearZ]
An array of shadowMapNear values for the corresponding shadow map in the cascade, near to far. These typically start with -1.0 (near plane) and match with the previous shadowCascadeFarZ array value.
Default — [ -1.000, 0.990, 0.998 ].
[property:Array shadowCascadeFarZ]
An array of shadowMapFar values for the corresponding shadow map in the cascade, near to far. These typically match with the next shadowCascadeNearZ array value, ending in 1.0.
Default — [ 0.990, 0.998, 1.000 ].
[property:Array shadowCascadeArray]
Array of size shadowCascadeCount of [page:DirectionalLight THREE.DirectionalLight] objects. This holds the series of separate shadow maps in a cascade, near to far. Created internally.
[property:Vector2 shadowMapSize]
The shadowMapWidth and shadowMapHeight stored in a [page:Vector2 THREE.Vector2]. Set internally during rendering.
[property:OrthographicCamera shadowCamera]
The shadow's view of the world. Computed internally during rendering from the shadowCamera* settings.
[property:Matrix4 shadowMatrix]
Model to shadow camera space, to compute location and depth in shadow map. Computed internally during rendering.
[property:WebGLRenderTarget shadowMap]
The depth map generated using the shadowCamera; a location beyond a pixel's depth is in shadow. Computed internally during rendering.
Methods
Source
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]