Unity-DepthAPI 开源项目教程

项目概述

Unity-DepthAPI 是由 Oculus 提供的一个示例仓库，它展示了如何利用深度 API 实现实时动态遮挡效果。这个技术对于创建虚拟与现实内容之间可信的视觉交互至关重要，增强用户的沉浸感体验。该项目支持 Unity 的不同渲染管线（BiRP 和 URP），并基于特定版本的 Unity 引擎和 Meta XR Core SDK。

目录结构及介绍

以下是 Unity-DepthAPI 仓库的主要目录结构及各部分简要说明：

• DepthAPI-BiRP: 支持 Unity 的内置渲染管线(Built-in Render Pipeline)的示例项目。
• DepthAPI-URP: 针对通用渲染管线(Universal Render Pipeline)设计的示例项目。
• Assets: 包含两个示例项目共有的资源文件夹，如场景、脚本和着色器。
  • Scenes: 存放所有的示例场景，比如用于展示基本设置和模式切换的 OcclusionToggler 场景。
  • Scripts: 包含关键脚本，如用于管理环境深度的 EnvironmentDepthManager.cs。
  • Shaders: 含有实现深度遮挡的各种着色器。
• LICENSE: 许可证文件。
• README.md: 项目主要的说明文档，包含了安装、配置和使用的详细步骤。
• CODE_OF_CONDUCT.md, CONTRIBUTING.md: 代码行为准则和贡献指南。

启动文件介绍

在 Unity 中开始项目之前，首先要确保你已设置了正确的 Unity 环境。选择 DepthAPI-BiRP 或 DepthAPI-URP 文件夹作为启动项目。这两个项目都具有独立的配置，分别适用于不同的 Unity 渲染引擎设置。

• Unity 工程启动：
  1. 使用 Unity Hub，打开对应的 .unity 文件或直接在 Unity 编辑器中通过“Open Project”选择项目文件夹。
  2. 确保符合最低版本要求，并且已经安装了必要的插件和组件，特别是 Meta XR Core SDK v67.0.0 及以上版本。

项目配置文件介绍

主要配置文件

• Project Settings： Unity 项目的核心配置位于“编辑器 -> 项目设置”。对于本项目特别重要的配置包括：

  • Graphics API 应被设置为 Vulkan，以支持 Depth API。
  • StereoRendering Mode 设置为 Multiview，这通常会在使用XR插件时自动配置。
  • 通过 OVR Manager 在 Player Settings 中启用 AndroidManifest.xml 的 USE_SCENE 权限，这是使用 Depth API 的前提条件之一。

• EnvironmentDepthManager.cs 这个脚本是添加到场景中的关键配置组件，负责环境深度的管理和处理，它是实现动态遮挡的基础。

• Passthrough Feature Integration 虽不直接作为一个单独的文件描述，但在项目设置过程中，确保通过 Project Setup Tool 或手动配置来集成 Passthrough 功能，并确保场景支持该功能。

通过遵循官方文档和项目中的指导，开发者可以有效地配置这些设置，使得项目能够利用深度信息来实现精确的动态遮挡，从而提升混合现实应用的真实感和用户体验。