开发

获取 Oculus MR 设置

更新时间: 2026年4月15日
返回一个 UOculusXRMR_Settings 对象指针,用于在运行时配置混合现实捕捉 (MRC) 属性。

概览

此函数通常是配置 MRC 工作流程的起点。调用 UOculusXRMRFunctionLibrary 中的 GetOculusXRMRSettings() 以获取设置对象,然后读取或修改下面列出的属性,然后将其存回磁盘。
此函数与从 Ini 加载保存至 Ini 配合使用,从 Engine.ini 文件中加载 Oculus MR 设置对象的内容,或将 Oculus MR 设置对象的内容保存至该文件。

Blueprint

Get Oculus MR Settings Blueprint node with an Oculus MR Settings object return value.

参数

  • 无参数。

输出

返回值:返回值是指向 UOculusXRMR_Settings 对象的指针,该对象具有以下属性:
  • bIsCasting (GetIsCasting/SetIsCasting) - 开启和关闭 MRC(不会保存至 ini 或从中加载)。
  • CompositionMethod (GetCompositionMethod/SetCompositionMethod)
    • ExternalComposition(默认):投屏窗口包含背景和前景视图。
    • DirectComposition(已停用):游戏场景与相机画面直接合成。
  • BindToTrackedCameraIndex (BindToTrackedCameraIndexIfAvailable/GetBindToTrackedCameraIndex) - 游戏内 MRC 相机应绑定到的已校准外部相机的索引。
  • ClippingReference - 指定从相机到 MRC 投屏背景/前景边界的距离。设置为 CR_TrackingReference 以使用到追踪参考的距离(推荐用于静止体验)。设置为 CR_Head 以使用到 HMD 的距离(默认值,推荐用于移动体验)。
  • bUseTrackedCameraResolution - 如果为 true,则投屏视口将使用与校准过程中使用的相机相同的分辨率。
  • WidthPerView - 当 bUseTrackedCameraResolution 为 false 时,设置每个投屏视口(前景、背景或直接合成)的宽度。
  • HeightPerView- 当 bUseTrackedCameraResolution 为 false 时,设置每个投屏视口(前景、背景或直接合成)的高度。
  • CastingLatency - 当 CompositionMethod 设置为 ExternalComposition 时,设置投屏输出的延迟。此设置可用于帮助与外部合成应用程序中的相机延迟同步。
  • BackdropColor - 当 CompositionMethod 设置为 ExternalComposition 时,设置前景视图中的背景颜色。
  • ExternalCompositionPostProcessEffects - 当 CompositionMethod 设置为 ExternalComposition 时,设置 MRC 输出中显示的后处理效果数量。PPE_Off 会禁用所有后处理效果。PPE_On 会启用后处理效果,但可能导致视觉不准确。

已停用的属性

以下属性已停用,可能会在未来版本的 Meta XR 插件中移除:
  • CapturingCamera(已停用)- 此前用于指定为直接合成提供视频帧的物理相机设备。获取器始终返回 CD_None_DEPRECATED,设置器无操作。
  • HandPoseStateLatency(已停用)- 此前为合成场景中的追踪控制器添加以秒为单位的延迟,用于校正相机延迟。已与直接合成一同停用。
  • ChromaKeyColor(已停用)- 此前指定绿幕的近似颜色作为合成参考。
  • ChromaKeySimilarity(已停用)- 此前控制用于隐藏与色度键颜色匹配的像素的色距阈值。
  • ChromaKeySmoothRange(已停用)- 此前定义视频帧像素渲染为半透明状态的色距范围。
  • ChromaKeySpillRange(已停用)- 此前定义视频帧像素去饱和度以减少绿边的色距范围。

示例

此示例展示如何将“获取 Oculus MR 设置”与几个相关的 Blueprint 函数搭配使用。该图表将检索 MRC 设置对象,从 ini 文件加载值,然后存回更新后的设置。
Blueprint graph using Get Oculus MR Settings with Load from Ini and Save to Ini nodes.