@woosh/meep-engine 3.45.0 → 3.46.0

package/src/shade/device/graph/BufferResourceDescriptor.js

@@ -1,194 +1,197 @@
-import { assert } from "../../../core/assert.js";
-import { combine_hash } from "../../../core/collection/array/combine_hash.js";
-import { isArrayEqualStrict } from "../../../core/collection/array/isArrayEqualStrict.js";
-import { number_format_by_thousands } from "../../../core/primitives/numbers/number_format_by_thousands.js";
-import {
-    ResourceDescriptor
-} from "../../../engine/graphics/render/frame_graph/resource/ResourceDescriptor.js";
-import { decode_bitmask_enum } from "../decode_bitmask_enum.js";
-
-
-export class BufferResourceDescriptor extends ResourceDescriptor {
-    /**
-     * In bytes
-     * @type {number}
-     */
-    size = 0;
-
-    /**
-     * Minimize the number of usage flags per-resource.
-     * The fewer flags you use - the more efficient the access will be.
-     * The driver can happily allow you the full set of flags - but the memory access will typically be much slower compared to just a few needed flags.
-     * @see GPUBufferUsage
-     * @type {number}
-     */
-    usage = 0;
-
-    /**
-     * Range of the buffer that needs to be cleared (reset to 0)
-     * Make sure to have a `GPUBufferUsage.COPY_DST` usage flag set if you want to clear the buffer
-     */
-    ensure_cleared = new Uint32Array(2);
-
-    toString() {
-        return `Buffer{ size = ${number_format_by_thousands(this.size)}, usage = ${decode_bitmask_enum(this.usage, GPUBufferUsage).join(" | ")} }`
-    }
-
-    get type() {
-        return "buffer";
-    }
-
-    /**
-     *
-     * @param {BufferResourceDescriptor} other
-     */
-    copy(other) {
-        this.size = other.size;
-        this.usage = other.usage;
-        this.ensure_cleared[0] = other.ensure_cleared[0];
-        this.ensure_cleared[1] = other.ensure_cleared[1];
-    }
-
-    /**
-     *
-     * @return {BufferResourceDescriptor}
-     */
-    clone() {
-        const r = new BufferResourceDescriptor();
-
-        r.copy(this);
-
-        return r;
-    }
-
-    hash() {
-        // XOR is symmetric, so it maps (size, usage) and (usage, size) onto one value, and it left
-        // `ensure_cleared` out entirely although `equals` compares it — two descriptors that are
-        // not equal sharing a bucket, which is how a texture ends up being probed with a buffer.
-        return combine_hash(
-            this.size,
-            this.usage,
-            this.ensure_cleared[0],
-            this.ensure_cleared[1]
-        );
-    }
-
-    equals(other) {
-        return super.equals(other)
-            && this.size === other.size
-            && this.usage === other.usage
-            && isArrayEqualStrict(this.ensure_cleared, other.ensure_cleared)
-            ;
-    }
-
-    /**
-     *
-     * @param {BufferResourceDescriptor} other
-     * @return {number}
-     */
-    compare(other) {
-        if (other.type !== this.type) {
-            return super.compare(other);
-        }
-
-        const d_size = this.size - other.size;
-
-        if (d_size !== 0) {
-            return d_size;
-        }
-
-        const d_usage = this.usage - other.usage;
-
-        if (d_usage !== 0) {
-            return d_usage;
-        }
-
-        return 0;
-    }
-
-    /**
-     *
-     * @param {GPUBuffer} gpu_buffer
-     * @returns {BufferResourceDescriptor}
-     */
-    static fromBuffer(gpu_buffer) {
-        assert.defined(gpu_buffer, 'gpu_buffer');
-
-        const r = new BufferResourceDescriptor();
-
-        r.usage = gpu_buffer.usage;
-        r.size = gpu_buffer.size;
-
-        return r;
-    }
-
-    /**
-     * Shortcut to create a buffer that is cleared to 0 for the entire size.
-     * If you don't need the buffer to be cleared, use {@link BufferResourceDescriptor.from} instead.
-     *
-     *
-     * @param {number} size
-     * @param {GPUBufferUsage|number} usage
-     * @returns {BufferResourceDescriptor}
-     */
-    static empty(size, usage) {
-        return BufferResourceDescriptor.from(
-            size,
-            usage,
-            0,
-            size
-        );
-    }
-
-    /**
-     *
-     * @param {number} size
-     * @param {GPUBufferUsage|number} usage will automatically add `GPUBufferUsage.COPY_DST` if `clear_size > 0`
-     * @param {number} [clear_offset]
-     * @param {number} [clear_size]
-     * @returns {BufferResourceDescriptor}
-     */
-    static from(
-        size,
-        usage,
-        clear_offset = 0,
-        clear_size = 0
-    ) {
-
-        assert.isNonNegativeInteger(size, 'size');
-        assert.isNonNegativeInteger(usage, 'usage');
-        assert.notEqual(usage, 0, 'usage may not be 0');
-        assert.isNonNegativeInteger(clear_offset, 'clear_offset');
-        assert.isNonNegativeInteger(clear_size, 'clear_size');
-
-        assert.lessThanOrEqual(clear_offset + clear_size, size, 'clear region is out of bounds');
-
-        // spec requires 4 byte alignment: https://www.w3.org/TR/webgpu/#dom-gpucommandencoder-clearbuffer
-        assert.equal(clear_offset % 4, 0, 'offset must be a multiple of 4');
-        assert.equal(clear_size % 4, 0, 'size must be a multiple of 4');
-
-        const r = new BufferResourceDescriptor();
-
-        r.size = size;
-        r.usage = usage;
-
-        r.ensure_cleared[0] = clear_offset;
-        r.ensure_cleared[1] = clear_size;
-
-        if (clear_size > 0) {
-            // requesting buffer to be cleared, this requires COPY_DST to actually fulfill
-            // automatically add it in case it was missing
-            // "buffer.usage contains COPY_DST", spec https://www.w3.org/TR/webgpu/#dom-gpucommandencoder-clearbuffer
-            r.usage |= GPUBufferUsage.COPY_DST;
-        }
-
-
-        return r;
-    }
-}
-
-/**
- * Type check shortcut
- * @type {boolean}
- */
+import { assert } from "../../../core/assert.js";
+import { hash_mix2 } from "../../../core/math/hash/hash_mix2.js";
+import { hash_mix3 } from "../../../core/math/hash/hash_mix3.js";
+import { isArrayEqualStrict } from "../../../core/collection/array/isArrayEqualStrict.js";
+import { number_format_by_thousands } from "../../../core/primitives/numbers/number_format_by_thousands.js";
+import {
+    ResourceDescriptor
+} from "../../../engine/graphics/render/frame_graph/resource/ResourceDescriptor.js";
+import { decode_bitmask_enum } from "../decode_bitmask_enum.js";
+
+
+export class BufferResourceDescriptor extends ResourceDescriptor {
+    /**
+     * In bytes
+     * @type {number}
+     */
+    size = 0;
+
+    /**
+     * Minimize the number of usage flags per-resource.
+     * The fewer flags you use - the more efficient the access will be.
+     * The driver can happily allow you the full set of flags - but the memory access will typically be much slower compared to just a few needed flags.
+     * @see GPUBufferUsage
+     * @type {number}
+     */
+    usage = 0;
+
+    /**
+     * Range of the buffer that needs to be cleared (reset to 0)
+     * Make sure to have a `GPUBufferUsage.COPY_DST` usage flag set if you want to clear the buffer
+     */
+    ensure_cleared = new Uint32Array(2);
+
+    toString() {
+        return `Buffer{ size = ${number_format_by_thousands(this.size)}, usage = ${decode_bitmask_enum(this.usage, GPUBufferUsage).join(" | ")} }`
+    }
+
+    get type() {
+        return "buffer";
+    }
+
+    /**
+     *
+     * @param {BufferResourceDescriptor} other
+     */
+    copy(other) {
+        this.size = other.size;
+        this.usage = other.usage;
+        this.ensure_cleared[0] = other.ensure_cleared[0];
+        this.ensure_cleared[1] = other.ensure_cleared[1];
+    }
+
+    /**
+     *
+     * @return {BufferResourceDescriptor}
+     */
+    clone() {
+        const r = new BufferResourceDescriptor();
+
+        r.copy(this);
+
+        return r;
+    }
+
+    hash() {
+        // XOR is symmetric, so it maps (size, usage) and (usage, size) onto one value, and it left
+        // `ensure_cleared` out entirely although `equals` compares it — two descriptors that are
+        // not equal sharing a bucket, which is how a texture ends up being probed with a buffer.
+        return hash_mix2(
+            hash_mix3(
+                this.size,
+                this.usage,
+                this.ensure_cleared[0]
+            ),
+            this.ensure_cleared[1]
+        );
+    }
+
+    equals(other) {
+        return super.equals(other)
+            && this.size === other.size
+            && this.usage === other.usage
+            && isArrayEqualStrict(this.ensure_cleared, other.ensure_cleared)
+            ;
+    }
+
+    /**
+     *
+     * @param {BufferResourceDescriptor} other
+     * @return {number}
+     */
+    compare(other) {
+        if (other.type !== this.type) {
+            return super.compare(other);
+        }
+
+        const d_size = this.size - other.size;
+
+        if (d_size !== 0) {
+            return d_size;
+        }
+
+        const d_usage = this.usage - other.usage;
+
+        if (d_usage !== 0) {
+            return d_usage;
+        }
+
+        return 0;
+    }
+
+    /**
+     *
+     * @param {GPUBuffer} gpu_buffer
+     * @returns {BufferResourceDescriptor}
+     */
+    static fromBuffer(gpu_buffer) {
+        assert.defined(gpu_buffer, 'gpu_buffer');
+
+        const r = new BufferResourceDescriptor();
+
+        r.usage = gpu_buffer.usage;
+        r.size = gpu_buffer.size;
+
+        return r;
+    }
+
+    /**
+     * Shortcut to create a buffer that is cleared to 0 for the entire size.
+     * If you don't need the buffer to be cleared, use {@link BufferResourceDescriptor.from} instead.
+     *
+     *
+     * @param {number} size
+     * @param {GPUBufferUsage|number} usage
+     * @returns {BufferResourceDescriptor}
+     */
+    static empty(size, usage) {
+        return BufferResourceDescriptor.from(
+            size,
+            usage,
+            0,
+            size
+        );
+    }
+
+    /**
+     *
+     * @param {number} size
+     * @param {GPUBufferUsage|number} usage will automatically add `GPUBufferUsage.COPY_DST` if `clear_size > 0`
+     * @param {number} [clear_offset]
+     * @param {number} [clear_size]
+     * @returns {BufferResourceDescriptor}
+     */
+    static from(
+        size,
+        usage,
+        clear_offset = 0,
+        clear_size = 0
+    ) {
+
+        assert.isNonNegativeInteger(size, 'size');
+        assert.isNonNegativeInteger(usage, 'usage');
+        assert.notEqual(usage, 0, 'usage may not be 0');
+        assert.isNonNegativeInteger(clear_offset, 'clear_offset');
+        assert.isNonNegativeInteger(clear_size, 'clear_size');
+
+        assert.lessThanOrEqual(clear_offset + clear_size, size, 'clear region is out of bounds');
+
+        // spec requires 4 byte alignment: https://www.w3.org/TR/webgpu/#dom-gpucommandencoder-clearbuffer
+        assert.equal(clear_offset % 4, 0, 'offset must be a multiple of 4');
+        assert.equal(clear_size % 4, 0, 'size must be a multiple of 4');
+
+        const r = new BufferResourceDescriptor();
+
+        r.size = size;
+        r.usage = usage;
+
+        r.ensure_cleared[0] = clear_offset;
+        r.ensure_cleared[1] = clear_size;
+
+        if (clear_size > 0) {
+            // requesting buffer to be cleared, this requires COPY_DST to actually fulfill
+            // automatically add it in case it was missing
+            // "buffer.usage contains COPY_DST", spec https://www.w3.org/TR/webgpu/#dom-gpucommandencoder-clearbuffer
+            r.usage |= GPUBufferUsage.COPY_DST;
+        }
+
+
+        return r;
+    }
+}
+
+/**
+ * Type check shortcut
+ * @type {boolean}
+ */
 BufferResourceDescriptor.prototype.isBufferResourceDescriptor = true;

package/src/shade/device/graph/TextureResourceDescriptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextureResourceDescriptor.d.ts","sourceRoot":"","sources":["../../../../../src/shade/device/graph/TextureResourceDescriptor.js"],"names":[],"mappings":";;;sCAgBU,MAAM;;;;;AAOhB;IAmCI;;;;;;;;;OASG;IACH;QAP6B,UAAU,EAA5B,MAAM,EAAE;QAC6B,SAAS,GAA9C,sBAAoB,MAAM;QACO,MAAM,EAAvC,mBAAiB,MAAM;QACe,KAAK,GAA3C,uBAAqB,MAAM;QACT,UAAU,GAA5B,OAAO;QACL,yBAAyB,CAkCrC;IAED;;;;OAIG;IACH,yCAFa,yBAAyB,CAoBrC;IArGD;;;;;;;;;OASG;IACH,mBAFU,uBAAuB,GAAC,MAAM,CAEyB;IAGjE,yBAAyC;IACzC,oBAAgB;IAEhB,sBAAkB;IAElB;;;OAGG;IACH,WAFU,sBAAoB,MAAM,CAEpB;IAEhB;;OAEG;IACH,QAFU,MAAM,mBAAiB,CAEX;IAEtB;;OAEG;IACH,OAFU,MAAM,uBAAqB,CAEG;IAsFxC;;;;OAIG;IACH,cAHW,yBAAyB,GACvB,OAAO,CAuBnB;CAKJ;mCArKM,4EAA4E"}
+{"version":3,"file":"TextureResourceDescriptor.d.ts","sourceRoot":"","sources":["../../../../../src/shade/device/graph/TextureResourceDescriptor.js"],"names":[],"mappings":";;;sCAiBU,MAAM;;;;;AAOhB;IAmCI;;;;;;;;;OASG;IACH;QAP6B,UAAU,EAA5B,MAAM,EAAE;QAC6B,SAAS,GAA9C,sBAAoB,MAAM;QACO,MAAM,EAAvC,mBAAiB,MAAM;QACe,KAAK,GAA3C,uBAAqB,MAAM;QACT,UAAU,GAA5B,OAAO;QACL,yBAAyB,CAkCrC;IAED;;;;OAIG;IACH,yCAFa,yBAAyB,CAoBrC;IArGD;;;;;;;;;OASG;IACH,mBAFU,uBAAuB,GAAC,MAAM,CAEyB;IAGjE,yBAAyC;IACzC,oBAAgB;IAEhB,sBAAkB;IAElB;;;OAGG;IACH,WAFU,sBAAoB,MAAM,CAEpB;IAEhB;;OAEG;IACH,QAFU,MAAM,mBAAiB,CAEX;IAEtB;;OAEG;IACH,OAFU,MAAM,uBAAqB,CAEG;IA0FxC;;;;OAIG;IACH,cAHW,yBAAyB,GACvB,OAAO,CAuBnB;CAKJ;mCAzKM,4EAA4E"}