@plastic-software/three 0.174.0 → 0.175.0

package/examples/jsm/shaders/GTAOShader.js

@@ -6,36 +6,18 @@ import {
 	Vector3,
 } from 'three';
 
+/** @module GTAOShader */
+
 /**
- * References:
- * - implemented algorithm - GTAO
- *   - https://iryoku.com/downloads/Practical-Realtime-Strategies-for-Accurate-Indirect-Occlusion.pdf
- *   - https://github.com/Patapom/GodComplex/blob/master/Tests/TestHBIL/2018%20Mayaux%20-%20Horizon-Based%20Indirect%20Lighting%20(HBIL).pdf
+ * GTAO shader. Use by {@link GTAOPass}.
  *
- * - other AO algorithms that are not implemented here:
- *   - Screen Space Ambient Occlusion (SSAO), see also SSAOShader.js
- *	 - http://john-chapman-graphics.blogspot.com/2013/01/ssao-tutorial.html
- *	 - https://learnopengl.com/Advanced-Lighting/SSAO
- *	 - https://creativecoding.soe.ucsc.edu/courses/cmpm164/_schedule/AmbientOcclusion.pdf
- *	 - https://drive.google.com/file/d/1SyagcEVplIm2KkRD3WQYSO9O0Iyi1hfy/edit
- *   - Scalable Ambient Occlusion (SAO), see also SAOShader.js
- *	 - https://casual-effects.com/research/McGuire2012SAO/index.html
- *	   - https://research.nvidia.com/sites/default/files/pubs/2012-06_Scalable-Ambient-Obscurance/McGuire12SAO.pdf
- *   - N8HO
- *	 - https://github.com/N8python/n8ao
- *   - Horizon Based Ambient Occlusion (HBAO)
- *	 - http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.577.2286&rep=rep1&type=pdf
- *	 - https://www.derschmale.com/2013/12/20/an-alternative-implementation-for-hbao-2/
+ * References:
+ * - [Practical Realtime Strategies for Accurate Indirect Occlusion]{@link https://iryoku.com/downloads/Practical-Realtime-Strategies-for-Accurate-Indirect-Occlusion.pdf}.
+ * - [Horizon-Based Indirect Lighting (HBIL)]{@link https://github.com/Patapom/GodComplex/blob/master/Tests/TestHBIL/2018%20Mayaux%20-%20Horizon-Based%20Indirect%20Lighting%20(HBIL).pdf}
  *
- * - further reading
- * 	 - https://ceur-ws.org/Vol-3027/paper5.pdf
- *   - https://www.comp.nus.edu.sg/~lowkl/publications/mssao_visual_computer_2012.pdf
- *   - https://web.ics.purdue.edu/~tmcgraw/papers/mcgraw-ao-2008.pdf
- *   - https://www.activision.com/cdn/research/Practical_Real_Time_Strategies_for_Accurate_Indirect_Occlusion_NEW%20VERSION_COLOR.pdf
- *   - https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.390.2463&rep=rep1&type=pdf
- *   - https://www.intel.com/content/www/us/en/developer/articles/technical/adaptive-screen-space-ambient-occlusion.html
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const GTAOShader = {
 
 	name: 'GTAOShader',
@@ -87,7 +69,7 @@ const GTAOShader = {
 		uniform float cameraNear;
 		uniform float cameraFar;
 		uniform mat4 cameraProjectionMatrix;
-		uniform mat4 cameraProjectionMatrixInverse;		
+		uniform mat4 cameraProjectionMatrixInverse;
 		uniform mat4 cameraWorldMatrix;
 		uniform float radius;
 		uniform float distanceExponent;
@@ -98,7 +80,7 @@ const GTAOShader = {
 			uniform vec3 sceneBoxMin;
 			uniform vec3 sceneBoxMax;
 		#endif
-		
+
 		#include <common>
 		#include <packing>
 
@@ -112,11 +94,11 @@ const GTAOShader = {
 			return viewSpacePosition.xyz / viewSpacePosition.w;
 		}
 
-		float getDepth(const vec2 uv) {  
+		float getDepth(const vec2 uv) {
 			return textureLod(tDepth, uv.xy, 0.0).DEPTH_SWIZZLING;
 		}
 
-		float fetchDepth(const ivec2 uv) {   
+		float fetchDepth(const ivec2 uv) {
 			return texelFetch(tDepth, uv.xy, 0).DEPTH_SWIZZLING;
 		}
 
@@ -166,7 +148,7 @@ const GTAOShader = {
 			float sampleSceneDepth = getDepth(sampleUv);
 			return vec3(sampleUv, sampleSceneDepth);
 		}
-		
+
 		void main() {
 			float depth = getDepth(vUv.xy);
 			if (depth >= 1.0) {
@@ -192,7 +174,7 @@ const GTAOShader = {
 					return;
 				}
 			#endif
-			
+
 			vec2 noiseResolution = vec2(textureSize(tNoise, 0));
 			vec2 noiseUv = vUv * resolution / noiseResolution;
 			vec4 noiseTexel = textureLod(tNoise, noiseUv, 0.0);
@@ -205,21 +187,21 @@ const GTAOShader = {
 			const int STEPS = (SAMPLES + DIRECTIONS - 1) / DIRECTIONS;
 			float ao = 0.0;
 			for (int i = 0; i < DIRECTIONS; ++i) {
-				
+
 				float angle = float(i) / float(DIRECTIONS) * PI;
-				vec4 sampleDir = vec4(cos(angle), sin(angle), 0., 0.5 + 0.5 * noiseTexel.w); 
+				vec4 sampleDir = vec4(cos(angle), sin(angle), 0., 0.5 + 0.5 * noiseTexel.w);
 				sampleDir.xyz = normalize(kernelMatrix * sampleDir.xyz);
 
 				vec3 viewDir = normalize(-viewPos.xyz);
 				vec3 sliceBitangent = normalize(cross(sampleDir.xyz, viewDir));
 				vec3 sliceTangent = cross(sliceBitangent, viewDir);
 				vec3 normalInSlice = normalize(viewNormal - sliceBitangent * dot(viewNormal, sliceBitangent));
-				
+
 				vec3 tangentToNormalInSlice = cross(normalInSlice, sliceBitangent);
 				vec2 cosHorizons = vec2(dot(viewDir, tangentToNormalInSlice), dot(viewDir, -tangentToNormalInSlice));
-				
+
 				for (int j = 0; j < STEPS; ++j) {
-					vec3 sampleViewOffset = sampleDir.xyz * radiusToUse * sampleDir.w * pow(float(j + 1) / float(STEPS), distanceExponent);	
+					vec3 sampleViewOffset = sampleDir.xyz * radiusToUse * sampleDir.w * pow(float(j + 1) / float(STEPS), distanceExponent);
 
 					vec3 sampleSceneUvDepth = getSceneUvAndDepth(viewPos + sampleViewOffset);
 					vec3 sampleSceneViewPos = getViewPosition(sampleSceneUvDepth.xy, sampleSceneUvDepth.z);
@@ -227,7 +209,7 @@ const GTAOShader = {
 					if (abs(viewDelta.z) < thickness) {
 						float sampleCosHorizon = dot(viewDir, normalize(viewDelta));
 						cosHorizons.x += max(0., (sampleCosHorizon - cosHorizons.x) * mix(1., 2. / float(j + 2), distanceFallOff));
-					}		
+					}
 
 					sampleSceneUvDepth = getSceneUvAndDepth(viewPos - sampleViewOffset);
 					sampleSceneViewPos = getViewPosition(sampleSceneUvDepth.xy, sampleSceneUvDepth.z);
@@ -247,7 +229,7 @@ const GTAOShader = {
 				ao += occlusion;
 			}
 
-			ao = clamp(ao / float(DIRECTIONS), 0., 1.);		
+			ao = clamp(ao / float(DIRECTIONS), 0., 1.);
 		#if SCENE_CLIP_BOX == 1
 			ao = mix(ao, 1., smoothstep(0., radiusToUse, boxDistance));
 		#endif
@@ -258,6 +240,12 @@ const GTAOShader = {
 
 };
 
+/**
+ * GTAO depth shader. Use by {@link GTAOPass}.
+ *
+ * @constant
+ * @type {Object}
+ */
 const GTAODepthShader = {
 
 	name: 'GTAODepthShader',
@@ -306,6 +294,12 @@ const GTAODepthShader = {
 
 };
 
+/**
+ * GTAO blend shader. Use by {@link GTAOPass}.
+ *
+ * @constant
+ * @type {Object}
+ */
 const GTAOBlendShader = {
 
 	name: 'GTAOBlendShader',

package/examples/jsm/shaders/GammaCorrectionShader.js

@@ -1,8 +1,14 @@
+/** @module GammaCorrectionShader */
+
 /**
  * Gamma Correction Shader
- * http://en.wikipedia.org/wiki/gamma_correction
+ *
+ * References:
+ * - {@link http://en.wikipedia.org/wiki/gamma_correction}.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const GammaCorrectionShader = {
 
 	name: 'GammaCorrectionShader',

package/examples/jsm/shaders/GodRaysShader.js

@@ -3,6 +3,8 @@ import {
 	Vector3
 } from 'three';
 
+/** @module GodRaysShader */
+
 /**
  * God-rays (crepuscular rays)
  *
@@ -17,10 +19,11 @@ import {
  * 6*6*6 = 216 samples.
  *
  * References:
+ * - [Sousa2008, Crysis Next Gen Effects, GDC2008]{@link http://www.crytek.com/sites/default/files/GDC08_SousaT_CrysisEffects.ppt}.
  *
- * Sousa2008 - Crysis Next Gen Effects, GDC2008, http://www.crytek.com/sites/default/files/GDC08_SousaT_CrysisEffects.ppt
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const GodRaysDepthMaskShader = {
 
 	name: 'GodRaysDepthMaskShader',
@@ -72,8 +75,10 @@ const GodRaysDepthMaskShader = {
  *
  * The results of the previous pass are re-blurred, each time with a
  * decreased distance between samples.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const GodRaysGenerateShader = {
 
 	name: 'GodRaysGenerateShader',
@@ -194,8 +199,10 @@ const GodRaysGenerateShader = {
 /**
  * Additively applies god rays from texture tGodRays to a background (tColors).
  * fGodRayIntensity attenuates the god rays.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const GodRaysCombineShader = {
 
 	name: 'GodRaysCombineShader',
@@ -253,8 +260,10 @@ const GodRaysCombineShader = {
 /**
  * A dodgy sun/sky shader. Makes a bright spot at the sun location. Would be
  * cheaper/faster/simpler to implement this as a simple sun sprite.
+ *
+ * @constant
+ * @type {Object}
  */
-
 const GodRaysFakeSunShader = {
 
 	name: 'GodRaysFakeSunShader',

package/examples/jsm/shaders/HalftoneShader.js

@@ -1,10 +1,16 @@
+/** @module HalftoneShader */
+
 /**
- * RGB Halftone shader for three.js.
- *	NOTE:
- * 		Shape (1 = Dot, 2 = Ellipse, 3 = Line, 4 = Square)
- *		Blending Mode (1 = Linear, 2 = Multiply, 3 = Add, 4 = Lighter, 5 = Darker)
+ * RGB Halftone shader.
+ *
+ * Used by {@link HalftonePass}.
+ *
+ * Shape (1 = Dot, 2 = Ellipse, 3 = Line, 4 = Square)
+ * Blending Mode (1 = Linear, 2 = Multiply, 3 = Add, 4 = Lighter, 5 = Darker)
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const HalftoneShader = {
 
 	name: 'HalftoneShader',

package/examples/jsm/shaders/HorizontalBlurShader.js

@@ -1,12 +1,18 @@
+/** @module HorizontalBlurShader */
+
 /**
- * Two pass Gaussian blur filter (horizontal and vertical blur shaders)
- * - see http://www.cake23.de/traveling-wavefronts-lit-up.html
+ * Two pass Gaussian blur filter (horizontal and vertical blur shaders).
+ *
+ * References:
+ * - {@link http://www.cake23.de/traveling-wavefronts-lit-up.html}.
  *
  * - 9 samples per pass
  * - standard deviation 2.7
  * - "h" and "v" parameters should be set to "1 / width" and "1 / height"
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const HorizontalBlurShader = {
 
 	name: 'HorizontalBlurShader',

package/examples/jsm/shaders/HorizontalTiltShiftShader.js

@@ -1,12 +1,16 @@
+/** @module HorizontalTiltShiftShader */
+
 /**
- * Simple fake tilt-shift effect, modulating two pass Gaussian blur (see above) by vertical position
+ * Simple fake tilt-shift effect, modulating two pass Gaussian blur (see above) by vertical position.
  *
  * - 9 samples per pass
  * - standard deviation 2.7
  * - "h" and "v" parameters should be set to "1 / width" and "1 / height"
  * - "r" parameter control where "focused" horizontal line lies
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const HorizontalTiltShiftShader = {
 
 	name: 'HorizontalTiltShiftShader',

package/examples/jsm/shaders/HueSaturationShader.js

@@ -1,10 +1,14 @@
+/** @module HueSaturationShader */
+
 /**
- * Hue and saturation adjustment
- * https://github.com/evanw/glfx.js
+ * Hue and saturation adjustment, {@link https://github.com/evanw/glfx.js}.
+ *
  * hue: -1 to 1 (-1 is 180 degrees in the negative direction, 0 is no change, etc.
  * saturation: -1 to 1 (-1 is solid gray, 0 is no change, and 1 is maximum contrast)
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const HueSaturationShader = {
 
 	name: 'HueSaturationShader',

package/examples/jsm/shaders/KaleidoShader.js

@@ -1,13 +1,17 @@
+/** @module KaleidoShader */
+
 /**
- * Kaleidoscope Shader
+ * Kaleidoscope Shader.
  * Radial reflection around center point
- * Ported from: http://pixelshaders.com/editor/
- * by Toby Schachman / http://tobyschachman.com/
+ * Ported from: {@link http://pixelshaders.com/editor/}
+ * by [Toby Schachman]{@link http://tobyschachman.com/}
  *
  * sides: number of reflections
  * angle: initial angle in radians
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const KaleidoShader = {
 
 	name: 'KaleidoShader',

package/examples/jsm/shaders/LuminosityHighPassShader.js

@@ -2,17 +2,18 @@ import {
 	Color
 } from 'three';
 
+/** @module LuminosityHighPassShader */
+
 /**
- * Luminosity
- * http://en.wikipedia.org/wiki/Luminosity
+ * Luminosity high pass shader.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const LuminosityHighPassShader = {
 
 	name: 'LuminosityHighPassShader',
 
-	shaderID: 'luminosityHighPass',
-
 	uniforms: {
 
 		'tDiffuse': { value: null },

package/examples/jsm/shaders/LuminosityShader.js

@@ -1,8 +1,11 @@
+/** @module LuminosityShader */
+
 /**
- * Luminosity
- * http://en.wikipedia.org/wiki/Luminosity
+ * Luminosity shader.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const LuminosityShader = {
 
 	name: 'LuminosityShader',

package/examples/jsm/shaders/MirrorShader.js

@@ -1,10 +1,13 @@
+/** @module MirrorShader */
+
 /**
- * Mirror Shader
- * Copies half the input to the other half
+ * Copies half the input to the other half.
+ *
+ * side: side of input to mirror (0 = left, 1 = right, 2 = top, 3 = bottom).
  *
- * side: side of input to mirror (0 = left, 1 = right, 2 = top, 3 = bottom)
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const MirrorShader = {
 
 	name: 'MirrorShader',

package/examples/jsm/shaders/NormalMapShader.js

@@ -2,11 +2,13 @@ import {
 	Vector2
 } from 'three';
 
+/** @module NormalMapShader */
+
 /**
- * Normal map shader
- * - compute normals from heightmap
+ * Normal map shader, compute normals from heightmap.
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const NormalMapShader = {
 
 	name: 'NormalMapShader',

package/examples/jsm/shaders/OutputShader.js

@@ -1,3 +1,14 @@
+/** @module OutputShader */
+
+/**
+ * Performs tone mapping and color space conversion for
+ * FX workflows.
+ *
+ * Used by {@link OutputPass}.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
+ */
 const OutputShader = {
 
 	name: 'OutputShader',

package/examples/jsm/shaders/PoissonDenoiseShader.js

@@ -4,12 +4,18 @@ import {
 	Vector3,
 } from 'three';
 
+/** @module PoissonDenoiseShader */
+
 /**
+ * Poisson Denoise Shader.
+ *
  * References:
- * https://openaccess.thecvf.com/content/WACV2021/papers/Khademi_Self-Supervised_Poisson-Gaussian_Denoising_WACV_2021_paper.pdf
- * https://arxiv.org/pdf/2206.01856.pdf
+ * - [Self-Supervised Poisson-Gaussian Denoising]{@link https://openaccess.thecvf.com/content/WACV2021/papers/Khademi_Self-Supervised_Poisson-Gaussian_Denoising_WACV_2021_paper.pdf}.
+ * - [Poisson2Sparse: Self-Supervised Poisson Denoising From a Single Image]{@link https://arxiv.org/pdf/2206.01856.pdf}
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const PoissonDenoiseShader = {
 
 	name: 'PoissonDenoiseShader',
@@ -59,7 +65,7 @@ const PoissonDenoiseShader = {
 		uniform float normalPhi;
 		uniform float radius;
 		uniform int index;
-		
+
 		#include <common>
 		#include <packing>
 
@@ -82,9 +88,9 @@ const PoissonDenoiseShader = {
 			vec4 viewSpacePosition = cameraProjectionMatrixInverse * clipSpacePosition;
 			return viewSpacePosition.xyz / viewSpacePosition.w;
 		}
-		
+
 		float getDepth(const vec2 uv) {
-		#if DEPTH_VALUE_SOURCE == 1    
+		#if DEPTH_VALUE_SOURCE == 1
 			return textureLod(tDepth, uv.xy, 0.0).a;
 		#else
 			return textureLod(tDepth, uv.xy, 0.0).r;
@@ -92,7 +98,7 @@ const PoissonDenoiseShader = {
 		}
 
 		float fetchDepth(const ivec2 uv) {
-			#if DEPTH_VALUE_SOURCE == 1    
+			#if DEPTH_VALUE_SOURCE == 1
 				return texelFetch(tDepth, uv.xy, 0).a;
 			#else
 				return texelFetch(tDepth, uv.xy, 0).r;
@@ -139,7 +145,7 @@ const PoissonDenoiseShader = {
 			vec3 sampleNormal = getViewNormal(sampleUv);
 			vec3 neighborColor = sampleTexel.rgb;
 			vec3 viewPosSample = getViewPosition(sampleUv, sampleDepth);
-			
+
 			float normalDiff = dot(viewNormal, sampleNormal);
 			float normalSimilarity = pow(max(normalDiff, 0.), normalPhi);
 			float lumaDiff = abs(getLuminance(neighborColor) - getLuminance(center));
@@ -147,14 +153,14 @@ const PoissonDenoiseShader = {
 			float depthDiff = abs(dot(viewPos - viewPosSample, viewNormal));
 			float depthSimilarity = max(1. - depthDiff / depthPhi, 0.);
 			float w = lumaSimilarity * depthSimilarity * normalSimilarity;
-		
+
 			denoised += w * neighborColor;
 			totalWeight += w;
 		}
-		
+
 		void main() {
-			float depth = getDepth(vUv.xy);	
-			vec3 viewNormal = getViewNormal(vUv);	
+			float depth = getDepth(vUv.xy);
+			vec3 viewNormal = getViewNormal(vUv);
 			if (depth == 1. || dot(viewNormal, viewNormal) == 0.) {
 				discard;
 				return;
@@ -168,7 +174,7 @@ const PoissonDenoiseShader = {
 			vec4 noiseTexel = textureLod(tNoise, noiseUv, 0.0);
       		vec2 noiseVec = vec2(sin(noiseTexel[index % 4] * 2. * PI), cos(noiseTexel[index % 4] * 2. * PI));
     		mat2 rotationMatrix = mat2(noiseVec.x, -noiseVec.y, noiseVec.x, noiseVec.y);
-		
+
 			float totalWeight = 1.0;
 			vec3 denoised = texel.rgb;
 			for (int i = 0; i < SAMPLES; i++) {
@@ -177,8 +183,8 @@ const PoissonDenoiseShader = {
 				vec2 sampleUv = vUv + offset;
 				denoiseSample(center, viewNormal, viewPos, sampleUv, denoised, totalWeight);
 			}
-		
-			if (totalWeight > 0.) { 
+
+			if (totalWeight > 0.) {
 				denoised /= totalWeight;
 			}
 			gl_FragColor = FRAGMENT_OUTPUT;

package/examples/jsm/shaders/RGBShiftShader.js

@@ -1,3 +1,5 @@
+/** @module RGBShiftShader */
+
 /**
  * RGB Shift Shader
  * Shifts red and blue channels from center in opposite directions
@@ -6,8 +8,10 @@
  *
  * amount: shift distance (1 is width of input)
  * angle: shift angle in radians
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const RGBShiftShader = {
 
 	name: 'RGBShiftShader',

package/examples/jsm/shaders/SAOShader.js

@@ -3,10 +3,16 @@ import {
 	Vector2
 } from 'three';
 
+/** @module SAOShader */
+
 /**
- * TODO
+ * SAO shader.
+ *
+ * Used by {@link SAOPass}.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const SAOShader = {
 
 	name: 'SAOShader',

package/examples/jsm/shaders/SMAAShader.js

@@ -5,9 +5,19 @@ import {
 /**
  * WebGL port of Subpixel Morphological Antialiasing (SMAA) v2.8
  * Preset: SMAA 1x Medium (with color edge detection)
- * https://github.com/iryoku/smaa/releases/tag/v2.8
+ *
+ * References:
+ * - {@link https://github.com/iryoku/smaa/releases/tag/v2.8}
+ *
+ * @module SMAAShader
  */
 
+/**
+ * SMAA Edges shader.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
+ */
 const SMAAEdgesShader = {
 
 	name: 'SMAAEdgesShader',
@@ -115,6 +125,12 @@ const SMAAEdgesShader = {
 
 };
 
+/**
+ * SMAA Weights shader.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
+ */
 const SMAAWeightsShader = {
 
 	name: 'SMAAWeightsShader',
@@ -371,6 +387,12 @@ const SMAAWeightsShader = {
 
 };
 
+/**
+ * SMAA Blend shader.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
+ */
 const SMAABlendShader = {
 
 	name: 'SMAABlendShader',

package/examples/jsm/shaders/SSAOShader.js

@@ -3,13 +3,19 @@ import {
 	Vector2
 } from 'three';
 
+/** @module SSAOShader */
+
 /**
+ * SSAO shader.
+ *
  * References:
- * http://john-chapman-graphics.blogspot.com/2013/01/ssao-tutorial.html
- * https://learnopengl.com/Advanced-Lighting/SSAO
- * https://github.com/McNopper/OpenGL/blob/master/Example28/shader/ssao.frag.glsl
+ * - {@link http://john-chapman-graphics.blogspot.com/2013/01/ssao-tutorial.html}
+ * - {@link https://learnopengl.com/Advanced-Lighting/SSAO}
+ * - {@link https://github.com/McNopper/OpenGL/blob/master/Example28/shader/ssao.frag.glsl}
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
  */
-
 const SSAOShader = {
 
 	name: 'SSAOShader',
@@ -131,7 +137,7 @@ const SSAOShader = {
 			if ( depth == 1.0 ) {
 
 				gl_FragColor = vec4( 1.0 ); // don't influence background
-				
+
 			} else {
 
 				float viewZ = getViewZ( depth );
@@ -182,6 +188,12 @@ const SSAOShader = {
 
 };
 
+/**
+ * SSAO depth shader.
+ *
+ * @constant
+ * @type {ShaderMaterial~Shader}
+ */
 const SSAODepthShader = {
 
 	name: 'SSAODepthShader',
@@ -245,6 +257,12 @@ const SSAODepthShader = {
 
 };
 
+/**
+ * SSAO blur shader.
+ *
+ * @constant
+ * @type {Object}
+ */
 const SSAOBlurShader = {
 
 	name: 'SSAOBlurShader',