TressFX 项目使用教程

1. 项目目录结构及介绍

TressFX 项目的目录结构如下：

TressFX/
├── bin/
│   └── ...
├── build/
│   └── ...
├── doc/
│   └── ...
├── libs/
│   └── ...
├── maya-plugin/
│   └── ...
├── src/
│   ├── Common/
│   ├── DX12/
│   ├── Math/
│   ├── Shaders/
│   ├── TressFX/
│   └── VK/
├── .gitattributes
├── .gitignore
├── .gitmodules
├── CMakeLists.txt
├── README.md
└── license.txt

目录介绍

• bin/: 包含编译后的可执行文件。
• build/: 包含用于生成 Visual Studio 解决方案的脚本。
• doc/: 包含项目的文档，包括开发者指南。
• libs/: 包含 AMD Radeon® Cauldron 开源库。
• maya-plugin/: 包含 Autodesk® Maya® 插件。
• src/: 包含项目的源代码。
  • Common/: 包含渲染 API 无关的实现。
  • DX12/: 包含 DirectX® 12 特定的代码。
  • Math/: 包含 TressFX 数学库。
  • Shaders/: 包含 HLSL 着色器源代码。
  • TressFX/: 包含平台无关的 TressFX 文件。
  • VK/: 包含 Vulkan® 特定的代码。
• .gitattributes: Git 属性文件。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块文件。
• CMakeLists.txt: CMake 配置文件。
• README.md: 项目介绍和使用说明。
• license.txt: 项目许可证文件。

2. 项目启动文件介绍

TressFX 项目的启动文件位于 bin/ 目录下，具体文件名取决于编译的目标平台和 API。常见的启动文件包括：

• TressFX_DX12.exe: 用于 DirectX® 12 平台的可执行文件。
• TressFX_VK.exe: 用于 Vulkan® 平台的可执行文件。

启动步骤

1. 确保已安装所需的依赖项（如 Visual Studio、CMake、Vulkan SDK 等）。
2. 运行 build/GenerateSolutions.bat 脚本生成 Visual Studio 解决方案。
3. 打开生成的解决方案文件（如 TressFX.sln）并编译项目。
4. 编译成功后，在 bin/ 目录下找到相应的可执行文件并运行。

3. 项目的配置文件介绍

TressFX 项目的配置文件主要包括 CMakeLists.txt 和 README.md。

CMakeLists.txt

CMakeLists.txt 是 CMake 的配置文件，用于定义项目的构建规则和依赖项。该文件指定了项目的源文件、库文件、编译选项等。

README.md

README.md 是项目的介绍和使用说明文件，包含了项目的概述、安装步骤、依赖项、编译方法等信息。开发者可以通过阅读该文件快速了解项目的基本情况和使用方法。

其他配置文件

• .gitattributes: 定义 Git 属性，如文件的换行符处理等。
• .gitignore: 定义 Git 忽略的文件和目录，避免将不必要的文件提交到版本库。
• .gitmodules: 定义 Git 子模块，用于管理项目的外部依赖。
• license.txt: 项目的许可证文件，定义了项目的使用许可条款。

通过以上配置文件，开发者可以了解项目的构建和使用方法，并根据需要进行自定义配置。