大网数据广告活动
Web 标准与前端开发

XRSession: requestHitTestSource() method

· 52CE 我爱测

The **`requestHitTestSource()`** method of the XRSession interface returns a Promise that resolves with an XRHitTestSource object that can be passed to XRFrame.getHitTestResults().

WebXR Device API

The requestHitTestSource() method of the XRSession interface returns a Promise that resolves with an XRHitTestSource object that can be passed to XRFrame.getHitTestResults().

Syntax

requestHitTestSource(options)

Parameters

  • options
    • : An object containing configuration options, specifically:
      • space
        • : The XRSpace that will be tracked by the hit test source.
      • entityTypes
        • : An Array specifying the types of entities to be used for hit test source creation. If no entity type is specified, the array defaults to a single element with the plane type. Possible types:
          • point: Compute hit test results based on characteristic points detected.
          • plane: Compute hit test results based on real-world planes detected.
          • mesh: Compute hit test results based on meshes detected.
      • offsetRay
        • : The XRRay object that will be used to perform hit test. If no XRRay object has been provided, a new XRRay object is constructed without any parameters.

Return value

A Promise that resolves with an XRHitTestSource object.

Exceptions

Rather than throwing true exceptions, requestHitTestSource() rejects the returned promise with a DOMException, specifically, one of the following:

  • NotSupportedError DOMException
    • : Thrown if hit-test is not an enabled feature in XRSystem.requestSession().
  • InvalidStateError DOMException
    • : Thrown if the session has already ended.
  • NotAllowedError DOMException
    • : Thrown if there is an unreasonable number of requests. Some user agents might limit usage for privacy reasons.

Examples

Requesting a hit test source

To request a hit test source, start an XRSession with the hit-test session feature enabled. Next, configure the hit test source and store it for later use in the frame loop and call XRFrame.getHitTestResults() to obtain the result.

const xrSession = navigator.xr.requestSession("immersive-ar", {
  requiredFeatures: ["local", "hit-test"],
});

let hitTestSource = null;

xrSession
  .requestHitTestSource({
    space: viewerSpace, // obtained from xrSession.requestReferenceSpace("viewer");
    offsetRay: new XRRay({ y: 0.5 }),
  })
  .then((viewerHitTestSource) => {
    hitTestSource = viewerHitTestSource;
  });

// frame loop
function onXRFrame(time, xrFrame) {
  let hitTestResults = xrFrame.getHitTestResults(hitTestSource);

  // do things with the hit test results
}

Specifications

Browser compatibility

See also

  • XRSession.requestHitTestSourceForTransientInput()

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。