DiligentEngine项目配置指南：从零开始搭建CMake项目

前言

DiligentEngine是一个现代化的跨平台图形渲染引擎，采用C++编写并支持多种图形API。对于初次接触该引擎的开发者来说，如何正确配置CMake项目可能会遇到一些挑战。本文将详细介绍如何从零开始搭建一个基于DiligentEngine的CMake项目。

基础CMake配置

首先创建一个基本的CMakeLists.txt文件，这是CMake项目的核心配置文件：

cmake_minimum_required(VERSION 3.10)
project(MyDiligentProject CXX)

设置DiligentEngine路径

假设你已经将DiligentEngine源代码克隆到本地，需要设置其路径变量：

set(DILIGENT_DIR ${CMAKE_SOURCE_DIR}/../DiligentEngine)

添加源文件和可执行目标

定义你的项目源文件并创建可执行目标：

set(SOURCE
    src/main.cpp
)

add_executable(MyDiligentProject WIN32 ${SOURCE})

配置图形API支持

DiligentEngine支持多种图形API，你可以根据需要启用：

set(VULKAN_SUPPORTED TRUE)    # 启用Vulkan支持
set(D3D11_SUPPORTED TRUE)     # 启用Direct3D 11支持
set(D3D12_SUPPORTED TRUE)     # 启用Direct3D 12支持
set(GL_SUPPORTED TRUE)        # 启用OpenGL支持

添加DiligentEngine子模块

将DiligentEngine的核心模块和工具添加到你的项目中：

add_subdirectory(${DILIGENT_DIR}/DiligentCore DiligentCore_build)
add_subdirectory(${DILIGENT_DIR}/DiligentSamples/SampleBase SampleBase_build)
add_subdirectory(${DILIGENT_DIR}/DiligentTools/NativeApp NativeApp_build)

配置包含目录

确保编译器能找到所有必要的头文件：

target_include_directories(MyDiligentProject 
    PRIVATE 
    ${DILIGENT_DIR}/DiligentCore/Common/interface
    ${DILIGENT_DIR}/DiligentCore/Graphics/GraphicsEngineD3D12/interface
    ${DILIGENT_DIR}/DiligentCore/Platforms/Win32/interface
    ${DILIGENT_DIR}/DiligentSamples/SampleBase/include
    ${DILIGENT_DIR}/DiligentTools/NativeApp/include
)

链接库文件

将你的项目与DiligentEngine的库文件链接：

target_link_libraries(MyDiligentProject 
    PRIVATE 
    Diligent-BuildSettings
    Diligent-SampleBase
)

# 根据启用的图形API链接相应的库
if(D3D11_SUPPORTED)
    target_link_libraries(MyDiligentProject PRIVATE Diligent-GraphicsEngineD3D11-shared)
endif()
if(D3D12_SUPPORTED)
    target_link_libraries(MyDiligentProject PRIVATE Diligent-GraphicsEngineD3D12-shared)
endif()
if(GL_SUPPORTED)
    target_link_libraries(MyDiligentProject PRIVATE Diligent-GraphicsEngineOpenGL-shared)
endif()
if(VULKAN_SUPPORTED)
    target_link_libraries(MyDiligentProject PRIVATE Diligent-GraphicsEngineVk-shared)
endif()

处理运行时依赖

如果需要复制运行时依赖的DLL文件：

if(COMMAND copy_required_dlls)
    copy_required_dlls(MyDiligentProject)
endif()

常见问题解决方案

1. SampleBase库未构建：确保正确添加了SampleBase子目录，并且路径设置正确。

2. 头文件找不到：检查所有包含路径是否正确设置，特别是接口和include目录。

3. 链接错误：确认所有需要的库都已正确链接，并且图形API支持已正确启用。

最佳实践建议

1. 保持DiligentEngine源代码的路径结构完整，不要随意移动文件位置。

2. 在项目初期，建议从一个简单的示例项目开始，逐步添加功能。

3. 定期同步DiligentEngine的最新版本，以获取最新的功能和修复。

4. 对于复杂的项目，考虑将DiligentEngine作为git子模块引入，便于版本管理。

通过以上步骤，你应该能够成功搭建一个基于DiligentEngine的CMake项目框架。根据你的具体需求，可以进一步定制和扩展这个基础配置。