Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
926ae16
commit 581ba9c
Showing
1 changed file
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# RFC: Shadow for directional lights | ||
|
||
* **Authors**: Jian Huang | ||
|
||
* **Date**: July. 2019 | ||
|
||
* **Status**: For Review | ||
|
||
## Abstract | ||
Deck.gl has new basic lighting effect since 7.0, having shadow effects for directional lights can improve rendering quality. | ||
|
||
## Proposal | ||
### API | ||
`LightWithShadowEffect` class is the public interface to create shadow effects, it extends from `LightingEffect` and has one param. | ||
* `lights`(Object): collection of light sources | ||
|
||
New layer prop | ||
* `enableShadow`(Boolean): when this prop is true, layer casts and renders shadows | ||
|
||
### Example | ||
```js | ||
const ambientLight = new AmbientLight({ | ||
color: [255, 255, 255], | ||
intensity: 1.0 | ||
}); | ||
|
||
const dirLight0 = new DirectionalLight({ | ||
color: [255, 255, 255], | ||
intensity: 1.0, | ||
direction: [10, -20, -30] | ||
}); | ||
|
||
const dirLight1 = new DirectionalLight({ | ||
color: [255, 255, 255], | ||
intensity: 1.0, | ||
direction: [-10, -20, -30] | ||
}); | ||
|
||
const lightWithShadowEffect = new LightWithShadowEffect({ | ||
ambientLight, | ||
dirLight0, | ||
dirLight1 | ||
}); | ||
const deckgl = new Deck({ | ||
canvas: 'my-deck-canvas', | ||
effects: [lightWithShadowEffect], | ||
layers: [ | ||
// building layer | ||
new SolidPolygonLayer({ | ||
enableShadow: true, | ||
... | ||
}), | ||
// ground layer | ||
new SolidPolygonLayer({ | ||
enableShadow: true, | ||
... | ||
}) | ||
] | ||
}); | ||
``` | ||
### Workflow | ||
* User creates `LightWithShadowEffect` instance which adds shadow modules into default shader modules | ||
* `LightWithShadowEffect` instance is passed into deck and create shadow passes based on light directions, there is one shadow pass for each directional light, for now totally two lights are supported | ||
* For each shadow pass, layers are rendered to a shadow map | ||
* After all the effects are processed, there is a regular layer rendering pass, shadow maps are used to render the final shadows. | ||
|
||
## Limitations | ||
With the current design, the user needs to create `LightWithShadowEffect` instance before Deck's initialization, so that the default modules can be modified before layer shaders are assembled. |