@terraware/web-components 5.0.1-rc.0 → 5.0.1

package/components/VirtualWalkthrough/SplatModel.d.ts

@@ -20,8 +20,18 @@ export interface SplatModelProps {
     cropFade?: boolean;
     cropFadeDistance?: number;
     revealRain?: boolean;
+    /**
+     * Maximum allowable budget for splat rendering operations. Only applies to streamed sog models.
+     * A value of 0 means no limit. Left at the engine's default when omitted.
+     */
+    splatBudget?: number;
+    /**
+     * Caps the device pixel ratio the scene renders at, trading sharpness for fill rate on high-DPI
+     * displays. Left at the engine's default when omitted.
+     */
+    maxPixelRatio?: number;
     onError?: (error: Error) => void;
 }
-declare const _default: React.MemoExoticComponent<({ splatSrc, splatFormat, rotation, scaleFactor, cropAabbMin, cropAabbMax, cropEdgeScaleFactor, cropFade, cropFadeDistance, revealRain, onError, }: SplatModelProps) => import("react/jsx-runtime").JSX.Element | null>;
+declare const _default: React.MemoExoticComponent<({ splatSrc, splatFormat, rotation, scaleFactor, cropAabbMin, cropAabbMax, cropEdgeScaleFactor, cropFade, cropFadeDistance, revealRain, splatBudget, maxPixelRatio, onError, }: SplatModelProps) => import("react/jsx-runtime").JSX.Element | null>;
 export default _default;
 //# sourceMappingURL=SplatModel.d.ts.map

package/components/VirtualWalkthrough/SplatModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SplatModel.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/SplatModel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA0B,MAAM,OAAO,CAAC;AAU/C,OAAO,EAAE,WAAW,EAA0C,MAAM,eAAe,CAAC;AAEpF,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;sMAcE,eAAe;AAkClB,wBAAgC"}
+{"version":3,"file":"SplatModel.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/SplatModel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA0B,MAAM,OAAO,CAAC;AAU/C,OAAO,EAAE,WAAW,EAA0C,MAAM,eAAe,CAAC;AAEpF,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;kOAgBE,eAAe;AAgDlB,wBAAgC"}

package/components/VirtualWalkthrough/SplatModel.js

@@ -1,7 +1,7 @@
 import { memo, useEffect } from 'react';
 import { Entity } from '@playcanvas/react';
 import { GSplat } from '@playcanvas/react/components';
-import { useSplat } from '@playcanvas/react/hooks';
+import { useApp, useSplat } from '@playcanvas/react/hooks';
 import BlockingSpinner from './BlockingSpinner.js';
 import SplatCrop from './SplatCrop.js';
 import SplatFadeCrop from './SplatFadeCrop.js';
@@ -20,8 +20,12 @@ const SplatModel = ({
   cropFade = false,
   cropFadeDistance = 0.5,
   revealRain = false,
+  splatBudget,
+  maxPixelRatio,
   onError
 }) => {
+  const app = useApp();
+
   // The loader selects its parser from this filename rather than from splatSrc, so it has to name the
   // format we are actually loading. See splatFormat.ts.
   const filename = splatLoaderFilename(splatFormat ?? detectSplatFormat(splatSrc));
@@ -34,6 +38,17 @@ const SplatModel = ({
       filename
     }
   });
+  useEffect(() => {
+    if (!app) {
+      return;
+    }
+    if (splatBudget !== undefined) {
+      app.scene.gsplat.splatBudget = splatBudget;
+    }
+    if (maxPixelRatio !== undefined) {
+      app.graphicsDevice.maxPixelRatio = maxPixelRatio;
+    }
+  }, [app, splatBudget, maxPixelRatio]);
   useEffect(() => {
     if (error) {
       onError?.(new Error(error));

package/components/VirtualWalkthrough/VirtualWalkthroughViewer.d.ts

@@ -1,4 +1,5 @@
 import { AnnotationProps } from './Annotation';
+import { SplatModelProps } from './SplatModel';
 import { SplatFormat } from './splatFormat';
 /**
  * Every coordinate, distance and size in this component is world-space, in the metres an XR
@@ -30,6 +31,12 @@ export interface VirtualWalkthroughViewerProps {
      * entity alone — every other coordinate this component takes is already world-space.
      */
     scaleFactor?: number;
+    /**
+     * Overrides passed through to the splat model, for tuning things like `splatBudget` and
+     * `maxPixelRatio`. The props this component drives itself — `splatSrc`, `splatFormat`,
+     * `rotation`, `scaleFactor` and `revealRain` — take precedence over anything set here.
+     */
+    splatModelProps?: Partial<SplatModelProps>;
     annotations: AnnotationProps[];
     onSaveAnnotations: (annotations: AnnotationProps[]) => void | Promise<void>;
     editable?: boolean;
@@ -38,6 +45,6 @@ export interface VirtualWalkthroughViewerProps {
     onToggleFullScreen?: () => void;
     maxImagesPerAnnotation?: number;
 }
-declare const VirtualWalkthroughViewer: ({ splatSrc, splatFormat, origin, cameraPosition, sceneBounds, groundPlane: groundPlaneProp, skyColor, groundColor, averageCameraHeight, scaleFactor, annotations, onSaveAnnotations, editable, showFreeFly, isFullScreen, onToggleFullScreen, maxImagesPerAnnotation, }: VirtualWalkthroughViewerProps) => import("react/jsx-runtime").JSX.Element;
+declare const VirtualWalkthroughViewer: ({ splatSrc, splatFormat, origin, cameraPosition, sceneBounds, groundPlane: groundPlaneProp, skyColor, groundColor, averageCameraHeight, scaleFactor, splatModelProps, annotations, onSaveAnnotations, editable, showFreeFly, isFullScreen, onToggleFullScreen, maxImagesPerAnnotation, }: VirtualWalkthroughViewerProps) => import("react/jsx-runtime").JSX.Element;
 export default VirtualWalkthroughViewer;
 //# sourceMappingURL=VirtualWalkthroughViewer.d.ts.map

package/components/VirtualWalkthrough/VirtualWalkthroughViewer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VirtualWalkthroughViewer.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/VirtualWalkthroughViewer.tsx"],"names":[],"mappings":"AAYA,OAAmB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAgB3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAkB5C;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,8CAA8C;IAC9C,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,2FAA2F;IAC3F,WAAW,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7D,uEAAuE;IACvE,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,QAAA,MAAM,wBAAwB,GAAI,yQAkB/B,6BAA6B,4CA6X/B,CAAC;AAEF,eAAe,wBAAwB,CAAC"}
+{"version":3,"file":"VirtualWalkthroughViewer.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/VirtualWalkthroughViewer.tsx"],"names":[],"mappings":"AAYA,OAAmB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAO3D,OAAmB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAS3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAmB5C;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,8CAA8C;IAC9C,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,2FAA2F;IAC3F,WAAW,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7D,uEAAuE;IACvE,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,QAAA,MAAM,wBAAwB,GAAI,0RAmB/B,6BAA6B,4CAgY/B,CAAC;AAEF,eAAe,wBAAwB,CAAC"}

package/components/VirtualWalkthrough/VirtualWalkthroughViewer.js

@@ -24,6 +24,7 @@ import XrExitButton from './XrExitButton.js';
 import XrGazeDwell from './XrGazeDwell.js';
 import XrPointerRay from './XrPointerRay.js';
 import { XrStartPose } from './XrStartPose.js';
+import useXrRenderTuning from './useXrRenderTuning.js';
 import { WalkthroughCamera } from './walkthrough-camera.js';
 import { rayHitsInteractiveUi } from './xr-interactive-ui.js';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
@@ -59,6 +60,7 @@ const VirtualWalkthroughViewer = ({
   groundColor,
   averageCameraHeight = 0,
   scaleFactor = 1,
+  splatModelProps,
   annotations,
   onSaveAnnotations,
   editable = false,
@@ -90,6 +92,7 @@ const VirtualWalkthroughViewer = ({
     isCurrentlyInVr,
     isCurrentlyInAr
   } = useXr();
+  useXrRenderTuning();
   const sceneBoundsRadius = useMemo(() => {
     if (sceneBounds?.m !== undefined) {
       return sceneBounds.m;
@@ -250,12 +253,13 @@ const VirtualWalkthroughViewer = ({
   }), [handleAnnotationUpdate]);
   const canSave = useMemo(() => localAnnotations.every(annotation => annotation.title && annotation.title.trim() !== ''), [localAnnotations]);
   const splatModel = useMemo(() => /*#__PURE__*/jsx(SplatModel, {
+    ...splatModelProps,
     splatSrc: splatSrc,
     splatFormat: splatFormat,
     rotation: [-180, 0, 0],
     scaleFactor: scaleFactor,
     revealRain: isHighPerformance
-  }, 'splat'), [isHighPerformance, splatSrc, splatFormat, scaleFactor]);
+  }, 'splat'), [isHighPerformance, splatSrc, splatFormat, scaleFactor, splatModelProps]);
   return /*#__PURE__*/jsxs(Fragment, {
     children: [/*#__PURE__*/jsx(GradientSky, {
       topColor: skyColor || '#FFFFFF',
@@ -295,6 +299,7 @@ const VirtualWalkthroughViewer = ({
         script: TfXrNavigation,
         enabled: !isEdit,
         enableTeleport: !isCurrentlyInAr && !viewingAnnotation,
+        enableSnapVertical: false,
         isTeleportBlocked: isTeleportBlocked
       }), !isCurrentlyInXr && /*#__PURE__*/jsx(Script, {
         script: AutoRotator,

package/components/VirtualWalkthrough/useXrRenderTuning.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Holds the XR render settings in place for the duration of a session.
+ *
+ * Call this once per application. The gsplat settings it writes are scene-global, so a second
+ * caller would capture the first caller's tuned values as the state to restore, and the scene would
+ * come out of the session still tuned.
+ */
+export declare const useXrRenderTuning: () => void;
+export default useXrRenderTuning;
+//# sourceMappingURL=useXrRenderTuning.d.ts.map

package/components/VirtualWalkthrough/useXrRenderTuning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useXrRenderTuning.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/useXrRenderTuning.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,YAsC7B,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/components/VirtualWalkthrough/useXrRenderTuning.js

@@ -0,0 +1,46 @@
+import { useEffect } from 'react';
+import { useApp } from '@playcanvas/react/hooks';
+import { applyGsplatTuning, XR_FIXED_FOVEATION, restoreGsplatTuning } from './xr-render-tuning.js';
+
+/**
+ * Holds the XR render settings in place for the duration of a session.
+ *
+ * Call this once per application. The gsplat settings it writes are scene-global, so a second
+ * caller would capture the first caller's tuned values as the state to restore, and the scene would
+ * come out of the session still tuned.
+ */
+const useXrRenderTuning = () => {
+  const app = useApp();
+  useEffect(() => {
+    const xr = app.xr;
+    if (!xr) {
+      return;
+    }
+    let previous = null;
+    const restore = () => {
+      if (previous) {
+        restoreGsplatTuning(app.scene.gsplat, previous);
+        previous = null;
+      }
+    };
+    const handleStart = () => {
+      // Guards against capturing already-tuned values as the restore target if `start` ever
+      // fires again before a matching `end`.
+      if (!previous) {
+        previous = applyGsplatTuning(app.scene.gsplat);
+      }
+      // Only settable on an active session, so it cannot go in the start options alongside
+      // framebufferScaleFactor. A no-op when the presentation layer doesn't support it.
+      xr.fixedFoveation = XR_FIXED_FOVEATION;
+    };
+    xr.on('start', handleStart);
+    xr.on('end', restore);
+    return () => {
+      xr.off('start', handleStart);
+      xr.off('end', restore);
+      restore();
+    };
+  }, [app]);
+};
+
+export { useXrRenderTuning as default, useXrRenderTuning };

package/components/VirtualWalkthrough/xr-render-tuning.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Render settings applied for the duration of an XR session. Splats rasterize as alpha-blended
+ * quads with no early-z rejection, which makes a headset's stereo pixel throughput the binding
+ * constraint on framerate long before splat count is.
+ */
+/**
+ * Peripheral back-buffer resolution reduction, 0 (off) to 1 (strongest). Ineffective while MSAA is
+ * on, which is one reason the application requests `antialias: false`.
+ */
+export declare const XR_FIXED_FOVEATION = 1;
+/**
+ * The subset of `GSplatParams` this module writes. Structural rather than the PlayCanvas type so
+ * the logic can be exercised against a plain object.
+ */
+export interface GsplatTuningParams {
+    radialSorting: boolean;
+    alphaClipForward: number;
+    minPixelSize: number;
+}
+/**
+ * `radialSorting` orders splats by distance from the camera rather than by depth along its forward
+ * axis, which is the more accurate ordering when the camera rotates rather than translates. Sorting
+ * runs on a worker and so lags the view by at least a frame; head rotation dominates in a headset,
+ * where that lag is what reads as swimming.
+ *
+ * The other two trade fidelity for fill rate: `alphaClipForward` drops near-transparent splats from
+ * the forward pass, and `minPixelSize` drops splats that project to less than a few pixels.
+ */
+export declare const XR_GSPLAT_TUNING: GsplatTuningParams;
+/**
+ * Applies the XR settings, returning the values that were replaced so they can be restored when the
+ * session ends. These live on the scene, so leaving them tuned would degrade desktop rendering.
+ */
+export declare const applyGsplatTuning: (params: GsplatTuningParams) => GsplatTuningParams;
+export declare const restoreGsplatTuning: (params: GsplatTuningParams, previous: GsplatTuningParams) => void;
+//# sourceMappingURL=xr-render-tuning.d.ts.map

package/components/VirtualWalkthrough/xr-render-tuning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xr-render-tuning.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-render-tuning.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,EAAE,kBAI9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,kBAAkB,KAAG,kBAY9D,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,QAAQ,kBAAkB,EAAE,UAAU,kBAAkB,KAAG,IAI9F,CAAC"}

package/components/VirtualWalkthrough/xr-render-tuning.js

@@ -0,0 +1,54 @@
+/**
+ * Render settings applied for the duration of an XR session. Splats rasterize as alpha-blended
+ * quads with no early-z rejection, which makes a headset's stereo pixel throughput the binding
+ * constraint on framerate long before splat count is.
+ */
+
+/**
+ * Peripheral back-buffer resolution reduction, 0 (off) to 1 (strongest). Ineffective while MSAA is
+ * on, which is one reason the application requests `antialias: false`.
+ */
+const XR_FIXED_FOVEATION = 1;
+
+/**
+ * The subset of `GSplatParams` this module writes. Structural rather than the PlayCanvas type so
+ * the logic can be exercised against a plain object.
+ */
+
+/**
+ * `radialSorting` orders splats by distance from the camera rather than by depth along its forward
+ * axis, which is the more accurate ordering when the camera rotates rather than translates. Sorting
+ * runs on a worker and so lags the view by at least a frame; head rotation dominates in a headset,
+ * where that lag is what reads as swimming.
+ *
+ * The other two trade fidelity for fill rate: `alphaClipForward` drops near-transparent splats from
+ * the forward pass, and `minPixelSize` drops splats that project to less than a few pixels.
+ */
+const XR_GSPLAT_TUNING = {
+  radialSorting: true,
+  alphaClipForward: 0.1,
+  minPixelSize: 1
+};
+
+/**
+ * Applies the XR settings, returning the values that were replaced so they can be restored when the
+ * session ends. These live on the scene, so leaving them tuned would degrade desktop rendering.
+ */
+const applyGsplatTuning = params => {
+  const previous = {
+    radialSorting: params.radialSorting,
+    alphaClipForward: params.alphaClipForward,
+    minPixelSize: params.minPixelSize
+  };
+  params.radialSorting = XR_GSPLAT_TUNING.radialSorting;
+  params.alphaClipForward = XR_GSPLAT_TUNING.alphaClipForward;
+  params.minPixelSize = XR_GSPLAT_TUNING.minPixelSize;
+  return previous;
+};
+const restoreGsplatTuning = (params, previous) => {
+  params.radialSorting = previous.radialSorting;
+  params.alphaClipForward = previous.alphaClipForward;
+  params.minPixelSize = previous.minPixelSize;
+};
+
+export { XR_FIXED_FOVEATION, XR_GSPLAT_TUNING, applyGsplatTuning, restoreGsplatTuning };

package/hooks/useXr.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useXr.d.ts","sourceRoot":"","sources":["../../src/hooks/useXr.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjC,UAAU,YAAY;IACpB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAOD,eAAO,MAAM,KAAK,GAAI,cAAa,YAAiB;0BA4CT,MAAM;oBAGtC,MAAM;;;;;CA6BhB,CAAC;AAEF,eAAe,KAAK,CAAC"}
+{"version":3,"file":"useXr.d.ts","sourceRoot":"","sources":["../../src/hooks/useXr.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjC,UAAU,YAAY;IACpB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAgBD,eAAO,MAAM,KAAK,GAAI,cAAa,YAAiB;0BA4CT,MAAM;oBAGtC,MAAM;;;;;CA8BhB,CAAC;AAEF,eAAe,KAAK,CAAC"}

package/hooks/useXr.js

@@ -6,6 +6,15 @@ const XR_TYPES = {
   VR: XRTYPE_VR,
   AR: XRTYPE_AR
 };
+
+/**
+ * Factor PlayCanvas applies on top of the device pixel ratio to compute the headset's
+ * framebuffer resolution: `app.graphicsDevice.maxPixelRatio / window.devicePixelRatio *
+ * XR_FRAMEBUFFER_SCALE_FACTOR`. Splat rendering in stereo is fill-rate bound, so this (and
+ * `maxPixelRatio`, which also multiplies XR resolution) is the largest lever on XR framerate.
+ * Read once when the session starts and fixed for its lifetime.
+ */
+const XR_FRAMEBUFFER_SCALE_FACTOR = 1;
 const useXr = ({
   onError
 } = {}) => {
@@ -56,6 +65,7 @@ const useXr = ({
   const startXr = useCallback(type => {
     const camera = app.root.findComponent('camera');
     app.xr?.start(camera, XR_TYPES[type], XRSPACE_LOCALFLOOR, {
+      framebufferScaleFactor: XR_FRAMEBUFFER_SCALE_FACTOR,
       callback: err => {
         if (err) {
           onError?.(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terraware/web-components",
-  "version": "5.0.1-rc.0",
+  "version": "5.0.1",
   "author": "Terraformation Inc.",
   "license": "Apache-2.0",
   "repository": {