super-three 0.184.0 → 0.185.0

package/src/renderers/webgpu/descriptors/GPURenderPassDescriptor.js

@@ -0,0 +1,72 @@
+/**
+ * Reusable descriptor for `GPUCommandEncoder.beginRenderPass()`.
+ *
+ * @private
+ */
+class GPURenderPassDescriptor {
+
+	constructor() {
+
+		/**
+		 * The label of the render pass.
+		 *
+		 * @type {string}
+		 */
+		this.label = '';
+
+		/**
+		 * The color attachments of the render pass.
+		 *
+		 * @type {Array<?Object>}
+		 */
+		this.colorAttachments = [];
+
+		/**
+		 * The depth-stencil attachment of the render pass.
+		 *
+		 * @type {Object|undefined}
+		 */
+		this.depthStencilAttachment = undefined;
+
+		/**
+		 * The query set used for occlusion queries during the pass.
+		 *
+		 * @type {?GPUQuerySet|undefined}
+		 */
+		this.occlusionQuerySet = undefined;
+
+		/**
+		 * Defines which timestamp values are written and where.
+		 *
+		 * @type {Object|undefined}
+		 */
+		this.timestampWrites = undefined;
+
+		/**
+		 * The maximum number of draw calls that can be issued during the pass.
+		 *
+		 * @type {number}
+		 * @default 50000000
+		 */
+		this.maxDrawCount = 50000000;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state. The internal `colorAttachments`
+	 * array is emptied without releasing its backing storage.
+	 */
+	reset() {
+
+		this.label = '';
+		this.colorAttachments.length = 0;
+		this.depthStencilAttachment = undefined;
+		this.occlusionQuerySet = undefined;
+		this.timestampWrites = undefined;
+		this.maxDrawCount = 50000000;
+
+	}
+
+}
+
+export default GPURenderPassDescriptor;

package/src/renderers/webgpu/descriptors/GPURenderPassTimestampWrites.js

@@ -0,0 +1,49 @@
+/**
+ * Reusable descriptor for `GPURenderPassTimestampWrites`, the
+ * `timestampWrites` field of `GPURenderPassDescriptor`. The same shape is
+ * also accepted as `GPUComputePassTimestampWrites`.
+ *
+ * @private
+ */
+class GPURenderPassTimestampWrites {
+
+	constructor() {
+
+		/**
+		 * The query set the timestamps are written to.
+		 *
+		 * @type {?GPUQuerySet}
+		 * @default null
+		 */
+		this.querySet = null;
+
+		/**
+		 * The index in the query set the beginning timestamp is written to.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.beginningOfPassWriteIndex = undefined;
+
+		/**
+		 * The index in the query set the ending timestamp is written to.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.endOfPassWriteIndex = undefined;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.querySet = null;
+		this.beginningOfPassWriteIndex = undefined;
+		this.endOfPassWriteIndex = undefined;
+
+	}
+
+}
+
+export default GPURenderPassTimestampWrites;

package/src/renderers/webgpu/descriptors/GPURenderPipelineDescriptor.js

@@ -0,0 +1,130 @@
+/**
+ * Reusable descriptor for `GPUDevice.createRenderPipeline()` and
+ * `createRenderPipelineAsync()`.
+ *
+ * @private
+ */
+class GPURenderPipelineDescriptor {
+
+	constructor() {
+
+		/**
+		 * The label of the render pipeline.
+		 *
+		 * @type {string}
+		 */
+		this.label = '';
+
+		/**
+		 * The pipeline layout the pipeline conforms to, or `'auto'`.
+		 *
+		 * @type {?GPUPipelineLayout|string}
+		 * @default null
+		 */
+		this.layout = null;
+
+		/**
+		 * The programmable vertex stage.
+		 *
+		 * @type {?Object}
+		 * @default null
+		 */
+		this.vertex = null;
+
+		/**
+		 * The primitive-assembly state.
+		 *
+		 * @type {Object}
+		 */
+		this.primitive = {};
+
+		/**
+		 * The depth/stencil state, omitted when the pipeline has no depth or stencil aspect.
+		 *
+		 * @type {Object|undefined}
+		 */
+		this.depthStencil = undefined;
+
+		/**
+		 * The multisample state.
+		 *
+		 * @type {GPUMultisampleState}
+		 */
+		this.multisample = new GPUMultisampleState();
+
+		/**
+		 * The programmable fragment stage. Omitted for vertex-only pipelines.
+		 *
+		 * @type {?Object}
+		 * @default null
+		 */
+		this.fragment = null;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.label = '';
+		this.layout = null;
+		this.vertex = null;
+		this.primitive = {};
+		this.depthStencil = undefined;
+		this.multisample.reset();
+		this.fragment = null;
+
+	}
+
+}
+
+/**
+ * Reusable nested state for `GPURenderPipelineDescriptor.multisample`.
+ *
+ * @private
+ */
+class GPUMultisampleState {
+
+	constructor() {
+
+		/**
+		 * The number of samples per pixel.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
+		this.count = 1;
+
+		/**
+		 * A bitmask determining which samples are written to.
+		 *
+		 * @type {number}
+		 * @default 0xFFFFFFFF
+		 */
+		this.mask = 0xFFFFFFFF;
+
+		/**
+		 * Whether a fragment's alpha channel is used to generate a sample coverage mask.
+		 *
+		 * @type {boolean}
+		 * @default false
+		 */
+		this.alphaToCoverageEnabled = false;
+
+	}
+
+	/**
+	 * Resets the state to its default values.
+	 */
+	reset() {
+
+		this.count = 1;
+		this.mask = 0xFFFFFFFF;
+		this.alphaToCoverageEnabled = false;
+
+	}
+
+}
+
+export default GPURenderPipelineDescriptor;

package/src/renderers/webgpu/descriptors/GPUSamplerDescriptor.js

@@ -0,0 +1,119 @@
+/**
+ * Reusable descriptor for `GPUDevice.createSampler()`.
+ *
+ * @private
+ */
+class GPUSamplerDescriptor {
+
+	constructor() {
+
+		/**
+		 * The label of the sampler.
+		 *
+		 * @type {string}
+		 */
+		this.label = '';
+
+		/**
+		 * The address mode for the sampler's U coordinate.
+		 *
+		 * @type {string}
+		 * @default 'clamp-to-edge'
+		 */
+		this.addressModeU = 'clamp-to-edge';
+
+		/**
+		 * The address mode for the sampler's V coordinate.
+		 *
+		 * @type {string}
+		 * @default 'clamp-to-edge'
+		 */
+		this.addressModeV = 'clamp-to-edge';
+
+		/**
+		 * The address mode for the sampler's W coordinate.
+		 *
+		 * @type {string}
+		 * @default 'clamp-to-edge'
+		 */
+		this.addressModeW = 'clamp-to-edge';
+
+		/**
+		 * The magnification filter mode.
+		 *
+		 * @type {string}
+		 * @default 'nearest'
+		 */
+		this.magFilter = 'nearest';
+
+		/**
+		 * The minification filter mode.
+		 *
+		 * @type {string}
+		 * @default 'nearest'
+		 */
+		this.minFilter = 'nearest';
+
+		/**
+		 * The mipmap filter mode.
+		 *
+		 * @type {string}
+		 * @default 'nearest'
+		 */
+		this.mipmapFilter = 'nearest';
+
+		/**
+		 * The minimum level of detail used to sample.
+		 *
+		 * @type {number}
+		 * @default 0
+		 */
+		this.lodMinClamp = 0;
+
+		/**
+		 * The maximum level of detail used to sample.
+		 *
+		 * @type {number}
+		 * @default 32
+		 */
+		this.lodMaxClamp = 32;
+
+		/**
+		 * The compare function used by the sampler.
+		 *
+		 * @type {string|undefined}
+		 */
+		this.compare = undefined;
+
+		/**
+		 * The maximum allowed anisotropic filtering.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
+		this.maxAnisotropy = 1;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.label = '';
+		this.addressModeU = 'clamp-to-edge';
+		this.addressModeV = 'clamp-to-edge';
+		this.addressModeW = 'clamp-to-edge';
+		this.magFilter = 'nearest';
+		this.minFilter = 'nearest';
+		this.mipmapFilter = 'nearest';
+		this.lodMinClamp = 0;
+		this.lodMaxClamp = 32;
+		this.compare = undefined;
+		this.maxAnisotropy = 1;
+
+	}
+
+}
+
+export default GPUSamplerDescriptor;

package/src/renderers/webgpu/descriptors/GPUShaderModuleDescriptor.js

@@ -0,0 +1,46 @@
+/**
+ * Reusable descriptor for `GPUDevice.createShaderModule()`.
+ *
+ * @private
+ */
+class GPUShaderModuleDescriptor {
+
+	constructor() {
+
+		/**
+		 * The label of the shader module.
+		 *
+		 * @type {string}
+		 */
+		this.label = '';
+
+		/**
+		 * The WGSL source code of the shader module.
+		 *
+		 * @type {string}
+		 */
+		this.code = '';
+
+		/**
+		 * Compilation hints that may help the implementation produce optimized code.
+		 *
+		 * @type {Array<Object>}
+		 */
+		this.compilationHints = [];
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.label = '';
+		this.code = '';
+		this.compilationHints.length = 0;
+
+	}
+
+}
+
+export default GPUShaderModuleDescriptor;

package/src/renderers/webgpu/descriptors/GPUTexelCopyBufferInfo.js

@@ -0,0 +1,57 @@
+/**
+ * Reusable descriptor for `GPUTexelCopyBufferInfo`, the buffer side of
+ * `GPUCommandEncoder.copyTextureToBuffer()` and `copyBufferToTexture()`.
+ *
+ * @private
+ */
+class GPUTexelCopyBufferInfo {
+
+	constructor() {
+
+		/**
+		 * The target buffer.
+		 *
+		 * @type {?GPUBuffer}
+		 * @default null
+		 */
+		this.buffer = null;
+
+		/**
+		 * The byte offset within the buffer where the texel data begins.
+		 *
+		 * @type {number}
+		 * @default 0
+		 */
+		this.offset = 0;
+
+		/**
+		 * The stride, in bytes, between rows of texel blocks.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.bytesPerRow = undefined;
+
+		/**
+		 * The number of texel block rows per single image of the texture.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.rowsPerImage = undefined;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.buffer = null;
+		this.offset = 0;
+		this.bytesPerRow = undefined;
+		this.rowsPerImage = undefined;
+
+	}
+
+}
+
+export default GPUTexelCopyBufferInfo;

package/src/renderers/webgpu/descriptors/GPUTexelCopyBufferLayout.js

@@ -0,0 +1,48 @@
+/**
+ * Reusable descriptor for `GPUTexelCopyBufferLayout`, the data-layout argument
+ * to `GPUQueue.writeTexture()`.
+ *
+ * @private
+ */
+class GPUTexelCopyBufferLayout {
+
+	constructor() {
+
+		/**
+		 * The byte offset within the source data where the texel data begins.
+		 *
+		 * @type {number}
+		 * @default 0
+		 */
+		this.offset = 0;
+
+		/**
+		 * The stride, in bytes, between rows of texel blocks.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.bytesPerRow = undefined;
+
+		/**
+		 * The number of texel block rows per single image of the texture.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.rowsPerImage = undefined;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.offset = 0;
+		this.bytesPerRow = undefined;
+		this.rowsPerImage = undefined;
+
+	}
+
+}
+
+export default GPUTexelCopyBufferLayout;

package/src/renderers/webgpu/descriptors/GPUTexelCopyTextureInfo.js

@@ -0,0 +1,61 @@
+/**
+ * Reusable descriptor for `GPUTexelCopyTextureInfo`, the texture side of
+ * `GPUCommandEncoder.copyTextureToTexture()`, `copyTextureToBuffer()` and
+ * `GPUQueue.writeTexture()`.
+ *
+ * @private
+ */
+class GPUTexelCopyTextureInfo {
+
+	constructor() {
+
+		/**
+		 * The target texture.
+		 *
+		 * @type {?GPUTexture}
+		 * @default null
+		 */
+		this.texture = null;
+
+		/**
+		 * The mipmap level of the texture.
+		 *
+		 * @type {number}
+		 * @default 0
+		 */
+		this.mipLevel = 0;
+
+		/**
+		 * The origin offset within the texture.
+		 *
+		 * @type {{x: number, y: number, z: number}}
+		 */
+		this.origin = { x: 0, y: 0, z: 0 };
+
+		/**
+		 * Which aspect of the texture is referenced.
+		 *
+		 * @type {string}
+		 * @default 'all'
+		 */
+		this.aspect = 'all';
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.texture = null;
+		this.mipLevel = 0;
+		this.origin.x = 0;
+		this.origin.y = 0;
+		this.origin.z = 0;
+		this.aspect = 'all';
+
+	}
+
+}
+
+export default GPUTexelCopyTextureInfo;

package/src/renderers/webgpu/descriptors/GPUTextureDescriptor.js

@@ -0,0 +1,99 @@
+/**
+ * Reusable descriptor for `GPUDevice.createTexture()`.
+ *
+ * @private
+ */
+class GPUTextureDescriptor {
+
+	constructor() {
+
+		/**
+		 * The label of the texture.
+		 *
+		 * @type {string}
+		 */
+		this.label = '';
+
+		/**
+		 * The size of the texture.
+		 *
+		 * @type {{width: number, height: number, depthOrArrayLayers: number}}
+		 */
+		this.size = { width: 0, height: 1, depthOrArrayLayers: 1 };
+
+		/**
+		 * The number of mip levels the texture will contain.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
+		this.mipLevelCount = 1;
+
+		/**
+		 * The sample count of the texture.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
+		this.sampleCount = 1;
+
+		/**
+		 * The dimension of the set of texel coordinates.
+		 *
+		 * @type {string}
+		 * @default '2d'
+		 */
+		this.dimension = '2d';
+
+		/**
+		 * The format of the texture.
+		 *
+		 * @type {string|undefined}
+		 */
+		this.format = undefined;
+
+		/**
+		 * The allowed usages for the texture.
+		 *
+		 * @type {number|undefined}
+		 */
+		this.usage = undefined;
+
+		/**
+		 * The formats that views of this texture may use.
+		 *
+		 * @type {Array<string>}
+		 */
+		this.viewFormats = [];
+
+		/**
+		 * The view dimension to use when binding the texture (compatibility mode).
+		 *
+		 * @type {string|undefined}
+		 */
+		this.textureBindingViewDimension = undefined;
+
+	}
+
+	/**
+	 * Resets the descriptor to its default state.
+	 */
+	reset() {
+
+		this.label = '';
+		this.size.width = 0;
+		this.size.height = 1;
+		this.size.depthOrArrayLayers = 1;
+		this.mipLevelCount = 1;
+		this.sampleCount = 1;
+		this.dimension = '2d';
+		this.format = undefined;
+		this.usage = undefined;
+		this.viewFormats.length = 0;
+		this.textureBindingViewDimension = undefined;
+
+	}
+
+}
+
+export default GPUTextureDescriptor;