react-native-webgpu 0.13.1 → 0.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-webgpu",
-  "version": "0.13.1",
+  "version": "0.14.1",
   "description": "React Native WebGPU",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -82,7 +82,7 @@
     "clang-format": "^1.8.0",
     "del-cli": "^5.1.0",
     "eslint": "9.35.0",
-    "eslint-config-react-native-wcandillon": "5.0.0",
+    "eslint-config-react-native-wcandillon": "5.0.1",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-jest": "^28.8.2",
     "eslint-plugin-prettier": "^5.2.1",

package/src/external/reanimated/registerWebGPUForReanimated.ts

@@ -1,9 +1,25 @@
-// Declare global WebGPU worklet helper functions (installed by native module)
-declare function __webgpuIsWebGPUObject(obj: unknown): boolean;
-declare function __webgpuBox(obj: object): {
+// The native half of the serializer (WebGPUWorkletHelpers in
+// cpp/jsi/NativeObject.h), installed on the main runtime by the native module.
+// determine/pack capture it by closure, and worklets hands a HostObject to
+// every runtime by reference, so the serializer works wherever a WebGPU object
+// is captured (Reanimated UI runtime, createWorkletRuntime, Vision Camera frame
+// processors) without installing anything on those runtimes.
+interface WebGPUWorkletHelpers {
+  // True only for WebGPU objects (their NativeState is a WebGPU class). Other
+  // native-state objects, such as Skia's, and objects merely inheriting from a
+  // WebGPU prototype are rejected, and no JS property is ever read.
+  isNativeObject: (value: unknown) => boolean;
+  box: (value: object) => BoxedWebGPUObject;
+}
+
+interface BoxedWebGPUObject {
   unbox: () => object;
   __boxedWebGPU: true;
-};
+}
+
+declare global {
+  var __webgpuWorkletHelpers: WebGPUWorkletHelpers | undefined;
+}
 
 let isRegistered = false;
 
@@ -19,6 +35,12 @@ export const registerWebGPUForReanimated = () => {
   }
   isRegistered = true;
 
+  const helpers = globalThis.__webgpuWorkletHelpers;
+  if (helpers === undefined) {
+    // The native module is not installed (web, node): nothing to serialize.
+    return;
+  }
+
   try {
     const { registerCustomSerializable } = require("react-native-worklets");
 
@@ -26,13 +48,13 @@ export const registerWebGPUForReanimated = () => {
       name: "WebGPU",
       determine: (value: object): value is object => {
         "worklet";
-        return __webgpuIsWebGPUObject(value);
+        return helpers.isNativeObject(value);
       },
       pack: (value: object) => {
         "worklet";
-        return __webgpuBox(value);
+        return helpers.box(value);
       },
-      unpack: (boxed: { unbox: () => object }) => {
+      unpack: (boxed: BoxedWebGPUObject) => {
         "worklet";
         return boxed.unbox();
       },

package/src/types.ts

@@ -204,10 +204,17 @@ export interface GPUSharedFenceExportInfo {
 export interface GPUSharedFence {
   readonly __brand: "GPUSharedFence";
   label: string;
+  // Throws, after a validation error says why, if the fence was destroyed or
+  // Dawn can't export it.
   export(): GPUSharedFenceExportInfo;
+  // Releases the fence now (closing its sync fd on Android) rather than when
+  // the object is garbage collected. A later use is a validation error, and
+  // export() and beginAccess() then throw.
+  destroy(): void;
 }
 
-// A fence and the timeline value to wait for (0n for binary sync-fd fences).
+// A fence and the timeline value to wait for. Binary fences (sync-fd on
+// Vulkan) must use 1n: Dawn rejects any other value.
 export interface GPUSharedFenceState {
   fence: GPUSharedFence;
   signaledValue: bigint;
@@ -252,4 +259,10 @@ export interface GPUSharedTextureMemory {
   // Ends the access and returns the fences Dawn produced for it. Throws if the
   // access could not be ended.
   endAccess(texture: GPUTexture): GPUSharedTextureMemoryEndAccessState;
+  // Releases the memory (the imported native buffer) now rather than when the
+  // object is garbage collected. End the access first (a destroy() during one
+  // is a validation error, and the access stays open) and destroy the textures
+  // created from it. A later use is a validation error: createTexture() then
+  // returns an invalid texture, beginAccess() and endAccess() throw.
+  destroy(): void;
 }