Deploying to gh-pages from @ df61916 🚀

CHANGELIST.md

@@ -1,5 +1,9 @@
 # Change List
 
+### 1.2.0
+
+* Add `getSizeOfUnsizedArrayElement`
+
 ### 1.1.0
 
 * Make `generateMipmap` support compatibility mode

README.md

@@ -301,12 +301,50 @@ Example:
 
 ```js
 const code = `
-@group(0) @binding(0) var<uniform> uni1: array<vec3f>;  // unsized array
+@group(0) @binding(0) var<storage> buf1: array<vec3f>;  // unsized array
 `;
 const defs = makeShaderDataDefinitions(code);
-const uni1 = makeStructuredView(defs.uniforms.uni1, new ArrayBuffer(4 * 16));
+const buf1 = makeStructuredView(defs.storages.buf1, new ArrayBuffer(4 * 16));
 
-// uni.views will be a Float32Array representing 4 vec3fs
+// buf1.views will be a Float32Array representing 4 vec3fs
+```
+
+Note: If you have a complex array element type you can call
+`getSizeOfUnsizedArrayElement` to get its size. Example:
+
+```js
+const code = `
+struct Light {
+  intensity: f32,
+  direction: vec3f,
+};
+@group(0) @binding(7) var<storage> lights: array<Light>;
+`;
+const defs = makeShaderDataDefinitions(code);
+const {size} = getSizeOfUnsizedArrayElement(defs.storages.lights);
+const numLights = 4;
+const buf1 = makeStructuredView(
+    defs.storages.lights, new ArrayBuffer(numLights * size));
+```
+
+Similarly if you are using an unsized array as the last member of a struct
+you might do this
+
+```js
+const code = `
+struct Kernel {
+  amount: f32,
+  entries: array<vec3f>,
+};
+@group(0) @binding(7) var<storage> conv: Kernel;
+`;
+const defs = makeShaderDataDefinitions(code);
+const {size: elemSize} = getSizeOfUnsizedArrayElement(defs.storages.conv);
+const numKernelEntries = 4;
+const size = defs.storages.conv.size + numKernelEntries * elemSize;
+const buf1 = makeStructuredView(
+    defs.storages.conv, new ArrayBuffer(size));
+)
 ```
 
 ## Usage

dist/1.x/buffer-views.d.ts

@@ -200,10 +200,57 @@ export declare function makeStructuredView(varDef: VariableDefinition | StructDe
 export declare function setTypedValues(typeDef: TypeDefinition, data: any, arrayBuffer: ArrayBuffer, offset?: number): void;
 /**
  * Same as @link {setTypedValues} except it takes a @link {VariableDefinition}.
- * @param typeDef A variable definition provided by @link {makeShaderDataDefinitions}
+ * @param varDef A variable definition provided by @link {makeShaderDataDefinitions}
  * @param data The source data
  * @param arrayBuffer The arrayBuffer who's data to set.
  * @param offset An offset in the arrayBuffer to start at.
  */
 export declare function setStructuredValues(varDef: VariableDefinition, data: any, arrayBuffer: ArrayBuffer, offset?: number): void;
+/**
+ * Returns the size, align, and unalignedSize of "the" unsized array element. Unsized arrays are only
+ * allowed at the outer most level or the last member of a top level struct.
+ *
+ * Example:
+ *
+ * ```js
+ * const code = `
+ * struct Foo {
+ *   a: u32,
+ *   b: array<vec3f>,
+ * };
+ * @group(0) @binding(0) var<storage> f: Foo;
+ * `;
+ * const defs = makeShaderDataDefinitions(code);
+ * const { size, align, unalignedSize } = getSizeAndAlignmentOfUnsizedArrayElement(
+ *    defs.storages.f);
+ * // size = 16   (since you need to allocate 16 bytes per element)
+ * // align = 16  (since vec3f needs to be aligned to 16 bytes)
+ * // unalignedSize = 12 (since only 12 bytes are used for a vec3f)
+ * ```
+ *
+ * Generally you only need size. Example:
+ *
+ *
+ * ```js
+ * const code = `
+ * struct Foo {
+ *   a: u32,
+ *   b: array<vec3f>,
+ * };
+ * @group(0) @binding(0) var<storage> f: Foo;
+ * `;
+ * const defs = makeShaderDataDefinitions(code);
+ * const { size } = getSizeAndAlignmentOfUnsizedArrayElement(defs.storages.f);
+ * const numElements = 10;
+ * const views = makeStructuredViews(
+ *    defs.storages.f,
+ *    new ArrayBuffer(defs.storages.f.size + size * numElements));
+ * ```
+  * @param varDef A variable definition provided by @link {makeShaderDataDefinitions}
+ * @returns the size, align, and unalignedSize in bytes of the unsized array element in this type definition.
+ */
+export declare function getSizeAndAlignmentOfUnsizedArrayElement(varDef: VariableDefinition | StructDefinition): {
+    size: number;
+    align: number;
+};
 export {};

docs/classes/TypedArrayViewGenerator.html

@@ -171,6 +171,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../functions/createTextureFromSources.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Texture<wbr/>From<wbr/>Sources</span></a></li>
 <li><a href="../functions/drawArrays.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>draw<wbr/>Arrays</span></a></li>
 <li><a href="../functions/generateMipmap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>generate<wbr/>Mipmap</span></a></li>
+<li><a href="../functions/getSizeAndAlignmentOfUnsizedArrayElement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Size<wbr/>And<wbr/>Alignment<wbr/>Of<wbr/>Unsized<wbr/>Array<wbr/>Element</span></a></li>
 <li><a href="../functions/getSizeForMipFromTexture.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Size<wbr/>For<wbr/>Mip<wbr/>From<wbr/>Texture</span></a></li>
 <li><a href="../functions/getSizeFromSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Size<wbr/>From<wbr/>Source</span></a></li>
 <li><a href="../functions/interleaveVertexData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>interleave<wbr/>Vertex<wbr/>Data</span></a></li>

docs/classes/primitives.TypedArrayWrapper.html

@@ -203,6 +203,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../functions/createTextureFromSources.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Texture<wbr/>From<wbr/>Sources</span></a></li>
 <li><a href="../functions/drawArrays.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>draw<wbr/>Arrays</span></a></li>
 <li><a href="../functions/generateMipmap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>generate<wbr/>Mipmap</span></a></li>
+<li><a href="../functions/getSizeAndAlignmentOfUnsizedArrayElement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Size<wbr/>And<wbr/>Alignment<wbr/>Of<wbr/>Unsized<wbr/>Array<wbr/>Element</span></a></li>
 <li><a href="../functions/getSizeForMipFromTexture.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Size<wbr/>For<wbr/>Mip<wbr/>From<wbr/>Texture</span></a></li>
 <li><a href="../functions/getSizeFromSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Size<wbr/>From<wbr/>Source</span></a></li>
 <li><a href="../functions/interleaveVertexData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>interleave<wbr/>Vertex<wbr/>Data</span></a></li>