three-gpu-pathtracer 0.0.13 → 0.0.15

package/README.md

@@ -3,7 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/three-gpu-pathtracer.svg?style=flat-square)](https://www.npmjs.com/package/three-gpu-pathtracer)
 [![build](https://img.shields.io/github/actions/workflow/status/gkjohnson/three-gpu-pathtracer/node.js.yml?style=flat-square&label=build&branch=main)](https://github.com/gkjohnson/three-gpu-pathtracer/actions)
 [![github](https://flat.badgen.net/badge/icon/github?icon=github&label)](https://github.com/gkjohnson/three-gpu-pathtracer/)
-[![twitter](https://flat.badgen.net/twitter/follow/garrettkjohnson)](https://twitter.com/garrettkjohnson)
+[![twitter](https://flat.badgen.net/badge/twitter/@garrettkjohnson/?icon&label)](https://twitter.com/garrettkjohnson)
 [![sponsors](https://img.shields.io/github/sponsors/gkjohnson?style=flat-square&color=1da1f2)](https://github.com/sponsors/gkjohnson/)
 
 ![](https://user-images.githubusercontent.com/734200/162287477-96696b18-890b-4c1b-8a73-d662e577cc48.png)
@@ -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)
@@ -130,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();
@@ -164,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 );
 
@@ -628,7 +630,10 @@ _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,
@@ -684,6 +689,19 @@ _extends MaterialBase_
 }
 ```
 
+## 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_
@@ -862,6 +880,29 @@ mergeMeshes( meshes : Array<Mesh> ) : {
 
 Merges the set of meshes into a single geometry with a `materialIndex` vertex attribute included on the geometry identifying the associated material in the returned `materials` array.
 
+## CompatibilityDetector
+
+Detects whether the path tracer can run on the current device by checking whether struct precision is reliable and the material shader will compile.
+
+### constructor
+
+```js
+constructor( renderer : WebGLRenderer, material : Material )
+```
+
+Takes a WebGLRenderer to use and material to test again.
+
+### .detect
+
+```js
+detect() : {
+	pass: Boolean,
+	message: String
+}
+```
+
+Returns `pass === true` if the path tracer can run. If it cannot run then a message is returned indicating why.
+
 ## Shader Chunks
 
 **shaderMaterialSampling**
@@ -958,4 +999,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)
+