Documentation / @ripl/3d / HemisphereLight
Class: HemisphereLight ​
Defined in: 3d/src/core/lights.ts:179
A two-colour light that fades from Light.color overhead to groundColor underfoot.
Cheaper than a pair of opposed directional lights and reads as bounced daylight, which is what a flat ambient term cannot give you.
Extends ​
Constructors ​
Constructor ​
new HemisphereLight(
options?):HemisphereLight
Defined in: 3d/src/core/lights.ts:193
Parameters ​
| Parameter | Type |
|---|---|
options? | HemisphereLightOptions |
Returns ​
HemisphereLight
Overrides ​
Properties ​
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
_color | protected | string | - | Light._color | 3d/src/core/lights.ts:108 |
_enabled | protected | boolean | - | Light._enabled | 3d/src/core/lights.ts:110 |
_intensity | protected | number | - | Light._intensity | 3d/src/core/lights.ts:109 |
type | readonly | LightType | The kind of illumination this light contributes. | Light.type | 3d/src/core/lights.ts:106 |
Accessors ​
color ​
Get Signature ​
get color():
string
Defined in: 3d/src/core/lights.ts:116
The light's colour.
Returns ​
string
Set Signature ​
set color(
value):void
Defined in: 3d/src/core/lights.ts:120
Parameters ​
| Parameter | Type |
|---|---|
value | string |
Returns ​
void
Inherited from ​
enabled ​
Get Signature ​
get enabled():
boolean
Defined in: 3d/src/core/lights.ts:136
Whether the light contributes at all.
Returns ​
boolean
Set Signature ​
set enabled(
value):void
Defined in: 3d/src/core/lights.ts:140
Parameters ​
| Parameter | Type |
|---|---|
value | boolean |
Returns ​
void
Inherited from ​
groundColor ​
Get Signature ​
get groundColor():
string
Defined in: 3d/src/core/lights.ts:184
The colour reaching surfaces that face downwards.
Returns ​
string
Set Signature ​
set groundColor(
value):void
Defined in: 3d/src/core/lights.ts:188
Parameters ​
| Parameter | Type |
|---|---|
value | string |
Returns ​
void
intensity ​
Get Signature ​
get intensity():
number
Defined in: 3d/src/core/lights.ts:126
How strongly the light contributes.
Returns ​
number
Set Signature ​
set intensity(
value):void
Defined in: 3d/src/core/lights.ts:130
Parameters ​
| Parameter | Type |
|---|---|
value | number |
Returns ​
void
Inherited from ​
Methods ​
invalidate() ​
invalidate():
void
Defined in: 3d/src/core/lights.ts:158
Requests a repaint of whatever this light is attached to. Call after mutating derived state.
Returns ​
void