Version: 2023.1
Unity XR SDK
UnitySubsystemsManifest.json

创建 XR 提供程序

XR 提供程序是 Unity 项目的一部分,由至少一个清单文件和一个或多个原生插件组成。它还可以包括其他资源,例如脚本和图像。只要启动编辑器时您的项目包含这些内容,Unity 就会发现它们。

注意:每当您更改提供程序的清单或编辑器原生插件时,都必须重新启动 Unity。

文件布局

原生插件必须位于相对于 UnitySubsystemsManifest.json 的子文件夹中。如果您的提供程序不是包的一部分,Unity 只能在 Assets 文件夹中最多向下一层找到 UnitySubsystemsManifest.json

UnitySubsystemsManifest.json

此清单包含有关您的提供程序的信息,例如它提供的子系统和插件名称。

For more information, see the UnitySubsystemsManifest.json page.

构建提供程序插件

要了解如何为目标平台构建原生插件,请参阅有关 Unity 原生插件接口 的文档。将您的动态库导入 Unity 后,请确保所有选项(如插件设置中的目标平台)是正确的。

您需要为要实现的子系统注册一个生命周期处理程序。例如:

extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API
UnityPluginLoad(IUnityInterfaces* unityInterfaces)
{
  s_XrDisplay = unityInterfaces->Get<IUnityXRDisplayInterface>();
  UnityLifecycleProvider displayLifecycleHandler =
  {
    NULL, // 这可以是要以 userData 形式传递给以下函数的任何对象
    &Lifecycle_Initialize,
    &Lifecycle_Start,
    &Lifecycle_Stop,
    &Lifecycle_Shutdown
  };
  s_XrDisplay->RegisterLifecycleProvider("Provider Plugin Name", "Display0", &displayLifecycleHandler);

  // 注册其他子系统
}

Note: The parameters passed to RegisterLifecycleProvider must match the name and id fields in your manifest file.

当您稍后调用 Initialize 方法时,将获得一个实例句柄,您可以使用它来调用接受 UnitySubsystemHandle 的方法。示例:

/// 在子系统应初始化以准备进入活动状态时执行的回调。
static UnitySubsystemErrorCode UNITY_INTERFACE_API Lifecycle_Initialize(UnitySubsystemHandle handle, void* data)
{
  // 在图形线程上注册回调。
  UnityXRDisplayGraphicsThreadProvider gfxThreadProvider = { NULL, NULL, &GfxThread_WaitForNextFrameDesc, NULL };
  s_XrDisplay->RegisterProviderForGraphicsThread(handle, &gfxThreadProvider);

  return kUnitySubsystemErrorCodeSuccess;
}

SDK 包中包含一个构建示例插件的示例项目。

在 Unity 中加载

For more information about loading your provider in Unity, see the Runtime discovery and activation of subsystems page.

Unity XR SDK
UnitySubsystemsManifest.json