three-stdlib 2.15.2 → 2.16.1

package/postprocessing/SSAARenderPass.js

@@ -1,170 +1,118 @@
-"use strict";
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
-const THREE = require("three");
-const Pass = require("./Pass.js");
-const CopyShader = require("../shaders/CopyShader.js");
-var SSAARenderPass = function(scene, camera, clearColor, clearAlpha) {
+import { Color, UniformsUtils, ShaderMaterial, AdditiveBlending, WebGLRenderTarget, LinearFilter, RGBAFormat } from 'three';
+import { FullScreenQuad, Pass } from './Pass.js';
+import { CopyShader } from '../shaders/CopyShader.js';
+
+/**
+ *
+ * Supersample Anti-Aliasing Render Pass
+ *
+ * This manual approach to SSAA re-renders the scene ones for each sample with camera jitter and accumulates the results.
+ *
+ * References: https://en.wikipedia.org/wiki/Supersampling
+ *
+ */
+
+var SSAARenderPass = function (scene, camera, clearColor, clearAlpha) {
   this.scene = scene;
   this.camera = camera;
-  this.sampleLevel = 4;
-  this.unbiased = true;
-  this.clearColor = clearColor !== void 0 ? clearColor : 0;
-  this.clearAlpha = clearAlpha !== void 0 ? clearAlpha : 0;
-  this._oldClearColor = new THREE.Color();
-  if (CopyShader.CopyShader === void 0)
-    console.error("THREE.SSAARenderPass relies on CopyShader");
-  var copyShader = CopyShader.CopyShader;
-  this.copyUniforms = THREE.UniformsUtils.clone(copyShader.uniforms);
-  this.copyMaterial = new THREE.ShaderMaterial({
+  this.sampleLevel = 4; // specified as n, where the number of samples is 2^n, so sampleLevel = 4, is 2^4 samples, 16.
+
+  this.unbiased = true; // as we need to clear the buffer in this pass, clearColor must be set to something, defaults to black.
+
+  this.clearColor = clearColor !== undefined ? clearColor : 0x000000;
+  this.clearAlpha = clearAlpha !== undefined ? clearAlpha : 0;
+  this._oldClearColor = new Color();
+  if (CopyShader === undefined) console.error('THREE.SSAARenderPass relies on CopyShader');
+  var copyShader = CopyShader;
+  this.copyUniforms = UniformsUtils.clone(copyShader.uniforms);
+  this.copyMaterial = new ShaderMaterial({
     uniforms: this.copyUniforms,
     vertexShader: copyShader.vertexShader,
     fragmentShader: copyShader.fragmentShader,
     premultipliedAlpha: true,
     transparent: true,
-    blending: THREE.AdditiveBlending,
+    blending: AdditiveBlending,
     depthTest: false,
     depthWrite: false
   });
-  this.fsQuad = new Pass.FullScreenQuad(this.copyMaterial);
+  this.fsQuad = new FullScreenQuad(this.copyMaterial);
 };
-SSAARenderPass.prototype = Object.assign(Object.create(Pass.Pass.prototype), {
+
+SSAARenderPass.prototype = Object.assign(Object.create(Pass.prototype), {
   constructor: SSAARenderPass,
-  dispose: function() {
+  dispose: function () {
     if (this.sampleRenderTarget) {
       this.sampleRenderTarget.dispose();
       this.sampleRenderTarget = null;
     }
   },
-  setSize: function(width, height) {
-    if (this.sampleRenderTarget)
-      this.sampleRenderTarget.setSize(width, height);
+  setSize: function (width, height) {
+    if (this.sampleRenderTarget) this.sampleRenderTarget.setSize(width, height);
   },
-  render: function(renderer, writeBuffer, readBuffer) {
+  render: function (renderer, writeBuffer, readBuffer) {
     if (!this.sampleRenderTarget) {
-      this.sampleRenderTarget = new THREE.WebGLRenderTarget(readBuffer.width, readBuffer.height, {
-        minFilter: THREE.LinearFilter,
-        magFilter: THREE.LinearFilter,
-        format: THREE.RGBAFormat
+      this.sampleRenderTarget = new WebGLRenderTarget(readBuffer.width, readBuffer.height, {
+        minFilter: LinearFilter,
+        magFilter: LinearFilter,
+        format: RGBAFormat
       });
-      this.sampleRenderTarget.texture.name = "SSAARenderPass.sample";
+      this.sampleRenderTarget.texture.name = 'SSAARenderPass.sample';
     }
+
     var jitterOffsets = SSAARenderPass.JitterVectors[Math.max(0, Math.min(this.sampleLevel, 5))];
     var autoClear = renderer.autoClear;
     renderer.autoClear = false;
     renderer.getClearColor(this._oldClearColor);
     var oldClearAlpha = renderer.getClearAlpha();
-    var baseSampleWeight = 1 / jitterOffsets.length;
+    var baseSampleWeight = 1.0 / jitterOffsets.length;
     var roundingRange = 1 / 32;
-    this.copyUniforms["tDiffuse"].value = this.sampleRenderTarget.texture;
-    var width = readBuffer.width, height = readBuffer.height;
+    this.copyUniforms['tDiffuse'].value = this.sampleRenderTarget.texture;
+    var width = readBuffer.width,
+        height = readBuffer.height; // render the scene multiple times, each slightly jitter offset from the last and accumulate the results.
+
     for (let i = 0; i < jitterOffsets.length; i++) {
       var jitterOffset = jitterOffsets[i];
+
       if (this.camera.setViewOffset) {
-        this.camera.setViewOffset(
-          width,
-          height,
-          jitterOffset[0] * 0.0625,
-          jitterOffset[1] * 0.0625,
-          width,
-          height
-        );
+        this.camera.setViewOffset(width, height, jitterOffset[0] * 0.0625, jitterOffset[1] * 0.0625, // 0.0625 = 1 / 16
+        width, height);
       }
+
       var sampleWeight = baseSampleWeight;
+
       if (this.unbiased) {
+        // the theory is that equal weights for each sample lead to an accumulation of rounding errors.
+        // The following equation varies the sampleWeight per sample so that it is uniformly distributed
+        // across a range of values whose rounding errors cancel each other out.
         var uniformCenteredDistribution = -0.5 + (i + 0.5) / jitterOffsets.length;
         sampleWeight += roundingRange * uniformCenteredDistribution;
       }
-      this.copyUniforms["opacity"].value = sampleWeight;
+
+      this.copyUniforms['opacity'].value = sampleWeight;
       renderer.setClearColor(this.clearColor, this.clearAlpha);
       renderer.setRenderTarget(this.sampleRenderTarget);
       renderer.clear();
       renderer.render(this.scene, this.camera);
       renderer.setRenderTarget(this.renderToScreen ? null : writeBuffer);
+
       if (i === 0) {
-        renderer.setClearColor(0, 0);
+        renderer.setClearColor(0x000000, 0.0);
         renderer.clear();
       }
+
       this.fsQuad.render(renderer);
     }
-    if (this.camera.clearViewOffset)
-      this.camera.clearViewOffset();
+
+    if (this.camera.clearViewOffset) this.camera.clearViewOffset();
     renderer.autoClear = autoClear;
     renderer.setClearColor(this._oldClearColor, oldClearAlpha);
   }
-});
-SSAARenderPass.JitterVectors = [
-  [[0, 0]],
-  [
-    [4, 4],
-    [-4, -4]
-  ],
-  [
-    [-2, -6],
-    [6, -2],
-    [-6, 2],
-    [2, 6]
-  ],
-  [
-    [1, -3],
-    [-1, 3],
-    [5, 1],
-    [-3, -5],
-    [-5, 5],
-    [-7, -1],
-    [3, 7],
-    [7, -7]
-  ],
-  [
-    [1, 1],
-    [-1, -3],
-    [-3, 2],
-    [4, -1],
-    [-5, -2],
-    [2, 5],
-    [5, 3],
-    [3, -5],
-    [-2, 6],
-    [0, -7],
-    [-4, -6],
-    [-6, 4],
-    [-8, 0],
-    [7, -4],
-    [6, 7],
-    [-7, -8]
-  ],
-  [
-    [-4, -7],
-    [-7, -5],
-    [-3, -5],
-    [-5, -4],
-    [-1, -4],
-    [-2, -2],
-    [-6, -1],
-    [-4, 0],
-    [-7, 1],
-    [-1, 2],
-    [-6, 3],
-    [-3, 3],
-    [-7, 6],
-    [-3, 6],
-    [-5, 7],
-    [-1, 7],
-    [5, -7],
-    [1, -6],
-    [6, -5],
-    [4, -4],
-    [2, -3],
-    [7, -2],
-    [1, -1],
-    [4, -1],
-    [2, 1],
-    [6, 2],
-    [0, 4],
-    [4, 4],
-    [2, 5],
-    [7, 5],
-    [5, 6],
-    [3, 7]
-  ]
-];
-exports.SSAARenderPass = SSAARenderPass;
+}); // These jitter vectors are specified in integers because it is easier.
+// I am assuming a [-8,8) integer grid, but it needs to be mapped onto [-0.5,0.5)
+// before being used, thus these integers need to be scaled by 1/16.
+//
+// Sample patterns reference: https://msdn.microsoft.com/en-us/library/windows/desktop/ff476218%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396
+
+SSAARenderPass.JitterVectors = [[[0, 0]], [[4, 4], [-4, -4]], [[-2, -6], [6, -2], [-6, 2], [2, 6]], [[1, -3], [-1, 3], [5, 1], [-3, -5], [-5, 5], [-7, -1], [3, 7], [7, -7]], [[1, 1], [-1, -3], [-3, 2], [4, -1], [-5, -2], [2, 5], [5, 3], [3, -5], [-2, 6], [0, -7], [-4, -6], [-6, 4], [-8, 0], [7, -4], [6, 7], [-7, -8]], [[-4, -7], [-7, -5], [-3, -5], [-5, -4], [-1, -4], [-2, -2], [-6, -1], [-4, 0], [-7, 1], [-1, 2], [-6, 3], [-3, 3], [-7, 6], [-3, 6], [-5, 7], [-1, 7], [5, -7], [1, -6], [6, -5], [4, -4], [2, -3], [7, -2], [1, -1], [4, -1], [2, 1], [6, 2], [0, 4], [4, 4], [2, 5], [7, 5], [5, 6], [3, 7]]];
+
+export { SSAARenderPass };

package/postprocessing/SSAOPass.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("three"),r=require("./Pass.cjs.js"),t=require("../math/SimplexNoise.cjs.js"),a=require("../shaders/SSAOShader.cjs.js"),i=require("../shaders/CopyShader.cjs.js");require("@babel/runtime/helpers/defineProperty");class s extends r.Pass{constructor(t,s,n,l){super(),this.width=void 0!==n?n:512,this.height=void 0!==l?l:512,this.clear=!0,this.camera=s,this.scene=t,this.kernelRadius=8,this.kernelSize=32,this.kernel=[],this.noiseTexture=null,this.output=0,this.minDistance=.005,this.maxDistance=.1,this._visibilityCache=new Map,this.generateSampleKernel(),this.generateRandomKernelRotations();const o=new e.DepthTexture;o.format=e.DepthStencilFormat,o.type=e.UnsignedInt248Type,this.beautyRenderTarget=new e.WebGLRenderTarget(this.width,this.height),this.normalRenderTarget=new e.WebGLRenderTarget(this.width,this.height,{minFilter:e.NearestFilter,magFilter:e.NearestFilter,depthTexture:o}),this.ssaoRenderTarget=new e.WebGLRenderTarget(this.width,this.height),this.blurRenderTarget=this.ssaoRenderTarget.clone(),void 0===a.SSAOShader&&console.error("THREE.SSAOPass: The pass relies on SSAOShader."),this.ssaoMaterial=new e.ShaderMaterial({defines:Object.assign({},a.SSAOShader.defines),uniforms:e.UniformsUtils.clone(a.SSAOShader.uniforms),vertexShader:a.SSAOShader.vertexShader,fragmentShader:a.SSAOShader.fragmentShader,blending:e.NoBlending}),this.ssaoMaterial.uniforms.tDiffuse.value=this.beautyRenderTarget.texture,this.ssaoMaterial.uniforms.tNormal.value=this.normalRenderTarget.texture,this.ssaoMaterial.uniforms.tDepth.value=this.normalRenderTarget.depthTexture,this.ssaoMaterial.uniforms.tNoise.value=this.noiseTexture,this.ssaoMaterial.uniforms.kernel.value=this.kernel,this.ssaoMaterial.uniforms.cameraNear.value=this.camera.near,this.ssaoMaterial.uniforms.cameraFar.value=this.camera.far,this.ssaoMaterial.uniforms.resolution.value.set(this.width,this.height),this.ssaoMaterial.uniforms.cameraProjectionMatrix.value.copy(this.camera.projectionMatrix),this.ssaoMaterial.uniforms.cameraInverseProjectionMatrix.value.copy(this.camera.projectionMatrixInverse),this.normalMaterial=new e.MeshNormalMaterial,this.normalMaterial.blending=e.NoBlending,this.blurMaterial=new e.ShaderMaterial({defines:Object.assign({},a.SSAOBlurShader.defines),uniforms:e.UniformsUtils.clone(a.SSAOBlurShader.uniforms),vertexShader:a.SSAOBlurShader.vertexShader,fragmentShader:a.SSAOBlurShader.fragmentShader}),this.blurMaterial.uniforms.tDiffuse.value=this.ssaoRenderTarget.texture,this.blurMaterial.uniforms.resolution.value.set(this.width,this.height),this.depthRenderMaterial=new e.ShaderMaterial({defines:Object.assign({},a.SSAODepthShader.defines),uniforms:e.UniformsUtils.clone(a.SSAODepthShader.uniforms),vertexShader:a.SSAODepthShader.vertexShader,fragmentShader:a.SSAODepthShader.fragmentShader,blending:e.NoBlending}),this.depthRenderMaterial.uniforms.tDepth.value=this.normalRenderTarget.depthTexture,this.depthRenderMaterial.uniforms.cameraNear.value=this.camera.near,this.depthRenderMaterial.uniforms.cameraFar.value=this.camera.far,this.copyMaterial=new e.ShaderMaterial({uniforms:e.UniformsUtils.clone(i.CopyShader.uniforms),vertexShader:i.CopyShader.vertexShader,fragmentShader:i.CopyShader.fragmentShader,transparent:!0,depthTest:!1,depthWrite:!1,blendSrc:e.DstColorFactor,blendDst:e.ZeroFactor,blendEquation:e.AddEquation,blendSrcAlpha:e.DstAlphaFactor,blendDstAlpha:e.ZeroFactor,blendEquationAlpha:e.AddEquation}),this.fsQuad=new r.FullScreenQuad(null),this.originalClearColor=new e.Color}dispose(){this.beautyRenderTarget.dispose(),this.normalRenderTarget.dispose(),this.ssaoRenderTarget.dispose(),this.blurRenderTarget.dispose(),this.normalMaterial.dispose(),this.blurMaterial.dispose(),this.copyMaterial.dispose(),this.depthRenderMaterial.dispose(),this.fsQuad.dispose()}render(r,t){switch(!1===r.capabilities.isWebGL2&&(this.noiseTexture.format=e.LuminanceFormat),r.setRenderTarget(this.beautyRenderTarget),r.clear(),r.render(this.scene,this.camera),this.overrideVisibility(),this.renderOverride(r,this.normalMaterial,this.normalRenderTarget,7829503,1),this.restoreVisibility(),this.ssaoMaterial.uniforms.kernelRadius.value=this.kernelRadius,this.ssaoMaterial.uniforms.minDistance.value=this.minDistance,this.ssaoMaterial.uniforms.maxDistance.value=this.maxDistance,this.renderPass(r,this.ssaoMaterial,this.ssaoRenderTarget),this.renderPass(r,this.blurMaterial,this.blurRenderTarget),this.output){case s.OUTPUT.SSAO:this.copyMaterial.uniforms.tDiffuse.value=this.ssaoRenderTarget.texture,this.copyMaterial.blending=e.NoBlending,this.renderPass(r,this.copyMaterial,this.renderToScreen?null:t);break;case s.OUTPUT.Blur:this.copyMaterial.uniforms.tDiffuse.value=this.blurRenderTarget.texture,this.copyMaterial.blending=e.NoBlending,this.renderPass(r,this.copyMaterial,this.renderToScreen?null:t);break;case s.OUTPUT.Beauty:this.copyMaterial.uniforms.tDiffuse.value=this.beautyRenderTarget.texture,this.copyMaterial.blending=e.NoBlending,this.renderPass(r,this.copyMaterial,this.renderToScreen?null:t);break;case s.OUTPUT.Depth:this.renderPass(r,this.depthRenderMaterial,this.renderToScreen?null:t);break;case s.OUTPUT.Normal:this.copyMaterial.uniforms.tDiffuse.value=this.normalRenderTarget.texture,this.copyMaterial.blending=e.NoBlending,this.renderPass(r,this.copyMaterial,this.renderToScreen?null:t);break;case s.OUTPUT.Default:this.copyMaterial.uniforms.tDiffuse.value=this.beautyRenderTarget.texture,this.copyMaterial.blending=e.NoBlending,this.renderPass(r,this.copyMaterial,this.renderToScreen?null:t),this.copyMaterial.uniforms.tDiffuse.value=this.blurRenderTarget.texture,this.copyMaterial.blending=e.CustomBlending,this.renderPass(r,this.copyMaterial,this.renderToScreen?null:t);break;default:console.warn("THREE.SSAOPass: Unknown output type.")}}renderPass(e,r,t,a,i){e.getClearColor(this.originalClearColor);const s=e.getClearAlpha(),n=e.autoClear;e.setRenderTarget(t),e.autoClear=!1,null!=a&&(e.setClearColor(a),e.setClearAlpha(i||0),e.clear()),this.fsQuad.material=r,this.fsQuad.render(e),e.autoClear=n,e.setClearColor(this.originalClearColor),e.setClearAlpha(s)}renderOverride(e,r,t,a,i){e.getClearColor(this.originalClearColor);const s=e.getClearAlpha(),n=e.autoClear;e.setRenderTarget(t),e.autoClear=!1,a=r.clearColor||a,i=r.clearAlpha||i,null!=a&&(e.setClearColor(a),e.setClearAlpha(i||0),e.clear()),this.scene.overrideMaterial=r,e.render(this.scene,this.camera),this.scene.overrideMaterial=null,e.autoClear=n,e.setClearColor(this.originalClearColor),e.setClearAlpha(s)}setSize(e,r){this.width=e,this.height=r,this.beautyRenderTarget.setSize(e,r),this.ssaoRenderTarget.setSize(e,r),this.normalRenderTarget.setSize(e,r),this.blurRenderTarget.setSize(e,r),this.ssaoMaterial.uniforms.resolution.value.set(e,r),this.ssaoMaterial.uniforms.cameraProjectionMatrix.value.copy(this.camera.projectionMatrix),this.ssaoMaterial.uniforms.cameraInverseProjectionMatrix.value.copy(this.camera.projectionMatrixInverse),this.blurMaterial.uniforms.resolution.value.set(e,r)}generateSampleKernel(){const r=this.kernelSize,t=this.kernel;for(let a=0;a<r;a++){const i=new e.Vector3;i.x=2*Math.random()-1,i.y=2*Math.random()-1,i.z=Math.random(),i.normalize();let s=a/r;s=e.MathUtils.lerp(.1,1,s*s),i.multiplyScalar(s),t.push(i)}}generateRandomKernelRotations(){void 0===t.SimplexNoise&&console.error("THREE.SSAOPass: The pass relies on SimplexNoise.");const r=new t.SimplexNoise,a=new Float32Array(16);for(let e=0;e<16;e++){const t=2*Math.random()-1,i=2*Math.random()-1,s=0;a[e]=r.noise3d(t,i,s)}this.noiseTexture=new e.DataTexture(a,4,4,e.RedFormat,e.FloatType),this.noiseTexture.wrapS=e.RepeatWrapping,this.noiseTexture.wrapT=e.RepeatWrapping,this.noiseTexture.needsUpdate=!0}overrideVisibility(){const e=this.scene,r=this._visibilityCache;e.traverse((function(e){r.set(e,e.visible),(e.isPoints||e.isLine)&&(e.visible=!1)}))}restoreVisibility(){const e=this.scene,r=this._visibilityCache;e.traverse((function(e){const t=r.get(e);e.visible=t})),r.clear()}}s.OUTPUT={Default:0,SSAO:1,Blur:2,Beauty:3,Depth:4,Normal:5},exports.SSAOPass=s;