super-three 0.171.0 → 0.173.0

package/src/renderers/webgpu/WebGPURenderer.Nodes.js

@@ -3,8 +3,30 @@ import WebGLBackend from '../webgl-fallback/WebGLBackend.js';
 import WebGPUBackend from './WebGPUBackend.js';
 import BasicNodeLibrary from './nodes/BasicNodeLibrary.js';
 
+/**
+ * This alternative version of {@link WebGPURenderer} only supports node materials.
+ * So classes like `MeshBasicMaterial` are not compatible.
+ *
+ * @private
+ * @augments module:Renderer~Renderer
+ */
 class WebGPURenderer extends Renderer {
 
+	/**
+	 * Constructs a new WebGPU renderer.
+	 *
+	 * @param {Object} parameters - The configuration parameter.
+	 * @param {Boolean} [parameters.logarithmicDepthBuffer=false] - Whether logarithmic depth buffer is enabled or not.
+	 * @param {Boolean} [parameters.alpha=true] - Whether the default framebuffer (which represents the final contents of the canvas) should be transparent or opaque.
+	 * @param {Boolean} [parameters.depth=true] - Whether the default framebuffer should have a depth buffer or not.
+	 * @param {Boolean} [parameters.stencil=false] - Whether the default framebuffer should have a stencil buffer or not.
+	 * @param {Boolean} [parameters.antialias=false] - Whether MSAA as the default anti-aliasing should be enabled or not.
+	 * @param {Number} [parameters.samples=0] - When `antialias` is `true`, `4` samples are used by default. Set this parameter to any other integer value than 0 to overwrite the default.
+	 * @param {Boolean} [parameters.forceWebGL=false] - If set to `true`, the renderer uses it WebGL 2 backend no matter if WebGPU is supported or not.
+	 * @param {Number} [parameters.outputType=undefined] - Texture type for output to canvas. By default, device's preferred format is used; other formats may incur overhead.
+	 * @param {Number} [parameters.colorBufferType=HalfFloatType] - Defines the type of color buffers. The default `HalfFloatType` is recommend for best
+	 * quality. To save memory and bandwidth, `UnsignedByteType` might be used. This will reduce rendering quality though.
+	 */
 	constructor( parameters = {} ) {
 
 		let BackendClass;
@@ -31,8 +53,22 @@ class WebGPURenderer extends Renderer {
 
 		super( backend, parameters );
 
+		/**
+		 * The generic default value is overwritten with the
+		 * standard node library for type mapping. Material
+		 * mapping is not supported with this version.
+		 *
+		 * @type {BasicNodeLibrary}
+		 */
 		this.library = new BasicNodeLibrary();
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {Boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isWebGPURenderer = true;
 
 	}

package/src/renderers/webgpu/WebGPURenderer.js

@@ -16,8 +16,31 @@ const debugHandler = {
 
 };
 */
+
+/**
+ * This renderer is the new alternative of `WebGLRenderer`. `WebGPURenderer` has the ability
+ * to target different backends. By default, the renderer tries to use a WebGPU backend if the
+ * browser supports WebGPU. If not, `WebGPURenderer` falls backs to a WebGL 2 backend.
+ *
+ * @augments module:Renderer~Renderer
+ */
 class WebGPURenderer extends Renderer {
 
+	/**
+	 * Constructs a new WebGPU renderer.
+	 *
+	 * @param {Object} parameters - The configuration parameter.
+	 * @param {Boolean} [parameters.logarithmicDepthBuffer=false] - Whether logarithmic depth buffer is enabled or not.
+	 * @param {Boolean} [parameters.alpha=true] - Whether the default framebuffer (which represents the final contents of the canvas) should be transparent or opaque.
+	 * @param {Boolean} [parameters.depth=true] - Whether the default framebuffer should have a depth buffer or not.
+	 * @param {Boolean} [parameters.stencil=false] - Whether the default framebuffer should have a stencil buffer or not.
+	 * @param {Boolean} [parameters.antialias=false] - Whether MSAA as the default anti-aliasing should be enabled or not.
+	 * @param {Number} [parameters.samples=0] - When `antialias` is `true`, `4` samples are used by default. Set this parameter to any other integer value than 0 to overwrite the default.
+	 * @param {Boolean} [parameters.forceWebGL=false] - If set to `true`, the renderer uses a WebGL 2 backend no matter if WebGPU is supported or not.
+	 * @param {Number} [parameters.outputType=undefined] - Texture type for output to canvas. By default, device's preferred format is used; other formats may incur overhead.
+	 * @param {Number} [parameters.colorBufferType=HalfFloatType] - Defines the type of color buffers. The default `HalfFloatType` is recommend for best
+	 * quality. To save memory and bandwidth, `UnsignedByteType` might be used. This will reduce rendering quality though.
+	 */
 	constructor( parameters = {} ) {
 
 		let BackendClass;
@@ -45,8 +68,21 @@ class WebGPURenderer extends Renderer {
 		//super( new Proxy( backend, debugHandler ) );
 		super( backend, parameters );
 
+		/**
+		 * The generic default value is overwritten with the
+		 * standard node library for type mapping.
+		 *
+		 * @type {StandardNodeLibrary}
+		 */
 		this.library = new StandardNodeLibrary();
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {Boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isWebGPURenderer = true;
 
 	}

package/src/renderers/webgpu/nodes/BasicNodeLibrary.js

@@ -2,28 +2,40 @@ import NodeLibrary from '../../common/nodes/NodeLibrary.js';
 
 // Lights
 import { PointLight } from '../../../lights/PointLight.js';
-import { PointLightNode } from '../../../nodes/Nodes.js';
 import { DirectionalLight } from '../../../lights/DirectionalLight.js';
-import { DirectionalLightNode } from '../../../nodes/Nodes.js';
 import { RectAreaLight } from '../../../lights/RectAreaLight.js';
-import { RectAreaLightNode } from '../../../nodes/Nodes.js';
 import { SpotLight } from '../../../lights/SpotLight.js';
-import { SpotLightNode } from '../../../nodes/Nodes.js';
 import { AmbientLight } from '../../../lights/AmbientLight.js';
-import { AmbientLightNode } from '../../../nodes/Nodes.js';
 import { HemisphereLight } from '../../../lights/HemisphereLight.js';
-import { HemisphereLightNode } from '../../../nodes/Nodes.js';
 import { LightProbe } from '../../../lights/LightProbe.js';
-import { LightProbeNode } from '../../../nodes/Nodes.js';
 import IESSpotLight from '../../../lights/webgpu/IESSpotLight.js';
-import { IESSpotLightNode } from '../../../nodes/Nodes.js';
+import {
+	PointLightNode,
+	DirectionalLightNode,
+	RectAreaLightNode,
+	SpotLightNode,
+	AmbientLightNode,
+	HemisphereLightNode,
+	LightProbeNode,
+	IESSpotLightNode
+} from '../../../nodes/Nodes.js';
 
 // Tone Mapping
 import { LinearToneMapping, ReinhardToneMapping, CineonToneMapping, ACESFilmicToneMapping, AgXToneMapping, NeutralToneMapping } from '../../../constants.js';
 import { linearToneMapping, reinhardToneMapping, cineonToneMapping, acesFilmicToneMapping, agxToneMapping, neutralToneMapping } from '../../../nodes/display/ToneMappingFunctions.js';
 
+/**
+ * This version of a node library represents a basic version
+ * just focusing on lights and tone mapping techniques.
+ *
+ * @private
+ * @augments NodeLibrary
+ */
 class BasicNodeLibrary extends NodeLibrary {
 
+	/**
+	 * Constructs a new basic node library.
+	 */
 	constructor() {
 
 		super();

package/src/renderers/webgpu/nodes/StandardNodeLibrary.js

@@ -21,28 +21,41 @@ import ShadowNodeMaterial from '../../../materials/nodes/ShadowNodeMaterial.js';
 
 // Lights
 import { PointLight } from '../../../lights/PointLight.js';
-import { PointLightNode } from '../../../nodes/Nodes.js';
 import { DirectionalLight } from '../../../lights/DirectionalLight.js';
-import { DirectionalLightNode } from '../../../nodes/Nodes.js';
 import { RectAreaLight } from '../../../lights/RectAreaLight.js';
-import { RectAreaLightNode } from '../../../nodes/Nodes.js';
 import { SpotLight } from '../../../lights/SpotLight.js';
-import { SpotLightNode } from '../../../nodes/Nodes.js';
 import { AmbientLight } from '../../../lights/AmbientLight.js';
-import { AmbientLightNode } from '../../../nodes/Nodes.js';
 import { HemisphereLight } from '../../../lights/HemisphereLight.js';
-import { HemisphereLightNode } from '../../../nodes/Nodes.js';
 import { LightProbe } from '../../../lights/LightProbe.js';
-import { LightProbeNode } from '../../../nodes/Nodes.js';
 import IESSpotLight from '../../../lights/webgpu/IESSpotLight.js';
-import { IESSpotLightNode } from '../../../nodes/Nodes.js';
+import {
+	PointLightNode,
+	DirectionalLightNode,
+	RectAreaLightNode,
+	SpotLightNode,
+	AmbientLightNode,
+	HemisphereLightNode,
+	LightProbeNode,
+	IESSpotLightNode
+} from '../../../nodes/Nodes.js';
 
 // Tone Mapping
 import { LinearToneMapping, ReinhardToneMapping, CineonToneMapping, ACESFilmicToneMapping, AgXToneMapping, NeutralToneMapping } from '../../../constants.js';
 import { linearToneMapping, reinhardToneMapping, cineonToneMapping, acesFilmicToneMapping, agxToneMapping, neutralToneMapping } from '../../../nodes/display/ToneMappingFunctions.js';
 
+/**
+ * This version of a node library represents the standard version
+ * used in {@link WebGPURenderer}. It maps lights, tone mapping
+ * techniques and materials to node-based implementations.
+ *
+ * @private
+ * @augments NodeLibrary
+ */
 class StandardNodeLibrary extends NodeLibrary {
 
+	/**
+	 * Constructs a new standard node library.
+	 */
 	constructor() {
 
 		super();