vrHMDService

vrHMDService() 类

vrHMDService 类

（继承 vrBaseService）

用于访问虚拟现实 HMD（头戴显示器），如 HTC Vive 或 Oculus。

摘要

函数：
信号：

函数

vrHMDService.getActiveOpenXRRuntimeName()
返回值：以字符串的形式返回活动 OpenXR 运行时的名称
返回值类型：string

vrHMDService.getActiveOpenXRSystemName()
返回值：以字符串的形式返回活动 OpenXR 系统的名称
返回值类型：string

vrHMDService.getDefaultRenderMode()

获取将在 HMD 激活时使用的渲染模式。

返回值：渲染模式
返回值类型：vrXRealityTypes.XRRenderMode

vrHMDService.getDepthTextureEnabled()

检查是否启用了位置时间扭曲的深度纹理。

返回值：如果已启用，则为 True；如果已禁用，则为 False
返回值类型：bool

vrHMDService.getEyeGaze()

在视角跟踪处于活动状态时，返回跟踪的眼睛注视数据。在不进行视角跟踪时，返回 HMD 用户的前视光线。注视光线以世界坐标表示。

注意：在 OpenXR 模式下，此项目前不可用。
返回值：注视数据
返回值类型：vrdEyeGaze

vrHMDService.getEyeTrackingEnabled()

返回是否应在虚拟现实中启用视角跟踪。请注意，这不能说明 HMD 实际上是否支持视角跟踪，或者当前是否正在运行视角跟踪。对于后者，请使用 vrHMDService.isEyeTrackingActive()。

返回值：如果启用，则为 True
返回值类型：bool

vrHMDService.getFovealRegionSize()

获取焦点渲染模式下焦点区域的大小。

返回值：焦点区域大小
返回值类型：float

vrHMDService.getFoveatedRenderingEnabled()

返回是否应在虚拟现实中启用焦点渲染。请注意，这不能说明显卡实际上是否支持焦点渲染。

返回值：如果启用，则为 True
返回值类型：bool

vrHMDService.getFoveatedRenderingQuality(preset)

获取给定预设的质量设置。

参数：preset (vrRenderTypes.FoveatedQualityPreset) - 焦点渲染模式下使用的着色质量的预设。
返回值：质量设置
返回值类型：vrdFoveatedQuality

vrHMDService.getFoveatedRenderingQualityPreset()

获取用于焦点渲染的质量预设。可使用 getFoveatedRenderingQuality(vrRenderTypes::FoveatedQualityPreset) 获取预设的各个设置。

返回值：当前预设
返回值类型：vrRenderTypes.FoveatedQualityPreset

vrHMDService.getMixedRealityDepthEstimationEnabled()

检查是否启用了针对混合现实的深度测试。

返回值：如果启用，则为 True（即使不可用也为 True），否则为 False
返回值类型：bool

vrHMDService.getMixedRealityEyeOffsetPercentage()

获取摄影机与混合现实的视点之间的偏移（以百分比为单位）。

返回值：视点与摄影机之间的偏移，位于 0.0 到 1.0 范围之间
返回值类型：float

vrHMDService.getMixedRealityHandDepthEstimationEnabled()

检查是否启用了针对混合现实的深度测试。

返回值：如果启用，则为 True（即使不可用也为 True），否则为 False
返回值类型：bool

vrHMDService.getOpenXRDepthLayerCompositionEnabled()
返回值：返回深度合成层是否应提交到 OpenXR 运行时。
返回值类型：bool

vrHMDService.getVarjoRenderSettings()

获取特定于 Varjo HMD 的当前渲染设置。

返回值：Varjo HMD 的渲染设置
返回值类型：vrdVarjoRenderSettings

vrHMDService.getXRRenderMode()

获取当前设置的扩展现实渲染模式。

返回值：当前设置的渲染模式，如果未附加任何支持透视的 HMD，则将返回 FullScene
返回值类型：vrXRealityTypes.XRRenderMode

vrHMDService.isEyeTrackingActive()

返回视角跟踪当前是否处于活动状态。仅当在虚拟现实中启用时以及 HMD 的视角跟踪器受 VRED 支持时，它才能处于活动状态。

返回值：如果处于活动状态，则为 True
返回值类型：bool

vrHMDService.isHmdActive()

检查 HMD（虚拟现实）显示模式是否处于活动状态。

返回值：如果处于 HMD 模式，则为 True
返回值类型：bool

vrHMDService.isMixedRealityDepthEstimationSupported()
返回值：如果当前活动的 HMD 在混合现实中支持深度测试，则为 True
返回值类型：bool

vrHMDService.isMixedRealitySupported()

检查当前激活的 HMD 是否支持混合现实。

返回值：如果不支持混合现实，或当前无 HMD 处于活动状态，则为 False，否则为 True
返回值类型：bool

vrHMDService.isXRRenderModeSupported(mode)

检查当前活动的 HMD 是否支持扩展现实渲染模式。

参数：mode (vrXRealityTypes.XRRenderMode) - 渲染模式
返回值：如果支持渲染模式，则为 True，否则为 False
返回值类型：bool

vrHMDService.setDefaultRenderMode(mode)

设置将在 HMD 激活时使用的渲染模式。

参数：mode (vrXRealityTypes.XRRenderMode) - 在激活时设置的渲染模式。如果模式不为 FullScene 且 HMD 不支持混合现实，则激活时将激活 FullScene 模式

vrHMDService.setDepthTextureEnabled(enabled)

启用/禁用位置时间扭曲的深度纹理（如果可用）。

参数：enabled (bool) - 为 True 时启用，为 False 时禁用

vrHMDService.setEyeTrackingEnabled(enabled)

在虚拟现实中启用或禁用视角跟踪（如果连接的 HMD 支持）。如果在启用虚拟现实模式之前设置了该选项，则在进入虚拟现实模式时应用该选项。启用视角跟踪以进行焦点渲染。

参数：enabled (bool) - 为 True 时启用视角跟踪，为 False 时禁用视角跟踪

vrHMDService.setFovealRegionSize(size)

设置焦点渲染模式下焦点区域的大小。请参见 vrHMDService.setFoveatedRenderingEnabled(enabled)。

参数：size (float) - 焦点区域大小。

vrHMDService.setFoveatedRenderingCustomQuality(quality)

允许为焦点渲染模式下使用的着色质量设置自定义配置。可通过将 vrHMDService.setFoveatedRenderingQualityPreset(preset) 设置为“自定义”来启用自定义质量。

参数：quality (vrdFoveatedQuality) –焦点着色质量设置。

vrHMDService.setFoveatedRenderingEnabled(enabled)

在虚拟现实中启用或禁用焦点渲染。这需要 NVIDIA Turing 显卡支持的 OpenGL 着色率图像扩展。如果在启用虚拟现实模式之前设置了该选项，则在进入虚拟现实模式时应用该选项。

参数：enabled (bool) - 为 True 时启用焦点渲染，为 False 时禁用焦点渲染。

vrHMDService.setFoveatedRenderingQualityPreset(preset)

设置用于焦点渲染的质量预设。

参数：preset (vrRenderTypes.FoveatedQualityPreset) - 焦点渲染模式下使用的着色质量的预设。

vrHMDService.setMixedRealityDepthEstimationEnabled(enabled)

启用/禁用针对混合现实的深度测试（如果支持）。通过深度测试，真实世界可以遮挡渲染图像的某些部分。

参数：enabled (bool) - 为 True 时启用，为 False 时禁用

vrHMDService.setMixedRealityEyeOffsetPercentage(offset)

设置混合现实的摄影机与视点之间的偏移（以百分比为单位）。将混合现实视频的视点与渲染的视点相匹配时需要此设置。

参数：offset (float) - 视点与摄影机之间的偏移，介于 0.0 到 1.0 之间

vrHMDService.setMixedRealityHandDepthEstimationEnabled(enabled)

启用/禁用针对混合现实的深度测试（如果支持）。通过深度测试，真实世界的手可以遮挡渲染图像的某些部分。

参数：enabled (bool) - 为 True 时启用，为 False 时禁用

vrHMDService.setOpenXRDepthLayerCompositionEnabled(enable)

启用或禁用深度合成层的提交，以向 OpenXR 运行时提供深度信息，例如，可用于位置时间扭曲或混合现实。请注意，并非所有运行时或 HMD 都支持此功能。

参数：enable (bool) - 为 True 时启用，为 False 时禁用。

vrHMDService.setVarjoRenderSettings(settings)

为 Varjo HMD 应用特定渲染设置。对这些设置所做的更改将在下次激活 Varjo HMD 模式时生效。

参数：settings (vrdVarjoRenderSettings) -

vrHMDService.setXRRenderMode(mode)

设置 HMD 的扩展现实渲染模式（如果可用）。

参数：mode (vrXRealityTypes.XRRenderMode) - 渲染模式

信号

vrHMDService.eyeGazeChanged()

在视角跟踪处于活动状态时，在每帧中触发此信号。

vrHMDService.foveatedRenderingStateChanged(enabled)

焦点渲染状态更改时触发此信号。

参数：enabled (bool) - 如果已启用焦点渲染，则为 True。

vrHMDService.handDepthEstimationChanged(enabled)

启用或禁用了混合现实中的深度测试时触发此信号。

参数：enabled (bool) - 如果启用了深度测试，则为 True，否则为 False

vrHMDService.hmdStatusChanged(active)

打开或关闭 HMD（虚拟现实）显示模式时触发此信号。

参数：active (bool) - 如果已打开 HMD 模式，则为 True

vrHMDService.hmdStatusWillChange(active)

打开或关闭 HMD（虚拟现实）显示模式之前触发此信号。

参数：active (bool) - 如果将打开 HMD 模式，则为 True，否则为 False

vrHMDService.XRRenderModeChanged(mode)

更改了扩展现实渲染模式时触发此信号。

参数：mode (vrXRealityTypes.XRRenderMode) - 渲染已切换到的模式。
父页面: VRED Python API v2