@plastic-software/three 0.174.0 → 0.175.1

package/examples/jsm/postprocessing/HalftonePass.js

@@ -6,25 +6,56 @@ import { Pass, FullScreenQuad } from './Pass.js';
 import { HalftoneShader } from '../shaders/HalftoneShader.js';
 
 /**
- * RGB Halftone pass for three.js effects composer. Requires HalftoneShader.
+ * Pass for creating a RGB halftone effect.
+ *
+ * ```js
+ * const params = {
+ * 	shape: 1,
+ * 	radius: 4,
+ * 	rotateR: Math.PI / 12,
+ * 	rotateB: Math.PI / 12 * 2,
+ * 	rotateG: Math.PI / 12 * 3,
+ * 	scatter: 0,
+ * 	blending: 1,
+ * 	blendingMode: 1,
+ * 	greyscale: false,
+ * 	disable: false
+ * };
+ * const halftonePass = new HalftonePass( params );
+ * composer.addPass( halftonePass );
+ * ```
+ *
+ * @augments Pass
  */
-
 class HalftonePass extends Pass {
 
-	constructor( width, height, params ) {
+	/**
+	 * Constructs a new halftone pass.
+	 *
+	 * @param {Object} params - The halftone shader parameter.
+	 */
+	constructor( params ) {
 
 		super();
 
+		/**
+		 * The pass uniforms.
+		 *
+		 * @type {Object}
+		 */
 	 	this.uniforms = UniformsUtils.clone( HalftoneShader.uniforms );
+
+		/**
+		 * The pass material.
+		 *
+		 * @type {ShaderMaterial}
+		 */
 	 	this.material = new ShaderMaterial( {
 	 		uniforms: this.uniforms,
 	 		fragmentShader: HalftoneShader.fragmentShader,
 	 		vertexShader: HalftoneShader.vertexShader
 	 	} );
 
-		// set params
-		this.uniforms.width.value = width;
-		this.uniforms.height.value = height;
 
 		for ( const key in params ) {
 
@@ -36,10 +67,23 @@ class HalftonePass extends Pass {
 
 		}
 
-		this.fsQuad = new FullScreenQuad( this.material );
+		// internals
+
+		this._fsQuad = new FullScreenQuad( this.material );
 
 	}
 
+	/**
+	 * Performs the halftone pass.
+	 *
+	 * @param {WebGLRenderer} renderer - The renderer.
+	 * @param {WebGLRenderTarget} writeBuffer - The write buffer. This buffer is intended as the rendering
+	 * destination for the pass.
+	 * @param {WebGLRenderTarget} readBuffer - The read buffer. The pass can access the result from the
+	 * previous pass from this buffer.
+	 * @param {number} deltaTime - The delta time in seconds.
+	 * @param {boolean} maskActive - Whether masking is active or not.
+	 */
 	render( renderer, writeBuffer, readBuffer/*, deltaTime, maskActive*/ ) {
 
  		this.material.uniforms[ 'tDiffuse' ].value = readBuffer.texture;
@@ -47,18 +91,24 @@ class HalftonePass extends Pass {
  		if ( this.renderToScreen ) {
 
  			renderer.setRenderTarget( null );
- 			this.fsQuad.render( renderer );
+ 			this._fsQuad.render( renderer );
 
 		} else {
 
  			renderer.setRenderTarget( writeBuffer );
  			if ( this.clear ) renderer.clear();
-			this.fsQuad.render( renderer );
+			this._fsQuad.render( renderer );
 
 		}
 
  	}
 
+	/**
+	 * Sets the size of the pass.
+	 *
+	 * @param {number} width - The width to set.
+	 * @param {number} height - The width to set.
+	 */
  	setSize( width, height ) {
 
  		this.uniforms.width.value = width;
@@ -66,11 +116,15 @@ class HalftonePass extends Pass {
 
  	}
 
+	/**
+	 * Frees the GPU-related resources allocated by this instance. Call this
+	 * method whenever the pass is no longer used in your app.
+	 */
 	dispose() {
 
 		this.material.dispose();
 
-		this.fsQuad.dispose();
+		this._fsQuad.dispose();
 
 	}
 

package/examples/jsm/postprocessing/LUTPass.js

@@ -56,8 +56,45 @@ const LUTShader = {
 
 };
 
+/**
+ * Pass for color grading via lookup tables.
+ *
+ * ```js
+ * const lutPass = new LUTPass( { lut: lut.texture3D } );
+ * composer.addPass( lutPass );
+ * ```
+ *
+ * @augments ShaderPass
+ */
 class LUTPass extends ShaderPass {
 
+	/**
+	 * Constructs a LUT pass.
+	 *
+	 * @param {{lut:Data3DTexture,intensity:number}} [options={}] - The pass options.
+	 */
+	constructor( options = {} ) {
+
+		super( LUTShader );
+
+		/**
+		 * The LUT as a 3D texture.
+		 *
+		 * @type {?Data3DTexture}
+		 * @default null
+		 */
+		this.lut = options.lut || null;
+
+		/**
+		 * The intensity.
+		 *
+		 * @type {?number}
+		 * @default 1
+		 */
+		this.intensity = 'intensity' in options ? options.intensity : 1;
+
+	}
+
 	set lut( v ) {
 
 		const material = this.material;
@@ -95,14 +132,6 @@ class LUTPass extends ShaderPass {
 
 	}
 
-	constructor( options = {} ) {
-
-		super( LUTShader );
-		this.lut = options.lut || null;
-		this.intensity = 'intensity' in options ? options.intensity : 1;
-
-	}
-
 }
 
 export { LUTPass };

package/examples/jsm/postprocessing/MaskPass.js

@@ -1,21 +1,81 @@
 import { Pass } from './Pass.js';
 
+/**
+ * This pass can be used to define a mask during post processing.
+ * Meaning only areas of subsequent post processing are affected
+ * which lie in the masking area of this pass. Internally, the masking
+ * is implemented with the stencil buffer.
+ *
+ * ```js
+ * const maskPass = new MaskPass( scene, camera );
+ * composer.addPass( maskPass );
+ * ```
+ *
+ * @augments Pass
+ */
 class MaskPass extends Pass {
 
+	/**
+	 * Constructs a new mask pass.
+	 *
+	 * @param {Scene} scene - The 3D objects in this scene will define the mask.
+	 * @param {Camera} camera - The camera.
+	 */
 	constructor( scene, camera ) {
 
 		super();
 
+		/**
+		 * The scene that defines the mask.
+		 *
+		 * @type {Scene}
+		 */
 		this.scene = scene;
+
+		/**
+		 * The camera.
+		 *
+		 * @type {Camera}
+		 */
 		this.camera = camera;
 
+		/**
+		 * Overwritten to perform a clear operation by default.
+		 *
+		 * @type {boolean}
+		 * @default true
+		 */
 		this.clear = true;
+
+		/**
+		 * Overwritten to disable the swap.
+		 *
+		 * @type {boolean}
+		 * @default false
+		 */
 		this.needsSwap = false;
 
+		/**
+		 * Whether to inverse the mask or not.
+		 *
+		 * @type {boolean}
+		 * @default false
+		 */
 		this.inverse = false;
 
 	}
 
+	/**
+	 * Performs a mask pass with the configured scene and camera.
+	 *
+	 * @param {WebGLRenderer} renderer - The renderer.
+	 * @param {WebGLRenderTarget} writeBuffer - The write buffer. This buffer is intended as the rendering
+	 * destination for the pass.
+	 * @param {WebGLRenderTarget} readBuffer - The read buffer. The pass can access the result from the
+	 * previous pass from this buffer.
+	 * @param {number} deltaTime - The delta time in seconds.
+	 * @param {boolean} maskActive - Whether masking is active or not.
+	 */
 	render( renderer, writeBuffer, readBuffer /*, deltaTime, maskActive */ ) {
 
 		const context = renderer.getContext();
@@ -82,16 +142,46 @@ class MaskPass extends Pass {
 
 }
 
+/**
+ * This pass can be used to clear a mask previously defined with {@link MaskPass}.
+ *
+ * ```js
+ * const clearPass = new ClearMaskPass();
+ * composer.addPass( clearPass );
+ * ```
+ *
+ * @augments Pass
+ */
 class ClearMaskPass extends Pass {
 
+	/**
+	 * Constructs a new clear mask pass.
+	 */
 	constructor() {
 
 		super();
 
+		/**
+		 * Overwritten to disable the swap.
+		 *
+		 * @type {boolean}
+		 * @default false
+		 */
 		this.needsSwap = false;
 
 	}
 
+	/**
+	 * Performs the clear of the currently defined mask.
+	 *
+	 * @param {WebGLRenderer} renderer - The renderer.
+	 * @param {WebGLRenderTarget} writeBuffer - The write buffer. This buffer is intended as the rendering
+	 * destination for the pass.
+	 * @param {WebGLRenderTarget} readBuffer - The read buffer. The pass can access the result from the
+	 * previous pass from this buffer.
+	 * @param {number} deltaTime - The delta time in seconds.
+	 * @param {boolean} maskActive - Whether masking is active or not.
+	 */
 	render( renderer /*, writeBuffer, readBuffer, deltaTime, maskActive */ ) {
 
 		renderer.state.buffers.stencil.setLocked( false );