@plastic-software/three 0.175.13 → 0.178.0

package/examples/jsm/postprocessing/SMAAPass.js

@@ -12,7 +12,7 @@ import { SMAABlendShader, SMAAEdgesShader, SMAAWeightsShader } from '../shaders/
 
 /**
  * A pass for applying SMAA. Unlike {@link FXAAPass}, `SMAAPass` operates in
- * `linar-srgb` so this pass must be executed before {@link OutputPass}.
+ * `linear-srgb` so this pass must be executed before {@link OutputPass}.
  *
  * ```js
  * const smaaPass = new SMAAPass();
@@ -20,6 +20,7 @@ import { SMAABlendShader, SMAAEdgesShader, SMAAWeightsShader } from '../shaders/
  * ```
  *
  * @augments Pass
+ * @three_import import { SMAAPass } from 'three/addons/postprocessing/SMAAPass.js';
  */
 class SMAAPass extends Pass {
 
@@ -177,7 +178,7 @@ class SMAAPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/SSAARenderPass.js

@@ -21,6 +21,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { SSAARenderPass } from 'three/addons/postprocessing/SSAARenderPass.js';
  */
 class SSAARenderPass extends Pass {
 
@@ -140,7 +141,7 @@ class SSAARenderPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/SSAOPass.js

@@ -39,6 +39,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { SSAOPass } from 'three/addons/postprocessing/SSAOPass.js';
  */
 class SSAOPass extends Pass {
 
@@ -350,7 +351,7 @@ class SSAOPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/SSRPass.js

@@ -34,6 +34,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { SSRPass } from 'three/addons/postprocessing/SSRPass.js';
  */
 class SSRPass extends Pass {
 
@@ -100,7 +101,7 @@ class SSRPass extends Pass {
 		this.groundReflector = groundReflector;
 
 		/**
-		 * The opactiy.
+		 * The opacity.
 		 *
 		 * @type {number}
 		 * @default 0.5
@@ -221,7 +222,7 @@ class SSRPass extends Pass {
 		this._distanceAttenuation = SSRShader.defines.DISTANCE_ATTENUATION;
 
 		/**
-		 * Whether to use distance attenutation or not.
+		 * Whether to use distance attenuation or not.
 		 *
 		 * @name SSRPass#distanceAttenuation
 		 * @type {boolean}
@@ -653,7 +654,7 @@ class SSRPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/SavePass.js

@@ -17,6 +17,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { SavePass } from 'three/addons/postprocessing/SavePass.js';
  */
 class SavePass extends Pass {
 
@@ -104,7 +105,7 @@ class SavePass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/ShaderPass.js

@@ -15,6 +15,7 @@ import { Pass, FullScreenQuad } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { ShaderPass } from 'three/addons/postprocessing/ShaderPass.js';
  */
 class ShaderPass extends Pass {
 

package/examples/jsm/postprocessing/TAARenderPass.js

@@ -20,6 +20,7 @@ import { SSAARenderPass } from './SSAARenderPass.js';
  * ```
  *
  * @augments SSAARenderPass
+ * @three_import import { TAARenderPass } from 'three/addons/postprocessing/TAARenderPass.js';
  */
 class TAARenderPass extends SSAARenderPass {
 

package/examples/jsm/postprocessing/TexturePass.js

@@ -17,6 +17,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { TexturePass } from 'three/addons/postprocessing/TexturePass.js';
  */
 class TexturePass extends Pass {
 

package/examples/jsm/postprocessing/UnrealBloomPass.js

@@ -31,6 +31,7 @@ import { LuminosityHighPassShader } from '../shaders/LuminosityHighPassShader.js
  * ```
  *
  * @augments Pass
+ * @three_import import { UnrealBloomPass } from 'three/addons/postprocessing/UnrealBloomPass.js';
  */
 class UnrealBloomPass extends Pass {
 
@@ -241,7 +242,7 @@ class UnrealBloomPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/renderers/CSS2DRenderer.js

@@ -9,6 +9,7 @@ import {
  * The only type of 3D object that is supported by {@link CSS2DRenderer}.
  *
  * @augments Object3D
+ * @three_import import { CSS2DObject } from 'three/addons/renderers/CSS2DRenderer.js';
  */
 class CSS2DObject extends Object3D {
 
@@ -103,6 +104,8 @@ const _b = new Vector3();
  * scene graph. All other types of renderable 3D objects (like meshes or point clouds) are ignored.
  *
  * `CSS2DRenderer` only supports 100% browser and display zoom.
+ *
+ * @three_import import { CSS2DRenderer } from 'three/addons/renderers/CSS2DRenderer.js';
  */
 class CSS2DRenderer {
 

package/examples/jsm/renderers/CSS3DRenderer.js

@@ -15,6 +15,7 @@ const _scale = new Vector3();
  * The base 3D object that is supported by {@link CSS3DRenderer}.
  *
  * @augments Object3D
+ * @three_import import { CSS3DObject } from 'three/addons/renderers/CSS3DRenderer.js';
  */
 class CSS3DObject extends Object3D {
 
@@ -86,6 +87,7 @@ class CSS3DObject extends Object3D {
  * DOM elements as sprites.
  *
  * @augments CSS3DObject
+ * @three_import import { CSS3DSprite } from 'three/addons/renderers/CSS3DRenderer.js';
  */
 class CSS3DSprite extends CSS3DObject {
 
@@ -148,6 +150,8 @@ const _matrix2 = new Matrix4();
  *
  * So `CSS3DRenderer` is just focused on ordinary DOM elements. These elements are wrapped into special
  * 3D objects ({@link CSS3DObject} or {@link CSS3DSprite}) and then added to the scene graph.
+ *
+ * @three_import import { CSS3DRenderer } from 'three/addons/renderers/CSS3DRenderer.js';
  */
 class CSS3DRenderer {
 

package/examples/jsm/renderers/Projector.js

@@ -124,6 +124,8 @@ class RenderableSprite {
  * This class can project a given scene in 3D space into a 2D representation
  * used for rendering with a 2D API. `Projector` is currently used by {@link SVGRenderer}
  * and was previously used by the legacy `CanvasRenderer`.
+ *
+ * @three_import import { Projector } from 'three/addons/renderers/Projector.js';
  */
 class Projector {
 

package/examples/jsm/renderers/SVGRenderer.js

@@ -19,6 +19,7 @@ import {
  * Can be used to wrap SVG elements into a 3D object.
  *
  * @augments Object3D
+ * @three_import import { SVGObject } from 'three/addons/renderers/SVGRenderer.js';
  */
 class SVGObject extends Object3D {
 
@@ -69,6 +70,8 @@ class SVGObject extends Object3D {
  * - No advanced shading.
  * - No texture support.
  * - No shadow support.
+ *
+ * @three_import import { SVGRenderer } from 'three/addons/renderers/SVGRenderer.js';
  */
 class SVGRenderer {
 

package/examples/jsm/shaders/ACESFilmicToneMappingShader.js

@@ -1,4 +1,7 @@
-/** @module ACESFilmicToneMappingShader */
+/**
+ * @module ACESFilmicToneMappingShader
+ * @three_import import { ACESFilmicToneMappingShader } from 'three/addons/shaders/ACESFilmicToneMappingShader.js';
+ */
 
 /**
  * ACES Filmic Tone Mapping Shader by Stephen Hill.

package/examples/jsm/shaders/AfterimageShader.js

@@ -1,4 +1,7 @@
-/** @module AfterimageShader */
+/**
+ * @module AfterimageShader
+ * @three_import import { AfterimageShader } from 'three/addons/shaders/AfterimageShader.js';
+ */
 
 /**
  * Inspired by [Three.js FBO motion trails]{@link https://codepen.io/brunoimbrizi/pen/MoRJaN?page=1&}.

package/examples/jsm/shaders/BasicShader.js

@@ -1,4 +1,7 @@
-/** @module BasicShader */
+/**
+ * @module BasicShader
+ * @three_import import { BasicShader } from 'three/addons/shaders/BasicShader.js';
+ */
 
 /**
  * Simple shader for testing.

package/examples/jsm/shaders/BleachBypassShader.js

@@ -1,5 +1,8 @@
 
-/** @module BleachBypassShader */
+/**
+ * @module BleachBypassShader
+ * @three_import import { BleachBypassShader } from 'three/addons/shaders/BleachBypassShader.js';
+ */
 
 /**
  * Bleach bypass shader [http://en.wikipedia.org/wiki/Bleach_bypass] based on

package/examples/jsm/shaders/BlendShader.js

@@ -1,4 +1,7 @@
-/** @module BlendShader */
+/**
+ * @module BlendShader
+ * @three_import import { BlendShader } from 'three/addons/shaders/BlendShader.js';
+ */
 
 /**
  * Blends two textures.

package/examples/jsm/shaders/BokehShader.js

@@ -1,4 +1,7 @@
-/** @module BokehShader */
+/**
+ * @module BokehShader
+ * @three_import import { BokehShader } from 'three/addons/shaders/BokehShader.js';
+ */
 
 /**
  * Depth-of-field shader with bokeh ported from

package/examples/jsm/shaders/BokehShader2.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module BokehShader2 */
+/**
+ * @module BokehShader2
+ * @three_import import { BokehShader, BokehDepthShader } from 'three/addons/shaders/BokehShader2.js';
+ */
 
 /**
  * Depth-of-field shader with bokeh ported from

package/examples/jsm/shaders/BrightnessContrastShader.js

@@ -1,4 +1,7 @@
-/** @module BrightnessContrastShader */
+/**
+ * @module BrightnessContrastShader
+ * @three_import import { BrightnessContrastShader } from 'three/addons/shaders/BrightnessContrastShader.js';
+ */
 
 /**
  * Brightness and contrast adjustment {@link https://github.com/evanw/glfx.js}.

package/examples/jsm/shaders/ColorCorrectionShader.js

@@ -2,7 +2,10 @@ import {
 	Vector3
 } from 'three';
 
-/** @module ColorCorrectionShader */
+/**
+ * @module ColorCorrectionShader
+ * @three_import import { ColorCorrectionShader } from 'three/addons/shaders/ColorCorrectionShader.js';
+ */
 
 /**
  * Color correction shader.

package/examples/jsm/shaders/ColorifyShader.js

@@ -2,7 +2,10 @@ import {
 	Color
 } from 'three';
 
-/** @module ColorifyShader */
+/**
+ * @module ColorifyShader
+ * @three_import import { ColorifyShader } from 'three/addons/shaders/ColorifyShader.js';
+ */
 
 /**
  * Colorify shader.

package/examples/jsm/shaders/ConvolutionShader.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module ConvolutionShader */
+/**
+ * @module ConvolutionShader
+ * @three_import import { ConvolutionShader } from 'three/addons/shaders/ConvolutionShader.js';
+ */
 
 /**
  * Convolution shader ported from o3d sample to WebGL / GLSL.

package/examples/jsm/shaders/CopyShader.js

@@ -1,4 +1,7 @@
-/** @module CopyShader */
+/**
+ * @module CopyShader
+ * @three_import import { CopyShader } from 'three/addons/shaders/CopyShader.js';
+ */
 
 /**
  * Full-screen copy shader pass.

package/examples/jsm/shaders/DOFMipMapShader.js

@@ -1,4 +1,7 @@
-/** @module DOFMipMapShader */
+/**
+ * @module DOFMipMapShader
+ * @three_import import { DOFMipMapShader } from 'three/addons/shaders/DOFMipMapShader.js';
+ */
 
 /**
  * Depth-of-field shader using mipmaps from Matt Handley @applmak.

package/examples/jsm/shaders/DepthLimitedBlurShader.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module DepthLimitedBlurShader */
+/**
+ * @module DepthLimitedBlurShader
+ * @three_import import { DepthLimitedBlurShader, BlurShaderUtils } from 'three/addons/shaders/DepthLimitedBlurShader.js';
+ */
 
 /**
  * TODO

package/examples/jsm/shaders/DigitalGlitch.js

@@ -1,4 +1,7 @@
-/** @module DigitalGlitch */
+/**
+ * @module DigitalGlitch
+ * @three_import import { DigitalGlitch } from 'three/addons/shaders/DigitalGlitch.js';
+ */
 
 /**
  * Digital glitch shader.

package/examples/jsm/shaders/DotScreenShader.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module DotScreenShader */
+/**
+ * @module DotScreenShader
+ * @three_import import { DotScreenShader } from 'three/addons/shaders/DotScreenShader.js';
+ */
 
 /**
  * Dot screen shader based on [glfx.js sepia shader]{@link https://github.com/evanw/glfx.js}.

package/examples/jsm/shaders/ExposureShader.js

@@ -1,4 +1,7 @@
-/** @module ExposureShader */
+/**
+ * @module ExposureShader
+ * @three_import import { ExposureShader } from 'three/addons/shaders/ExposureShader.js';
+ */
 
 /**
  * TODO

package/examples/jsm/shaders/FXAAShader.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module FXAAShader */
+/**
+ * @module FXAAShader
+ * @three_import import { FXAAShader } from 'three/addons/shaders/FXAAShader.js';
+ */
 
 /**
  * FXAA algorithm from NVIDIA, C# implementation by Jasper Flick, GLSL port by Dave Hoskins.

package/examples/jsm/shaders/FilmShader.js

@@ -1,4 +1,7 @@
-/** @module FilmShader */
+/**
+ * @module FilmShader
+ * @three_import import { FilmShader } from 'three/addons/shaders/FilmShader.js';
+ */
 
 /**
  * TODO

package/examples/jsm/shaders/FocusShader.js

@@ -1,4 +1,7 @@
-/** @module FocusShader */
+/**
+ * @module FocusShader
+ * @three_import import { FocusShader } from 'three/addons/shaders/FocusShader.js';
+ */
 
 /**
  * Focus shader based on [PaintEffect postprocess from ro.me]{@link http://code.google.com/p/3-dreams-of-black/source/browse/deploy/js/effects/PaintEffect.js}.

package/examples/jsm/shaders/FreiChenShader.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module FreiChenShader */
+/**
+ * @module FreiChenShader
+ * @three_import import { FreiChenShader } from 'three/addons/shaders/FreiChenShader.js';
+ */
 
 /**
  * Edge Detection Shader using Frei-Chen filter.

package/examples/jsm/shaders/GTAOShader.js

@@ -6,7 +6,10 @@ import {
 	Vector3,
 } from 'three';
 
-/** @module GTAOShader */
+/**
+ * @module GTAOShader
+ * @three_import import { GTAOShader } from 'three/addons/shaders/GTAOShader.js';
+ */
 
 /**
  * GTAO shader. Use by {@link GTAOPass}.

package/examples/jsm/shaders/GammaCorrectionShader.js

@@ -1,4 +1,7 @@
-/** @module GammaCorrectionShader */
+/**
+ * @module GammaCorrectionShader
+ * @three_import import { GammaCorrectionShader } from 'three/addons/shaders/GammaCorrectionShader.js';
+ */
 
 /**
  * Gamma Correction Shader

package/examples/jsm/shaders/GodRaysShader.js

@@ -3,7 +3,10 @@ import {
 	Vector3
 } from 'three';
 
-/** @module GodRaysShader */
+/**
+ * @module GodRaysShader
+ * @three_import import * as GodRaysShader from 'three/addons/shaders/GodRaysShader.js';
+ */
 
 /**
  * God-rays (crepuscular rays)

package/examples/jsm/shaders/HalftoneShader.js

@@ -1,4 +1,7 @@
-/** @module HalftoneShader */
+/**
+ * @module HalftoneShader
+ * @three_import import { HalftoneShader } from 'three/addons/shaders/HalftoneShader.js';
+ */
 
 /**
  * RGB Halftone shader.

package/examples/jsm/shaders/HorizontalBlurShader.js

@@ -1,4 +1,7 @@
-/** @module HorizontalBlurShader */
+/**
+ * @module HorizontalBlurShader
+ * @three_import import { HorizontalBlurShader } from 'three/addons/shaders/HorizontalBlurShader.js';
+ */
 
 /**
  * Two pass Gaussian blur filter (horizontal and vertical blur shaders).

package/examples/jsm/shaders/HorizontalTiltShiftShader.js

@@ -1,4 +1,7 @@
-/** @module HorizontalTiltShiftShader */
+/**
+ * @module HorizontalTiltShiftShader
+ * @three_import import { HorizontalTiltShiftShader } from 'three/addons/shaders/HorizontalTiltShiftShader.js';
+ */
 
 /**
  * Simple fake tilt-shift effect, modulating two pass Gaussian blur (see above) by vertical position.

package/examples/jsm/shaders/HueSaturationShader.js

@@ -1,4 +1,7 @@
-/** @module HueSaturationShader */
+/**
+ * @module HueSaturationShader
+ * @three_import import { HueSaturationShader } from 'three/addons/shaders/HueSaturationShader.js';
+ */
 
 /**
  * Hue and saturation adjustment, {@link https://github.com/evanw/glfx.js}.

package/examples/jsm/shaders/KaleidoShader.js

@@ -1,4 +1,7 @@
-/** @module KaleidoShader */
+/**
+ * @module KaleidoShader
+ * @three_import import { KaleidoShader } from 'three/addons/shaders/KaleidoShader.js';
+ */
 
 /**
  * Kaleidoscope Shader.

package/examples/jsm/shaders/LuminosityHighPassShader.js

@@ -2,7 +2,10 @@ import {
 	Color
 } from 'three';
 
-/** @module LuminosityHighPassShader */
+/**
+ * @module LuminosityHighPassShader
+ * @three_import import { LuminosityHighPassShader } from 'three/addons/shaders/LuminosityHighPassShader.js';
+ */
 
 /**
  * Luminosity high pass shader.

package/examples/jsm/shaders/LuminosityShader.js

@@ -1,4 +1,7 @@
-/** @module LuminosityShader */
+/**
+ * @module LuminosityShader
+ * @three_import import { LuminosityShader } from 'three/addons/shaders/LuminosityShader.js';
+ */
 
 /**
  * Luminosity shader.

package/examples/jsm/shaders/MirrorShader.js

@@ -1,4 +1,7 @@
-/** @module MirrorShader */
+/**
+ * @module MirrorShader
+ * @three_import import { MirrorShader } from 'three/addons/shaders/MirrorShader.js';
+ */
 
 /**
  * Copies half the input to the other half.

package/examples/jsm/shaders/NormalMapShader.js

@@ -2,7 +2,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module NormalMapShader */
+/**
+ * @module NormalMapShader
+ * @three_import import { NormalMapShader } from 'three/addons/shaders/NormalMapShader.js';
+ */
 
 /**
  * Normal map shader, compute normals from heightmap.

package/examples/jsm/shaders/OutputShader.js

@@ -1,4 +1,7 @@
-/** @module OutputShader */
+/**
+ * @module OutputShader
+ * @three_import import { OutputShader } from 'three/addons/shaders/OutputShader.js';
+ */
 
 /**
  * Performs tone mapping and color space conversion for

package/examples/jsm/shaders/PoissonDenoiseShader.js

@@ -4,7 +4,10 @@ import {
 	Vector3,
 } from 'three';
 
-/** @module PoissonDenoiseShader */
+/**
+ * @module PoissonDenoiseShader
+ * @three_import import { PoissonDenoiseShader } from 'three/addons/shaders/PoissonDenoiseShader.js';
+ */
 
 /**
  * Poisson Denoise Shader.

package/examples/jsm/shaders/RGBShiftShader.js

@@ -1,4 +1,7 @@
-/** @module RGBShiftShader */
+/**
+ * @module RGBShiftShader
+ * @three_import import { RGBShiftShader } from 'three/addons/shaders/RGBShiftShader.js';
+ */
 
 /**
  * RGB Shift Shader

package/examples/jsm/shaders/SAOShader.js

@@ -3,7 +3,10 @@ import {
 	Vector2
 } from 'three';
 
-/** @module SAOShader */
+/**
+ * @module SAOShader
+ * @three_import import { SAOShader } from 'three/addons/shaders/SAOShader.js';
+ */
 
 /**
  * SAO shader.

package/examples/jsm/shaders/SMAAShader.js

@@ -10,6 +10,7 @@ import {
  * - {@link https://github.com/iryoku/smaa/releases/tag/v2.8}
  *
  * @module SMAAShader
+ * @three_import import { SMAAShader } from 'three/addons/shaders/SMAAShader.js';
  */
 
 /**