XRSession: domOverlayState 属性

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

实验性: 这是一项实验性技术
在生产中使用此技术之前,请仔细检查浏览器兼容性表格

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

immersive-ar XRSession只读 domOverlayState 属性提供了有关 DOM 覆盖的信息(如果该功能已启用)。

如果 DOM 覆盖功能不受支持或未启用,则返回 null,否则返回一个包含 DOM 覆盖状态信息的对象,该对象具有以下属性:

type

一个指示 DOM 覆盖显示方式的字符串。可能的值:

screen

覆盖绘制在整个基于屏幕的设备上(适用于手持 AR 设备)。

head-locked

覆盖绘制在以头部为中心的用户界面上,该界面填充可渲染的视口并跟随用户的头部移动。

floating

覆盖显示为一个漂浮在空间中的矩形,始终保持在用户前面。它不一定会填充整个空间,并且/或者不严格地以头部为中心。

示例

检查启用了哪个 DOM 覆盖

js
if (session.domOverlayState) {
  console.log(session.domOverlayState.type);
} else {
  console.log("DOM overlay not supported or enabled!");
}

规范

规范
WebXR DOM 叠加模块
# dom-xrsession-domoverlaystate

浏览器兼容性

另见