Skip to content

WebGPURenderer: Add support for WebXR with WebGPU. #2182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Methuselah96 merged 4 commits into from
May 30, 2026
+89 −18
Merged

WebGPURenderer: Add support for WebXR with WebGPU. #2182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c38caa0
Update three.js
Methuselah96 May 30, 2026
9030522
Add jsdoc
Methuselah96 May 30, 2026
3d93870
Update patch and delete jsdoc
Methuselah96 May 30, 2026
a46c79c
Update declarations
Methuselah96 May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 75 additions & 13 deletions jsdoc-testing/changes.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13659,10 +13659,10 @@ index 82eedbdd9..f34d38405 100644
+
+export default TimestampQueryPool;
diff --git a/jsdoc-testing/jsdoc/src/renderers/common/XRManager.d.ts b/jsdoc-testing/jsdoc/src/renderers/common/XRManager.d.ts
index e7d43a132..cf8741d5d 100644
index 8581c09f6..fd0d845ee 100644
--- a/jsdoc-testing/jsdoc/src/renderers/common/XRManager.d.ts
+++ b/jsdoc-testing/jsdoc/src/renderers/common/XRManager.d.ts
@@ -1,4 +1,28 @@
@@ -1,11 +1,37 @@
-export default XRManager;
+import { EventDispatcher } from '../../core/EventDispatcher.js';
+import { ArrayCamera } from '../../cameras/ArrayCamera.js';
Expand All @@ -13688,11 +13688,12 @@ index e7d43a132..cf8741d5d 100644
+export interface LayerAttributes {
+ stencil?: boolean | undefined;
+}
+
+interface XRGPUBinding {}
+
/**
* The XR manager is built on top of the WebXR Device API to
* manage XR sessions with `WebGPURenderer`.
@@ -7,7 +31,7 @@ export default XRManager;
* manage XR sessions with renderer backends.
*
* @augments EventDispatcher
*/
Expand All @@ -13701,7 +13702,7 @@ index e7d43a132..cf8741d5d 100644
/**
* Constructs a new XR manager.
*
@@ -37,291 +61,6 @@ declare class XRManager extends EventDispatcher {
@@ -35,308 +61,6 @@ declare class XRManager extends EventDispatcher {
* @default true
*/
cameraAutoUpdate: boolean;
Expand Down Expand Up @@ -13804,6 +13805,7 @@ index e7d43a132..cf8741d5d 100644
- * @readonly
- */
- private readonly _supportsGlBinding;
- _supportsWebGPUBinding: boolean;
- /**
- * Helper function to create native WebXR Layer.
- *
Expand Down Expand Up @@ -13844,6 +13846,14 @@ index e7d43a132..cf8741d5d 100644
- */
- private _currentPixelRatio;
- /**
- * The renderer's sample count before XR temporarily overrides it.
- *
- * @private
- * @type {?number}
- * @default null
- */
- private _currentSamples;
- /**
- * The current size of the renderer's canvas
- * in logical pixel unit.
- *
Expand Down Expand Up @@ -13946,6 +13956,14 @@ index e7d43a132..cf8741d5d 100644
- */
- private _glBinding;
- /**
- * A reference to the current XR WebGPU binding.
- *
- * @private
- * @type {?XRGPUBinding}
- * @default null
- */
- private _webgpuBinding;
- /**
- * A reference to the current XR projection layer.
- *
- * @private
Expand Down Expand Up @@ -13993,7 +14011,7 @@ index e7d43a132..cf8741d5d 100644
/**
* Returns an instance of `THREE.Group` that represents the transformation
* of a XR controller in target ray space. The requested controller is defined
@@ -330,7 +69,7 @@ declare class XRManager extends EventDispatcher {
@@ -345,7 +69,7 @@ declare class XRManager extends EventDispatcher {
* @param {number} index - The index of the XR controller.
* @return {Group} A group that represents the controller's transformation.
*/
Expand All @@ -14002,7 +14020,7 @@ index e7d43a132..cf8741d5d 100644
/**
* Returns an instance of `THREE.Group` that represents the transformation
* of a XR controller in grip space. The requested controller is defined
@@ -339,7 +78,7 @@ declare class XRManager extends EventDispatcher {
@@ -354,7 +78,7 @@ declare class XRManager extends EventDispatcher {
* @param {number} index - The index of the XR controller.
* @return {Group} A group that represents the controller's transformation.
*/
Expand All @@ -14011,7 +14029,7 @@ index e7d43a132..cf8741d5d 100644
/**
* Returns an instance of `THREE.Group` that represents the transformation
* of a XR controller in hand space. The requested controller is defined
@@ -348,7 +87,7 @@ declare class XRManager extends EventDispatcher {
@@ -363,7 +87,7 @@ declare class XRManager extends EventDispatcher {
* @param {number} index - The index of the XR controller.
* @return {Group} A group that represents the controller's transformation.
*/
Expand All @@ -14020,7 +14038,7 @@ index e7d43a132..cf8741d5d 100644
/**
* Returns the foveation value.
*
@@ -413,7 +152,7 @@ declare class XRManager extends EventDispatcher {
@@ -428,7 +152,7 @@ declare class XRManager extends EventDispatcher {
*
* @return {'opaque'|'additive'|'alpha-blend'|undefined} The environment blend mode. Returns `undefined` when used outside of a XR session.
*/
Expand All @@ -14029,7 +14047,50 @@ index e7d43a132..cf8741d5d 100644
/**
* Returns the current base layer.
*
@@ -469,7 +208,7 @@ declare class XRManager extends EventDispatcher {
@@ -466,42 +190,6 @@ declare class XRManager extends EventDispatcher {
* @return {?XRGPUBinding} The XR WebGPU binding. Returns `null` if one cannot be created.
*/
getWebGPUBinding(): XRGPUBinding | null;
- /**
- * Returns whether the current XR session is using WebGPU.
- *
- * @private
- * @return {boolean} Whether the current session uses the WebGPU backend and the `webgpu` session feature.
- */
- private _isWebGPUSession;
- /**
- * Validates the current WebGPU XR session requirements.
- *
- * @private
- */
- private _validateWebGPUSession;
- /**
- * Initializes the WebGPU XR projection layer and render target.
- *
- * @private
- * @async
- * @param {XRSession} session - The XR session.
- * @return {Promise<void>}
- */
- private _initWebGPUSession;
- /**
- * Releases WebGPU XR resources associated with the current session.
- *
- * @private
- */
- private _disposeWebGPUSession;
- /**
- * Collects WebGPU XR sub-image data for the current frame.
- *
- * @private
- * @param {Array<XRView>} views - The XR views for the current pose.
- * @return {{colorTexture:?GPUTexture, viewDescriptors:Array<Object>, viewports:Array<XRViewport>}} The WebGPU XR view data.
- */
- private _getWebGPUViewData;
/**
* Returns the current XR frame.
*
@@ -529,7 +217,7 @@ declare class XRManager extends EventDispatcher {
* @param {Object} [attributes={}] - Allows to configure the layer's render target.
* @return {Mesh} A mesh representing the quadratic XR layer. This mesh should be added to the XR scene.
*/
Expand All @@ -14038,7 +14099,7 @@ index e7d43a132..cf8741d5d 100644
/**
* This method can be used in XR applications to create a cylindrical layer that presents a separate
* rendered scene.
@@ -486,7 +225,7 @@ declare class XRManager extends EventDispatcher {
@@ -546,7 +234,7 @@ declare class XRManager extends EventDispatcher {
* @param {Object} [attributes={}] - Allows to configure the layer's render target.
* @return {Mesh} A mesh representing the cylindrical XR layer. This mesh should be added to the XR scene.
*/
Expand All @@ -14047,7 +14108,7 @@ index e7d43a132..cf8741d5d 100644
/**
* Renders the XR layers that have been previously added to the scene.
*
@@ -509,7 +248,7 @@ declare class XRManager extends EventDispatcher {
@@ -569,7 +257,7 @@ declare class XRManager extends EventDispatcher {
* @param {XRSession} session - The XR session to set.
* @return {Promise} A Promise that resolves when the session has been set.
*/
Expand All @@ -14056,7 +14117,7 @@ index e7d43a132..cf8741d5d 100644
/**
* This method is called by the renderer per frame and updates the XR camera
* and it sub cameras based on the given camera. The given camera is the "user"
@@ -518,18 +257,6 @@ declare class XRManager extends EventDispatcher {
@@ -578,19 +266,6 @@ declare class XRManager extends EventDispatcher {
* @param {PerspectiveCamera} camera - The camera.
*/
updateCamera(camera: PerspectiveCamera): void;
Expand All @@ -14071,6 +14132,7 @@ index e7d43a132..cf8741d5d 100644
}
-import { EventDispatcher } from '../../core/EventDispatcher.js';
-import { ArrayCamera } from '../../cameras/ArrayCamera.js';
-import { RenderTarget } from '../../core/RenderTarget.js';
-import { Vector3 } from '../../math/Vector3.js';
-import { Quaternion } from '../../math/Quaternion.js';
-import { Mesh } from '../../objects/Mesh.js';
Expand Down
2 changes: 1 addition & 1 deletion three.js
Open in desktop
Submodule three.js updated 23 files
+9 −2 editor/js/Menubar.Add.js
+11 −1 editor/js/Menubar.Edit.js
+14 −3 editor/js/Sidebar.Settings.Shortcuts.js
+14 −0 editor/js/Viewport.js
+16 −6 examples/jsm/exporters/USDZExporter.js
+37 −13 examples/jsm/loaders/usd/USDAParser.js
+2 −2 examples/jsm/tsl/display/DepthOfFieldNode.js
+32 −14 examples/jsm/webxr/WebGLXRFallback.js
+1 −1 examples/webgpu_xr_cubes.html
+1 −1 examples/webgpu_xr_rollercoaster.html
+1 −1 src/materials/nodes/NodeMaterial.js
+3 −2 src/nodes/core/MRTNode.js
+59 −6 src/nodes/core/NodeBuilder.js
+1 −1 src/nodes/core/OutputStructNode.js
+15 −1 src/nodes/core/PropertyNode.js
+9 −0 src/renderers/common/Backend.js
+268 −26 src/renderers/common/XRManager.js
+3 −3 src/renderers/webgl-fallback/nodes/GLSLNodeBuilder.js
+100 −3 src/renderers/webgpu/WebGPUBackend.js
+2 −2 src/renderers/webgpu/nodes/WGSLNodeBuilder.js
+1 −1 src/renderers/webgpu/utils/WebGPUBindingUtils.js
+7 −0 src/renderers/webgpu/utils/WebGPUTextureUtils.js
+1 −0 test/e2e/puppeteer.js
17 changes: 13 additions & 4 deletions types/three/src/renderers/common/XRManager.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ export interface LayerAttributes {
stencil?: boolean | undefined;
}

interface XRGPUBinding {}

/**
* The XR manager is built on top of the WebXR Device API to
* manage XR sessions with `WebGPURenderer`.
*
* XR is currently only supported with a WebGL 2 backend.
* manage XR sessions with renderer backends.
*
* @augments EventDispatcher
*/
Expand Down Expand Up @@ -91,7 +91,7 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
/**
* Returns the foveation value.
*
* @return {number|undefined} The foveation value. Returns `undefined` if no base or projection layer is defined.
* @return {number|undefined} The foveation value.
*/
getFoveation(): number | undefined;
/**
Expand Down Expand Up @@ -181,6 +181,15 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
* @param {RenderTarget} renderTarget - The internal render target.
*/
foveateBoundTexture(renderTarget: RenderTarget): void;
/**
* Returns the current XR WebGPU binding.
*
* Creates a new binding if needed and the browser is
* capable of doing so.
*
* @return {?XRGPUBinding} The XR WebGPU binding. Returns `null` if one cannot be created.
*/
getWebGPUBinding(): XRGPUBinding | null;
/**
* Returns the current XR frame.
*
Expand Down
Loading