@covas-labs/electron-vr 0.3.2 → 0.4.3

package/README.md

@@ -53,6 +53,7 @@ app.on("ready", async () => {
   overlay = await VROverlay.openWindow(window, {
     name: "Status_HUD",
     sizeMeters: 1,
+    curvature: 0,
     placement: {
       mode: "head",
       position: { x: 0, y: 0, z: -1.2 },
@@ -62,9 +63,9 @@ app.on("ready", async () => {
 });
 ```
 
-You can also reposition the overlay later with `overlay.setPlacement(...)`, toggle it with `overlay.setVisible(...)`, and resize it in meters with `overlay.setSizeMeters(...)`.
+You can also reposition the overlay later with `overlay.setPlacement(...)`, toggle it with `overlay.setVisible(...)`, resize it in meters with `overlay.setSizeMeters(...)`, and curve it with `overlay.setCurvature(...)`.
 
-`sizeMeters` must be greater than zero, and placement values should be finite numbers.
+`sizeMeters` must be greater than zero, `curvature` must be between `0` and `1`, and placement values should be finite numbers. `curvature: 0` keeps the overlay flat. Positive curvature uses OpenVR overlay curvature on OpenVR and `XR_KHR_composition_layer_cylinder` cylinder layers on OpenXR.
 
 On Linux, runtime selection prefers `openxr`, then falls back to `openvr`, then to `mock`. Linux OpenVR is treated as a best-effort alternate backend when a compatible OpenVR runtime is installed but the OpenXR overlay path is unavailable or disabled. It is not currently validated end to end on the main development machine or in CI.
 

package/dist/VROverlay.d.ts

@@ -12,6 +12,7 @@ export interface VROverlayOptions {
     frameRate?: number;
     windowOptions?: OverlayWindowOptions;
     sizeMeters?: number;
+    curvature?: number;
     visible?: boolean;
     placement?: {
         mode: "head" | "world";
@@ -23,6 +24,7 @@ export interface ExistingWindowVROverlayOptions {
     name?: string;
     frameRate?: number;
     sizeMeters?: number;
+    curvature?: number;
     visible?: boolean;
     placement?: VROverlayOptions["placement"];
 }
@@ -34,6 +36,7 @@ export declare class VROverlay {
     readonly frameRate: number;
     readonly windowOptions?: VROverlayOptions["windowOptions"];
     private sizeMeters;
+    private curvature;
     private visible;
     private placement;
     private readonly vrBridge;
@@ -54,6 +57,7 @@ export declare class VROverlay {
     setPlacement(placement: VROverlayOptions["placement"]): boolean;
     setVisible(visible: boolean): boolean;
     setSizeMeters(sizeMeters: number): boolean;
+    setCurvature(curvature: number): boolean;
     private initializeBridgeForWindow;
     private readonly onWindowClosed;
 }

package/dist/VROverlay.js

@@ -1,6 +1,6 @@
 import { app, BrowserWindow } from "electron";
 import { createVrBridge } from "./bridge.js";
-import { assertSizeMeters, normalizePlacement } from "./overlayOptions.js";
+import { assertCurvature, assertSizeMeters, normalizePlacement } from "./overlayOptions.js";
 function mergeWindowOptions(width, height, windowOptions) {
     const requestedOffscreen = windowOptions?.webPreferences?.offscreen;
     const normalizedOffscreen = typeof requestedOffscreen === "object"
@@ -35,6 +35,7 @@ export class VROverlay {
     frameRate;
     windowOptions;
     sizeMeters;
+    curvature;
     visible;
     placement;
     vrBridge = createVrBridge();
@@ -50,6 +51,8 @@ export class VROverlay {
         this.windowOptions = options.windowOptions;
         this.sizeMeters = options.sizeMeters ?? 1.0;
         assertSizeMeters(this.sizeMeters);
+        this.curvature = options.curvature ?? 0.0;
+        assertCurvature(this.curvature);
         this.visible = options.visible ?? true;
         this.placement = normalizePlacement(options.placement);
     }
@@ -70,6 +73,7 @@ export class VROverlay {
             height,
             frameRate: options.frameRate,
             sizeMeters: options.sizeMeters,
+            curvature: options.curvature,
             visible: options.visible,
             placement: options.placement
         });
@@ -174,12 +178,25 @@ export class VROverlay {
         }
         return success;
     }
+    setCurvature(curvature) {
+        assertCurvature(curvature);
+        this.curvature = curvature;
+        if (!this.isInitialized()) {
+            return true;
+        }
+        const success = this.vrBridge.setOverlayCurvature(curvature);
+        if (!success) {
+            console.error("Failed to update VR overlay curvature:", this.vrBridge.getLastError());
+        }
+        return success;
+    }
     initializeBridgeForWindow(window, width, height) {
         const initialized = this.vrBridge.initialize({
             name: this.overlayName,
             width,
             height,
             sizeMeters: this.sizeMeters,
+            curvature: this.curvature,
             visible: this.visible,
             placement: this.placement
         });

package/dist/bridge.d.ts

@@ -45,6 +45,7 @@ export interface InitializeVROptions {
     width: number;
     height: number;
     sizeMeters: number;
+    curvature?: number;
     visible: boolean;
     placement: OverlayPlacement;
 }
@@ -105,6 +106,7 @@ export declare class VrBridge {
     setOverlayPlacement(placement: OverlayPlacement): boolean;
     setOverlayVisible(visible: boolean): boolean;
     setOverlaySizeMeters(sizeMeters: number): boolean;
+    setOverlayCurvature(curvature: number): boolean;
     shutdown(): void;
     isInitialized(): boolean;
     getLastError(): string | null;

package/dist/bridge.js

@@ -209,6 +209,9 @@ export class VrBridge {
     setOverlaySizeMeters(sizeMeters) {
         return this.addon.setOverlaySizeMeters(sizeMeters);
     }
+    setOverlayCurvature(curvature) {
+        return this.addon.setOverlayCurvature(curvature);
+    }
     shutdown() {
         this.detachWindow();
         this.addon.shutdownVR();

package/dist/overlayOptions.d.ts

@@ -8,4 +8,5 @@ export declare function isFiniteNumber(value: number): boolean;
 export declare function assertVec3(value: Vec3, context: string): void;
 export declare function assertQuat(value: Quat, context: string): void;
 export declare function assertSizeMeters(sizeMeters: number): void;
+export declare function assertCurvature(curvature: number): void;
 export declare function normalizePlacement(placement?: OverlayPlacementInput): OverlayPlacement;

package/dist/overlayOptions.js

@@ -16,6 +16,11 @@ export function assertSizeMeters(sizeMeters) {
         throw new RangeError("sizeMeters must be a finite number greater than zero.");
     }
 }
+export function assertCurvature(curvature) {
+    if (!isFiniteNumber(curvature) || curvature < 0 || curvature > 1) {
+        throw new RangeError("curvature must be a finite number between 0 and 1.");
+    }
+}
 export function normalizePlacement(placement) {
     const mode = placement?.mode ?? "head";
     if (mode !== "head" && mode !== "world") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@covas-labs/electron-vr",
-  "version": "0.3.2",
+  "version": "0.4.3",
   "description": "Electron VR overlay bridge with OpenXR, OpenVR, and mock fallback backends.",
   "repository": {
     "type": "git",
@@ -22,8 +22,8 @@
     "electron": ">=37"
   },
   "optionalDependencies": {
-    "@covas-labs/electron-vr-prebuilt-linux-x64": "0.3.2",
-    "@covas-labs/electron-vr-prebuilt-win32-x64": "0.3.2"
+    "@covas-labs/electron-vr-prebuilt-linux-x64": "0.4.3",
+    "@covas-labs/electron-vr-prebuilt-win32-x64": "0.4.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",