zincjs 2.4.1-beta.6 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zincjs",
-  "version": "2.4.1-beta.6",
+  "version": "3.0.0",
   "description": "ZincJS (Web-based-Zinc-Visualisation)",
   "type": "module",
   "main": "build/zinc.js",
@@ -49,7 +49,8 @@
   },
   "homepage": "http://alan-wu.github.io/ZincJS/",
   "allowScripts": {
-    "msw@2.14.6": true
+    "msw@2.14.6": true,
+    "webgpu@0.4.0": true
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^4.1.11",

package/src/primitives/glyphset.js

@@ -3,7 +3,8 @@ import { Glyph } from './glyph';
 import { ZincObject } from './zincObject';
 import { updateWorldMatrixFromAncestors } from '../utilities';
 import { JSONLoader } from '../loaders/JSONLoader';
-import { createGlyphTransformCompute, dispatchAndReadbackGlyphTransform, readbackGlyphTransform } from '../tsl/glyphTransform';
+import { createGlyphTransformCompute, dispatchAndReadbackGlyphTransform, isGlyphComputeSupported,
+  readbackGlyphTransform } from '../tsl/glyphTransform';
 import { createGlyphInstancedMaterial } from '../tsl/glyphRenderMaterial';
 
 /**
@@ -176,7 +177,9 @@ const Glyphset = function () {
     offset = glyphsetData.metadata.offset;
     scaleFactors = glyphsetData.metadata.scale_factors;
     glyphCompute = undefined;
-    if (morphVertices && numberOfTimeSteps > 1 && positions && positions["0"]) {
+    //The CPU path is used when the backend does not support GPU compute
+    if (morphVertices && numberOfTimeSteps > 1 && positions && positions["0"] &&
+      isGlyphComputeSupported()) {
       const baseCount = positions["0"].length / 3;
       try {
         glyphCompute = createGlyphTransformCompute({
@@ -699,6 +702,15 @@ const Glyphset = function () {
     }
   };
 
+  /**
+   * Check if the glyph transforms are animated on the GPU.
+   *
+   * @return {Boolean}
+   */
+  this.isUsingGPUCompute = () => {
+    return glyphCompute !== undefined;
+  }
+
   /**
    * Get the assigned label for instance at index
    */

package/src/renderer.js

@@ -3,6 +3,7 @@ import { ResizeSensor } from 'css-element-queries';
 import { Scene } from './scene';
 import { onRenderRequest, offRenderRequest } from './renderRequests';
 import { setTextPixelsPerUnit } from './textSprite';
+import { setGlyphComputeSupported } from './tsl/glyphTransform';
 /**
  * Create a Zinc 3D renderer in the container provided.
  * The primary function of a Zinc 3D renderer is to display the current
@@ -173,6 +174,9 @@ const Renderer = function (containerIn) {
       }
 			renderer = new THREE.WebGPURenderer(parameters);
       await renderer.init();
+      //GPU glyph animation requires the WebGPU backend, the WebGL fallback
+      //cannot index storage buffers freely.
+      setGlyphComputeSupported(renderer.backend?.isWebGPUBackend === true);
 
       //renderer = new THREE.WebGLRenderer(parameters);
 			if (container !== undefined) {

package/src/tsl/glyphTransform.js

@@ -334,4 +334,25 @@ async function dispatchAndReadbackGlyphTransform(renderer, glyphCompute) {
   return readbackGlyphTransform(renderer, glyphCompute);
 }
 
-export { createGlyphTransformCompute, dispatchAndReadbackGlyphTransform, readbackGlyphTransform, REPEAT_MODE };
+/*
+ * The GPU glyph transforms read storage buffers at arbitrary indices, which
+ * the WebGL fallback backend of WebGPURenderer does not support (it turns
+ * them into plain vertex attributes). The renderer sets this when it is
+ * initialised, glyphsets use the CPU animation path when it is false.
+ */
+let glyphComputeSupported = true;
+
+const setGlyphComputeSupported = (flag) => {
+  glyphComputeSupported = flag ? true : false;
+}
+
+const isGlyphComputeSupported = () => glyphComputeSupported;
+
+export {
+  createGlyphTransformCompute,
+  dispatchAndReadbackGlyphTransform,
+  isGlyphComputeSupported,
+  readbackGlyphTransform,
+  setGlyphComputeSupported,
+  REPEAT_MODE,
+};