Falcor

Falcor是一个支持DirectX 12和Vulkan的实时渲染框架。它旨在提高研究和原型项目的生产力。

功能包括：

抽象许多常见的图形操作，如着色器编译、模型加载和场景渲染
光线追踪支持
Python脚本支持
渲染图系统，用于构建模块化渲染器
常见的渲染技术，如后处理效果
无偏路径追踪器
集成各种RTX SDK，如DLSS、RTXDI和NRD

先决条件

Windows 10版本20H2（2020年10月更新）或更新版本，OS构建版本.789或更新
Visual Studio 2022
Windows 10 SDK (10.0.19041.0) for Windows 10, version 2004
支持DirectX光线追踪的GPU，如NVIDIA Titan V或GeForce RTX
NVIDIA驱动程序466.11或更新版本

可选：

Windows 10图形工具。要启用调试层运行DirectX 12应用程序，您必须安装此工具。安装方法有两种：
- 点击Windows按钮并输入可选功能，在打开的窗口中点击添加功能并选择图形工具。
- 从此处下载离线安装包。选择与您使用的操作系统版本匹配的ZIP文件（不是用于构建Falcor的SDK版本）。ZIP文件包含一个说明如何安装图形工具的文档。
NVAPI、CUDA、OptiX（见下文）

构建Falcor

Falcor使用CMake构建系统。有关如何使用CMake的Falcor的更多信息，请参阅CMake开发文档页面。

Visual Studio

如果您使用Visual Studio 2022，可以在克隆此存储库后运行setup_vs2022.bat来设置原生Visual Studio解决方案。解决方案文件将写入build/windows-vs2022，二进制输出位于build/windows-vs2022/bin。

Visual Studio Code

如果您使用Visual Studio Code，请在克隆此存储库后运行setup.bat。这将在.vscode文件夹中设置一个具有合理默认值的VS Code工作区（仅当.vscode尚不存在时）。在VS Code中打开项目文件夹时，它会提示安装推荐的扩展。我们建议您这样做，但至少确保安装了_CMake Tools_。要构建Falcor，您可以通过执行_CMake: Select Configure Preset_操作（Ctrl+Shift+P）来选择配置预设。选择_Windows Ninja/MSVC_预设。然后只需点击_Build_（或按F7）即可构建项目。二进制输出位于build/windows-ninja-msvc/bin。

警告：请勿从_Git Bash_启动VS Code，它会将PATH环境变量修改为不兼容的格式，导致CMake出现问题。

Linux

Falcor对Ubuntu 22.04有实验性支持。要在Linux上构建Falcor，请在克隆此存储库后运行setup.sh。您还需要使用以下命令安装一些系统库头文件：

sudo apt install xorg-dev libgtk-3-dev

您可以使用与上述_Visual Studio Code_部分相同的说明来构建Falcor，只需选择_Linux/GCC_预设即可。

配置预设

Falcor使用存储在CMakePresets.json中的_CMake预设_提供一组常用的构建配置。您可以运行cmake --list-presets获取可用配置预设的完整列表：

$ cmake --list-presets
Available configure presets:

  "windows-vs2022"           - Windows VS2022
  "windows-ninja-msvc"       - Windows Ninja/MSVC
  "linux-clang"              - Linux Ninja/Clang
  "linux-gcc"                - Linux Ninja/GCC

使用cmake --preset <预设名称>为给定预设生成构建树。构建树将写入build/<预设名称>文件夹，二进制输出文件位于build/<预设名称>/bin。

可以使用cmake --build build/<预设名称>编译现有的构建树。

Python中的Falcor

有关如何将Falcor作为Python模块使用的更多信息，请参阅Python中的Falcor。

Microsoft DirectX 12 Agility SDK

Falcor使用Microsoft DirectX 12 Agility SDK来访问最新的DirectX 12功能。应用程序可以通过在主.cpp文件中放置FALCOR_EXPORT_D3D12_AGILITY_SDK来启用Agility SDK。Mogwai、FalcorTest和RenderGraphEditor默认启用了Agility SDK。

NVAPI

要启用NVAPI支持，请前往https://developer.nvidia.com/nvapi 并下载最新版本的NVAPI（此构建已针对R535版本进行测试）。将zip文件的内容提取到external/packman/，并将R535-developer重命名为nvapi。

NSight Aftermath

要启用NSight Aftermath支持，请前往https://developer.nvidia.com/nsight-aftermath 并下载最新版本的Aftermath（此构建已针对2023.1版本进行测试）。将zip文件的内容提取到external/packman/aftermath。

CUDA

要启用CUDA支持，请下载并安装CUDA 11.6.2或更高版本，然后重新配置构建。

有关如何使用CUDA的示例，请参见位于Source/Samples/CudaInterop的CudaInterop示例应用程序。

OptiX

如果您想使用Falcor的OptiX功能（特别是OptixDenoiser渲染通道），请下载OptiX SDK（Falcor目前针对OptiX 7.3版本进行测试）。运行安装程序后，将OptiX SDK文件夹链接或复制到external/packman/optix（即，文件external/packman/optix/include/optix.h应存在）。

注意：要编译OptixDenoiser渲染通道，您还需要安装CUDA，详情请参见上文。

NVIDIA RTX SDK

Falcor附带以下NVIDIA RTX SDK：

DLSS (https://github.com/NVIDIA/DLSS)
RTXDI (https://github.com/NVIDIAGameWorks/RTXDI)
NRD (https://github.com/NVIDIAGameWorks/RayTracingDenoiser)

请注意，这些SDK的许可证与Falcor不同，详情请参见LICENSE.md。

资源

Falcor：Falcor的GitHub页面。
文档：其他信息和教程。
- 入门指南
- 渲染图教程
渲染资源：Falcor可加载的场景集合（pbrt-v4格式）。
ORCA：为Falcor优化的场景和资产集合。
Slang：Falcor的着色语言和编译器。

引用

如果您在导致发表的研究项目中使用Falcor，请引用该项目。 BibTex条目为：

@Misc{Kallweit22,
   author =      {Simon Kallweit and Petrik Clarberg and Craig Kolb and Tom{'a}{\v s} Davidovi{\v c} and Kai-Hwa Yao and Theresa Foley and Yong He and Lifan Wu and Lucy Chen and Tomas Akenine-M{\"o}ller and Chris Wyman and Cyril Crassin and Nir Benty},
   title =       {The {Falcor} Rendering Framework},
   year =        {2022},
   month =       {8},
   url =         {https://github.com/NVIDIAGameWorks/Falcor},
   note =        {\url{https://github.com/NVIDIAGameWorks/Falcor}}
}