Merge c1c178b into c773601

visgl · May 30, 2019 · 6a89c23 · 6a89c23
2 parents c773601 + c1c178b
commit 6a89c23
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 4 deletions.
diff --git a/dev-docs/RFCs/v7.x/post-process-effect-rfc.md b/dev-docs/RFCs/v7.x/post-process-effect-rfc.md
@@ -11,8 +11,8 @@ Post-processing effect rendering is part of deck.gl effect rendering pipeline, f
 
 A post-processing effect is created from `PostProcessEffect` class and Shader module.
 ```js
-import {brightnessContrast} from @luma.gl/effects;
-import {PostProcessEffect} from @deck.gl/core;
+import {brightnessContrast} from '@luma.gl/effects';
+import {PostProcessEffect} from '@deck.gl/core';
 
 const postProcessEffect = new PostProcessEffect(brightnessContrast, {
   brightness: 0.5,

diff --git a/docs/effects/lighting-effect.md b/docs/effects/lighting-effect.md
@@ -45,4 +45,4 @@ Array of [PointLight](/docs/api-reference/lights/point-light.md) source which em
 
 ## Source
 
-[/modules/core/src/effects/lighting-effect.js](https://github.com/uber/deck.gl/tree/master/modules/core/src/effects/lighting/lighting-effect.js)
+[/modules/core/src/effects/lighting/lighting-effect.js](https://github.com/uber/deck.gl/tree/master/modules/core/src/effects/lighting/lighting-effect.js)
diff --git a/docs/effects/post-process-effect.md b/docs/effects/post-process-effect.md
@@ -0,0 +1,40 @@
+# PostProcessEffect
+
+The post-processing Effect applies screen space pixel manipulation effects to deck.gl layers.
+
+## Constructor
+
+```js
+new PostProcessEffect(shaderModule, props);
+```
+
+Parameters:
+* `shaderModule`(Object) - a shader module wraps a screen space effect. For supported effects see [glfx shader modules](https://github.com/uber/luma.gl/blob/master/modules/effects/src/index.js).
+* `props`(Object) - parameters to replace the default values in shader module.
+
+## Example
+
+```js
+import {brightnessContrast} from '@luma.gl/effects';
+import {PostProcessEffect} from '@deck.gl/core';
+
+const postProcessEffect = new PostProcessEffect(brightnessContrast, {
+  brightness: 1.0,
+  contrast: 1.0
+});
+
+const deckgl = new Deck({
+  canvas: 'my-deck-canvas',
+  initialViewState,
+  controller: true,
+  // add effect to deck
+  effects: [postProcessEffect],
+  layers: [new GeoJsonLayer({
+    ...
+  })]
+});
+```
+
+## Source
+
+[/modules/core/src/effects/post-process-effect.js](https://github.com/uber/deck.gl/tree/master/modules/core/src/effects/post-process-effect.js)
diff --git a/docs/whats-new.md b/docs/whats-new.md
@@ -8,7 +8,7 @@ Release Date: 2019
 
 ### Post-processing Effects
 
-A new `PostProcessEffect` class, working with `@luma.gl/effects` module,  offers screen-space post-processing effects such as blur, noise, halftone, ink, etc.
+A new [PostProcessEffect](/docs/effects/post-process-effect.md) class, working with `@luma.gl/effects` module,  offers screen-space post-processing effects such as blur, noise, halftone, ink, etc.
 
 <table style="border: 0;" align="center">
   <tbody>

diff --git a/website/contents/pages.js b/website/contents/pages.js
@@ -576,6 +576,10 @@ export const docPages = generatePath([
           {
             name: 'LightingEffect',
             content: getDocUrl('effects/lighting-effect.md')
+          },
+          {
+            name: 'PostProcessEffect',
+            content: getDocUrl('effects/post-process-effect.md')
           }
         ]
       },