three-gpu-pathtracer 0.0.23 → 0.0.25

package/package.json

@@ -1,18 +1,29 @@
 {
   "name": "three-gpu-pathtracer",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "description": "Path tracing renderer and utilities for three.js built on top of three-mesh-bvh.",
   "module": "src/index.js",
   "main": "build/index.umd.cjs",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./build/index.umd.cjs"
+    },
+    "./webgpu": "./src/webgpu/index.js",
+    "./src/*": "./src/*"
+  },
   "type": "module",
   "types": "src/index.d.ts",
-  "sideEffects": false,
+  "sideEffects": [
+    "./src/webgpu/index.js",
+    "./src/webgpu/shims/*.js"
+  ],
   "files": [
     "src/*",
     "build/*"
   ],
   "keywords": [
-    "webgl",
+    "webgpu",
     "threejs",
     "performance",
     "geometry",
@@ -30,35 +41,41 @@
     "tracer"
   ],
   "devDependencies": {
-    "@lookingglass/webxr": "^0.3.1",
+    "@lookingglass/webxr": "^0.6.0",
     "@monogrid/gainmap-js": "^3.0.5",
-    "@types/node": "^20.12.7",
-    "@types/three": "^0.163.0",
-    "@typescript-eslint/parser": "^6.21.0",
-    "canvas-capture": "^2.0.5",
-    "eslint": "^7.32.0",
+    "@pmndrs/upscaler": "^0.2.0",
+    "@types/node": "^24.3.1",
+    "@types/three": "^0.185.1",
+    "@typescript-eslint/eslint-plugin": "^8.40.0",
+    "@vitejs/plugin-basic-ssl": "^2.3.0",
+    "@webgpu/types": "^0.1.72",
+    "eslint": "^8.56.0",
     "eslint-config-mdcs": "^5.0.0",
+    "eslint-plugin-jsdoc": "^50.8.0",
+    "jsdoc": "^4.0.5",
+    "mediabunny": "^1.50.9",
     "node-fetch": "^3.2.9",
-    "parcel": "^2.12.0",
+    "oidn-web": "^0.4.0",
     "pixelmatch": "^5.3.0",
     "pngjs": "^6.0.0",
     "process": "^0.11.10",
-    "puppeteer": "^15.4.0",
+    "puppeteer": "^24.42.0",
     "rollup": "^2.70.0",
     "simple-git": "^3.10.0",
-    "three": "^0.163.0",
-    "three-mesh-bvh": "^0.7.4",
-    "typescript": "5.3.3",
+    "three": "^0.185.1",
+    "three-mesh-bvh": "^0.9.15",
+    "typescript": "^5.9.2",
+    "vite": "^8.2.2",
     "yargs": "^17.5.1"
   },
   "peerDependencies": {
-    "three": ">=0.151.0",
-    "three-mesh-bvh": ">=0.7.4",
+    "three": ">=0.185.0",
+    "three-mesh-bvh": ">=0.9.15",
     "xatlas-web": "^0.1.0"
   },
   "scripts": {
-    "start": "cd example && parcel serve ./*.html --dist-dir ./dev-bundle/ --no-cache --no-hmr",
-    "build-examples": "cd example && parcel build ./*.html --dist-dir ./bundle/ --public-url . --no-cache --no-content-hash",
+    "start": "vite --config ./vite.config.js",
+    "build-examples": "vite build --config ./vite.config.js",
     "update-screenshots": "node ./scripts/push-screenshots.js",
     "screenshot-diff": "node ./scripts/regression-test.js",
     "build": "rollup -c",

package/src/core/PathTracingSceneGenerator.js

@@ -95,6 +95,7 @@ export class PathTracingSceneGenerator {
 		this._bvhWorker = null;
 		this._pendingGenerate = null;
 		this._buildAsync = false;
+		this._materialUuids = null;
 
 	}
 
@@ -176,12 +177,29 @@ export class PathTracingSceneGenerator {
 		// generate the geometry
 		const result = staticGeometryGenerator.generate( geometry );
 		const materials = result.materials;
+		let needsMaterialIndexUpdate = result.changeType !== NO_CHANGE || this._materialUuids === null || this._materialUuids.length !== length;
+		if ( ! needsMaterialIndexUpdate ) {
+
+			for ( let i = 0, length = materials.length; i < length; i ++ ) {
+
+				const material = materials[ i ];
+				if ( material.uuid !== this._materialUuids[ i ] ) {
+
+					needsMaterialIndexUpdate = true;
+					break;
+
+				}
+
+			}
+
+		}
+
 		const textures = getTextures( materials );
 		const { lights, iesTextures } = getLights( objects );
-
-		if ( result.changeType !== NO_CHANGE ) {
+		if ( needsMaterialIndexUpdate ) {
 
 			updateMaterialIndexAttribute( geometry, materials, materials );
+			this._materialUuids = materials.map( material => material.uuid );
 
 		}
 
@@ -225,6 +243,7 @@ export class PathTracingSceneGenerator {
 		return {
 			bvhChanged: result.changeType !== NO_CHANGE,
 			bvh: this.bvh,
+			needsMaterialIndexUpdate,
 			lights,
 			iesTextures,
 			geometry,

package/src/core/WebGLPathTracer.js

@@ -102,6 +102,8 @@ export class WebGLPathTracer {
 
 	constructor( renderer ) {
 
+		console.warn( 'WebGLPathTracer: This class has been deprecated and will be removed in a future release. Use "WebGPUPathTracer" instead.' );
+
 		// members
 		this._renderer = renderer;
 		this._generator = new PathTracingSceneGenerator();
@@ -306,7 +308,7 @@ export class WebGLPathTracer {
 		}
 
 		// update scene environment
-		material.environmentIntensity = scene.environmentIntensity ?? 1;
+		material.environmentIntensity = scene.environment !== null ? ( scene.environmentIntensity ?? 1 ) : 0;
 		material.environmentRotation.makeRotationFromEuler( scene.environmentRotation ).invert();
 		if ( this._previousEnvironment !== scene.environment ) {
 
@@ -326,10 +328,6 @@ export class WebGLPathTracer {
 
 				}
 
-			} else {
-
-				material.environmentIntensity = 0;
-
 			}
 
 		}
@@ -347,6 +345,7 @@ export class WebGLPathTracer {
 			geometry,
 			bvh,
 			bvhChanged,
+			needsMaterialIndexUpdate,
 		} = results;
 
 		this._materials = materials;
@@ -364,6 +363,10 @@ export class WebGLPathTracer {
 				geometry.attributes.color,
 			);
 
+		}
+
+		if ( needsMaterialIndexUpdate ) {
+
 			material.materialIndexAttribute.updateFrom( geometry.attributes.materialIndex );
 
 		}
@@ -494,8 +497,8 @@ export class WebGLPathTracer {
 
 	dispose() {
 
-		this._renderQuad.dispose();
-		this._renderQuad.material.dispose();
+		this._quad.dispose();
+		this._quad.material.dispose();
 		this._pathTracer.dispose();
 
 	}
@@ -523,4 +526,10 @@ export class WebGLPathTracer {
 
 	}
 
+	getRenderTime() {
+
+		return this._clock.getElapsedTime() * 1e3;
+
+	}
+
 }

package/src/core/utils/mergeGeometries.js

@@ -205,7 +205,20 @@ export function mergeGeometries( geometries, options = {}, targetGeometry = new
 			const attr = geometry.getAttribute( key );
  			if ( ! skip ) {
 
-				copyAttributeContents( attr, targetAttribute, offset );
+				if ( key === 'color' && targetAttribute.itemSize !== attr.itemSize ) {
+
+					// make sure the color attribute is aligned with itemSize 3 to 4
+					for ( let index = offset, l = attr.count; index < l; index ++ ) {
+
+						attr.setXYZW( index, targetAttribute.getX( index ), targetAttribute.getY( index ), targetAttribute.getZ( index ), 1.0 );
+
+					}
+
+				} else {
+
+					copyAttributeContents( attr, targetAttribute, offset );
+
+				}
 
 			}
 

package/src/core/utils/sceneUpdateUtils.js

@@ -72,20 +72,16 @@ export function getTextures( materials ) {
 export function getLights( scene ) {
 
 	const lights = [];
-	scene.traverse( c => {
+	scene.traverseVisible( c => {
 
-		if ( c.visible ) {
+		if (
+			c.isRectAreaLight ||
+			c.isSpotLight ||
+			c.isPointLight ||
+			c.isDirectionalLight
+		) {
 
-			if (
-				c.isRectAreaLight ||
-				c.isSpotLight ||
-				c.isPointLight ||
-				c.isDirectionalLight
-			) {
-
-				lights.push( c );
-
-			}
+			lights.push( c );
 
 		}
 

package/src/detectors/PrecisionMaterial.js

@@ -104,15 +104,15 @@ export class PrecisionMaterial extends MaterialBase {
 
 		switch ( v.toLowerCase() ) {
 
-		case 'float':
-			this.setDefine( 'MODE', 0 );
-			break;
-		case 'int':
-			this.setDefine( 'MODE', 1 );
-			break;
-		case 'uint':
-			this.setDefine( 'MODE', 2 );
-			break;
+			case 'float':
+				this.setDefine( 'MODE', 0 );
+				break;
+			case 'int':
+				this.setDefine( 'MODE', 1 );
+				break;
+			case 'uint':
+				this.setDefine( 'MODE', 2 );
+				break;
 
 		}
 

package/src/index.d.ts

@@ -21,7 +21,7 @@ import {
 	Scene,
 	PMREMGenerator
 } from 'three';
-import { FullScreenQuad } from 'three/examples/jsm/postprocessing/Pass';
+import { FullScreenQuad } from 'three/examples/jsm/postprocessing/Pass.js';
 import { MeshBVH, MeshBVHOptions } from 'three-mesh-bvh';
 
 // three.js type augmentation
@@ -57,6 +57,7 @@ export interface PathTracingSceneGeneratorResult {
 	lights: Array<Light>;
 	iesTextures: Array<DataTexture>;
 	geometry: BufferGeometry;
+	needsMaterialIndexUpdate: boolean;
 	materials: Array<Material>;
 	textures: Array<Texture>;
 	objects: Array<Object3D>;

package/src/index.js

@@ -18,6 +18,7 @@ export * from './utils/BlurredEnvMapGenerator.js';
 // materials
 export * from './materials/fullscreen/DenoiseMaterial.js';
 export * from './materials/surface/FogVolumeMaterial.js';
+export * from './materials/surface/AmbientOcclusionMaterial.js';
 
 // deprecated
 export * from './materials/pathtracing/PhysicalPathTracingMaterial.js';

package/src/materials/pathtracing/PhysicalPathTracingMaterial.js

@@ -10,7 +10,7 @@ import { PhysicalCameraUniform } from '../../uniforms/PhysicalCameraUniform.js';
 import { EquirectHdrInfoUniform } from '../../uniforms/EquirectHdrInfoUniform.js';
 import { LightsInfoUniformStruct } from '../../uniforms/LightsInfoUniformStruct.js';
 import { AttributesTextureArray } from '../../uniforms/AttributesTextureArray.js';
-import { MaterialsTexture } from '../../uniforms/MaterialsTexture.js';
+import { MaterialsTexture, MATERIAL_PIXELS } from '../../uniforms/MaterialsTexture.js';
 import { RenderTarget2DArray } from '../../uniforms/RenderTarget2DArray.js';
 import { StratifiedSamplesTexture } from '../../uniforms/StratifiedSamplesTexture.js';
 import { BlueNoiseTexture } from '../../textures/BlueNoiseTexture.js';
@@ -66,6 +66,7 @@ export class PhysicalPathTracingMaterial extends MaterialBase {
 				ATTR_TANGENT: 1,
 				ATTR_UV: 2,
 				ATTR_COLOR: 3,
+				MATERIAL_PIXELS: MATERIAL_PIXELS,
 			},
 
 			uniforms: {

package/src/materials/pathtracing/glsl/attenuate_hit_function.glsl.js

@@ -97,7 +97,8 @@ export const attenuate_hit_function = /* glsl */`
 				// alphaMap
 				if ( material.alphaMap != - 1 ) {
 
-					albedo.a *= texture2D( textures, vec3( uv, material.alphaMap ) ).x;
+					vec3 uvPrime = material.alphaMapTransform * vec3( uv, 1 );
+					albedo.a *= texture2D( textures, vec3( uvPrime.xy, material.alphaMap ) ).x;
 
 				}
 

package/src/materials/pathtracing/glsl/camera_util_functions.glsl.js

@@ -60,7 +60,7 @@ export const camera_util_functions = /* glsl */`
 			vec3 shapeUVW= rand3( 1 );
 			int blades = physicalCamera.apertureBlades;
 			float anamorphicRatio = physicalCamera.anamorphicRatio;
-			vec2 apertureSample = blades == 0 ? sampleCircle( shapeUVW.xy ) : sampleRegularPolygon( blades, shapeUVW );
+			vec2 apertureSample = sampleAperture( blades, shapeUVW );
 			apertureSample *= physicalCamera.bokehSize * 0.5 * 1e-3;
 
 			// rotate the aperture shape

package/src/materials/pathtracing/glsl/get_surface_record_function.glsl.js

@@ -48,7 +48,8 @@ export const get_surface_record_function = /* glsl */`
 		// alphaMap
 		if ( material.alphaMap != - 1 ) {
 
-			albedo.a *= texture2D( textures, vec3( uv, material.alphaMap ) ).x;
+			vec3 uvPrime = material.alphaMapTransform * vec3( uv, 1 );
+			albedo.a *= texture2D( textures, vec3( uvPrime.xy, material.alphaMap ) ).x;
 
 		}
 

package/src/materials/surface/AmbientOcclusionMaterial.js

@@ -1,6 +1,7 @@
 import { TangentSpaceNormalMap, Vector2 } from 'three';
 import { MaterialBase } from '../MaterialBase.js';
 import { MeshBVHUniformStruct, BVHShaderGLSL } from 'three-mesh-bvh';
+import { MATERIAL_PIXELS } from '../../uniforms/MaterialsTexture.js';
 
 import * as StructsGLSL from '../../shader/structs/index.js';
 import * as SamplingGLSL from '../../shader/sampling/index.js';
@@ -43,6 +44,7 @@ export class AmbientOcclusionMaterial extends MaterialBase {
 
 			defines: {
 				SAMPLES: 10,
+				MATERIAL_PIXELS: MATERIAL_PIXELS,
 			},
 
 			uniforms: {

package/src/objects/PhysicalSpotLight.js

@@ -1,5 +1,7 @@
 import { SpotLight } from 'three';
 
+// TODO: this should extend IESSpotLight, but the class is only exported from "three/webgpu" and
+// the node library resolves light nodes by exact constructor so a subclass would not rasterize
 export class PhysicalSpotLight extends SpotLight {
 
 	constructor( ...args ) {

package/src/shader/bsdf/bsdf_functions.glsl.js

@@ -233,7 +233,6 @@ export const bsdf_functions = /* glsl */`
 		// See equation (1) in http://www.aconty.com/pdf/s2017_pbs_imageworks_sheen.pdf
 		vec3 color = surf.sheenColor;
 		color *= D * G / ( 4.0 * abs( cosThetaO * cosThetaI ) );
-		color *= wi.z;
 
 		return color;
 

package/src/shader/bvh/inside_fog_volume_function.glsl.js

@@ -7,7 +7,7 @@ export const inside_fog_volume_function = /* glsl */`
 // returns whether the given material is a fog material or not
 bool isMaterialFogVolume( sampler2D materials, uint materialIndex ) {
 
-	uint i = materialIndex * 45u;
+	uint i = materialIndex * uint( MATERIAL_PIXELS );
 	vec4 s14 = texelFetch1D( materials, i + 14u );
 	return bool( int( s14.b ) & 4 );
 

package/src/shader/structs/material_struct.glsl.js

@@ -81,6 +81,7 @@ export const material_struct = /* glsl */ `
 		mat3 iridescenceThicknessMapTransform;
 		mat3 specularColorMapTransform;
 		mat3 specularIntensityMapTransform;
+		mat3 alphaMapTransform;
 
 	};
 
@@ -101,7 +102,7 @@ export const material_struct = /* glsl */ `
 
 	Material readMaterialInfo( sampler2D tex, uint index ) {
 
-		uint i = index * 45u;
+		uint i = index * uint( MATERIAL_PIXELS );
 
 		vec4 s0 = texelFetch1D( tex, i + 0u );
 		vec4 s1 = texelFetch1D( tex, i + 1u );
@@ -200,6 +201,7 @@ export const material_struct = /* glsl */ `
 		m.iridescenceThicknessMapTransform = m.iridescenceThicknessMap == - 1 ? mat3( 1.0 ) : readTextureTransform( tex, firstTextureTransformIdx + 24u );
 		m.specularColorMapTransform = m.specularColorMap == - 1 ? mat3( 1.0 ) : readTextureTransform( tex, firstTextureTransformIdx + 26u );
 		m.specularIntensityMapTransform = m.specularIntensityMap == - 1 ? mat3( 1.0 ) : readTextureTransform( tex, firstTextureTransformIdx + 28u );
+		m.alphaMapTransform = m.alphaMap == - 1 ? mat3( 1.0 ) : readTextureTransform( tex, firstTextureTransformIdx + 30u );
 
 		return m;
 

package/src/textures/BlueNoiseTexture.js

@@ -19,12 +19,12 @@ function getFormat( channels ) {
 
 	switch ( channels ) {
 
-	case 1:
-		return RedFormat;
-	case 2:
-		return RGFormat;
-	default:
-		return RGBAFormat;
+		case 1:
+			return RedFormat;
+		case 2:
+			return RGFormat;
+		default:
+			return RGBAFormat;
 
 	}
 

package/src/textures/ProceduralEquirectTexture.js

@@ -2,13 +2,14 @@ import {
 	ClampToEdgeWrapping,
 	Color,
 	DataTexture,
+	DataUtils,
 	EquirectangularReflectionMapping,
+	HalfFloatType,
 	LinearFilter,
 	RepeatWrapping,
 	RGBAFormat,
 	Spherical,
 	Vector2,
-	FloatType
 } from 'three';
 
 const _uv = new Vector2();
@@ -20,8 +21,8 @@ export class ProceduralEquirectTexture extends DataTexture {
 	constructor( width = 512, height = 512 ) {
 
 		super(
-			new Float32Array( width * height * 4 ),
-			width, height, RGBAFormat, FloatType, EquirectangularReflectionMapping,
+			new Uint16Array( width * height * 4 ),
+			width, height, RGBAFormat, HalfFloatType, EquirectangularReflectionMapping,
 			RepeatWrapping, ClampToEdgeWrapping, LinearFilter, LinearFilter,
 		);
 
@@ -53,10 +54,10 @@ export class ProceduralEquirectTexture extends DataTexture {
 
 				const i = y * width + x;
 				const i4 = 4 * i;
-				data[ i4 + 0 ] = ( _color.r );
-				data[ i4 + 1 ] = ( _color.g );
-				data[ i4 + 2 ] = ( _color.b );
-				data[ i4 + 3 ] = ( 1.0 );
+				data[ i4 + 0 ] = DataUtils.toHalfFloat( _color.r );
+				data[ i4 + 1 ] = DataUtils.toHalfFloat( _color.g );
+				data[ i4 + 2 ] = DataUtils.toHalfFloat( _color.b );
+				data[ i4 + 3 ] = DataUtils.toHalfFloat( 1.0 );
 
 			}
 

package/src/uniforms/EquirectHdrInfoUniform.js

@@ -178,6 +178,12 @@ export class EquirectHdrInfoUniform {
 
 	}
 
+	getPixelWeight( r, g, b ) {
+
+		return colorToLuminance( r, g, b );
+
+	}
+
 	dispose() {
 
 		this.marginalWeights.dispose();
@@ -218,10 +224,9 @@ export class EquirectHdrInfoUniform {
 				const g = DataUtils.fromHalfFloat( data[ 4 * i + 1 ] );
 				const b = DataUtils.fromHalfFloat( data[ 4 * i + 2 ] );
 
-				// the probability of the pixel being selected in this row is the
-				// scale of the luminance relative to the rest of the pixels.
-				// TODO: this should also account for the solid angle of the pixel when sampling
-				const weight = colorToLuminance( r, g, b );
+				// the probability of the pixel being selected in its row is proportional
+				// to its luminance relative to the other pixels.
+				const weight = this.getPixelWeight( r, g, b, y, height );
 				cumulativeRowWeight += weight;
 				totalSumValue += weight;
 

package/src/uniforms/FloatAttributeTextureArray.js

@@ -15,17 +15,17 @@ function copyArrayToArray( fromArray, fromStride, toArray, toStride, offset ) {
 	let maxValue = 1.0;
 	switch ( fromArray.constructor ) {
 
-	case Uint8Array:
-	case Uint16Array:
-	case Uint32Array:
-		maxValue = 2 ** bpe - 1;
-		break;
-
-	case Int8Array:
-	case Int16Array:
-	case Int32Array:
-		maxValue = 2 ** ( bpe - 1 ) - 1;
-		break;
+		case Uint8Array:
+		case Uint16Array:
+		case Uint32Array:
+			maxValue = 2 ** bpe - 1;
+			break;
+
+		case Int8Array:
+		case Int16Array:
+		case Int32Array:
+			maxValue = 2 ** ( bpe - 1 ) - 1;
+			break;
 
 	}
 

package/src/uniforms/MaterialsTexture.js

@@ -2,7 +2,7 @@ import { DataTexture, RGBAFormat, ClampToEdgeWrapping, FloatType, FrontSide, Bac
 import { getTextureHash } from '../core/utils/sceneUpdateUtils.js';
 import { bufferToHash } from '../utils/bufferToHash.js';
 
-const MATERIAL_PIXELS = 45;
+export const MATERIAL_PIXELS = 47;
 const MATERIAL_STRIDE = MATERIAL_PIXELS * 4;
 
 class MaterialFeatures {
@@ -362,15 +362,15 @@ export class MaterialsTexture extends DataTexture {
 
 				switch ( m.side ) {
 
-				case FrontSide:
-					floatArray[ index ++ ] = 1;
-					break;
-				case BackSide:
-					floatArray[ index ++ ] = - 1;
-					break;
-				case DoubleSide:
-					floatArray[ index ++ ] = 0;
-					break;
+					case FrontSide:
+						floatArray[ index ++ ] = 1;
+						break;
+					case BackSide:
+						floatArray[ index ++ ] = - 1;
+						break;
+					case DoubleSide:
+						floatArray[ index ++ ] = 0;
+						break;
 
 				}
 
@@ -427,6 +427,9 @@ export class MaterialsTexture extends DataTexture {
 			// specularIntensityMap transform 43
 			index += writeTextureMatrixToArray( m, 'specularIntensityMap', floatArray, index );
 
+			// alphaMap transform 45
+			index += writeTextureMatrixToArray( m, 'alphaMap', floatArray, index );
+
 		}
 
 		// check if the contents have changed