move await and bytestojs to separate jsx package

Author: rcoreilly

jsx/jsx.go

@@ -0,0 +1,52 @@
+//go:build js
+
+// Package jsx provides essential JavaScript functions that are used
+// widely in wgpu and are very useful for an wasm / js application.
+package jsx
+
+import (
+	"log/slog"
+	"syscall/js"
+	"unsafe"
+)
+
+// BytesToJS converts the given bytes to a js Uint8ClampedArray
+// by using the global wasm memory bytes. This avoids the
+// copying present in [js.CopyBytesToJS].
+func BytesToJS(b []byte) js.Value {
+	ptr := uintptr(unsafe.Pointer(&b[0]))
+	// We directly pass the offset and length to the constructor to avoid calling subarray or slice,
+	// thereby improving performance and safety (this fixes a detached array buffer crash).
+	return js.Global().Get("Uint8ClampedArray").New(js.Global().Get("wasm").Get("instance").Get("exports").Get("mem").Get("buffer"), ptr, len(b))
+}
+
+// Await is a helper function equivalent to await in JS.
+// It is copied from https://go-review.googlesource.com/c/go/+/150917/
+func Await(promise js.Value) (result js.Value, ok bool) {
+	if promise.Type() != js.TypeObject || promise.Get("then").Type() != js.TypeFunction {
+		return promise, true
+	}
+
+	done := make(chan struct{})
+
+	onResolve := js.FuncOf(func(this js.Value, args []js.Value) any {
+		result = args[0]
+		ok = true
+		close(done)
+		return nil
+	})
+	defer onResolve.Release()
+
+	onReject := js.FuncOf(func(this js.Value, args []js.Value) any {
+		result = args[0]
+		ok = false
+		slog.Error("wgpu.AwaitJS: promise rejected", "reason", result)
+		close(done)
+		return nil
+	})
+	defer onReject.Release()
+
+	promise.Call("then", onResolve, onReject)
+	<-done
+	return
+}

wgpu/adapter_js.go

@@ -5,6 +5,8 @@ package wgpu
 import (
 	"fmt"
 	"syscall/js"
+
+	"github.com/cogentcore/webgpu/jsx"
 )
 
 // Adapter as described:
@@ -14,7 +16,7 @@ type Adapter struct {
 }
 
 func (g Adapter) RequestDevice(descriptor *DeviceDescriptor) (*Device, error) {
-	device, ok := AwaitJS(g.jsValue.Call("requestDevice", pointerToJS(descriptor)))
+	device, ok := jsx.Await(g.jsValue.Call("requestDevice", pointerToJS(descriptor)))
 	if !ok || !device.Truthy() {
 		return nil, fmt.Errorf("no WebGPU device avaliable")
 	}

wgpu/buffer_js.go

@@ -2,7 +2,11 @@
 
 package wgpu
 
-import "syscall/js"
+import (
+	"syscall/js"
+
+	"github.com/cogentcore/webgpu/jsx"
+)
 
 // Buffer as described:
 // https://gpuweb.github.io/gpuweb/#gpubuffer
@@ -32,7 +36,7 @@ func (g Buffer) GetMappedRange(offset, size uint) []byte {
 }
 
 func (g Buffer) MapAsync(mode MapMode, offset uint64, size uint64, callback BufferMapCallback) (err error) {
-	AwaitJS(g.jsValue.Call("mapAsync", uint32(mode), offset, size))
+	jsx.Await(g.jsValue.Call("mapAsync", uint32(mode), offset, size))
 	callback(BufferMapAsyncStatusSuccess) // TODO(kai): is this the right thing to do?
 	return
 }

wgpu/device_ext_js.go

@@ -2,7 +2,9 @@
 
 package wgpu
 
-import "syscall/js"
+import (
+	"syscall/js"
+)
 
 // TODO(kai): this only needs to be separate for js because
 // [Buffer.GetMappedRange] does not work correctly without GopherJS.

wgpu/instance_js.go

@@ -6,6 +6,8 @@ import (
 	"fmt"
 	"log"
 	"syscall/js"
+
+	"github.com/cogentcore/webgpu/jsx"
 )
 
 // Instance as described:
@@ -25,7 +27,7 @@ func CreateInstance(descriptor *InstanceDescriptor) *Instance {
 }
 
 func (g Instance) RequestAdapter(options *RequestAdapterOptions) (*Adapter, error) {
-	adapter, ok := AwaitJS(g.jsValue.Call("requestAdapter", pointerToJS(options)))
+	adapter, ok := jsx.Await(g.jsValue.Call("requestAdapter", pointerToJS(options)))
 	if !ok || !adapter.Truthy() {
 		return nil, fmt.Errorf("no WebGPU adapter avaliable")
 	}

wgpu/queue_js.go

@@ -4,6 +4,8 @@ package wgpu
 
 import (
 	"syscall/js"
+
+	"github.com/cogentcore/webgpu/jsx"
 )
 
 // Queue as described:
@@ -28,21 +30,21 @@ func (g Queue) Submit(commandBuffers ...*CommandBuffer) {
 // WriteBuffer as described:
 // https://gpuweb.github.io/gpuweb/#dom-gpuqueue-writebuffer
 func (g Queue) WriteBuffer(buffer *Buffer, offset uint64, data []byte) (err error) {
-	g.jsValue.Call("writeBuffer", pointerToJS(buffer), offset, BytesToJS(data), uint64(0), len(data))
+	g.jsValue.Call("writeBuffer", pointerToJS(buffer), offset, jsx.BytesToJS(data), uint64(0), len(data))
 	return
 }
 
 // WriteTexture as described:
 // https://gpuweb.github.io/gpuweb/#dom-gpuqueue-writetexture
 func (g Queue) WriteTexture(destination *ImageCopyTexture, data []byte, dataLayout *TextureDataLayout, writeSize *Extent3D) (err error) {
-	g.jsValue.Call("writeTexture", pointerToJS(destination), BytesToJS(data), pointerToJS(dataLayout), pointerToJS(writeSize))
+	g.jsValue.Call("writeTexture", pointerToJS(destination), jsx.BytesToJS(data), pointerToJS(dataLayout), pointerToJS(writeSize))
 	return
 }
 
 // OnSubmittedWorkDone as described:
 // https://gpuweb.github.io/gpuweb/#dom-gpuqueue-onsubmittedworkdone
 func (g Queue) OnSubmittedWorkDone(callback QueueWorkDoneCallback) {
-	AwaitJS(g.jsValue.Call("onSubmittedWorkDone")) // TODO(kai): is this correct?
+	jsx.Await(g.jsValue.Call("onSubmittedWorkDone")) // TODO(kai): is this correct?
 	callback(QueueWorkDoneStatusSuccess)
 }
 

wgpu/util_js.go

@@ -2,22 +2,6 @@
 
 package wgpu
 
-import (
-	"log/slog"
-	"syscall/js"
-	"unsafe"
-)
-
-// BytesToJS converts the given bytes to a js Uint8ClampedArray
-// by using the global wasm memory bytes. This avoids the
-// copying present in [js.CopyBytesToJS].
-func BytesToJS(b []byte) js.Value {
-	ptr := uintptr(unsafe.Pointer(&b[0]))
-	// We directly pass the offset and length to the constructor to avoid calling subarray or slice,
-	// thereby improving performance and safety (this fixes a detached array buffer crash).
-	return js.Global().Get("Uint8ClampedArray").New(js.Global().Get("wasm").Get("instance").Get("exports").Get("mem").Get("buffer"), ptr, len(b))
-}
-
 // mapSlice can be used to transform one slice into another by providing a
 // function to do the mapping.
 func mapSlice[S, T any](slice []S, fn func(S) T) []T {
@@ -31,37 +15,6 @@ func mapSlice[S, T any](slice []S, fn func(S) T) []T {
 	return result
 }
 
-// AwaitJS is a helper function equivalent to await in JS.
-// It is copied from https://go-review.googlesource.com/c/go/+/150917/
-func AwaitJS(promise js.Value) (result js.Value, ok bool) {
-	if promise.Type() != js.TypeObject || promise.Get("then").Type() != js.TypeFunction {
-		return promise, true
-	}
-
-	done := make(chan struct{})
-
-	onResolve := js.FuncOf(func(this js.Value, args []js.Value) any {
-		result = args[0]
-		ok = true
-		close(done)
-		return nil
-	})
-	defer onResolve.Release()
-
-	onReject := js.FuncOf(func(this js.Value, args []js.Value) any {
-		result = args[0]
-		ok = false
-		slog.Error("wgpu.AwaitJS: promise rejected", "reason", result)
-		close(done)
-		return nil
-	})
-	defer onReject.Release()
-
-	promise.Call("then", onResolve, onReject)
-	<-done
-	return
-}
-
 // no-ops
 func SetLogLevel(level LogLevel) {}
 func GetVersion() Version        { return 0 }