three-gpu-pathtracer 0.0.12 → 0.0.14

package/README.md

@@ -38,6 +38,8 @@ _More features and capabilities in progress!_
 
 [Spot Light Support](https://gkjohnson.github.io/three-gpu-pathtracer/example/bundle/spotLights.html)
 
+[Volumetric Fog Support](https://gkjohnson.github.io/three-gpu-pathtracer/example/bundle/fog.html)
+
 **Test Scenes**
 
 [Material Test Orb](https://gkjohnson.github.io/three-gpu-pathtracer/example/bundle/materialBall.html)
@@ -54,6 +56,9 @@ _More features and capabilities in progress!_
 
 [Ambient Occlusion Material](https://gkjohnson.github.io/three-gpu-pathtracer/example/bundle/aoRender.html)
 
+[Looking Glass Portrait Quilt Render](https://gkjohnson.github.io/three-gpu-pathtracer/example/bundle/lkg.html)
+
+
 ## Running examples locally
 
 To run and modify the examples locally, make sure you have Node and NPM installed.  Check the supported versions in [the test configuration](./.github/workflows/node.js.yml).
@@ -127,7 +132,7 @@ ptMaterial.materials.updateFrom( materials, textures );
 ptMaterial.lights.updateFrom( lights );
 
 // set the environment map
-const texture = await new RGBELoader().loadAsync( envMapUrl );
+const texture = await new RGBELoader().setDataType( THREE.FloatType ).loadAsync( envMapUrl );
 ptRenderer.material.envMapInfo.updateFrom( texture );
 
 animate();
@@ -161,7 +166,7 @@ import { BlurredEnvMapGenerator } from 'three-gpu-pathtracer';
 
 // ...
 
-const envMap = await new RGBELoader().loadAsync( envMapUrl );
+const envMap = await new RGBELoader().setDataType( THREE.FloatType ).loadAsync( envMapUrl );
 const generator = new BlurredEnvMapGenerator( renderer );
 const blurredEnvMap = generator.generate( envMap, 0.35 );
 
@@ -222,6 +227,9 @@ readonly target : WebGLRenderTarget
 
 The target being rendered to. The size of the target is updated with `setSize` and is initialized to a FloatType texture.
 
+> **Note**
+> Target will swap render targets after every full sample when alpha is enabled.
+
 ### .camera
 
 ```js
@@ -271,7 +279,7 @@ alpha = false : Boolean
 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.
 
 > **Note**
-> 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.
+> When a transparent background is used the material used for the final render to the canvas must use the same "premultipliedAlpha" setting as the canvas otherwise the final image may look incorrect.
 
 ### constructor
 
@@ -303,6 +311,68 @@ reset() : void
 
 Resets and restarts the render from scratch.
 
+## QuiltPathTracingRenderer
+
+Renderer that supports rendering to a quilt renderer to rendering on displays such as the Looking Glass display.
+
+### .viewCount
+
+```js
+viewCount = 48 : Number
+```
+
+The number of views to be rendered. If this is less than the product of the quiltDimensions then there will be gaps at the end of the quilt.
+
+### .quiltDimensions
+```js
+quiltDimensions = Vector2( 8, 6 ) : Vector2
+```
+
+The number of quilt patches in each dimension.
+
+### .viewCone
+```js
+viewCone = 35 * DEG2RAD : Number
+```
+
+The total angle sweep for the camera views rendered across the quilt.
+
+### .viewFoV
+
+```js
+viewFoV = 14 * DEG2RAD : Number
+```
+
+The camera field of view to render.
+
+### .displayDistance
+
+```js
+displayDistance = 1 : Number
+```
+
+The distance of the viewer to the display.
+
+### .displayAspect
+
+```js
+displayAspect = 0.75 : Number
+```
+
+The aspect ratio of the display.
+
+### .setFromDisplayView
+
+```js
+setFromDisplayView(
+	displayDistance : Number,
+	displayWidth : Number,
+	displayHeight : Number,
+) : void
+```
+
+Updates the `displayDistance`, `displayAspect`, and the `viewFoV` from viewer and display information.
+
 ## PathTracingSceneGenerator
 
 Utility class for generating the set of data required for initializing the path tracing material with a bvh, geometry, materials, and textures.
@@ -560,7 +630,13 @@ _extends MaterialBase_
 ```js
 {
 	// The number of ray bounces to test. Higher is better quality but slower performance.
+	// TransmissiveBounces indicates the number of additional transparent or translucent surfaces
+	// the ray can pass through.
 	bounces = 3 : Number,
+	transmissiveBounces = 10 : Number,
+
+	// The number of additional transmissive ray bounces to allow on top of existing bounces for object opacity / transmission.
+	transmissiveBounces = 5 : Number,
 
 	// The physical camera parameters to use
 	physicalCamera : PhysicalCameraUniform,
@@ -603,15 +679,29 @@ _extends MaterialBase_
 ```js
 {
 
-	// Whether to use multiple importance sampling to help the image converge more quickly
+	// Whether to use multiple importance sampling to help the image converge more quickly.
 	FEATURE_MIS = 1 : Number,
 
-	// The number of transparent pixels to allow on top of existing bounces for object transparency.
-	TRANSPARENT_TRAVERSALS = 5 : Number,
+	// Whether to use russian roulette path termination. Path termination will kick in after
+	// a minimum three bounces have been performed.
+	FEATURE_RUSSIAN_ROULETTE = 1 : Number,
 
 }
 ```
 
+## FogVolumeMaterial
+
+_extends MeshStandardMaterial_
+
+A material used for rendering fog-like volumes within the scene. The `color`, `emissive`, and `emissiveIntensity` fields are all used in the render.
+
+> *NOTE*
+> Since fog models many particles throughout the scene and cause many extra bounces fog materials can dramatically impact render time.
+
+### .density
+
+The particulate density of the volume.
+
 ## DenoiseMaterial
 
 _extends MaterialBase_
@@ -812,7 +902,10 @@ Set of randomness and other light transport utilities for use in a shader. See t
 
 - The project requires use of WebGL2.
 - All textures must use the same wrap and interpolation flags.
-- Spotlights are not supported in non-MIS rendering currently.
+- SpotLights, DirectionalLights, and PointLights are only supported with MIS.
+- Only MeshStandardMaterial and MeshPhysicalMaterial are supported.
+- Instanced geometry and interleaved buffers are not supported.
+- Emissive materials are supported but do not take advantage of MIS.
 
 # Screenshots
 
@@ -883,4 +976,6 @@ Set of randomness and other light transport utilities for use in a shader. See t
 
 [knightcrawler25/GLSL-PathTracer](https://github.com/knightcrawler25/GLSL-PathTracer/)
 
+[DassaultSystemes-Technology/dspbr-pt](https://github.com/DassaultSystemes-Technology/dspbr-pt)
+