Atlas-Engine 项目教程

Atlas-Engine 项目教程

Atlas-Engine Cross platform toy render engine supporting physically based rendering and hardware/software ray tracing 项目地址: https://gitcode.com/gh_mirrors/at/Atlas-Engine

1. 项目目录结构及介绍

Atlas-Engine 项目的目录结构如下：

Atlas-Engine/
├── CMakeLists.txt
├── Doxyfile
├── LICENSE.md
├── README.md
├── THIRDPARTY.md
├── vcpkg.json
├── vsbuild.bat
├── data/
├── libs/
├── src/
└── wiki/

目录介绍

• CMakeLists.txt: 项目的 CMake 配置文件，用于构建项目。
• Doxyfile: Doxygen 配置文件，用于生成项目的文档。
• LICENSE.md: 项目的开源许可证文件，采用 MIT 许可证。
• README.md: 项目的介绍文件，包含项目的基本信息和使用说明。
• THIRDPARTY.md: 第三方依赖的版权声明文件。
• vcpkg.json: Vcpkg 配置文件，用于管理项目的依赖库。
• vsbuild.bat: 用于在 Windows 上编译项目的批处理文件。
• data/: 存放项目的数据文件，如模型、纹理等。
• libs/: 存放项目的库文件，包括第三方库和自定义库。
• src/: 项目的源代码目录，包含引擎的核心代码和示例应用程序。
• wiki/: 项目的 Wiki 页面，包含详细的文档和教程。

2. 项目启动文件介绍

Atlas-Engine 项目的启动文件主要位于 src/ 目录下。以下是一些关键的启动文件：

• src/main.cpp: 这是项目的入口文件，包含了应用程序的主函数。它负责初始化引擎并启动应用程序。
• src/AtlasEngineDemo.cpp: 这是示例应用程序的源文件，展示了如何使用 Atlas-Engine 创建一个简单的渲染场景。

启动流程

1. 初始化引擎: 在 main.cpp 中，首先初始化引擎的各个模块，如渲染器、输入系统等。
2. 加载场景: 加载预定义的场景数据，如模型、纹理等。
3. 启动主循环: 进入主循环，处理每一帧的渲染和输入事件。

3. 项目的配置文件介绍

Atlas-Engine 项目的配置文件主要包括以下几个：

• CMakeLists.txt: 这是 CMake 的配置文件，定义了项目的构建规则和依赖项。
• vcpkg.json: 这是 Vcpkg 的配置文件，用于管理项目的第三方依赖库。
• vsbuild.bat: 这是 Windows 上的批处理文件，用于简化项目的编译过程。

CMakeLists.txt

CMakeLists.txt 文件定义了项目的构建规则，包括源文件的组织、目标库的生成、依赖项的链接等。以下是一些关键配置项：

• ATLAS_BUILD_SHARED: 控制项目是否构建为共享库。
• ATLAS_EXPORT_MAIN: 控制是否导出主文件以供其他项目使用。
• ATLAS_NO_APP: 禁用引擎的主函数和应用程序功能。
• ATLAS_IMGUI: 启用 ImGui 集成。
• ATLAS_ASSIMP: 启用 Assimp 集成。
• ATLAS_HEADLESS: 启用无头模式，即不创建窗口。
• ATLAS_BINDLESS: 启用无绑定资源支持。
• ATLAS_TESTS: 生成测试项目。
• ATLAS_BUNDLE: 允许在 MacOS 上打包和安装应用程序。

vcpkg.json

vcpkg.json 文件定义了项目所需的第三方库及其版本。通过 Vcpkg，可以方便地管理这些依赖项。

vsbuild.bat

vsbuild.bat 是一个批处理文件，用于在 Windows 上编译项目。它简化了 CMake 的配置和构建过程，自动调用 CMake 并启动 Visual Studio。

总结

通过本教程，您应该对 Atlas-Engine 项目的目录结构、启动文件和配置文件有了基本的了解。这些知识将帮助您更好地理解和使用 Atlas-Engine 进行开发。

Atlas-Engine Cross platform toy render engine supporting physically based rendering and hardware/software ray tracing 项目地址: https://gitcode.com/gh_mirrors/at/Atlas-Engine