three-gpu-pathtracer 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -245,6 +245,14 @@ stableNoise = false : Boolean
245
245
 
246
246
  Whether to reset the random seed to `0` when restarting the render. If true then a consistent random sample pattern will appear when moving the camera, for example.
247
247
 
248
+ ### .stableTiles
249
+
250
+ ```js
251
+ stableTiles = true : Boolean
252
+ ```
253
+
254
+ Whether the initial tile is reset to the top left tile when moving the camera or if it should continue to shift every frame.
255
+
248
256
  ### .alpha
249
257
 
250
258
  ```js
@@ -253,6 +261,9 @@ alpha = false : Boolean
253
261
 
254
262
  Whether to support rendering scenes with transparent backgrounds. When transparent backgrounds are used two extra render targets are used, custom blending is performed, and PathTracingRenderer.target will change on every completed sample.
255
263
 
264
+ > **Note**
265
+ > When a transparent background is used then the material used for the final render to the canvas must use the same "premultipliedAlpha" setting as the canvas the final image may look incorrect.
266
+
256
267
  ### constructor
257
268
 
258
269
  ```js
@@ -566,6 +577,29 @@ _extends MaterialBase_
566
577
  }
567
578
  ```
568
579
 
580
+ ## DenoiseMaterial
581
+
582
+ _extends MaterialBase_
583
+
584
+ Denoise material based on [BrutPitt/glslSmartDeNoise](https://github.com/BrutPitt/glslSmartDeNoise) intended to be the final pass to the screen. Includes tonemapping and color space conversions.
585
+
586
+ **Uniforms**
587
+
588
+ ```js
589
+ {
590
+
591
+ // sigma - sigma Standard Deviation
592
+ // kSigma - sigma coefficient
593
+ // kSigma * sigma = radius of the circular kernel
594
+ sigma = 5.0 : Number,
595
+ kSigma = 1.0 : Number,
596
+
597
+ // edge sharpening threshold
598
+ threshold = 0.03 : Number,
599
+
600
+ }
601
+ ```
602
+
569
603
  ## RenderTarget2DArray
570
604
 
571
605
  _extends WebGLArrayRenderTarget_